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

Obtém os detalhes de uma instância.

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:GetInstance

get

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /api/v1/instances/{instanceId} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Não	O ID da instância. Obrigatório.	hgprecn-cn-i7m2v08uu00a

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
Instance	object	Os detalhes da instância.
InstanceChargeType	string	O método de cobrança da instância. Valores válidos: PostPaid : Pós-pago. PrePaid : Assinatura.	PrePaid
CommodityCode	string	O código do produto. Valores válidos: hologram_maxcomputeAccelerate_public_cn : Um cluster compartilhado vendido no site da China. hologram_combo_public_cn : Uma instância de assinatura no site da China. hologram_prepay_public_intl : Uma instância de assinatura vendida no site internacional. hologram_storage_dp_cn : Um plano de armazenamento vendido no site da China. hologram_postpay_public_cn : Uma instância pós-paga vendida no site da China. hologram_postpay_public_intl : Uma instância pós-paga vendida no site internacional. hologram_maxcomputeAccelerate_public_intl : Um cluster compartilhado vendido no site internacional. hologram_cu_dp_cn : Um plano de computação vendido no site da China.	hologram_combo_public_cn
Cpu	integer	O número de vCPUs.	32
CreationTime	string	A hora de criação.	2021-02-03T13:06:06Z
Disk	string	O tamanho do armazenamento padrão. Unidade: GB.	500
Endpoints	array<object>	A lista de endpoints.
	object	Os detalhes do endpoint.
Endpoint	string	The domain name of the endpoint.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	The network type. Valores válidos: VPCSingleTunnel : VPC Intranet : Internal network VPCAnyTunnel : (Not supported for new instances) Internet : Public network	Internet
Enabled	boolean	Indicates whether the network is enabled. Valores válidos: true : The network is enabled. false : The network is disabled.	true
VSwitchId	string	The vSwitch ID.	vsw-bp1jqwp2ys6kp7tc9t983
VpcId	string	The VPC ID.	vpc-uf66jjber3hgvwhki3wna
VpcInstanceId	string	The VPC instance ID.	hgprecn-cn-uqm362o1b001-frontend-st
AlternativeEndpoints	string	Some earlier instances have both AnyTunnel and SingleTunnel enabled. When you switch from AnyTunnel to SingleTunnel, the endpoints for both are retained. This field is used to store the extra endpoint.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
ExpirationTime	string	A hora de expiração. Instâncias pós-pagas não expiram.	2021-02-03T13:06:06Z
InstanceId	string	O ID da instância.	hgpostcn-cn-tl32s6cgw00b
InstanceName	string	O nome da instância. O nome deve ter de 2 a 64 caracteres. Cada letra ou caractere chinês é contado como um único caractere.	test
InstanceType	string	O tipo de instância. Valores válidos: Warehouse : Instância de warehouse virtual. Follower : Instância secundária somente leitura. Standard : Instância de uso geral. Serverless : Instância Serverless. Shared : Cluster compartilhado.	Standard
Memory	integer	O tamanho da memória. Unidade: GB.	128
InstanceOwner	string	O proprietário da instância.	12345678900000
InstanceStatus	string	O status da instância. Valores válidos: Creating : A instância está sendo criada. Running : A instância está em execução. Suspended : A instância está parada. Allocating : A instância está alocando recursos.	Running
Version	string	A versão da instância.	r1.3.37
SuspendReason	string	O motivo pelo qual a instância foi parada. Valores válidos: Indebet : O pagamento está em atraso. Manual : A instância foi parada manualmente. Overdue : A assinatura expirou.	Manual
Tags	array<object>	As tags da instância.
	object	Os detalhes da tag.
Key	string	The tag key.	tag
Value	string	The tag value.	value
LeaderInstanceId	string	O ID da instância primária.	hgpostcn-cn-i7m2ncd6w002
EnableHiveAccess	string	Indica se a aceleração do data lake está ativada.	true
ResourceGroupId	string	O ID do grupo de recursos.	rg-aekzuq7hpybze2i
ComputeNodeCount	integer	O número de nós de computação. Um nó tem 16 vCPUs e 32 GB de memória.	2
ZoneId	string	O ID da zona.	cn-hangzhou-h
ColdStorage	integer	A capacidade de armazenamento frio. Unidade: GB. O SSD é o armazenamento quente, que também é o armazenamento padrão. O HDD é o armazenamento frio.	800
AutoRenewal	string	Indica se a renovação automática está ativada. Valores válidos: true : A renovação automática está ativada. false : A renovação automática está desativada.	true
GatewayCount	integer	O número de nós de gateway.	2
GatewayCpu	integer	Os recursos de vCPU do gateway. Unidade: núcleos.	4
GatewayMemory	integer	Os recursos de memória do gateway. Unidade: GB.	16
RegionId	string	O ID da região.	cn-hangzhou
ReplicaRole	string	A função da instância na recuperação de desastres. Active: a instância primária. Passive: a instância secundária. PreActive: uma instância primária que não atingiu o estado desejado.	Active
EnableServerless	boolean	Indica se o Serverless Computing está ativado. Valores válidos: true : O Serverless Computing está ativado. false : O Serverless Computing está desativado.	true
StorageType	string	A classe de armazenamento:\n\n- redundant: Armazenamento com redundância de zona\n\n- local: Armazenamento com redundância local.	redundant
EnableSSL	boolean	Indica se o SSL está ativado.	true
Success	boolean	O resultado da solicitação, que indica se ocorreu uma exceção. Este parâmetro não está relacionado à lógica de negócios.	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": "865A02C2-B374-5DD4-9B34-0CA15DA1AEBD",
  "Instance": {
    "InstanceChargeType": "PrePaid",
    "CommodityCode": "hologram_combo_public_cn",
    "Cpu": 32,
    "CreationTime": "2021-02-03T13:06:06Z",
    "Disk": "500",
    "Endpoints": [
      {
        "Endpoint": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80",
        "Type": "Internet",
        "Enabled": true,
        "VSwitchId": "vsw-bp1jqwp2ys6kp7tc9t983",
        "VpcId": "vpc-uf66jjber3hgvwhki3wna",
        "VpcInstanceId": "hgprecn-cn-uqm362o1b001-frontend-st",
        "AlternativeEndpoints": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80"
      }
    ],
    "ExpirationTime": "2021-02-03T13:06:06Z",
    "InstanceId": "hgpostcn-cn-tl32s6cgw00b",
    "InstanceName": "test",
    "InstanceType": "Standard",
    "Memory": 128,
    "InstanceOwner": "12345678900000",
    "InstanceStatus": "Running",
    "Version": "r1.3.37",
    "SuspendReason": "Manual",
    "Tags": [
      {
        "Key": "tag",
        "Value": "value"
      }
    ],
    "LeaderInstanceId": "hgpostcn-cn-i7m2ncd6w002",
    "EnableHiveAccess": "true",
    "ResourceGroupId": "rg-aekzuq7hpybze2i",
    "ComputeNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "ColdStorage": 800,
    "AutoRenewal": "true",
    "GatewayCount": 2,
    "GatewayCpu": 4,
    "GatewayMemory": 16,
    "RegionId": "cn-hangzhou",
    "ReplicaRole": "Active",
    "EnableServerless": true,
    "StorageType": "redundant",
    "EnableSSL": true
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

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.