# Alibaba Cloud IoT Platform API

> Alibaba Cloud IoT Platform API on Apizie: 400 endpoints (Imports external data to IoT Platform. Data imported to IoT Platform through this API operation is referred…, Adds existing shared devices in a voice broadcasting sharing task to a sales promotion activity, AddPowerStation, Adds devices to a sharing task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-iot/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-iot`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/iot
- Page: https://apizie.tech/api/cloud/aliyun-iot
- OpenAPI: https://apizie.tech/api/cloud/aliyun-iot/openapi.json

Alibaba Cloud OpenAPI for IoT Platform (iot, version 2018-01-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Imports external data to IoT Platform. Data imported to IoT Platform through this API operation is referred…
`POST https://apizie.tech/v1/cloud:aliyun-iot/add-data-for-api-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ApiId | string | yes | The API datasource ID, which is the API ID. You can view the API ID of the API datasource on the data analytics > Data Collection >… |
| Content | string | yes | The data content to be uploaded to IoT Platform. The content must be in JSON format. The JSON data must contain the ts field, which… |

### Adds existing shared devices in a voice broadcasting sharing task to a sales promotion activity
`POST https://apizie.tech/v1/cloud:aliyun-iot/add-device-to-share-promotion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| SharePromotionActivityId | string | yes | The ID of the sales promotion activity. The value is the Data parameter returned by calling the CreateSharePromotionActivity API operation |
| ShareTaskCode | string | yes | The sharing code of the sharing task. For more information about the sharing code of a sharing task, refer to… |
| IotInstanceId | string | no | Instance ID of the instance. You can view instance ID of the current instance on the Instance Overview tab in the IoT Platform console. If… |
| DeviceSimpleInfoList | string | yes | The DeviceSimpleInfoList (JSON-encoded) |

### AddPowerStation
`POST https://apizie.tech/v1/cloud:aliyun-iot/add-power-station` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | yes | The IotInstanceId |
| AlgorithmInstanceUid | string | yes | The AlgorithmInstanceUid |
| PowerStationName | string | yes | The PowerStationName |
| Description | string | no | The Description |
| RatedPower | integer | yes | The RatedPower |

### Adds devices to a sharing task
`POST https://apizie.tech/v1/cloud:aliyun-iot/add-share-task-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ShareTaskId | string | yes | The ID of the sharing task |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID is… |
| ProductKey | string | no | The ProductKey of the product to which the devices to be added belong. You can view the information about all products under the current… |
| IotIdList | string | no | The list of devices to be added. You must specify the IotId of each device. You can obtain this parameter by calling the… |

### Sends a message to a specified device
`POST https://apizie.tech/v1/cloud:aliyun-iot/async-rrpc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |
| ProductKey | string | yes | The ProductKey of the product to which the device that receives the message belongs |
| DeviceName | string | yes | The device name of the device that accepts the message |
| ExtInfo | string | no | When you send a message to a device that uses the cloud gateway GB/T 32960 protocol, you must specify this parameter to indicate the… |
| MessageContent | string | yes | The body of the message to be sent. You must convert the original message into binary data and encode the data in Base64 to generate the… |
| TopicFullName | string | no | When you send a message to a device that uses the MQTT protocol, you must specify the custom topic of the device. The operation… |

### Associates a specified data destination with a parser
`POST https://apizie.tech/v1/cloud:aliyun-iot/attach-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IsFailover | string | yes | Specifies whether the data destination is configured to forward error operation data, which refers to data that fails to be forwarded to… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ParserId | integer | yes | The parser ID. You can call the https://help.aliyun.com/document_detail/429046.html operation to query the parser list and obtain the… |
| DestinationId | integer | yes | The data destination ID. You can call the https://help.aliyun.com/document_detail/433025.html operation to query the data destination list… |

### Associates a specified data source with a specified parser
`POST https://apizie.tech/v1/cloud:aliyun-iot/attach-parser-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| ParserId | integer | yes | The parser ID. You can call the https://help.aliyun.com/document_detail/429046.html operation to query the parser list and obtain the… |
| DataSourceId | integer | yes | The data source ID. You can call the https://help.aliyun.com/document_detail/432676.html operation to query the data source list and… |

### Imports external data to IoT Platform in batches. Data imported to IoT Platform by using this API operation…
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-add-data-for-api-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ApiId | string | yes | The ID of the API data source, which is the API ID. You can view the API ID of the API data source on the data analytics > Data Collection… |
| ContentList | string | yes | The data content to be uploaded to IoT Platform in batches, in JSON list format. The JSON list can contain up to 100 JSON objects. Each… |

### Adds one or more devices to a specified group
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-add-device-group-relations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| GroupId | string | yes | The group ID, which is the globally unique identifier of the group |
| Device | string | no | The list of devices to be added to the group (JSON-encoded) |

### Adds device topology relationships in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-add-thing-topo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| GwProductKey | string | yes | The ProductKey of the product to which the gateway device belongs |
| GwDeviceName | string | yes | The name of the gateway device |
| TopoAddItem | string | yes | The list of device topology relationships to be added (JSON-encoded) |

### Assigns devices to an edge instance in batches and configures drivers for the devices
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-bind-device-to-edge-instance-with-driver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | Instance ID of the edge instance. On the Edge Instances page of the Link IoT Edge console… |
| DriverId | string | yes | The ID of the driver. On the Drivers page of the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list), move the pointer… |
| IotIds | string | yes | The list of device IDs. You can call the https://help.aliyun.com/document_detail/69905.html operation to query all devices under the… |

### Associates devices with a project in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-bind-devices-into-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| ProjectId | string | yes | The project ID. Log on to the IoT Studio console (https://studio.iot.aliyun.com/?spm=a2c4g.11186623.2.8.1e7830fagdybMb). In the upper-left… |
| Devices | string | yes | The list of devices (JSON-encoded) |

### Associates multiple products with a project
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-bind-products-into-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. Enterprise Enterprise instance: You must specify this parameter. You can view the ID of your Enterprise Enterprise… |
| ProjectId | string | yes | The project ID. Log on to the IoT Studio console (https://studio.iot.aliyun.com/?spm=a2c4g.11186623.2.8.1e7830fagdybMb). In the upper-left… |
| ProductKeys | string | yes | The list of ProductKeys of the products to be associated with the project (JSON-encoded) |

### Invokes this operation to customize device names in batches under a specified product. IoT Platform checks…
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-check-device-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the product to which the devices to be registered belong |
| DeviceName | string | no | The DeviceName (JSON-encoded) |
| DeviceNameList | string | no | The DeviceNameList (JSON-encoded) |

### Validates imported devices in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-check-import-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the cloud gateway product to which the device belongs |
| DeviceList | string | yes | The list of devices to be validated in batches. You can specify information about up to 10,000 devices in a single call. Data that exceeds… |

### Validates imported cloud gateway devices in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-check-vehicle-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| ProductKey | string | yes | The ProductKey of the cloud gateway product to which the device belongs |
| DeviceList | string | yes | The list of devices to be validated in batches (JSON-encoded) |

### Clears the device configurations of an edge instance in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-clear-edge-instance-device-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | The edge instance ID. You can obtain the ID by moving the pointer over the name of the target edge instance on the Edge Instance page in… |
| IotIds | string | yes | The list of device IDs to query. You can call the https://help.aliyun.com/document_detail/135261.html operation to query the device IDs in… |

### Creates sound code labels in batches for a specified schedule
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-create-sound-code-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| Total | integer | yes | The number of sound codes to create in a batch. Valid values: 1 to 200. The system automatically generates a label consisting of a random… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ScheduleCode | string | yes | The unique identifier of the schedule |
| Description | string | no | The description of the batch. The description must be 1 to 64 characters in length. Each Chinese character counts as two characters |

### Creates sound code labels in batches for a specified schedule
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-create-sound-code-label-with-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| ScheduleCode | string | yes | The unique identifier of the schedule |
| Description | string | no | The batch description. The description must be 1 to 64 characters in length, and each Chinese character counts as two characters |
| Labels | string | yes | The list of labels. You can specify 1 to 200 labels. Each label must be 1 to 64 characters in length, and each Chinese character counts as… |

### Calls the BatchDeleteDeviceGroupRelations operation to remove devices from a specified group in a batch.…
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-delete-device-group-relations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If this parameter is… |
| GroupId | string | yes | The group ID, which is the globally unique identifier of the group |
| Device | string | no | The list of devices to remove from the group (JSON-encoded) |

### Deletes driver channels from an edge instance in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-delete-edge-instance-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances. You must specify this parameter for Enterprise instances |
| InstanceId | string | yes | The ID of the edge instance. To obtain the ID, go to the Edge Instances page in the Link IoT Edge console… |
| DriverId | string | yes | The driver ID. To obtain the ID, go to the Drivers page in the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list) and… |
| ChannelIds | string | yes | The IDs of the driver channels. You can call the https://help.aliyun.com/document_detail/162253.html operation to obtain the channel IDs.… |

