Use DescribeDeviceService to query instance and virtual device properties - ENS

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeDeviceService

get

*All Resource

*

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 elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	3A535110-3EE3-5EC5-B1ED-10B7067A1FC8
ResourceDetailInfos	array<object>	The information about the devices.
	object	Equipment information.
RegionID	string	The ID of the ENS node.	cn-jiaozuo-2
ID	string	The ID of the cloud device.	h-uf6009zoaexs5pefypbo
IP	string	The IP address.	120.27.219.219
Server	string	The server name of the ENS node.	ens-nc2
Status	string	The status of the device.	Running
Type	string	The type of the device.	ens.ac6.large
Mac	string	The media access control (MAC) address of the device.	AA:BB:77:88:99:03
ISP	string	The Internet service provider (ISP).	cmcc
DeviceName	string	The name of the device.	5JhF100NEgdBcpNren32
ImageID	string	The ID of the image.	m-2ze40oyhjorpyw61k7be
AppStatus	object	The status information of the application.
Phase	string	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
StatusDescrip	string	The description of the application status.	Creating
UpdateTime	string	The time when the status was last updated.	2021-01-26T05:04Z
AppMetaData	object	The basic properties of the application.
AppId	string	The ID of the application.	97a32f2a-aa2c-436a-b19c-05b20d258618
AppName	string	The name of the application.	iotx-api-admin
AppStableVersion	string	The stable version number of the application.	v1
AppType	string	The type of the application. The value is of the enumeration type. Valid values: Common Scheduler	Common
ClusterName	string	The name of the application cluster.	poc
CreateTime	string	The time when the application was created.	2022-03-03T03:42:11
Description	string	The description of the application.	Test application
ResourceInfos	array<object>	The information about the instances.
	array<object>	Resource information.
AppVersion	string	The version of the application.	v1
AreaCode	string	The area code.	410800
AreaName	string	The region name.	Central China,Henan Province,Jiaozuo City
CreateTime	string	The time when the application was created.	2019-10-02T08:26Z
DeviceInfos	array<object>	The information about the devices.
	array<object>	Equipment information.
Name	string	The name of the device.	test-api
Network	array<object>	The network information.
	object	Network information.
ContainerPorts	string	The port of the container.	10000-10010
ExternalIp	string	The public IP address.	39.105.62.120
HostPorts	string	The port range.	80-8080
Protocol	string	The protocol of the gateway. The value is of the enumeration type. Valid values: TCP UDP	TCP
Status	string	The status.	Running
InstanceId	string	The ID of the instance.	i-5s9boobrmh5000kv4jmi0oeai
InstanceStatus	string	The status of the instance.	Running
InternalIps	array<object>	The internal IP addresses.
	object	IP information.
Ip	string	The internal IP address.	10.0.2.3
PublicIps	array<object>	The public IP addresses.
	object	Public IP address.
Ip	string	The public IP address.	122.13.173.137
RegionCode	string	The ID of the region.	cn-jiaozuo-2
RegionId	string	The ID of the ENS node.	cn-jiaozuo-2
RegionName	string	The name of the region.	China Jiaozuo-2

Examples

Success response

JSON format

{
  "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": "Creating",
    "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": "Test application"
  },
  "ResourceInfos": [
    {
      "AppVersion": "v1",
      "AreaCode": "410800",
      "AreaName": "Central China,Henan Province,Jiaozuo City",
      "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": "China Jiaozuo-2"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.