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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetInstance	Operação a ser executada. Defina o valor como GetInstance.
Tid	Long	Sim	2***	ID do tenant. Chame a operação GetUserActiveTenant para consultar o ID do tenant.
Host	String	Sim	172.17.XXX.XXX	Endpoint da instância de banco de dados. Chame a operação ListInstances para consultar o endpoint.
Port	Integer	Sim	5432	Número da porta usada para conectar à instância de banco de dados. Chame a operação ListInstances para consultar o número da porta.
Sid	String	Não	test	System ID (SID) da instância de banco de dados. Chame a operação ListInstances para consultar o SID.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	F6C80B69-3203-56AC-8021-18BA72A6F4E1	ID da solicitação.
Instance	Object		Detalhes da instância de banco de dados.
VpcId	String	vpc-o6wrloqsdqc9io3mg****	ID da Virtual Private Cloud (VPC) à qual a instância de banco de dados pertence.
DatabaseUser	String	dbuser	Conta usada para fazer login na instância de banco de dados.
DbaId	String	29****	ID do administrador de banco de dados (DBA) da instância.
UseDsql	Integer	0	Indica se o recurso de consulta entre bancos de dados está ativado para a instância. Valores válidos: 0: Recurso de consulta entre bancos de dados desativado. 1: Recurso de consulta entre bancos de dados ativado.
Port	Integer	5432	Número da porta usada para conectar à instância de banco de dados.
EcsInstanceId	String	i-bp124ldpklqz59y3****	ID da instância do Elastic Compute Service (ECS) onde a instância de banco de dados está implantada.
EnvType	String	test	Tipo de ambiente onde a instância de banco de dados está implantada. Valores válidos: product: Ambiente de produção dev: Ambiente de desenvolvimento pre: Ambiente de pré-lançamento test: Ambiente de teste sit: Ambiente de teste de integração de sistema (SIT) uat: Ambiente de teste de aceitação do usuário (UAT) pet: Ambiente de teste de estresse stag: Ambiente de staging
Sid	String	test	SID da instância de banco de dados.
OwnerIdList	Array of String	10****	IDs dos proprietários da instância de banco de dados.
SafeRuleId	String	3****	ID do conjunto de regras de segurança da instância de banco de dados.
OwnerNameList	Array of String	yang_test	Apelidos dos proprietários da instância de banco de dados.
DbaNickName	String	dbaname	Apelido do DBA da instância de banco de dados.
QueryTimeout	Integer	7200	Tempo limite para consultar dados na instância de banco de dados.
InstanceSource	String	ECS_OWN	source da instância de banco de dados.
Host	String	192.168.XXX.XXX	Endpoint usado para conectar à instância de banco de dados.
State	String	NORMAL	Status da instância de banco de dados. Valores válidos: NORMAL: A instância está normal. DISABLE: A instância está desativada.
DataLinkName	String	test	Nome do link de banco de dados da instância.
ExportTimeout	Integer	86400	Tempo limite para exportar dados da instância de banco de dados.
InstanceId	String	188****	ID da instância.
InstanceType	String	postgresql	Tipo da instância de banco de dados.
DatabasePassword	String	******	Senha usada para fazer login na instância de banco de dados.
InstanceAlias	String	Test	Alias da instância de banco de dados.
DdlOnline	Integer	0	Indica se o recurso de alteração de esquema sem bloqueio está ativado para a instância de banco de dados.
EcsRegion	String	cn-beijing	ID da região onde a instância de banco de dados reside.
StandardGroup	Object		Modo de controle da instância de banco de dados.
GroupName	String	Flexible Management	Nome da regra de segurança correspondente ao modo de controle.
GroupMode	String	NONE_CONTROL	Tipo do modo de controle. Valores válidos: COMMON: Security Collaboration NONE_CONTROL: Flexible Management STABLE: Stable Change
SellSitd	String	false	Indica se o recurso de proteção de dados sensíveis está ativado. Valores válidos: true: Recurso de proteção de dados sensíveis ativado. false: Recurso de proteção de dados sensíveis desativado.
ErrorCode	String	UnknownError	Código de erro retornado se a solicitação falhar.
ErrorMessage	String	UnknownError	Mensagem de erro retornada se a solicitação falhar.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true: Solicitação bem-sucedida. false: Falha na solicitação.

Exemplos

Exemplos de solicitações

http(s)://dms-enterprise.aliyuncs.com/?Action=GetInstance
&Tid=1
&Host=172.17.XXX.XXX
&Port=5432
&Sid=test
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<GetInstanceResponse>
    <RequestId>F6C80B69-3203-56AC-8021-18BA72A6F4E1</RequestId>
    <Instance>
        <Port>5432</Port>
        <DatabasePassword>******</DatabasePassword>
        <ExportTimeout>86400</ExportTimeout>
        <EnvType>test</EnvType>
        <DbaId>12****</DbaId>
        <InstanceAlias>Test</InstanceAlias>
        <EcsRegion>cn-beijing</EcsRegion>
        <InstanceType>postgresql</InstanceType>
        <QueryTimeout>7200</QueryTimeout>
        <DataLinkName>dbl_postgresql_2</DataLinkName>
        <SafeRuleId>3****</SafeRuleId>
        <SellSitd>false</SellSitd>
        <InstanceSource>ECS_OWN</InstanceSource>
        <StandardGroup>
            <GroupName>Flexible Management</GroupName>
            <GroupMode>NONE_CONTROL</GroupMode>
        </StandardGroup>
        <InstanceId>188****</InstanceId>
        <Host>172.17.XXX.XXX</Host>
        <DdlOnline>0</DdlOnline>
        <UseDsql>0</UseDsql>
        <EcsInstanceId>i-bp124ldpklqz59y3****</EcsInstanceId>
        <State>NORMAL</State>
        <DatabaseUser>postgres</DatabaseUser>
        <OwnerNameList>
            <OwnerNames>yang_test</OwnerNames>
        </OwnerNameList>
        <DbaNickName>dbaname</DbaNickName>
        <OwnerIdList>
            <OwnerIds>10****</OwnerIds>
        </OwnerIdList>
    </Instance>
    <Success>true</Success>
</GetInstanceResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance" : {
    "Port" : 5432,
    "DatabasePassword" : "******",
    "ExportTimeout" : 86400,
    "EnvType" : "test",
    "DbaId" : "12****",
    "InstanceAlias" : "Test",
    "EcsRegion" : "cn-beijing",
    "InstanceType" : "postgresql",
    "QueryTimeout" : 7200,
    "DataLinkName" : "dbl_postgresql_2",
    "SafeRuleId" : "3****",
    "SellSitd" : false,
    "InstanceSource" : "ECS_OWN",
    "StandardGroup" : {
      "GroupName" : "Flexible Management",
      "GroupMode" : "NONE_CONTROL"
    },
    "InstanceId" : "188****",
    "Host" : "172.17.XXX.XXX",
    "DdlOnline" : 0,
    "UseDsql" : "0",
    "EcsInstanceId" : "i-bp124ldpklqz59y3****",
    "State" : "NORMAL",
    "DatabaseUser" : "postgres",
    "OwnerNameList" : {
      "OwnerNames" : [ "yang_test" ]
    },
    "DbaNickName" : "dbaname",
    "OwnerIdList" : {
      "OwnerIds" : [ "10****" ]
    }
  },
  "Success" : true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.