### Queries the binding status of gateways or devices to edge instances in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-device-bind-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances. You must specify this parameter for Enterprise instances |
| IotIds | string | yes | The list of device IDs. You can call the https://help.aliyun.com/document_detail/69905.html operation to query device IDs. You can specify… |

### Queries the running status of specified devices under the same product in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-device-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | no | The ProductKey of the product to which the devices whose running status you want to query belong. If you specify this parameter, you must… |
| DeviceName | string | no | The names of the devices whose running status you want to query. If you specify this parameter, you must also specify ProductKey.… |
| IotId | string | no | The IDs of the devices whose running status you want to query. IotId is the unique identifier of a device and corresponds to the… |

### Queries driver information in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-edge-driver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| DriverIds | string | yes | The list of driver IDs. You can specify up to 30 driver IDs, which means you can query the information of up to 30 drivers at a time. For… |

### Queries driver channels in edge instances in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-edge-instance-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for an Enterprise instance |
| InstanceId | string | yes | The ID of the edge instance. On the Edge Instances page of the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list),… |
| DriverId | string | yes | The driver ID. On the Drivers page of the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list), move the pointer over… |
| ChannelIds | string | yes | The list of driver channel IDs. You can call the https://help.aliyun.com/document_detail/162253.html operation to obtain channel IDs. You… |

### Retrieves the driver channels associated with sub-devices in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-edge-instance-device-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for an Enterprise instance |
| InstanceId | string | yes | The ID of the edge instance. On the Edge Instances page of the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list),… |
| DriverId | string | yes | The driver ID. On the Drivers page of the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list), move the pointer over… |
| IotIds | string | yes | The list of sub-device IDs. You can call the https://help.aliyun.com/document_detail/69905.html operation to query sub-device IDs. You can… |

### Retrieves the device configurations of an edge instance in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-edge-instance-device-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | Instance ID of the edge instance. On the Edge Instances page of the Link IoT Edge console… |
| IotIds | string | yes | The list of device IDs to query. You can call the https://help.aliyun.com/document_detail/135261.html operation to query the device IDs in… |

### Retrieves the drivers associated with sub-devices
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-edge-instance-device-driver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances. You must specify this parameter for Enterprise instances |
| InstanceId | string | yes | The ID of the edge instance. To obtain the ID, go to the Edge Instances page in the Link IoT Edge console… |
| IotIds | string | yes | The list of sub-device IDs. You can call the https://help.aliyun.com/document_detail/69905.html operation to query device IDs. You can… |

### Retrieves the driver configurations of edge instances in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-get-edge-instance-driver-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for Enterprise instances |
| InstanceId | string | yes | Instance ID of the edge instance. On the Edge Instances page of the Link IoT Edge console… |
| DriverIds | string | yes | The list of driver IDs to query. On the Driver Management page of the Link IoT Edge console… |

### Continues the canary migration of newly added devices
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-gray-migration-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ProductKey | string | yes | The ProductKey of the product to which the device belongs |
| DeviceNames | string | yes | The list of device names to be migrated in the canary release. You can specify up to 10 device names in a single call. Device names that… |

### Imports devices in batches under an MQTT instance or an MQTT cloud gateway product
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-import-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |
| ProductKey | string | yes | The ProductKey of the cloud gateway product to which the device belongs |
| DeviceList | string | yes | The list of devices to be imported in batches. You can specify up to 10,000 devices in a single call. Data that exceeds this limit is… |

### Imports devices in batches under a cloud gateway product
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-import-vehicle-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the cloud gateway product to which the device belongs |
| DeviceList | string | yes | The DeviceList (JSON-encoded) |

### Publishes messages in batches to multiple devices under a specified product by using a custom topic
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-pub` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the product to which you want to send messages |
| Qos | integer | no | The quality of service (QoS) level for message delivery. Valid values: 0: At most once. 1: At least once. If you do not specify this… |
| TopicShortName | string | no | The suffix of the custom topic. The format of a custom topic is `/${productKey}/${deviceName}/user/${TopicShortName}`. Specify the suffix… |
| MessageContent | string | yes | The message body to be sent. The maximum size of a message is 256 KB. You must convert the original message into binary data and encode it… |
| TopicTemplateName | string | no | The TopicTemplateName |
| ResponseTopicTemplateName | string | no | The ResponseTopicTemplateName |
| CorrelationData | string | no | The CorrelationData |
| PayloadFormatIndicator | integer | no | The PayloadFormatIndicator |
| ContentType | string | no | The ContentType |
| MessageExpiryInterval | integer | no | The MessageExpiryInterval |
| Retained | string | no | The Retained |
| DeviceName | string | yes | The name of the device that receives the message. This parameter must be used together with ProductKey. The specified devices must belong… |
| UserProp | string | no | The UserProp (JSON-encoded) |

### Queries the details of multiple devices under a specified product
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-query-device-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ProductKey | string | yes | The ProductKey of the product to which the devices in DeviceName.N belong |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| DeviceName | string | yes | The list of device names to query. A maximum of 100 device names can be included. The queried devices must belong to the same product… |

### Registers multiple devices in batches under a specified product with randomly generated device names
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-register-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If your instance… |
| ProductKey | string | yes | The ProductKey of the product to which the devices to be registered in batches belong |
| Count | integer | yes | The number of devices to be registered. You can register up to 10,000 devices in a single call |

### Registers devices in batches based on the application batch ID (ApplyId)
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-register-device-with-apply-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the product to which the devices to be registered in batches belong |
| ApplyId | integer | yes | The application batch ID of the devices to be registered in batches. The application batch ID is generated by calling the… |

### Associates driver channels with sub-devices in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-set-edge-instance-device-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances but is required for Enterprise instances |
| InstanceId | string | yes | The ID of the edge instance. On the Edge Instances page of the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list),… |
| DriverId | string | yes | The driver ID. On the Drivers page of the Link IoT Edge console (https://iot.console.aliyun.com/le/instance/list), move the pointer over… |
| ChannelId | string | yes | The driver channel ID. You can call the https://help.aliyun.com/document_detail/162253.html operation to obtain the ID |
| IotIds | string | yes | The list of sub-device IDs. You can call the https://help.aliyun.com/document_detail/69905.html operation to query sub-device IDs. You can… |

### Configures devices in an edge instance in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-set-edge-instance-device-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | The edge instance ID. You can obtain the ID by moving the pointer over the name of the target edge instance on the Edge Instances page in… |
| DeviceConfigs | string | yes | The list of device configurations (JSON-encoded) |

### Removes multiple devices from an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-unbind-device-from-edge-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances. You must specify this parameter for Enterprise instances |
| InstanceId | string | yes | The edge instance ID. To obtain the ID, go to the Edge Instances page in the Link IoT Edge console… |
| IotIds | string | yes | The list of device IDs. You can call the https://help.aliyun.com/document_detail/69905.html operation to query all devices under the… |

### Dissociates devices from a project in batches
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-unbind-project-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProjectId | string | yes | The project ID. Log on to the IoT Studio console (https://studio.iot.aliyun.com/?spm=a2c4g.11186623.2.8.1e7830fagdybMb). In the upper-left… |
| Devices | string | yes | The list of devices to be dissociated (JSON-encoded) |

### Dissociates specified products from a specified project. Batch operations are supported
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-unbind-project-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. Enterprise Enterprise instance: You must specify this parameter. You can view the ID of your Enterprise Enterprise… |
| ProjectId | string | yes | The project ID. Log on to the IoT Studio console (https://studio.iot.aliyun.com/?spm=a2c4g.11186623.2.8.1e7830fagdybMb). In the upper-left… |
| ProductKeys | string | yes | The list of ProductKeys of the products to be dissociated from the project (JSON-encoded) |

### Updates the nicknames of multiple devices
`POST https://apizie.tech/v1/cloud:aliyun-iot/batch-update-device-nickname` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| DeviceNicknameInfo | string | yes | The list of devices whose nicknames you want to update (JSON-encoded) |

