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

Obtém uma lista de instâncias.

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

hologram:ListInstances

list

*Instância.

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

Nenhuma

Sintaxe da solicitação

POST /api/v1/instances HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	O corpo da solicitação.
resourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmvscak73zmby
tag	array<object>	Não	As tags da instância.
	object	Não	Os detalhes da tag.
key	string	Não	A chave da tag.	mytag
value	string	Não	O valor da tag.	valor
cmsInstanceType	string	Não	O tipo de instância do CloudMonitor. Valores válidos: standard follower mc-acceleration warehouse high-memory serverless Nota Isso é para o CloudMonitor.	standard

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D1303CD4-AA70-5998-8025-F55B22C50840
InstanceList	array<object>	A lista de instâncias.
	array<object>	Os detalhes da instância.
CommodityCode	string	O código da commodity, que é o mesmo que o código de detalhes do produto no User Center.	hologram_postpay_public_cn
CreationTime	string	A hora de criação. O horário está em UTC e no formato ISO 8601.	2022-12-16T02:24:05Z
ExpirationTime	string	A hora de expiração. O horário está em UTC e no formato ISO 8601.	2023-05-04T16:00:00.000Z
InstanceId	string	O ID da instância.	hgpostcn-cn-aaab9ad2d8fb
InstanceName	string	O nome da instância.	test_instance
InstanceStatus	string	O status da instância. Valores válidos: Creating : Em criação. Running : Em execução normal. Suspended : Suspensa. Allocating : Em processamento.	Running
InstanceType	string	O tipo de instância. Valores válidos: Warehouse : Tipo de grupo de computação. Follower : Instância follower somente leitura. Standard : Tipo padrão. Serverless : Tipo serverless. Shared : Tipo compartilhado.	Standard
Tags	array<object>	A lista de tags.
	object	Os detalhes da tag.
Key	string	A chave da tag.	tag
Value	string	O valor da tag.	valor
InstanceChargeType	string	O método de cobrança da instância. Valores válidos: PostPaid : Pós-pago. PrePaid : Assinatura.	PrePaid
LeaderInstanceId	string	O ID da instância primária.	hgprecn-cn-2r42sqvxm006
SuspendReason	string	O motivo da suspensão.	Manual
EnableHiveAccess	string	Indica se a aceleração da Data Lakehouse Edition está ativada. Valores válidos: true : Ativada. false : Desativada.	true
Version	string	A versão da instância.	1.3.37
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmvscak73zmby
Endpoints	array<object>	A lista de endpoints.
	object	Os detalhes do endpoint.
Endpoint	string	O endpoint.	hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	O tipo de rede. Valores válidos: VPCSingleTunnel : VPC. Intranet : Rede interna. VPCAnyTunnel : Não é mais suportado para novas instâncias. Internet : Internet.	Internet
Enabled	boolean	Indica se o endpoint está ativado. Valores válidos: true : Ativada. false : Desativada.	true
VSwitchId	string	O ID do vSwitch.	vsw-wz9oap28raidjevhuszg4
VpcId	string	O ID da VPC.	vpc-uf6mrahzyu7uorlqqpz5f
VpcInstanceId	string	O ID da instância conectada à VPC.	hgpostcn-cn-wwo3665tx004-frontend-st
RegionId	string	O ID da região.	cn-hangzhou
ZoneId	string	O ID da zona.	cn-hangzhou-h
StorageType	string	O tipo de armazenamento. Valores válidos:\n* redundant: implantação em três zonas.\n* local: implantação em zona única.	redundant
EnableSSL	string	Indica se o SSL está ativado.	true
Success	string	Indica se a chamada de API foi bem-sucedida.	true
ErrorCode	string	O código de erro.	null
ErrorMessage	string	A mensagem de erro.	null
HttpStatusCode	string	O código de status HTTP.	200

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D1303CD4-AA70-5998-8025-F55B22C50840",
  "InstanceList": [
    {
      "CommodityCode": "hologram_postpay_public_cn",
      "CreationTime": "2022-12-16T02:24:05Z",
      "ExpirationTime": "2023-05-04T16:00:00.000Z",
      "InstanceId": "hgpostcn-cn-aaab9ad2d8fb",
      "InstanceName": "test_instance",
      "InstanceStatus": "Running",
      "InstanceType": "Standard",
      "Tags": [
        {
          "Key": "tag",
          "Value": "value"
        }
      ],
      "InstanceChargeType": "PrePaid",
      "LeaderInstanceId": "hgprecn-cn-2r42sqvxm006",
      "SuspendReason": "Manual",
      "EnableHiveAccess": "true",
      "Version": "1.3.37",
      "ResourceGroupId": "rg-acfmvscak73zmby",
      "Endpoints": [
        {
          "Endpoint": "hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80",
          "Type": "Internet",
          "Enabled": true,
          "VSwitchId": "vsw-wz9oap28raidjevhuszg4",
          "VpcId": "vpc-uf6mrahzyu7uorlqqpz5f",
          "VpcInstanceId": "hgpostcn-cn-wwo3665tx004-frontend-st"
        }
      ],
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-h",
      "StorageType": "redundant",
      "EnableSSL": "true"
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.