Queries detailed information of a specified 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 GetEdgeInstance

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

InstanceId String Yes F3APY0tPLhmgGtx0****

The ID of 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 16645053-546B-4D7C-832E-E519B0E23CF1

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.

Data Struct

The data returned if the call was successful.

InstanceId String F3APY0tPLhmgGtx0****

The ID of the edge instance.

Name String new test instance

The name of the edge instance.

Tags String 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.

Type String 0

Indicates whether you own the edge instance or you are authorized to use the edge instance.

  • 0: You own the edge instance.
  • 1: You are authorized to use the edge instance.
Spec Integer 30

The specification of the edge instance.

  • 10: Lite Edition.
  • 20: Standard Edition.
  • 30: Pro Edition.
BizEnable Boolean true

Indicates whether the edge instance was enabled.

  • true: enabled.
  • false: disabled.
GmtCreate String 2019-06-26 12:33:25

The time when the edge instance was created.

GmtModified String 2019-06-26 12:33:25

The time when the edge instance was last updated.

RoleArn String acs:ram::1473922805******:role/aliyuniotaccessingfcrole

The Alibaba Cloud Resource Name (ARN) of the RAM role.

RoleName String AliyunIOTAccessingFCRole

The name of the RAM role.

RoleAttachTime String 2020-02-19 11:25:48

The time when the RAM role was attached to IoT Platform.

LatestDeploymentStatus Integer 2

The status of the latest deployment task.

  • 0: The task has not started.
  • 1: The task is being processed.
  • 2: The task was successful.
  • 3: The task failed.
LatestDeploymentType String deploy

The type of the latest deployment task.

  • deploy: deploys the edge instance.
  • Reset: resets the edge instance.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=GetEdgeInstance
&InstanceId=F3APY0tPLhmgGtx0****
&<Common request parameters>

Sample success responses

XML format

<GetEdgeInstanceResponse>
    <RequestId>16645053-546B-4D7C-832E-E519B0E23CF1</RequestId>
    <Data>
        <GmtCreate>2019-06-26 12:33:25</GmtCreate>
        <BizEnable>true</BizEnable>
        <InstanceId>F3APY0tPLhmgGtx0****</InstanceId>
        <LatestDeploymentType>deploy</LatestDeploymentType>
        <GmtModified>2019-06-26 16:16:22</GmtModified>
        <Spec>30</Spec>
        <Tags>k1:v1,k2:v2</Tags>
        <Name>new test instance</Name>
        <LatestDeploymentStatus>2</LatestDeploymentStatus>
    </Data>
    <Code>Success</Code>
    <Success>true</Success>
</GetEdgeInstanceResponse>

JSON format

{  "RequestId": "16645053-546B-4D7C-832E-E519B0E23CF1",
  "Data": {
    "GmtCreate": "2019-06-26 12:33:25",
    "BizEnable": true,
    "InstanceId": "F3APY0tPLhmgGtx0****",
    "LatestDeploymentType": "deploy",
    "GmtModified": "2019-06-26 16:16:22",
    "Spec": 30,
    "Tags": "k1:v1,k2:v2",
    "Name": "new test instance",
    "LatestDeploymentStatus": 2
  },
  "Code": "Success",
  "Success": true
}

Error codes

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