### Binds an edge application to an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/bind-application-to-edge-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | The ID of the edge instance. On the Edge Instances page of the edge computing console (https://iot.console.aliyun.com/le/instance/list),… |
| ApplicationId | string | yes | The ID of the edge application. On the Application Management page of the edge computing console… |
| ApplicationVersion | string | yes | The version number of the edge application |

### Assigns a driver to an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/bind-driver-to-edge-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances but is required for Enterprise instances |
| InstanceId | string | yes | The edge instance ID. You can obtain the ID by moving the pointer over the name of the target edge instance on the Edge Instances page in… |
| DriverId | string | yes | The driver ID. You can obtain the ID by moving the pointer over the name of the target driver on the Driver Management page in the Link… |
| DriverVersion | string | no | The driver version number. If you do not specify this parameter, the latest driver version is used by default |
| OrderId | string | no | The order ID. This parameter is required when the driver is a purchased driver. You do not need to specify this parameter when the driver… |

### Assigns a gateway to an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/bind-gateway-to-edge-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances but is required for Enterprise Edition instances |
| InstanceId | string | yes | The edge instance ID. You can obtain the ID by moving the pointer over the name of the target edge instance on the Edge Instances page in… |
| ProductKey | string | no | The ProductKey of the product to which the gateway belongs. It is the unique identifier of the product. If you specify this parameter, you… |
| DeviceName | string | no | The device name of the gateway device. If you specify this parameter, you must also specify ProductKey |
| IotId | string | no | The ID of the gateway device. It is a unique identifier generated by IoT Platform for the device and corresponds to the combination of… |

### Authorizes licenses for devices under a specified product
`POST https://apizie.tech/v1/cloud:aliyun-iot/bind-license-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID of the Enterprise instance. You can view the ID of the current instance on the Instance Overview page in the IoT Platform… |
| LicenseCode | string | yes | The license type (audio and video specifications). Valid values: 480P and 720P |
| ProductKey | string | yes | The ProductKey of the product to which the devices to be authorized belong. You can view the information of all products under the current… |
| IotIdList | string | no | The list of devices to which the license is to be authorized. You must specify the IotId of each device. You can call the… |
| DeviceNameList | string | no | The list of devices to which the license is to be authorized. You must specify the DeviceName of each device. You can call the… |

### Grants a license to a specified product
`POST https://apizie.tech/v1/cloud:aliyun-iot/bind-license-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID of the Enterprise instance. You can view the ID of the current instance on the Instance Overview page in the IoT Platform… |
| LicenseCode | string | yes | The license type, which specifies the audio and video specifications. Valid values: 480P and 720P |
| ProductKey | string | yes | The ProductKey of the product to which you want to grant the license. You can view the information about all products in the current… |

### Binds a role to an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/bind-role-to-edge-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | The edge instance ID. To obtain the ID, go to the Edge Instances page in the Link IoT Edge console… |
| RoleArn | string | yes | The global resource descriptor (ARN) of the authorization role. After you create a role in the Resource Access Management (RAM) console… |
| RoleName | string | yes | The role name |

### Attaches a scene orchestration rule to an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/bind-scene-rule-to-edge-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for Enterprise Edition instances |
| InstanceId | string | yes | The ID of the edge instance. To obtain the ID, move the pointer over the name of the target edge instance on the Edge Instances page in… |
| RuleId | string | yes | The ID of the scene orchestration rule. You can invoke the https://help.aliyun.com/document_detail/169498.html operation to obtain the… |

### Cancels the execution of a task
`POST https://apizie.tech/v1/cloud:aliyun-iot/cancel-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If the ID value is… |
| JobId | string | yes | The task ID. The globally unique identifier of the task |

### Cancels a dynamic upgrade policy
`POST https://apizie.tech/v1/cloud:aliyun-iot/cancel-otastrategy-by-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| JobId | string | yes | The ID of the upgrade job. The JobId returned when you call the https://help.aliyun.com/document_detail/147887.html operation to create an… |

### Cancels the device upgrade jobs that are in the pending upgrade state for a specified firmware
`POST https://apizie.tech/v1/cloud:aliyun-iot/cancel-otatask-by-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| FirmwareId | string | yes | The ID of the OTA upgrade package. The ID is the unique identifier of the OTA upgrade package. The ID of the OTA upgrade package is one of… |
| ProductKey | string | yes | The ProductKey of the product to which the devices whose upgrades are to be canceled belong |
| JobId | string | no | The ID of the update batch. If you specify this parameter, only the device update tasks in the specified batch are canceled. The batch ID… |
| DeviceName | string | yes | The names of the devices whose upgrades are to be canceled. The device names must be unique. You can specify up to 200 device names… |

### Cancels device upgrade jobs in a specified batch
`POST https://apizie.tech/v1/cloud:aliyun-iot/cancel-otatask-by-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| JobId | string | yes | The ID of the upgrade batch. The JobId returned when you call the https://help.aliyun.com/document_detail/147496.html or… |
| CancelScheduledTask | string | no | Specifies whether to cancel the device upgrade jobs in a scheduled upgrade batch. A scheduled upgrade batch is created when you specify… |
| CancelQueuedTask | string | no | Specifies whether to cancel all device upgrade jobs in the QUEUED state in the batch. Valid values: true: Cancels the jobs. false: Does… |
| CancelInProgressTask | string | no | Specifies whether to cancel all device upgrade jobs in the IN_PROGRESS state in the batch. Valid values: true: Cancels the jobs. false:… |
| CancelNotifiedTask | string | no | Specifies whether to cancel all device upgrade jobs in the NOTIFIED state in the batch. Valid values: true: Cancels the jobs. false: Does… |
| CancelUnconfirmedTask | string | no | Specifies whether to cancel all device upgrade jobs in the CONFIRM state in the batch. Valid values: true: Cancels the jobs. false: Does… |

### Unpublishes a specified product
`POST https://apizie.tech/v1/cloud:aliyun-iot/cancel-release-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the product to be unpublished |

### Queries the license authorization progress based on the unique ID (CheckProgressId) returned by the batch…
`POST https://apizie.tech/v1/cloud:aliyun-iot/check-bind-license-device-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | Enterprise instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. For new… |
| LicenseCode | string | yes | The license type (audio and video specifications). Valid values: 480P and 720P |
| ProductKey | string | yes | The ProductKey of the product to which the device belongs. You can view the information about all products under the current instance in… |
| CheckProgressId | string | yes | The unique ID used to query the progress of batch device license authorization |

### Clears the desired property values that have been set for a device
`POST https://apizie.tech/v1/cloud:aliyun-iot/clear-device-desired-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. On the Overview page in the IoT Platform console, you can view the ID of the current instance. If this value exists, you… |
| ProductKey | string | no | The ProductKey of the product to which the device belongs whose desired property values you want to clear. If you specify this parameter,… |
| DeviceName | string | no | The device name of the device whose desired property values you want to clear. If you specify this parameter, you must also specify… |
| IotId | string | no | The ID of the device whose desired property values you want to clear. This is the unique identifier issued by IoT Platform for the device.… |
| Identifies | string | no | The list of property identifiers whose desired property values you want to clear. You can specify up to 10 property identifiers… |

### Clears the driver configurations of an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/clear-edge-instance-driver-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | The edge instance ID. To obtain the ID, go to the Edge Instances page in the Link IoT Edge console… |
| DriverId | string | yes | The driver ID. To obtain the ID, go to the Driver Management page in the Link IoT Edge console… |

### Closes an open secure tunnel
`POST https://apizie.tech/v1/cloud:aliyun-iot/close-device-tunnel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| TunnelId | string | yes | The ID of the secure tunnel to close |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |

### Closes the deployment task ticket for an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/close-edge-instance-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances. You must specify this parameter for Enterprise instances |
| InstanceId | string | yes | Instance ID of the edge instance. On the Edge Instances page of the Link IoT Edge console… |

