All Products
Search
Document Center

ENS:DescribeDeviceService

Last Updated:Mar 12, 2024

Queries the properties of instances and virtual devices in a specific edge application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceIdstringNo

Service ID

s-cxxxxx
InstanceIdstringNo

The ID of the instance.

i-5sg1owx0g4ojy66ab2tez77r2
RegionIdstringNo

The ID of the Edge Node Service (ENS) node.

cn-chongqing-11
AppIdstringNo

The ID of the application.

a2bac6f4-75dc-455e-8389-2dc8e47526d3
EnsRegionIdstringNo

This parameter does not take effect.

cn-chongqing-10
OrderIdstringNo

The ID of the order.

2661b1dd-3453-418d-8182-bb34f79e8d3c

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

3A535110-3EE3-5EC5-B1ED-10B7067A1FC8
ResourceDetailInfosobject []

The information about the devices.

RegionIDstring

The ID of the ENS node.

cn-jiaozuo-2
IDstring

The ID of the cloud device.

h-uf6009zoaexs5pefypbo
IPstring

The IP address.

120.27.219.219
Serverstring

The server name of the ENS node.

ens-nc2
Statusstring

The status of the device.

Running
Typestring

The type of the device.

ens.ac6.large
Macstring

The media access control (MAC) address of the device.

AA:BB:77:88:99:03
ISPstring

The Internet service provider (ISP).

cmcc
DeviceNamestring

The name of the device.

5JhF100NEgdBcpNren32
ImageIDstring

The ID of the image.

m-2ze40oyhjorpyw61k7be
AppStatusobject

The status information of the application.

Phasestring

The status of the application. The value is of the enumeration type. Valid values:

Three intermediate states:

  • CREATING
  • UPDATING
  • DELETING

Four final states:

  • CREATE_FAILED
  • UPDATE_FAILED
  • DELETE_FAILED
  • RUNNING
CREATING
StatusDescripstring

The description of the application status.

UpdateTimestring

The time when the status was last updated.

2021-01-26T05:04Z
AppMetaDataobject

The basic properties of the application.

AppIdstring

The ID of the application.

97a32f2a-aa2c-436a-b19c-05b20d258618
AppNamestring

The name of the application.

iotx-api-admin
AppStableVersionstring

The stable version number of the application.

v1
AppTypestring

The type of the application. The value is of the enumeration type. Valid values:

  • Common
  • Scheduler
Common
ClusterNamestring

The name of the application cluster.

poc
CreateTimestring

The time when the application was created.

2022-03-03T03:42:11
Descriptionstring

The description of the application.

ResourceInfosobject []

The information about the instances.

AppVersionstring

The version of the application.

v1
AreaCodestring

The area code.

410800
AreaNamestring

The region name.

CreateTimestring

The time when the application was created.

2019-10-02T08:26Z
DeviceInfosobject []

The information about the devices.

Namestring

The name of the device.

test-api
Networkobject []

The network information.

ContainerPortsstring

The port of the container.

10000-10010
ExternalIpstring

The public IP address.

39.105.62.120
HostPortsstring

The port range.

80-8080
Protocolstring

The protocol of the gateway. The value is of the enumeration type. Valid values:

  • TCP
  • UDP
TCP
Statusstring

The status.

Running
InstanceIdstring

The ID of the instance.

i-5s9boobrmh5000kv4jmi0oeai
InstanceStatusstring

The status of the instance.

Running
InternalIpsobject []

The internal IP addresses.

Ipstring

The internal IP address.

10.0.2.3
PublicIpsobject []

The public IP addresses.

Ipstring

The public IP address.

122.13.173.137
RegionCodestring

The ID of the region.

cn-jiaozuo-2
RegionIdstring

The ID of the ENS node.

cn-jiaozuo-2
RegionNamestring

The name of the region.

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 codeError codeError message
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history