DescribeDeviceService - ENS: Central de Documentação do Alibaba Cloud

Consulta a lista de informações de propriedades básicas, como instâncias e o status de rede de dispositivos virtuais em um aplicativo de borda.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ens:DescribeDeviceService

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ServiceId	string	Não	O ID do serviço.	s-cxxxxx
InstanceId	string	Não	O ID da instância.	i-5sg1owx0g4ojy66ab2tez77r2
RegionId	string	Não	O ID do nó de borda ENS.	cn-chongqing-11
AppId	string	Não	O ID do aplicativo.	a2bac6f4-75dc-455e-8389-2dc8e47526d3
EnsRegionId	string	Não	Parâmetro inválido.	cn-chongqing-10
OrderId	string	Não	O ID do pedido.	2661b1dd-3453-418d-8182-bb34f79e8d3c

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	3A535110-3EE3-5EC5-B1ED-10B7067A1FC8
ResourceDetailInfos	array<object>	A lista de dispositivos.
	object	As informações do dispositivo.
RegionID	string	O ID do nó de borda ENS.	cn-jiaozuo-2
ID	string	O ID do dispositivo em nuvem.	h-uf6009zoaexs5pefypbo
IP	string	O endereço IP.	120.27.219.219
Server	string	O nome do servidor NC do nó de borda ENS.	ens-nc2
Status	string	O status do dispositivo.	Running
Type	string	O tipo de dispositivo.	ens.ac6.large
Mac	string	O endereço MAC do dispositivo.	AA:BB:77:88:99:03
ISP	string	As informações do provedor de serviços de Internet (ISP).	cmcc
DeviceName	string	O nome do dispositivo.	5JhF100NEgdBcpNren32
ImageID	string	O ID da imagem.	m-2ze40oyhjorpyw61k7be
AppStatus	object	As informações de status do aplicativo.
Phase	string	O status do aplicativo. Valores válidos: Três estados intermediários: CREATING UPDATING DELETING Quatro estados finais: CREATE_FAILED UPDATE_FAILED DELETE_FAILED RUNNING	CREATING
StatusDescrip	string	A descrição do status do aplicativo.	Creating
UpdateTime	string	A hora da atualização de status mais recente.	2021-01-26T05:04Z
AppMetaData	object	As propriedades básicas do aplicativo.
AppId	string	O ID do aplicativo.	97a32f2a-aa2c-436a-b19c-05b20d258618
AppName	string	O nome do aplicativo.	iotx-api-admin
AppStableVersion	string	O número da versão estável do aplicativo.	v1
AppType	string	O tipo de aplicativo. Valores válidos: Common: comum. Scheduler: recurso de agendamento.	Common
ClusterName	string	O nome do cluster do aplicativo.	poc
CreateTime	string	A hora em que o aplicativo foi criado.	2022-03-03T03:42:11
Description	string	A descrição do aplicativo.	Aplicativo de teste
ResourceInfos	array<object>	A lista de informações de instâncias de recursos.
	array<object>	As informações do recurso.
AppVersion	string	O número da versão do aplicativo.	v1
AreaCode	string	O código de área.	410800
AreaName	string	O nome da área.	China Central, Província de Henan, Cidade de Jiaozuo
CreateTime	string	A hora em que o recurso foi criado.	2019-10-02T08:26Z
DeviceInfos	array<object>	A lista de informações de dispositivos.
	array<object>	As informações do dispositivo.
Name	string	O nome do dispositivo.	test-api
Network	array<object>	A lista de informações de rede.
	object	As informações de rede.
ContainerPorts	string	A porta do contêiner.	10000-10010
ExternalIp	string	O endereço IP público.	39.105.62.120
HostPorts	string	O intervalo de portas do host.	80-8080
Protocol	string	O protocolo do gateway. Valores válidos: TCP UDP	TCP
Status	string	O status.	Running
InstanceId	string	O ID da instância.	i-5s9boobrmh5000kv4jmi0oeai
InstanceStatus	string	O status da instância.	Running
InternalIps	array<object>	A lista de endereços IP internos.
	object	As informações de IP.
Ip	string	O endereço IP.	10.0.2.3
PublicIps	array<object>	Os endereços IP públicos.
	object	Os endereços IP públicos.
Ip	string	O endereço IP.	122.13.173.137
RegionCode	string	O código da região.	cn-jiaozuo-2
RegionId	string	O ID do nó de borda ENS.	cn-jiaozuo-2
RegionName	string	O nome da área.	China Jiaozuo-2

Exemplos

Resposta de sucesso

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": "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": "华中,河南省,焦作市",
      "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": "中国焦作-2"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.