### Confirms multiple device upgrade jobs that are in the pending confirmation state
`POST https://apizie.tech/v1/cloud:aliyun-iot/confirm-otatask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| TaskId | string | yes | The IDs of the device upgrade jobs that are pending confirmation. You can specify up to 10 task IDs (JSON-encoded) |

### Copies the Thing Specification Language (TSL) model of a specified product to a destination product
`POST https://apizie.tech/v1/cloud:aliyun-iot/copy-thing-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |
| ResourceGroupId | string | no | The resource group ID. IoT Platform supports resource group management only at the instance level. The ResourceGroupId request parameter… |
| SourceProductKey | string | yes | The ProductKey of the product to which the TSL model to be copied belongs. You can view the ProductKey on the Product page in the IoT… |
| TargetProductKey | string | yes | The ProductKey of the destination product. You can view the ProductKey on the Product page in the IoT Platform console, or call the… |
| SourceModelVersion | string | no | The version number of the TSL model to be copied. You can call the https://help.aliyun.com/document_detail/150318.html operation to view… |

### CopyThingModelAsync
`POST https://apizie.tech/v1/cloud:aliyun-iot/copy-thing-model-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| TargetProductKey | string | yes | The TargetProductKey |
| IotInstanceId | string | no | The IotInstanceId |
| SourceModelVersion | string | no | The SourceModelVersion |
| SourceProductKey | string | yes | The SourceProductKey |

### Queries the hourly data volume of shared broadcasts in Qliqli Voice Broadcasting by paging
`POST https://apizie.tech/v1/cloud:aliyun-iot/count-speech-broadcast-hour` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ShareTaskCode | string | yes | The share code of the corpus sharing task. You can obtain the share code on the Shared Corpus Management page of Qliqli Voice Broadcasting… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value is… |
| QueryDateTimeHour | string | yes | The time to query. For example, 2020090919 indicates 19:00 on September 9, 2020 |

### Creates a consumer group for AMQP server-side subscriptions
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| GroupName | string | yes | The name of the consumer group. The name must be 4 to 30 characters in length and can contain Chinese characters, letters, digits, and… |

### Adds a consumer group to an AMQP subscription
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-consumer-group-subscribe-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ConsumerGroupId | string | yes | The ID of the consumer group. After you call the https://help.aliyun.com/document_detail/170388.html operation to create a consumer group,… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| ProductKey | string | yes | The ProductKey of the product in the subscription |

### Creates a data algorithm service API
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-data-apiservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| RequestParam | string | no | The list of request parameters (JSON-encoded) |
| ResponseParam | string | no | The list of response parameters (JSON-encoded) |
| DisplayName | string | yes | The display name of the API. The name must be globally unique. It can contain only Chinese characters, letters, digits, underscores (_),… |
| OriginSql | string | yes | The original SQL statement corresponding to the API, which specifies the SQL style for data development. For example, `select count(*) as… |
| Desc | string | no | The description of the API |
| TemplateSql | string | yes | The template SQL statement of the service, which is the parameterized version of the original SQL statement. For example, `select count(*)… |
| ApiPath | string | yes | The custom part of the API endpoint. As the API resource identifier, it must be globally unique. The first part of the API endpoint is… |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances. You must specify this parameter for Enterprise instances |

### Adds a topic to a data source in the rules engine
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-data-source-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| DataSourceId | integer | yes | The data source ID |
| Topic | string | yes | The specific topic applied to the rules engine. The format is typically `/${productKey}/${deviceName}/topicShortName`. `${productKey}` is… |
| ProductKey | string | no | The ProductKey of the product to which the custom topic belongs. For open-source MQTT managed products and devices, and MQTT cloud gateway… |
| DeviceName | string | no | The device name of the device to which the custom topic belongs. For open-source MQTT managed products and devices, and MQTT cloud gateway… |
| ScopeType | string | no | The scope of the custom topic subscription. Valid values: PRODUCT: the product dimension. This value indicates that the topic applies to… |

### Creates a data destination for a parser to forward data
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| Configuration | string | yes | The configuration information corresponding to the data destination, passed in as a JSON string. The required content varies depending on… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value is… |
| Type | string | yes | The type of the data destination action. Valid values: REPUBLISH: Forwards the topic data processed by the parser script to another… |
| Name | string | yes | The name of the data destination |
| Description | string | no | The description of the data destination |

### Creates a device distribution task and distributes the product to which the device belongs by default
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-device-distribute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| DeviceName | string | yes | The list of device names to be distributed. A maximum of 1,000 device names can be included (JSON-encoded) |
| TargetInstanceConfig | string | yes | The list of target instance configurations (JSON-encoded) |
| SourceInstanceId | string | yes | The ID of the source instance to which the device belongs. Public instance IDs in different regions: - China (Shanghai):… |
| ProductKey | string | yes | The ProductKey of the product to which the device belongs |
| TargetUid | string | no | The Alibaba Cloud account ID to which the device belongs. To view the ID, logon to the IoT Platform console, click the profile picture,… |
| TargetAliyunId | string | no | The Alibaba Cloud account to which the device belongs. To view the account, log on to the IoT Platform console, click the profile picture,… |
| Strategy | integer | yes | The distribution strategy. Default value: 0. 0: Specifies a region. The device is distributed to an instance in the specified region. 1:… |

### Creates a dynamic group and adds devices that meet the dynamic group conditions to the group
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-device-dynamic-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console |
| GroupDesc | string | no | The group description. The description can be up to 100 characters in length. Each Chinese character counts as one character |
| GroupName | string | yes | The group name. The name must be 4 to 30 characters in length and can contain Chinese characters, letters, digits, and underscores (_).… |
| DynamicGroupExpression | string | yes | The dynamic group rule, which is used to query and dynamically match devices to the group. For more information about how to write rule… |

### Creates a device group
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-device-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| SuperGroupId | string | no | The ID of the parent group. If you want to create a top-level group, do not specify this parameter |
| GroupDesc | string | no | The description of the group. The description can be up to 100 characters in length, and each Chinese character counts as one character |
| GroupName | string | yes | The name of the group. The name must be 4 to 30 characters in length and can contain Chinese characters, letters, digits, and underscores… |

### Creates a secure tunnel for a specified device
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-device-tunnel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotId | string | no | The ID of the device. If you specify this parameter, you do not need to specify ProductKey or DeviceName. IotId is the unique identifier… |
| Description | string | no | The description of the secure tunnel. The description can be up to 1,024 characters in length |
| Udi | string | no | The custom information pushed to the device. The data format is custom and the length cannot exceed 4,096 characters. This information is… |
| ProductKey | string | no | The ProductKey of the product to which the device belongs. If you specify this parameter, you must also specify DeviceName. |
| DeviceName | string | no | The device name. If you specify this parameter, you must also specify ProductKey. |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |

### Creates a data download task
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-download-data-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page of the IoT Platform console. If an ID value… |
| TableName | string | yes | The name of the table to download |
| DownloadDataType | string | yes | The type of the download object. Only TABLE is supported |
| FileConfig | string | no | The download file settings. Set a name (fileName) for the download file. You can customize the name. If fileName is not specified, a file… |
| StartTime | integer | no | The start time of the data query time range. The value is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time of the data query time range. The value is a UNIX timestamp in milliseconds |

### Creates a driver
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-edge-driver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| DriverName | string | yes | The name of the driver. The name can contain uppercase and lowercase letters, digits, and underscores (_). It must start with a letter and… |
| DriverProtocol | string | yes | The communication protocol of the driver. Valid values: modbus: Modbus protocol. opc-ua: OPC Unified Architecture protocol. customize:… |
| Runtime | string | yes | The programming language of the driver. Valid values: nodejs8: Node.js v8. python3: Python v3.5. c: C |
| CpuArch | string | no | The CPU architecture that the driver supports. Valid values: armv7 armv7-hf aarch64 x86-64 x86 |
| IsBuiltIn | string | no | Specifies whether the driver is a built-in driver. Valid values: true: The driver is a built-in driver. The driver code is pre-installed… |

