Queries all edge instances that belong to a specified Alibaba Cloud account.
Limits
A single Alibaba Cloud account can run a maximum of 10 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | QueryEdgeInstance |
The operation that you want to perform. Set the value to QueryEdgeInstance. |
CurrentPage | Integer | Yes | 1 |
The number of the page from which the results are displayed. The minimum value is 1. If you specify a value smaller than 1, the system uses 1. |
PageSize | Integer | Yes | 15 |
The number of entries to return on each page. Maximum value: 30. Default value: 10. If you specify a value smaller than 1, the system uses 10. |
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. |
Name | String | No | test instance_test |
The name of the edge instance. |
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 | 199BBC5D-FC99-46CB-88E2-FB98E92446FA |
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. |
|
Total | Integer | 201 |
The number of edge instances. |
PageSize | Integer | 2 |
The number of entries returned per page. |
CurrentPage | Integer | 1 |
The page number of the returned page. |
InstanceList | Array |
A list of edge instances. |
|
InstanceId | String | 9iqyQAKDb2aYGVKa**** |
The ID of the edge instance. |
Name | String | test_le1 |
The name of the edge instance. |
Tags | String | k1:v1,k2:v2 |
The tags of the edge instance. |
Type | Integer | 0 |
Indicates whether you own the edge instance or you are authorized to use the edge instance.
|
GmtCreate | String | 2019-07-17 14:34:28 |
The time when the edge instance was created. |
GmtModified | String | 2019-07-17 14:51:38 |
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. |
Spec | Integer | 30 |
The specification of the edge instance.
|
BizEnable | Boolean | true |
Indicates whether the edge instance was enabled.
|
LatestDeploymentStatus | Integer | 1 |
The status of the latest deployment task.
|
LatestDeploymentType | String | deploy |
The type of the latest deployment task.
|
Examples
Sample requests
http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryEdgeInstance
&PageSize=15
&CurrentPage=1
&<Common request parameters>
Sample success responses
XML
format
<QueryEdgeInstanceResponse>
<RequestId>199BBC5D-FC99-46CB-88E2-FB98E92446FA</RequestId>
<Data>
<PageSize>2</PageSize>
<CurrentPage>1</CurrentPage>
<Total>201</Total>
<InstanceList>
<Instance>
<GmtCreate>2019-07-17 14:34:28</GmtCreate>
<BizEnable>true</BizEnable>
<InstanceId>9iqyQAKDb2aYGVKa****</InstanceId>
<GmtModified>2019-07-17 14:51:38</GmtModified>
<Spec>20</Spec>
<Name>test_le1</Name>
</Instance>
<Instance>
<GmtCreate>2018-10-22 20:09:29</GmtCreate>
<BizEnable>true</BizEnable>
<InstanceId>ZpbCxkQpbb2kpmm0****</InstanceId>
<LatestDeploymentType>reset</LatestDeploymentType>
<GmtModified>2019-07-16 16:50:50</GmtModified>
<Spec>30</Spec>
<Name>test_le1</Name>
<LatestDeploymentStatus>1</LatestDeploymentStatus>
</Instance>
</InstanceList>
</Data>
<Code>Success</Code>
<Success>true</Success> </QueryEdgeInstanceResponse>
JSON
format
{
"RequestId": "199BBC5D-FC99-46CB-88E2-FB98E92446FA",
"Data": {
"PageSize": 2,
"CurrentPage": 1,
"Total": 201,
"InstanceList": [
{
"GmtCreate": "2019-07-17 14:34:28",
"BizEnable": true,
"InstanceId": "9iqyQAKDb2aYGVKa****",
"GmtModified": "2019-07-17 14:51:38",
"Spec": 20,
"Name": "test_le1"
},
{
"GmtCreate": "2018-10-22 20:09:29",
"BizEnable": true,
"InstanceId": "ZpbCxkQpbb2kpmm0****",
"LatestDeploymentType": "reset",
"GmtModified": "2019-07-16 16:50:50",
"Spec": 30,
"Name": "test_le1",
"LatestDeploymentStatus": 1
}
]
},
"Code": "Success",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.