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

dms:GetInstance

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Tid	integer	Não	O ID do locatário. Você pode chamar a operação GetUserActiveTenant para obter o valor deste parâmetro.	2***
Host	string	Sim	O endpoint da instância. Você pode chamar a operação ListInstances para obter o valor deste parâmetro.	172.17.XXX.XXX
Port	integer	Sim	A porta de conexão da instância. Você pode chamar a operação ListInstances para obter o valor deste parâmetro.	5432
Sid	string	Não	O SID da instância. Você pode chamar a operação ListInstances para obter o valor deste parâmetro.	test
RealLoginUserUid	string	Não	O UID da conta Alibaba Cloud do usuário que realmente chama a operação de API.	21400447956867****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	F6C80B69-3203-56AC-8021-18BA72A6F4E1
Instance	object	Os detalhes da instância.
VpcId	string	O ID da VPC à qual a instância pertence.	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	O nome de usuário usado para fazer logon na instância.	dbuser
DbaId	string	O ID do DBA da instância.	29****
UseDsql	integer	Especifica se a consulta entre bancos de dados está ativada para a instância. Valores válidos: 0: Desativado. 1: Ativado.	0
Port	integer	A porta de conexão da instância.	5432
EcsInstanceId	string	O ID da instância ECS.	i-bp124ldpklqz59y3****
EnvType	string	O tipo de ambiente da instância. Valores válidos: product: Ambiente de produção. dev: Ambiente de desenvolvimento. pre: Ambiente de staging. test: Ambiente de teste. sit: Ambiente SIT. uat: Ambiente UAT. pet: Ambiente de teste de estresse. stag: Ambiente STAG.	test
Sid	string	O SID da instância.	test
OwnerIdList	object
OwnerIds	array	A lista de IDs de usuário proprietários da instância.
	string	O ID de usuário proprietário da instância.	10****
SafeRuleId	string	O ID da regra de segurança da instância.	3****
OwnerNameList	object
OwnerNames	array	A lista de apelidos dos proprietários da instância.
	string	O apelido do proprietário da instância.	yang_test
DbaNickName	string	O apelido do DBA da instância.	dbaname
QueryTimeout	integer	O tempo limite de consulta da instância.	7200
InstanceSource	string	A origem da instância.	ECS_OWN
Host	string	O endpoint da instância.	192.168.XXX.XXX
State	string	O status da instância. Valores válidos: NORMAL: Normal. DISABLE: Desativado.	NORMAL
DataLinkName	string	O nome do link de dados da instância.	test
ExportTimeout	integer	O tempo limite de exportação da instância.	86400
InstanceId	string	O ID da instância.	188****
InstanceType	string	O tipo de banco de dados da instância.	postgresql
DatabasePassword	string	A senha do usuário do banco de dados.	******
InstanceAlias	string	O alias da instância.	Test
DdlOnline	integer	A configuração de DDL online da instância.	0
EcsRegion	string	A região à qual a instância pertence.	cn-beijing
StandardGroup	object	As informações do modo de controle da instância.
GroupName	string	O nome da regra de segurança correspondente ao modo de controle.	Free operation
GroupMode	string	O tipo do modo de controle. Valores válidos: COMMON: Modo de colaboração de segurança. NONE_CONTROL: Modo de operação livre. STABLE: Modo de alteração estável.	NONE_CONTROL
SellSitd	string	Especifica se a proteção de dados sensíveis está ativada. Valores válidos: true: Ativado. false: Desativado.	false
SellTrust	string	Especifica se a hospedagem de segurança está ativada. Valores válidos: true: Ativado. false: Desativado.	true
ErrorCode	string	O código de erro.	UnknownError
ErrorMessage	string	A mensagem de erro.	UnknownError
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance": {
    "VpcId": "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser": "dbuser",
    "DbaId": "29****",
    "UseDsql": 0,
    "Port": 5432,
    "EcsInstanceId": "i-bp124ldpklqz59y3****",
    "EnvType": "test",
    "Sid": "test",
    "OwnerIdList": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "yang_test"
      ]
    },
    "DbaNickName": "dbaname",
    "QueryTimeout": 7200,
    "InstanceSource": "ECS_OWN",
    "Host": "192.168.XXX.XXX",
    "State": "NORMAL",
    "DataLinkName": "test",
    "ExportTimeout": 86400,
    "InstanceId": "188****",
    "InstanceType": "postgresql",
    "DatabasePassword": "******",
    "InstanceAlias": "测试",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "自由操作",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false",
    "SellTrust": "true"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

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.