### Creates a driver version
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-edge-driver-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for Enterprise Edition instances |
| DriverId | string | yes | The driver ID. To obtain the ID, go to the Driver Management page in the Link IoT Edge console… |
| DriverVersion | string | yes | The driver version number. The version number must be unique for the driver. You cannot set two identical version numbers for the same… |
| EdgeVersion | string | yes | The Link IoT Edge version that the driver is adapted to. The driver can run only on gateways of this version or later. For example, 2.4.0… |
| Description | string | no | The driver description. The description can be up to 256 bytes in length |
| SourceConfig | string | no | The source configuration of the driver code. The value is a JSON string in the following format: `… |
| DriverConfig | string | no | The driver configuration. The value is a JSON-formatted string in the following format: `{"format":"JSON","content":"{}"}` The parameter… |
| ContainerConfig | string | no | The container configuration. The value is a JSON string. For more information, see the ContainerConfig table below |
| ConfigCheckRule | string | no | The configuration validation rules. The value is a JSON-formatted string in the following format:… |
| Argument | string | no | The Java Virtual Machine (JVM) startup parameters |

### Creates an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-edge-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for Enterprise instances |
| Name | string | yes | The name of the edge instance. The name can contain Chinese characters, uppercase and lowercase letters, digits, underscores (_), and… |
| Tags | string | no | The tags of the edge instance. Each tag is in the `key:value` format. Separate multiple tags with commas (,). Example: `k1:v1,k2:v2`.… |
| Spec | integer | no | The product edition. Valid values: 10: Lite Edition. 20: Standard Edition. 30: Pro Edition. Default value: 20 (Standard Edition) |

### Creates a driver channel in an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-edge-instance-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for Enterprise instances |
| InstanceId | string | yes | The ID of the edge instance. To obtain the ID, go to the Edge Instances page in the Link IoT Edge console… |
| DriverId | string | yes | The ID of the driver. To obtain the ID, go to the Drivers page in the Link IoT Edge console… |
| ChannelName | string | yes | The name of the driver channel. The name must be 1 to 30 characters in length, and can contain Chinese characters, English letters,… |
| Configs | string | yes | The list of configurations (JSON-encoded) |

### Creates a deployment task for an edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-edge-instance-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances, but you must specify it for Enterprise instances |
| InstanceId | string | yes | Instance ID of the edge instance. You can obtain instance ID by moving the pointer over the name of the target edge instance on the Edge… |
| Type | string | yes | The type of the deployment task. Valid values: deploy: Deployment. reset: Reset |

### Creates a message route for a specified edge instance
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-edge-instance-message-routing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | Instance ID of the IoT Platform instance. Enterprise Enterprise instance: You must specify this parameter. You can view instance ID of… |
| InstanceId | string | yes | The edge instance ID. You can obtain the ID by moving the pointer over the name of the target edge instance on the Edge Instances page of… |
| Name | string | no | The name of the message route. The name must be 4 to 32 characters in length. Each Chinese character or full-width symbol counts as two… |
| TopicFilter | string | no | The message filtering condition. Valid values: A specific message topic: Messages from the message source that match the topic are… |
| SourceType | string | yes | The message source. Valid values: device: Messages are sent by devices. function: Messages are sent by edge applications. IotHub: Messages… |
| SourceData | string | no | The data of the message source. The value varies based on the following conditions: If SourceType is set to device: - If a specific device… |
| TargetType | string | yes | The message receiver. The value varies based on the following conditions: If SourceType is set to device: Valid values are function and… |
| TargetData | string | no | The data of the message receiver. The value varies based on the following conditions: If TargetType is set to function: Set this parameter… |
| TargetIotHubQos | integer | no | The quality of service (QoS) level. Valid values: 0: A message is sent only once, regardless of whether it is successfully received by the… |

### Creates a presigned URL for Object Storage Service (OSS)
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-edge-oss-pre-signed-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The resource ID. Currently, only driver resources are supported. Therefore, this parameter specifies the driver ID. You can move the… |
| FileName | string | yes | The file name, in the ` . ` format |
| IotInstanceId | string | no | The instance ID. You do not need to specify this parameter for public instances. You must specify this parameter for Enterprise instances |
| Type | string | yes | The content type of the file. Valid values: DRIVER_VERSION_CONTENT: the code of a specific driver version. DRIVER_VERSION_DEFAULT_CONFIG:… |
| InstanceId | string | no | The edge instance ID. You can move the pointer over the name of the target edge instance on the Edge Instances page in the Link IoT Edge… |
| ResourceVersion | string | yes | The resource version. Currently, only driver resources are supported. Therefore, this parameter specifies the driver version |

### Creates a device job
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |
| Description | string | no | The description of the job. The description can be up to 100 characters in length |
| JobDocument | string | yes | The job execution rule file that is delivered to devices. The data format is JSON, and the length cannot exceed 65,536 characters. For… |
| Type | string | yes | The job type. Valid values: INVOKE_SERVICE: batch service invocation job for devices. SET_PROPERTY: batch property setting job for… |
| JobFile | string | no | The file that is delivered to devices in a custom job. You can specify this parameter only when Type is set to CUSTOM_JOB. This parameter… |
| JobName | string | yes | The job name. The name can contain Chinese characters, letters, digits, and underscores (_), and must be 4 to 30 characters in length |
| TimeoutConfig | string | no | The timeout configuration for job execution under the job. The data format is JSON, and the length cannot exceed 8,192 characters. For… |
| RolloutConfig | string | no | The push rate configuration for jobs under the job. The data format is JSON, and the length cannot exceed 8,192 characters. For more… |
| TargetConfig | string | yes | The target device configuration for the device job. For more information, see the "TargetConfig" section below (JSON-encoded) |
| ScheduledTime | integer | no | The scheduled execution time of the job, in milliseconds. Valid values: 10 minutes to 7 days after the current time. If you do not specify… |

### Creates a task to batch register LoRaWAN devices
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-lo-ra-nodes-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| ProductKey | string | yes | The ProductKey of the product to which the device belongs |
| DeviceInfo | string | yes | The list of LoRaWAN devices (JSON-encoded) |

### Creates a dynamic OTA update batch
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-otadynamic-upgrade-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |
| FirmwareId | string | yes | The update package ID, which is the unique identifier of the update package. The update package ID is one of the response parameters… |
| ProductKey | string | yes | The ProductKey of the product to which the update package belongs |
| RetryInterval | integer | no | The automatic retry interval after a device update fails. Unit: minutes. Valid values: 0: Retry immediately. 10: Retry after 10 minutes.… |
| RetryCount | integer | no | The number of automatic retries. If you specify RetryInterval, you must also specify this parameter. Valid values: 1: 1 time. 2: 2 times.… |
| TimeoutInMinutes | integer | no | The update timeout period for the device. If the device does not complete the update within the specified period, the update fails. Unit:… |
| MaximumPerMinute | integer | no | The maximum number of devices to which the update package download URL is pushed per minute. Valid values: 10 to 10000. If you do not… |
| OverwriteMode | integer | no | Specifies whether to overwrite previous update tasks. Valid values: 1 (default): Do not overwrite. If the device already has an update… |
| DynamicMode | integer | no | The dynamic update mode. Valid values: 1 (default): In addition to updating devices that currently meet the update conditions, the system… |
| NeedPush | string | no | Specifies whether IoT Platform actively pushes update tasks to devices. Valid values: true (default): Yes. After the batch task is… |
| NeedConfirm | string | no | Specifies whether to manually control device OTA upgrades. You can configure this parameter to control whether a device can perform OTA… |
| GroupId | string | no | The group ID. If you specify this parameter, you must also specify GroupType, and you cannot specify SrcVersion.N. If you do not specify… |
| GroupType | string | no | The group type. The only valid value is LINK_PLATFORM_DYNAMIC (dynamic group). If you specify this parameter, you must also specify… |
| DownloadProtocol | string | no | The download protocol for over-the-air update package. Valid values: HTTPS (default) and MQTT. After the device receives over-the-air… |
| MultiModuleMode | string | no | Specifies whether the device supports simultaneous multi-module upgrades. Valid values: false (default): No. The device does not support… |
| SrcVersion | string | no | The list of version numbers to be updated. If you specify this parameter, you cannot specify GroupId and GroupType. If you do not specify… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates an OTA update package for a device after the URL of the OTA update package file is generated
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-otafirmware` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |
| FirmwareName | string | yes | The name of the OTA update package. The name must be unique within the Alibaba Cloud account and cannot be modified after creation. The… |
| DestVersion | string | yes | The version number of the current OTA update package. The version number can contain only letters, digits, half-width periods (.), hyphens… |
| FirmwareUrl | string | no | The URL of the OTA update package file, which is the storage address of over-the-air update package file in Object Storage Service (OSS).… |
| FirmwareSign | string | no | The signature of the OTA update package file. The value is calculated by using the SignMethod to sign the content of over-the-air update… |
| SignMethod | string | no | The signature method for the OTA update package. Currently, only MD5 (MD5 signature) is supported. If you do not specify this parameter,… |
| FirmwareSize | integer | no | The size of the OTA update package file. Unit: bytes. You can specify this parameter only when a single file is added to the OTA update… |
| ProductKey | string | no | The ProductKey of the product to which the OTA update package belongs |
| FirmwareDesc | string | no | The description of the OTA update package. The description can be up to 100 characters in length. Each Chinese character counts as one… |
| Type | integer | no | The type of the OTA update package. Valid values: 0: full update package. The over-the-air update package file contains the complete… |
| SrcVersion | string | no | The version number of the OTA module to be updated, which is the current version number of the OTA module on the device. You can call the… |
| ModuleName | string | no | The name of the OTA module. OTA modules are different updatable modules of devices under the same product. If you do not specify this… |
| NeedToVerify | string | no | Specifies whether to verify the update package before creating a batch update task. Valid values: true (default): yes false: no |
| Udi | string | no | The custom information pushed to the device. The text format is not limited, and the length cannot exceed 4,096 characters. After the… |
| MultiFiles | string | no | The list of OTA update package files (JSON-encoded) |

