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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListInstances	Operação a ser executada. Defina o valor como ListInstances.
Tid	Long	Não	3***	ID do locatário. Para obtê-lo, chame a operação GetUserActiveTenant.
SearchKey	String	Não	test	Palavra-chave para pesquisar instâncias de banco de dados.
DbType	String	Não	MySQL	Tipo do banco de dados. Para mais informações sobre os valores válidos, consulte Parâmetro DbType.
EnvType	String	Não	product	Tipo de ambiente da instância de banco de dados. Valores válidos: product: produção dev: desenvolvimento pre: pré-lançamento test: teste sit: teste de integração de sistema (SIT) uat: teste de aceitação do usuário (UAT) pet: teste de estresse stag: staging
InstanceSource	String	Não	RDS	Origem da instância de banco de dados. Valores válidos: PUBLIC_OWN: instância autogerenciada implantada na Internet RDS: instância do ApsaraDB RDS ECS_OWN: banco de dados autogerenciado em uma instância do Elastic Compute Service (ECS) VPC_IDC: instância autogerenciada em um data center conectado via Virtual Private Cloud (VPC)
NetType	String	Não	VPC	Tipo de rede da instância de banco de dados. Valores válidos: CLASSIC: rede clássica VPC: VPC
InstanceState	String	Não	NORMAL	Status da instância de banco de dados. Valores válidos: NORMAL: normal DISABLE: desativada
PageNumber	Integer	Não	1	Número da página a retornar.
PageSize	Integer	Não	50	Quantidade de entradas por página. O valor máximo é 100.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Long	1	Total de instâncias de banco de dados retornadas.
RequestId	String	B4B07137-F6AE-4756-8474-7F92BB6C4E04	ID da solicitação.
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.
InstanceList	Array of Instance		Informações das instâncias de banco de dados retornadas.
Instance
VpcId	String	vpc-o6wrloqsdqc9io3mg****	ID da VPC à qual a instância pertence.
DatabaseUser	String	dbUser	Conta usada para fazer login no banco de dados.
DbaId	String	31****	ID do administrador de banco de dados (DBA) da instância.
UseDsql	Integer	1	Indica se o recurso de consulta entre bancos de dados está ativado na instância. Valores válidos: 0: desativado 1: ativado
Port	Integer	3306	Porta usada para conectar-se à instância de banco de dados.
EcsInstanceId	String	150****	ID da instância ECS onde o banco de dados está implantado.
EnvType	String	product	Tipo de ambiente da instância de banco de dados. Valores válidos: product: produção dev: desenvolvimento pre: pré-lançamento test: teste sit: SIT uat: UAT pet: teste de estresse stag: staging
Sid	String	test	ID do sistema (SID) da instância de banco de dados.
OwnerIdList	Array of String	123453	IDs dos proprietários da instância de banco de dados.
SafeRuleId	String	1	ID do conjunto de regras de segurança da instância.
OwnerNameList	Array of String	yuyang_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	60	Tempo limite para consultar dados na instância.
InstanceSource	String	RDS	Origem da instância de banco de dados.
Host	String	****.mysql.rds.aliyuncs.com	Endereço do host usado para conectar-se à instância.
State	String	NORMAL	Status da instância de banco de dados.
DataLinkName	String	dblink_test	Nome do link de banco de dados da instância.
ExportTimeout	Integer	86400	Tempo limite para exportar dados da instância.
InstanceId	String	150***	ID da instância de banco de dados.
InstanceType	String	mysql	Tipo da instância de banco de dados.
DatabasePassword	String	******	Senha usada para fazer login no banco de dados.
InstanceAlias	String	test	Alias da instância de banco de dados.
DdlOnline	Integer	1	Indica se o recurso de alteração de esquema sem bloqueio está ativado na instância.
EcsRegion	String	cn-hangzhou	ID da região onde a instância reside.
StandardGroup	Object		Modo de controle da instância de banco de dados.
GroupName	String	test	Nome do conjunto de regras de segurança correspondente ao modo de controle.
GroupMode	String	COMMON	Tipo do modo de controle. Valores válidos: COMMON: Colaboração de Segurança NONE_CONTROL: Gerenciamento Flexível STABLE: Alteração Estável
SellSitd	Boolean	true	Indica se o recurso de proteção de dados sensíveis está ativado na instância. Valores válidos: true: ativado false: desativado
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=ListInstances
&Tid=3***
&SearchKey=test
&DbType=MySQL
&EnvType=product
&InstanceSource=RDS
&NetType=VPC
&InstanceState=NORMAL
&PageNumber=1
&PageSize=50
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

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

<ListInstancesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>B4B07137-F6AE-4756-8474-7F92BB6C4E04</RequestId>
    <InstanceList>
        <VpcId>vpc-o6wrloqsdqc9io3mg****</VpcId>
        <DatabaseUser>dbUser</DatabaseUser>
        <DbaId>31****</DbaId>
        <UseDsql>1</UseDsql>
        <Port>3306</Port>
        <EcsInstanceId>150****</EcsInstanceId>
        <EnvType>product</EnvType>
        <Sid>test</Sid>
        <OwnerIdList>123453</OwnerIdList>
        <SafeRuleId>1</SafeRuleId>
        <OwnerNameList>yuyang_test</OwnerNameList>
        <DbaNickName>dbaName</DbaNickName>
        <QueryTimeout>60</QueryTimeout>
        <InstanceSource>RDS</InstanceSource>
        <Host>****.mysql.rds.aliyuncs.com</Host>
        <State>NORMAL</State>
        <DataLinkName>dblink_test</DataLinkName>
        <ExportTimeout>86400</ExportTimeout>
        <InstanceId>150***</InstanceId>
        <InstanceType>mysql</InstanceType>
        <DatabasePassword>******</DatabasePassword>
        <InstanceAlias>test</InstanceAlias>
        <DdlOnline>1</DdlOnline>
        <EcsRegion>cn-hangzhou</EcsRegion>
        <StandardGroup>
            <GroupName>test</GroupName>
            <GroupMode>COMMON</GroupMode>
        </StandardGroup>
        <SellSitd>true</SellSitd>
    </InstanceList>
    <Success>true</Success>
</ListInstancesResponse>

Formato JSON

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

{
  "TotalCount" : 1,
  "RequestId" : "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
  "InstanceList" : [ {
    "VpcId" : "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser" : "dbUser",
    "DbaId" : "31****",
    "UseDsql" : 1,
    "Port" : 3306,
    "EcsInstanceId" : "150****",
    "EnvType" : "product",
    "Sid" : "test",
    "OwnerIdList" : [ "123453" ],
    "SafeRuleId" : "1",
    "OwnerNameList" : [ "yuyang_test" ],
    "DbaNickName" : "dbaName",
    "QueryTimeout" : 60,
    "InstanceSource" : "RDS",
    "Host" : "****.mysql.rds.aliyuncs.com",
    "State" : "NORMAL",
    "DataLinkName" : "dblink_test",
    "ExportTimeout" : 86400,
    "InstanceId" : "150***",
    "InstanceType" : "mysql",
    "DatabasePassword" : "******",
    "InstanceAlias" : "test",
    "DdlOnline" : 1,
    "EcsRegion" : "cn-hangzhou",
    "StandardGroup" : {
      "GroupName" : "test",
      "GroupMode" : "COMMON"
    },
    "SellSitd" : true
  } ],
  "Success" : true
}

Códigos de erro

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