ListResourceInstances - Platform For AI: Central de Documentação do Alibaba Cloud

Lista as instâncias em um grupo de recursos dedicado especificado.

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

eas:ListResourceInstances

get

*Resource

acs:eas:{#regionId}:{#accountId}:resource/{#ResourceId}

Nenhuma

Sintaxe da solicitação

GET /api/v2/resources/{ClusterId}/{ResourceId}/instances HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Sim	O ID da região onde o grupo de recursos está localizado.	cn-shanghai
ResourceId	string	Sim	O ID do grupo de recursos. Para mais informações, consulte ListResources.	iot

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ChargeType	string	Não	Filtra instâncias pelo método de cobrança. Valores válidos: PrePaid: assinatura. PostPaid: pós-pago. Valores válidos: PostPaid : Pós-pago. PrePaid : Assinatura.	PrePaid
PageNumber	integer	Não	O número da página. O valor começa em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de instâncias a serem retornadas em cada página. Valor padrão: 100.	20
InstanceName	string	Não	Filtra pelo nome da instância.	e-xxxx***
InstanceId	string	Não	Filtra pelo ID da instância. Para mais informações, consulte ListResourceInstances.	i-bp1jd6x3uots****a
InstanceIP	string	Não	O endereço IP da instância.	10.224.xx.xx
Filter	string	Não	Uma palavra-chave para pesquisa. Você pode pesquisar pelo ID da instância ou pelo endereço IP.	10.224.xx.xx
InstanceStatus	string	Não	O status da instância. Valores válidos: Ready-SchedulingDisabled : A instância está disponível, mas não pode ser agendada. Ready : Pronto. NotReady : Não pronto. Stopped : Parada. NotReady-SchedulingDisabled : A instância está indisponível e não pode ser agendada. Attaching : Anexando. Deleting : Excluindo. CreateFailed : Falha na criação.	Ready
Label	object	Não	Filtra pela tag.
	string	Não	Insira a tag no formato `{"key":"value"}`. O valor pode ser `null` ou uma string vazia. Isso permite filtrar apenas pela chave, independentemente do valor.	{"key1":"value1","key2":null}
Sort	string	Não	O campo de ordenação. Valores válidos: CreateTime : Hora de criação. MemoryUsed : Uso de memória. GpuUsed : Uso de GPU. ExpireTime : Hora de expiração. CpuUsed : Uso de CPU.	CreateTime
Order	string	Não	A ordem de classificação. Valores válidos: asc : Crescente. desc : Decrescente.	desc
Zone	string	Não	A zona da instância.	J

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	40325405-579C-4D82****
Instances	array	A lista de instâncias.
	ResourceInstance	As informações da instância.
PageNumber	integer	O número da página da lista de instâncias retornada.	1
PageSize	integer	O número de instâncias retornadas em cada página.	20
TotalCount	integer	O número total de instâncias.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "40325405-579C-4D82****",
  "Instances": [
    {
      "InstanceId": "eas-i-1800z74n30kao****",
      "InstanceName": "eas01122713204*****",
      "InstanceIp": "11.227.XX.XX",
      "InstanceStatus": "Ready",
      "InstancePhase": "",
      "InstanceCpuCount": 4,
      "InstanceGpuCount": 0,
      "InstanceMemory": "8192M",
      "InstanceSystemDiskSize": 200,
      "InstanceGpuMemory": "0G",
      "InstanceUsedCpu": 2.4,
      "InstanceUsedGpu": 0,
      "InstanceUsedMemory": "1000M",
      "InstanceType": "ecs.s6-c1m2.xlarge",
      "CreateTime": "2020-07-05T22:51:32Z",
      "ChargeType": "PrePaid",
      "ExpiredTime": "2020-08-05T22:51:32Z",
      "AutoRenewal": false,
      "Arch": "arm64",
      "Region": "cn-hangzhou",
      "Zone": "cn-hangzhou-b",
      "ResourceId": "eas-r-xxxxx",
      "InstanceTenantIp": "192.168.XX.XX",
      "InstanceUsedGpuMemory": "470M",
      "Labels": [
        {
          "LabelKey": "key",
          "LabelValue": "value"
        }
      ],
      "LastCordonOperator": "",
      "LastCordonReason": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.