### Creates an OTA module for a product
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-otamodule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| AliasName | string | no | The alias of the OTA module. The alias can contain Chinese characters, letters, digits, periods (.), hyphens (-), and underscores (_). It… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If this parameter is… |
| ModuleName | string | yes | The name of the OTA module. The name must be unique within the product and cannot be modified. The name can contain letters, digits,… |
| Desc | string | no | The description of the OTA module. The description can be up to 100 characters in length |
| ProductKey | string | yes | The ProductKey of the product to which the OTA module belongs |

### Creates a static OTA update batch
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-otastatic-upgrade-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| FirmwareId | string | yes | The ID of the update package. The ID is the unique identifier of the update package. The update package ID is one of the response… |
| ProductKey | string | yes | The ProductKey of the product to which the update package belongs |
| TargetSelection | string | yes | The update scope. Valid values: ALL: full update. SPECIFIC: targeted update. GRAY: canary update. GROUP: group update |
| ScheduleTime | integer | no | The time when the over-the-air update is initiated. The scheduled time must be 5 minutes to 7 days after the current time. The value is a… |
| RetryInterval | integer | no | The automatic retry interval after a device update fails. Unit: minutes. Valid values: 0: Retry immediately. 10: Retry after 10 minutes.… |
| RetryCount | integer | no | The number of automatic retries. If you specify the RetryInterval parameter, you must also specify this parameter. Valid values: 1: 1… |
| TimeoutInMinutes | integer | no | The timeout period for the device update. If the device fails to complete the update within the specified period, the update fails. Unit:… |
| MaximumPerMinute | integer | no | The maximum number of devices to which the download URL of the update package is pushed per minute. Valid values: 10 to 10,000. If you do… |
| GrayPercent | string | no | The canary update percentage. The value is a percentage in string format, with up to three decimal places. The system rounds down the… |
| ScheduleFinishTime | integer | no | The time when the update ends. The end time must be at least 1 hour and at most 30 days after the start time (ScheduleTime). The value is… |
| OverwriteMode | integer | no | Specifies whether to overwrite the previous update tasks. Valid values: 1 (default): Do not overwrite. If a device already has an update… |
| DnListFileUrl | string | no | The URL of the device list file for the targeted update. If you initiate a targeted update (`TargetSelection=SPECIFIC`), you must specify… |
| NeedPush | string | no | Specifies whether IoT Platform proactively pushes over-the-air update task to devices. Valid values: true (default): Yes. After the batch… |
| NeedConfirm | string | no | Specifies whether to manually control the OTA upgrade of devices. You can configure this parameter to control whether a device can perform… |
| GroupId | string | no | The group ID. You must specify this parameter and GroupType only when you initiate a group update (`TargetSelection=GROUP`). You can call… |
| GroupType | string | no | The group type. Set the value to LINK_PLATFORM. You must specify this parameter and GroupId only when you initiate a group update… |
| DownloadProtocol | string | no | The protocol used to download over-the-air update package. Valid values: HTTPS (default) and MQTT. After a device receives over-the-air… |
| MultiModuleMode | string | no | Specifies whether the device supports simultaneous upgrades of multiple modules. Valid values: false (default): No. The device does not… |
| SrcVersion | string | no | The list of version numbers to be updated. You can specify this parameter when you initiate a full update (`TargetSelection=ALL`) or a… |
| TargetDeviceName | string | no | The list of device names for the targeted update. If you initiate a targeted update (`TargetSelection=SPECIFIC`), you must specify this… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates an OTA upgrade package authentication task
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-otaverify-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| FirmwareId | string | yes | The ID of the OTA upgrade package. The ID is the unique identifier of the upgrade package. FirmwareId is one of the response parameters… |
| TimeoutInMinutes | integer | no | The timeout period for a device update. Unit: minutes. Valid values: 1 to 1,440 |
| ProductKey | string | yes | The ProductKey of the product to which the OTA upgrade package belongs |
| NeedPush | string | no | Specifies whether IoT Platform actively pushes update tasks to devices. true (default): Yes. After the batch task is created, IoT Platform… |
| NeedConfirm | string | no | Specifies whether to require confirmation from a mobile app before a device can perform an OTA upgrade. You can configure this parameter… |
| DownloadProtocol | string | no | The protocol used to download over-the-air update package. Valid values: HTTPS (default) and MQTT. After a device receives over-the-air… |
| TargetDeviceName | string | yes | The devices to be authenticated. The product to which the device belongs must be the same as the product to which the OTA upgrade package… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates a parser
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-parser` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance overview page in the IoT Platform console. If the instance… |
| Name | string | yes | The name of the parser. The name can contain Chinese characters, English letters, Japanese characters, digits, underscores (_), and… |
| Description | string | no | The description of the parser |

### Creates a data source for data forwarding
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-parser-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance overview page in the IoT Platform console. If the instance… |
| Name | string | yes | The name of the data source. The name can contain Chinese characters, English letters, Japanese characters, digits, underscores (_), and… |
| Description | string | no | The description of the data source |

### Creates a product
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductName | string | yes | The name of the product. The name must be 4 to 30 characters in length and can contain Chinese characters, letters, digits, and… |
| NodeType | integer | yes | The node type of the product. Valid values: 0: device. A device cannot be attached with sub-devices. It can connect to IoT Platform… |
| DataFormat | integer | no | The data format. Valid values: 0: pass-through or custom format (CUSTOM_FORMAT). 1: Alink protocol (ALINK_FORMAT). In an MQTT-based… |
| Description | string | no | The description of the product. The description can be up to 100 characters in length |
| AliyunCommodityCode | string | no | The edition of the product. If you do not specify this parameter, a Basic Edition product is created by default. Basic Edition products do… |
| Id2 | string | no | Specifies whether to use ID²-based authentication. Valid values: true: enables ID²-based authentication. false: disables ID²-based… |
| ProtocolType | string | no | The protocol type that is used by a device to connect to a gateway. If the product uses the Thing Specification Language model… |
| NetType | string | no | The network connection method. If the devices under the product are gateway devices or directly connected devices, you must specify this… |
| JoinPermissionId | string | no | The ID of the LoRaWAN network access credential. This parameter is required if you set NetType to LORA. You can call the… |
| ResourceGroupId | string | no | The resource group ID. IoT Platform supports resource group management only at the instance level. The ResourceGroupId request parameter… |
| AuthType | string | no | The authentication method that is used by the devices under the product to connect to IoT Platform. secret: uses a device secret for… |
| CategoryKey | string | no | The identifier of the product category. If you specify this parameter, the created product uses the Thing Specification Language model of… |
| PublishAuto | string | no | Specifies whether to automatically publish the Thing Specification Language model after the product is created. true: publishes the model.… |
| ValidateType | integer | no | The data validation level. If you do not specify this parameter, weak validation is used by default. Valid values: 1: weak validation.… |

### Invokes this operation to create a product distribution node to distribute a specified product to a…
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-product-distribute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| SourceInstanceId | string | yes | The ID of the source instance to which the product belongs. Public instance IDs in different regions: - China (Shanghai):… |
| ProductKey | string | yes | The ProductKey of the product to be distributed |
| TargetInstanceId | string | yes | The ID of the target instance to which the product is distributed. For details about the instance ID, see the description of the… |
| TargetUid | string | no | The Alibaba Cloud account ID to which the product belongs. You can logon to the IoT Platform console, click the profile picture, and view… |
| TargetAliyunId | string | no | The Alibaba Cloud account to which the product belongs. You can log on to the IoT Platform console, click the profile picture, and view… |

### Creates tags for a specified product
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-product-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the product. A ProductKey is a globally unique identifier issued by IoT Platform for a newly created product. You can… |
| ProductTag | string | yes | The list of product tags (JSON-encoded) |

### Creates a custom topic category for a specified product
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-product-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| ProductKey | string | yes | The ProductKey of the product to which the topic category to be created belongs |
| TopicShortName | string | yes | The custom category name of the topic category. The topic format must use `/` to separate each category in a hierarchy. The category name… |
| Operation | string | yes | The operation permissions that the device has on the topic category. Valid values: SUB: subscribe. PUB: publish. ALL: publish and subscribe |
| Desc | string | no | The description of the topic category. The description can be up to 100 characters in length |
| EnableProxySubscribe | string | no | Specifies whether to enable proxy subscription when Operation is set to SUB (subscribe) or ALL (publish and subscribe). Valid values:… |
| Codec | string | no | Specifies whether to enable data compression or decompression for custom topics in a Dedicated Enterprise Edition instance. Valid values:… |

### Creates a rule for a specified topic
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |
| Select | string | no | The SQL SELECT statement to be executed. For more information, see https://help.aliyun.com/document_detail/30554.html. Specify the content… |
| ShortTopic | string | no | The specific topic to which the rule is applied. The format is typically `${deviceName}/topicShortName`. In this format, `${deviceName}`… |
| Where | string | no | The trigger condition of the rule. For more information, see https://help.aliyun.com/document_detail/30554.html. Specify the content that… |
| ProductKey | string | no | The ProductKey of the product to which the rule is applied |
| Name | string | yes | The name of the rule. The name must be 1 to 30 characters in length, and can contain Chinese characters, English letters, Japanese… |
| RuleDesc | string | no | The description of the rule. The description can be up to 100 characters in length. A Chinese character counts as one character |
| DataType | string | no | The data format processed by the rule. The format must be the same as the device data to be processed. Valid values: JSON (default): JSON… |
| TopicType | integer | no | 0: the basic communication topic or Thing Specification Language model communication topic described in the ShortTopic parameter,… |
| ResourceGroupId | string | no | The resource group ID. IoT Platform only supports resource group management at the instance level. The ResourceGroupId request parameter… |
| Topic | string | no | The complete topic for the add rule operation. If you specify this parameter, you do not need to specify the ShortTopic and TopicType… |

### Creates a rule action under a specified rule to forward processed topic data to another topic in IoT…
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-rule-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| RuleId | integer | yes | The ID of the rule for which you want to create an action. You can view the rule ID on the Rules Engine > Data Forwarding page in the IoT… |
| Type | string | yes | The type of the rule action. Valid values: REPUBLISH: forwards the processed topic data to another topic in IoT Platform. AMQP: forwards… |
| Configuration | string | yes | The configuration information of the rule action, in JSON string format. The required content varies by rule action type. For specific… |
| ErrorActionFlag | string | no | Specifies whether the rule action is an error action that forwards data of failed operations. Failed operations refer to data that fails… |

### Creates a scene orchestration rule
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-scene-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. This parameter is not required for public instances, but is required for Enterprise Edition instances |
| RuleName | string | yes | The name of the scene orchestration rule. The name can contain Chinese characters, uppercase and lowercase letters, digits, underscores… |
| RuleContent | string | no | The content of the scene orchestration rule. For more information about the format, see https://help.aliyun.com/document_detail/171059.html |
| RuleDescription | string | no | The description of the scene orchestration rule. The description can be up to 100 characters in length |

### Creates a sound code scheduling time period
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-schedule-period` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| SoundCodeContent | string | yes | The sound code parsing content for the time period. The content must be 1 to 512 characters in length. Each Chinese character counts as… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ScheduleCode | string | yes | The unique identifier of the schedule |
| Description | string | yes | The description of the time period. The description must be 1 to 64 characters in length. Each Chinese character counts as two characters |
| StartTime | string | yes | The start time of the time period. The time must be in the 24-hour format and range from 00:00 to 23:59 |
| EndTime | string | yes | The end time of the time period. The time must be in the 24-hour format and range from 00:00 to 23:59. The end time cannot be earlier than… |

