Creates a deployment task for an edge instance.
Limits
Each Alibaba Cloud account can run a maximum of five queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateEdgeInstanceDeployment |
The operation that you want to perform. Set the value to CreateEdgeInstanceDeployment. |
InstanceId | String | Yes | PgEfYupSn6Pvhfkx**** |
The ID of the edge instance. To obtain the instance ID, perform the following steps: Log on to the Link IoT Edge console. On the Edge Instances page, move the pointer over the name of the edge instance for which you want to create a deployment task and obtain the instance ID. You can also call the QueryEdgeInstance operation to query the instance ID. |
Type | String | Yes | deploy |
The type of the deployment task.
|
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the Internet of Things (IoT) service instance. This parameter is not required for the public instance but required for Enterprise Edition instances. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | Success |
The return code of the operation. A value of Success indicates that the call was successful. Other values indicate that specific errors occurred. For more information, see Error codes. |
DeploymentId | String | 38d544b1222d45b4b425240167bf**** |
The deployment task ID that is returned if the call was successful. |
ErrorMessage | String | request parameter error |
The error message that is returned if the call failed. |
RequestId | String | C8293A57-6BBC-42FB-B093-BF304D5BF09C |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful. A value of true indicates that the call was successful. A value of false indicates that the call failed. |
Examples
Sample requests
http(s)://iot.cn-shanghai.aliyuncs.com/? Action=CreateEdgeInstanceDeployment
&InstanceId=PgEfYupSn6Pvhfkx****
&Type=deploy
&<Common request parameters>
Sample success responses
XML
format
<CreateEdgeInstanceDeploymentResponse>
<RequestId>C8293A57-6BBC-42FB-B093-BF304D5BF09C</RequestId>
<DeploymentId>38d544b1222d45b4b425240167bf****</Data>
<Code>Success</Code>
<Success>true</Success>
</CreateEdgeInstanceDeploymentResponse>
JSON
format
{
"RequestId": "C8293A57-6BBC-42FB-B093-BF304D5BF09C",
"DeploymentId": "38d544b1222d45b4b425240167bf****",
"Code": "Success",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.