Creates a deployment task for an edge instance.


A single Alibaba Cloud account can run a maximum of 5 queries per second (QPS).

Note RAM users share the quota of the Alibaba Cloud account.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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.

Type String Yes deploy

The type of the deployment task.

  • deploy: deploys the edge instance.
  • Reset: resets the edge instance.
IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the Internet of Things (IoT) service instance. This parameter is not required for public instances. However, this parameter is required for the instances that you have purchased.

In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String C8293A57-6BBC-42FB-B093-BF304D5BF09C

The ID of the request.

Success Boolean true

Indicates whether the call was successful. true: indicates that the call was successful. false: indicates that the call failed.

Code String Success

The error code. Success indicates that the call was successful. Other values indicate that specific errors occurred. For more information, see Error codes.

ErrorMessage String request parameter error

The error message returned if the call failed.

DeploymentId String 38d544b1222d45b4b425240167bf****

The deployment task ID returned if the call was successful.


Sample requests

http(s):// Action=CreateEdgeInstanceDeployment
&<Common request parameters>

Sample success responses

XML format


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.