All Products
Search

This Product

    :CreateEdgeInstance

    Document Center

    :CreateEdgeInstance

    Last Updated:May 13, 2024

    Creates an edge instance.

    Limits

    A single Alibaba Cloud account can run a maximum of 10 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 CreateEdgeInstance

    The operation that you want to perform. Set the value to CreateEdgeInstance.
    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 values 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.
    Spec Integer No 20

    The specification of the edge instance.

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

    Default value: 20.

    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 28D159F4-980F-423D-95F0-F705E9DFC016

    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.
    ErrorMessage String request parameter error

    The error message returned if 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.
    InstanceId String F3APY0tPLhmgGtx0****

    The ID of the edge instance.

    Examples

    Sample requests

    http(s)://iot.cn-shanghai.aliyuncs.com/? Action=CreateEdgeInstance
&Spec=30
&Tags=k1:v1,k2:v2
&Name=test instance
&<Common request parameters>

    Sample success responses

    XML format

    <CreateEdgeInstanceResponse>
      <RequestId>28D159F4-980F-423D-95F0-F705E9DFC016</RequestId>
      <InstanceId>F3APY0tPLhmgGtx0****</InstanceId>
      <Code>Success</Code>
      <Success>true</Success>
</CreateEdgeInstanceResponse>

    JSON format

    {
  "RequestId": "28D159F4-980F-423D-95F0-F705E9DFC016",
  "InstanceId": "F3APY0tPLhmgGtx0****",
  "Code": "Success",
  "Success": true
}

    Error codes

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