Queries the properties of instances and virtual devices in a specific edge application.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ens:DescribeDeviceService | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ServiceId | string | No | Service ID | s-cxxxxx |
| InstanceId | string | No | The ID of the instance. | i-5sg1owx0g4ojy66ab2tez77r2 |
| RegionId | string | No | The ID of the Edge Node Service (ENS) node. | cn-chongqing-11 |
| AppId | string | No | The ID of the application. | a2bac6f4-75dc-455e-8389-2dc8e47526d3 |
| EnsRegionId | string | No | This parameter does not take effect. | cn-chongqing-10 |
| OrderId | string | No | The ID of the order. | 2661b1dd-3453-418d-8182-bb34f79e8d3c |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "3A535110-3EE3-5EC5-B1ED-10B7067A1FC8",
"ResourceDetailInfos": [
{
"RegionID": "cn-jiaozuo-2",
"ID": "h-uf6009zoaexs5pefypbo",
"IP": "120.27.219.219",
"Server": "ens-nc2",
"Status": "Running",
"Type": "ens.ac6.large",
"Mac": "AA:BB:77:88:99:03",
"ISP": "cmcc",
"DeviceName": "5JhF100NEgdBcpNren32",
"ImageID": "m-2ze40oyhjorpyw61k7be"
}
],
"AppStatus": {
"Phase": "CREATING",
"StatusDescrip": "",
"UpdateTime": "2021-01-26T05:04Z"
},
"AppMetaData": {
"AppId": "97a32f2a-aa2c-436a-b19c-05b20d258618",
"AppName": "iotx-api-admin",
"AppStableVersion": "v1",
"AppType": "Common",
"ClusterName": "poc",
"CreateTime": "2022-03-03T03:42:11",
"Description": ""
},
"ResourceInfos": [
{
"AppVersion": "v1",
"AreaCode": "410800",
"AreaName": "",
"CreateTime": "2019-10-02T08:26Z",
"DeviceInfos": [
{
"Name": "test-api",
"Network": [
{
"ContainerPorts": "10000-10010",
"ExternalIp": "39.105.62.120",
"HostPorts": "80-8080",
"Protocol": "TCP"
}
],
"Status": "Running"
}
],
"InstanceId": "i-5s9boobrmh5000kv4jmi0oeai",
"InstanceStatus": "Running",
"InternalIps": [
{
"Ip": "10.0.2.3"
}
],
"PublicIps": [
{
"Ip": "122.13.173.137"
}
],
"RegionCode": "cn-jiaozuo-2",
"RegionId": "cn-jiaozuo-2\n",
"RegionName": ""
}
]
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | NoPermission | Permission denied. |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history