Updates a specified edge instance.

Limits

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.

Debugging

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 UpdateEdgeInstance

The operation that you want to perform. Set the value to UpdateEdgeInstance.

InstanceId String Yes F3APY0tPLhmgGtx0****

The ID of the edge instance.

Name String Yes LinkIoTEdge_Node

The name of the edge instance.

An instance name cannot exceed 20 characters in length and can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).

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.

Tags String No k1:v1,k2:v2

The tags of the edge instance. Syntax of a tag:key:value. Multiple tags are separated with commas (,), for example, k1:v1,k2:v2.

  • Note the following limits on tag keys:
    • Tag keys cannot be left empty.
    • Tag keys must be unique in the edge instance.
    • Tag keys only support letters.
    • Each tag key cannot exceed 20 characters in length.
  • Note the following limits on tag values:
    • Tag values cannot be left empty.
    • A tag value can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
    • Each tag value cannot exceed 20 characters in length.

If you leave this parameter empty, this parameter is not updated.

Spec Integer No 10

The specification of the edge instance.

  • 10: Lite Edition.
  • 20: Standard Edition.
  • 30: Pro Edition.

If you leave this parameter empty, this parameter is not updated.

BizEnable Boolean No true

Indicates whether to enable the edge instance. Valid values:

  • true: enables the edge instance.
  • false: disables the edge instance.

If you leave this parameter empty, this parameter is not updated.

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 10CA6DAD-EBAF-4D3E-9309-9DB5B0FF48F2

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.

ErrorMessage String request parameter error

The error message returned if the call failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=UpdateEdgeInstance
&InstanceId=F3APY0tPLhmgGtx0****
&Spec=30
&Tags=room:1,floor:1
&BizEnable=true
&Name=new test instance
&<Common request parameters>

Sample success responses

XML format

<UpdateEdgeInstanceResponse>
      <RequestId>10CA6DAD-EBAF-4D3E-9309-9DB5B0FF48F2</RequestId>
      <Code>Success</Code>
      <Success>true</Success>
</UpdateEdgeInstanceResponse>

JSON format

{
  "RequestId": "10CA6DAD-EBAF-4D3E-9309-9DB5B0FF48F2",
  "Code": "Success",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.