ListInstances - : Central de Documentação do Alibaba Cloud

Consulta informações sobre uma ou mais instâncias EIAM.

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

eiam:ListInstances

get

*Instance.

acs:eiam:{#regionId}:{#accountId}:instance/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O tamanho da página.	20
InstanceIds	array	Não	A lista de IDs de instâncias.
	string	Não	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
Status	string	Não	O status da instância. Valores válidos: creating: Em criação. running: Em execução.	running
Edition	string	Não	A edição da licença. Valores válidos: free: Edição Gratuita. trial: Edição de Avaliação. scalability: Edição de Escalabilidade. standard: Edição Standard. enterprise: Edição Enterprise.	free
CrossRegionReplication	string	Não	O status de replicação entre regiões.	disabled
ServiceManaged	boolean	Não	Indica se a instância é gerenciada por um serviço de nuvem.	true
ManagedServiceCode	string	Não	O código do serviço de nuvem gerenciador.	kms

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	O número total de entradas retornadas.	100
Instances	array<object>	A lista de informações das instâncias.
	array<object>	As informações da instância retornadas em uma matriz de instâncias.
InstanceId	string	O ID da instância.	idaas_eypq6ljgyeuwmlw672sulxxxxx
CreateTime	integer	A hora em que a instância foi criada. O valor é um carimbo de data/hora UNIX em milissegundos.	1550115455000
Status	string	O status da instância. Valores válidos: creating: Em criação. running: Em execução.	running
Description	string	A descrição da instância.	instance_for_test
DefaultEndpoint	object	O endpoint padrão da instância.
Endpoint	string	O endereço do endpoint da instância.	example-xxx.aliyunidaas.com
Status	string	O status do endpoint. Valores válidos: resolved: Resolvido. unresolved: Não resolvido.	resolved
ServiceManaged	boolean	Indica se a instância é gerenciada por um serviço de nuvem.	true
ManagedServiceCode	string	O código do serviço de nuvem que gerencia a instância.	sase
CrossRegionReplication	string	Indica se a replicação entre regiões está ativada. Valores válidos: enabled e disabled.	enabled
CrossRegionReplicationRole	string	A função de replicação entre regiões. Valores válidos: primary, que indica a instância primária, e backup, que indica a instância de backup.	primary
InstanceFailoverStatus	string	O status de ativação de failover da instância. Valores válidos: active, que indica que o failover está ativado, e inactive, que indica que o failover não está ativado.	inactive
ReplicationConfiguration	object	A configuração de replicação. Este parâmetro é retornado apenas quando CrossRegionReplication é definido como enabled.
ReplicationCreateTime	integer	A hora em que a replicação de dados de recuperação de desastres foi criada. O valor é um carimbo de data/hora UNIX em milissegundos.	1778499337000
PrimaryInstanceId	string	O ID da instância primária.	idaas_xxxxxx
PrimaryInstanceRegionId	string	O ID da região da instância primária.	cn-hangzhou
BackupInstanceId	string	O ID da instância de recuperação de desastres.	idaas_xxxxxx
BackupInstanceRegionId	string	O ID da região da instância de recuperação de desastres.	cn-beijing

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Instances": [
    {
      "InstanceId": "idaas_eypq6ljgyeuwmlw672sulxxxxx",
      "CreateTime": 1550115455000,
      "Status": "running",
      "Description": "instance_for_test",
      "DefaultEndpoint": {
        "Endpoint": "example-xxx.aliyunidaas.com",
        "Status": "resolved"
      },
      "ServiceManaged": true,
      "ManagedServiceCode": "sase",
      "CrossRegionReplication": "enabled",
      "CrossRegionReplicationRole": "primary",
      "InstanceFailoverStatus": "inactive",
      "ReplicationConfiguration": {
        "ReplicationCreateTime": 1778499337000,
        "PrimaryInstanceId": "idaas_xxxxxx",
        "PrimaryInstanceRegionId": "cn-hangzhou",
        "BackupInstanceId": "idaas_xxxxxx",
        "BackupInstanceRegionId": "cn-beijing"
      }
    }
  ]
}

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.