DescribeDeviceService - ENS - Centro de documentación de Alibaba Cloud

Consulta la lista de información de propiedades básicas, como las instancias y el estado de red de los dispositivos virtuales, de una aplicación de borde.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ens:DescribeDeviceService

get

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ServiceId	string	No	El ID del servicio.	s-cxxxxx
InstanceId	string	No	El ID de la instancia.	i-5sg1owx0g4ojy66ab2tez77r2
RegionId	string	No	El ID del nodo de borde de ENS.	cn-chongqing-11
AppId	string	No	El ID de la aplicación.	a2bac6f4-75dc-455e-8389-2dc8e47526d3
EnsRegionId	string	No	Parámetro no válido.	cn-chongqing-10
OrderId	string	No	El ID del pedido.	2661b1dd-3453-418d-8182-bb34f79e8d3c

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	3A535110-3EE3-5EC5-B1ED-10B7067A1FC8
ResourceDetailInfos	array<object>	La lista de dispositivos.
	object	La información del dispositivo.
RegionID	string	El ID del nodo de borde de ENS.	cn-jiaozuo-2
ID	string	El ID del dispositivo en la nube.	h-uf6009zoaexs5pefypbo
IP	string	La dirección IP.	120.27.219.219
Server	string	El nombre NC del servidor del nodo de borde de ENS.	ens-nc2
Status	string	El estado del dispositivo.	Running
Type	string	El tipo de dispositivo.	ens.ac6.large
Mac	string	La dirección MAC del dispositivo.	AA:BB:77:88:99:03
ISP	string	La información del proveedor de servicios de Internet (ISP).	cmcc
DeviceName	string	El nombre del dispositivo.	5JhF100NEgdBcpNren32
ImageID	string	El ID de la imagen.	m-2ze40oyhjorpyw61k7be
AppStatus	object	La información del estado de la aplicación.
Phase	string	El estado de la aplicación. Valores válidos: Tres estados intermedios: CREATING UPDATING DELETING Cuatro estados finales: CREATE_FAILED UPDATE_FAILED DELETE_FAILED RUNNING	CREATING
StatusDescrip	string	La descripción del estado de la aplicación.	Creando
UpdateTime	string	La hora de la última actualización de estado.	2021-01-26T05:04Z
AppMetaData	object	Las propiedades básicas de la aplicación.
AppId	string	El ID de la aplicación.	97a32f2a-aa2c-436a-b19c-05b20d258618
AppName	string	El nombre de la aplicación.	iotx-api-admin
AppStableVersion	string	El número de versión estable de la aplicación.	v1
AppType	string	El tipo de aplicación. Valores válidos: Common: común. Scheduler: programación de recursos.	Common
ClusterName	string	El nombre del clúster de la aplicación.	poc
CreateTime	string	La hora en que se creó la aplicación.	2022-03-03T03:42:11
Description	string	La descripción de la aplicación.	Aplicación de prueba
ResourceInfos	array<object>	La lista de información de las instancias de recursos.
	array<object>	La información del recurso.
AppVersion	string	El número de versión de la aplicación.	v1
AreaCode	string	El código de área.	410800
AreaName	string	El nombre del área.	China central, provincia de Henan, ciudad de Jiaozuo
CreateTime	string	La hora en que se creó el recurso.	2019-10-02T08:26Z
DeviceInfos	array<object>	La lista de información de los dispositivos.
	array<object>	La información del dispositivo.
Name	string	El nombre del dispositivo.	test-api
Network	array<object>	La lista de información de red.
	object	La información de red.
ContainerPorts	string	El puerto del contenedor.	10000-10010
ExternalIp	string	La dirección IP pública.	39.105.62.120
HostPorts	string	El rango de puertos del host.	80-8080
Protocol	string	El protocolo de puerta de enlace. Valores válidos: TCP UDP	TCP
Status	string	El estado.	Running
InstanceId	string	El ID de la instancia.	i-5s9boobrmh5000kv4jmi0oeai
InstanceStatus	string	El estado de la instancia.	Running
InternalIps	array<object>	La lista de direcciones IP internas.
	object	La información de la IP.
Ip	string	La dirección IP.	10.0.2.3
PublicIps	array<object>	Las direcciones IP públicas.
	object	Las direcciones IP públicas.
Ip	string	La dirección IP.	122.13.173.137
RegionCode	string	El código de región.	cn-jiaozuo-2
RegionId	string	El ID del nodo de borde de ENS.	cn-jiaozuo-2
RegionName	string	El nombre del área.	China Jiaozuo-2

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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",
      "RegionName": "中国焦作-2"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.