### Creates a promotional activity for a speech broadcast sharing task
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-share-promotion-activity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| SharePromotionActivityName | string | yes | The name of the promotional activity |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance overview tab in the IoT Platform console. If an instance ID… |
| StartTime | integer | no | The start time of the promotional activity. The value is a UNIX timestamp in milliseconds. If you do not specify this parameter, the… |
| EndTime | integer | no | The end time of the promotional activity. The value is a UNIX timestamp in milliseconds. If you do not specify this parameter, the… |

### Creates shared speech models for promotional activities of voice broadcast sharing tasks
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-share-promotion-speech-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| Voice | string | yes | The voice used to broadcast the speech model. The voice is preset by the system, such as standard female voice and standard male voice.… |
| SharePromotionActivityId | string | yes | The ID of the promotional activity. Set the value to the Data value returned by the CreateSharePromotionActivity operation |
| SpeechModelType | string | yes | The type of the speech model. Only the fixed value custom is supported, which indicates a custom speech model |
| IotInstanceId | string | no | Instance ID of the instance. You can view instance ID of the current instance on the Instance Overview tab in the IoT Platform console. If… |
| BizCode | string | yes | The identifier of the speech model. The identifier is user-defined, supports letters and digits, and must be 1 to 32 characters in length.… |
| SpeechRate | integer | no | The broadcast speed. Valid values: -500 to 500 |
| AudioFormat | string | yes | The audio format. Only the wav and mp3 formats are supported |
| Volume | integer | no | The volume. Valid values: 0 to 100 |
| ShareTaskCode | string | yes | The sharing code of the sharing task. For more information about the sharing code of a sharing task, refer to… |
| Text | string | yes | The text of the speech model. The text supports letters, Chinese characters, and spaces, and must be 1 to 100 characters in length. Each… |

### Creates a sound code
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-sound-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| Duration | integer | yes | The duration of the sound code. Unit: seconds. Valid values: 1 to 30 |
| SoundCodeContent | string | yes | The marketing content of the sound code, such as the URL of the product details page. The content can be up to 100 characters in length |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instances page in the IoT Platform console. If an instance ID is… |
| Name | string | no | The name of the sound code. The name must be 1 to 64 characters in length. Each Chinese character counts as two characters. The name must… |
| OpenType | string | no | The schedule access type. Internal (default): Set the value to INNER. Only devices under the instance to which the schedule belongs can… |

### Creates a sound code label for a specified schedule
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-sound-code-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value is… |
| ScheduleCode | string | yes | The unique identifier of the schedule |
| Label | string | yes | The label. The label must be 1 to 64 characters in length. A Chinese character counts as two characters. The label must be unique within… |

### Creates a sound code schedule
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-sound-code-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| Name | string | yes | The name of the schedule. The name must be 1 to 64 characters in length, and each Chinese character counts as two characters. The name… |
| Description | string | no | The description of the schedule. The description must be 1 to 64 characters in length, and each Chinese character counts as two… |
| StartDate | string | yes | The start date of the schedule. Specify the date in the yyyy-MM-dd format |
| EndDate | string | yes | The end date of the schedule. Specify the date in the yyyy-MM-dd format. The end date cannot be earlier than the start date |
| OpenType | string | no | The access type of the schedule. Valid values: INNER: internal. This is the default value. Only devices under the instance where the… |

### Creates a corpus
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-speech` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| Voice | string | yes | The voice used for corpus playback. The voice is preset by the system, such as standard female voice and standard male voice. You can… |
| SpeechType | string | no | The corpus type. The corpus is classified into custom corpus and common corpus. If you do not specify this parameter or set it to custom,… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| BizCode | string | no | The corpus identifier. When a device calls multiple corpora for combined playback, this identifier is used to play the specified corpus.… |
| SpeechRate | integer | no | The playback speed. Valid values: -500 to 500 |
| Volume | integer | no | The volume. Valid values: 0 to 100 |
| ProjectCode | string | yes | The project ID, which is the unique identifier of the project. You can obtain the project ID from the Project Management Console… |
| Text | string | no | The corpus text. This parameter is required if you set the corpus type to custom corpus. The corpus text supports letters, Chinese… |
| AudioFormat | string | no | The audio format. Only wav, mp3, and amr formats are supported |
| SoundCodeConfig | string | no | The sound code configuration. This includes the following fields: SoundCodeContent: The sound code marketing content, such as the product… |
| EnableSoundCode | string | no | Specifies whether to enable the sound code. If you set this parameter to true, you must specify the SoundCodeConfig parameter. Otherwise,… |

### Adds a domain name to an application
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-studio-app-domain-open` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| AppId | string | yes | The application ID. You can call https://help.aliyun.com/document_detail/216816.html to query the ID |
| Host | string | yes | The domain name |
| Protocol | string | yes | The request protocol. Valid values: https http |
| ProjectId | string | yes | The project ID. Log on to the IoT Platform console… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |

### Creates a Message Service (MNS) or Advanced Message Queuing Protocol (AMQP) server-side subscription
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-subscribe-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the product in the subscription |
| DeviceDataFlag | string | no | Specifies whether to push device-reported messages. Valid values: true: yes. false (default): no |
| DeviceLifeCycleFlag | string | no | Specifies whether to push device lifecycle change messages. Valid values: true: yes. false (default): no |
| DeviceStatusChangeFlag | string | no | Specifies whether to push device status change notifications. Valid values: true: yes. false (default): no |
| DeviceTopoLifeCycleFlag | string | no | Specifies whether to push device topology change messages. Valid values: true: yes. This value is valid only for gateway products. false… |
| FoundDeviceListFlag | string | no | Specifies whether to push sub-device discovery messages reported by gateways. Valid values: true: yes. This value is valid only for… |
| MnsConfiguration | string | no | The configuration information of the MNS queue. This parameter is required when Type is set to MNS. For specific requirements and… |
| Type | string | no | The subscription type. Valid values: MNS. AMQP |
| OtaEventFlag | string | no | Specifies whether to push OTA upgrade status notifications. Valid values: true: yes. false (default): no |
| ThingHistoryFlag | string | no | Specifies whether to push historical Thing Specification Language (TSL) model data reported by devices. Valid values: true: yes. false… |
| DeviceTagFlag | string | no | Specifies whether to push device tag change messages. Valid values: true: yes. This value is valid only when Type is set to AMQP. false… |
| OtaVersionFlag | string | no | Specifies whether to push OTA module version numbers reported by devices. Valid values: true: yes. This value is valid only when Type is… |
| OtaJobFlag | string | no | Specifies whether to push OTA upgrade batch status notifications. Valid values: true: yes. This value is valid only when Type is set to… |
| SubscribeFlags | string | no | Identifies other types of messages for the currently subscribed product. The data format is a JSON string. If the subscription is for a… |
| ConsumerGroupIds | string | no | The consumer group IDs in the created AMQP subscription. This parameter is required when Type is set to AMQP. After you call… |

### Adds features to the Thing Specification Language (TSL) model of a specified product and supports adding…
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-thing-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance overview page in the IoT Platform console. If the instance… |
| ProductKey | string | yes | The ProductKey of the product. A ProductKey is a globally unique identifier that is issued by IoT Platform to a product. You can view the… |
| ThingModelJson | string | no | The details of the features to add. You can specify the definitions of up to 10 features. In each property structure of ThingModelJson,… |
| FunctionBlockId | string | no | The identifier of the custom TSL module. The identifier must be unique within the product. The identifier can contain letters, digits, and… |
| FunctionBlockName | string | no | The name of the custom TSL module. The name can contain Chinese characters, English letters, Japanese characters, digits, and underscores… |

### Submits a data parsing script for a specified product
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-thing-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ScriptContent | string | yes | The script content. This parameter cannot be empty. For more information about script examples, see… |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If this ID value exists,… |
| ProductKey | string | yes | The ProductKey of the product. You can view the ProductKey on the Products page in the IoT Platform console, or call… |
| ScriptType | string | yes | The script type. Valid values: JavaScript Python_27: Python 2.7 PHP_72: PHP 7.2 |

### CreateTopicConfig
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-topic-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| Description | string | no | The Description |
| ProductKey | string | yes | The ProductKey |
| EnableBroadcast | string | no | The EnableBroadcast |
| EnableProxySubscribe | string | no | The EnableProxySubscribe |
| Codec | string | no | The Codec |
| Operation | string | yes | The Operation |
| TopicFullName | string | yes | The TopicFullName |

### Creates a message routing relationship between topics
`POST https://apizie.tech/v1/cloud:aliyun-iot/create-topic-route-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| SrcTopic | string | yes | The source topic, which is the topic to be subscribed to. Example: `SrcTopic=/x7aWKW9****/testDataToDataHub/user/update` |
| DstTopic | string | yes | The list of destination topics, which are the topics that subscribe to messages from the SrcTopic. Even if there is only one topic, use… |

### Deletes all client IDs of a device in the pre-registration-free unique-certificate-per-product…
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-client-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotId | string | yes | The ID of the device |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an instance ID… |

### Deletes a consumer group used for AMQP server-side subscriptions
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| GroupId | string | yes | The consumer group ID. After you call https://help.aliyun.com/document_detail/170388.html to create a consumer group, the consumer group… |

### Removes a specified consumer group from an AMQP subscription
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-consumer-group-subscribe-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| ConsumerGroupId | string | yes | The ID of the consumer group. You can call the https://help.aliyun.com/document_detail/170352.html operation to query the ID of the… |
| IotInstanceId | string | no | The ID of the instance. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an… |
| ProductKey | string | yes | The ProductKey of the product in the subscription |

### Deletes a specified topic from a specified data source
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-data-source-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| DataSourceItemId | integer | yes | The ID of the data source topic. You can call the https://help.aliyun.com/document_detail/421072.html operation to query the list of… |
| DataSourceId | integer | yes | The data source ID. You can call the https://help.aliyun.com/document_detail/432676.html operation to query the list of data sources and… |

### Deletes a created data destination
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If this parameter is… |
| DestinationId | integer | yes | The ID of the data destination. You can call the https://help.aliyun.com/document_detail/433025.html operation to query the list of data… |

### Deletes a device. You can also call this operation to delete the topological relationships between a gateway…
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the instance… |
| ProductKey | string | no | The ProductKey of the product to which the device to be deleted belongs. If you specify this parameter, you must also specify DeviceName. |
| DeviceName | string | no | The name of the device to be deleted. If you specify this parameter, you must also specify ProductKey. |
| IotId | string | no | The ID of the device to be deleted. IotId is the unique identifier of the device and corresponds to the combination of ProductKey and… |

### Deletes a device distribution task
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-device-distribute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The ID of the distribution task, which is the globally unique identifier of the task |

### Logically deletes a dynamic device group and removes the relationships between devices and the group
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-device-dynamic-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console |
| GroupId | string | yes | The group ID, which is the globally unique identifier of the group. You can call the https://help.aliyun.com/document_detail/93356.html… |

### Deletes a specified file uploaded by a specified device to IoT Platform
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-device-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| ProductKey | string | no | The ProductKey of the product to which the device that uploaded the file to be deleted belongs. If you specify this parameter, you must… |
| DeviceName | string | no | The device name to which the file to be deleted belongs. If you specify this parameter, you must also specify ProductKey |
| IotId | string | no | The ID of the device that uploaded the file to be deleted. The ID is issued by IoT Platform and uniquely identifies the device. If you… |
| FileId | string | yes | The ID of the file to be deleted. You can call the https://help.aliyun.com/document_detail/112001.html operation and view the file ID in… |

### Deletes a specified group
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-device-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |
| GroupId | string | yes | The group ID, which is the globally unique identifier of the group |

### Deletes a specified tag from a device
`POST https://apizie.tech/v1/cloud:aliyun-iot/delete-device-prop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iot.ap-southeast-1.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance overview page in the IoT Platform console. If the instance… |
| ProductKey | string | no | The ProductKey of the product to which the device with the tag belongs. If you specify this parameter, you must also specify DeviceName |
| DeviceName | string | no | The name of the device to which the tag belongs. If you specify this parameter, you must also specify ProductKey |
| PropKey | string | yes | The key of the device tag to be deleted. IoT Platform searches for the key you provided in the tags of the target device and deletes the… |
| IotId | string | no | The ID of the device to which the tag belongs. If you specify this parameter, you do not need to specify ProductKey or DeviceName. IotId… |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-iot/add-data-for-api-source" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud IoT Platform API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-iot/add-data-for-api-source with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud IoT Platform API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud IoT Platform itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud IoT Platform API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-iot.

### What is the status of the Alibaba Cloud IoT Platform API?
Needs your own provider key (bring your own key)