Consulta de instâncias - : Central de Documentação do Alibaba Cloud

Chame a operação DescribeDBInstances para consultar uma ou mais instâncias do ApsaraDB RDS que atendam às condições especificadas.

Use um dos métodos a seguir para verificar a resposta:

Método 1: Use o parâmetro

MaxResults

para definir o número de entradas por página. Em seguida, use o parâmetro

NextToken

para indicar o token usado na exibição da próxima página. Defina o valor do parâmetro

NextToken

como o valor retornado na chamada mais recente da operação

DescribeDBInstances

para o parâmetro

NextToken

.

Nota
Na primeira chamada à operação DescribeDBInstances para realizar uma consulta paginada, especifique apenas o parâmetro

MaxResults

. Nesse caso, a operação retorna os dados da primeira página e o valor do parâmetro

NextToken

.
Método 2: Use o parâmetro PageSize para definir o número de entradas por página. Depois, use o parâmetro PageNumber para exibir a próxima página.

Nota

Use apenas um dos métodos acima. Se houver um grande volume de entradas retornadas, recomenda-se o Método 1 para aumentar a velocidade da consulta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBInstances	A operação a ser executada. Defina o valor como DescribeDBInstances.
ClientToken	String	Não	ETnLKlblzczshOTUbOCzxxxxxxx	Token do cliente usado para garantir a idempotência da solicitação. Você pode gerar esse valor com o cliente, mas ele deve ser exclusivo entre diferentes solicitações. O token aceita apenas caracteres ASCII e não pode exceder 64 caracteres.
proxyId	String	Não	API	ID do modo de proxy usado nas instâncias.
Engine	String	Não	MySQL	Motor de banco de dados executado pelas instâncias. Valores válidos: MySQL SQLServer PostgreSQL MariaDB Por padrão, esta operação retorna instâncias que executam qualquer um dos motores de banco de dados compatíveis.
ZoneId	String	Não	cn-hangzhou-a	ID da zona à qual as instâncias pertencem.
ResourceGroupId	String	Não	rg-acfmyxxxxx	ID do grupo de recursos ao qual as instâncias pertencem.
DBInstanceStatus	String	Não	Running	Status das instâncias. Para mais informações, consulte Tabela de estados de instância.
Expired	String	Não	True	Indica se as instâncias expiraram. Valores válidos: True: consulta instâncias expiradas. False: consulta instâncias não expiradas.
SearchKey	String	Não	rm-uf6w	Palavras-chave contidas nos IDs ou descrições das instâncias.
DBInstanceId	String	Não	rm-uf6wjk5xxxxxxx	ID da instância. Chame a operação DescribeDBInstances para consultar os IDs das instâncias.
DBInstanceType	String	Não	Primary	Função das instâncias. Valores válidos: Primary: instância primária Readonly: instância somente leitura Guard: instância de recuperação de desastres Temp: instância temporária Por padrão, esta operação retorna instâncias com qualquer uma das funções compatíveis.
RegionId	String	Sim	cn-hangzhou	ID da região onde as instâncias estão localizadas. Chame a operação DescribeRegions para obter a lista de regiões mais recente.
PageSize	Integer	Não	30	Número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 30.
PageNumber	Integer	Não	1	Número da página a ser retornada. Valores válidos: qualquer inteiro positivo diferente de zero. Valor padrão: 1.
InstanceNetworkType	String	Não	Classic	Tipo de rede das instâncias. Valores válidos: VPC Classic Por padrão, esta operação retorna instâncias localizadas em qualquer um dos tipos de rede compatíveis.
VpcId	String	Não	vpc-uf6f7l4fg90xxxxxxxxxx	ID da Virtual Private Cloud (VPC) à qual as instâncias pertencem.
VSwitchId	String	Não	vsw-uf6adz52c2pxxxxxxxxxx	ID do vSwitch.
DBInstanceClass	String	Não	rds.mys2.small	Especificação das instâncias. Para mais informações, consulte Tipos de instância primária do ApsaraDB RDS.
EngineVersion	String	Não	5.7	Versão do motor de banco de dados executado pelas instâncias.
PayType	String	Não	Postpaid	Método de faturamento das instâncias. Valores válidos: Postpaid: pagamento conforme o uso Prepaid: assinatura
ConnectionMode	String	Não	Standard	Modo de conexão das instâncias. Valores válidos: Standard: modo padrão Safe: modo de proxy de banco de dados Por padrão, esta operação retorna instâncias que operam em qualquer um dos modos de conexão compatíveis.
Tags	String	Não	{"key1":"value1"}	Tags adicionadas à instância. Cada tag é um par chave-valor composto por duas partes: TagKey e TagValue. Especifique até cinco tags por solicitação no seguinte formato: {"key1":"value1","key2":"value2"...}.
DedicatedHostGroupId	String	Não	dhg-7a9xxxxxxxx	ID do cluster dedicado ao qual as instâncias pertencem.
DedicatedHostId	String	Não	i-bpxxxxxxx	ID do host onde as instâncias residem no cluster dedicado especificado.
InstanceLevel	Integer	Não	0	Define se as edições do RDS das instâncias devem ser retornadas usando o parâmetro Category. Valores válidos: 0: Retorna as edições do RDS das instâncias. 1: Não retorna as edições do RDS das instâncias.
ConnectionString	String	Não	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	Endpoint da instância. Especifique este parâmetro apenas quando desejar consultar uma única instância.
NextToken	String	Não	o7PORW5o2TJg**********	Token usado para exibir a próxima página. Defina este parâmetro com o valor retornado na chamada mais recente da operação DescribeDBInstances para o parâmetro NextToken. Se as entradas retornadas estiverem distribuídas em várias páginas, a próxima página será exibida ao chamar esta operação novamente com esse parâmetro especificado.
MaxResults	Integer	Não	30	Número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 30. Nota Se você especificar este parâmetro, os parâmetros PageSize e PageNumber ficarão indisponíveis.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	ID da solicitação.
PageNumber	Integer	1	Número da página retornada. Nota Se você especificar o parâmetro MaxResults ou o parâmetro NextToken, apenas o valor 1 será retornado. Ignore o valor 1.
PageRecordCount	Integer	10	Número de entradas retornadas na página atual.
TotalRecordCount	Integer	100	Número total de entradas retornadas. Nota Se você especificar o parâmetro MaxResults ou o parâmetro NextToken, apenas o número de entradas da página atual será retornado. Ignore esse número.
Items	Array of DBInstance		Detalhes das instâncias.
DBInstance
VpcId	String	vpc-uf6f7l4fg90xxxxxxx	ID da VPC à qual a instância pertence.
DedicatedHostIdForLog	String	dh-bpxxxx	ID do host onde a instância de logger reside.
CreateTime	String	2018-11-05T11:26:02Z	Horário de criação da instância. O horário segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.
PayType	String	Postpaid	Método de faturamento da instância. Valores válidos: Postpaid: pagamento conforme o uso Prepaid: assinatura
DedicatedHostNameForLog	String	testlog	Nome do host onde a instância de logger reside.
MutriORsignle	Boolean	true	Indica se o método de implantação multizona é usado na instância. Valores válidos: true e false. Nota Se o método de implantação multizona for utilizado, o ID da zona da instância conterá MAZ. Exemplo: `cn-hangzhou-MAZ10(h,i)`.
DedicatedHostGroupName	String	testhostgroup	Nome do cluster dedicado ao qual a instância pertence.
EngineVersion	String	5.7	Versão do motor de banco de dados executado pela instância.
DedicatedHostGroupId	String	dhg-7a9xxxxxxxx	ID do cluster dedicado ao qual a instância pertence.
VpcName	String	test-huadong	Nome da VPC à qual a instância pertence.
DedicatedHostZoneIdForMaster	String	cn-hangzhou-c	ID da zona à qual a instância primária pertence.
ConnectionString	String	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	Endpoint da instância.
InstanceNetworkType	String	Classic	Tipo de rede da instância. Valores válidos: Classic VPC
MasterInstanceId	String	rm-uf6wjk5xxxxxxxxxx	ID da instância primária. Se o valor deste parâmetro for nulo, a instância é primária.
ExpireTime	String	2019-02-27T16:00:00Z	Horário de expiração da instância. O horário segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. O horário é exibido em UTC. Nota Instâncias com pagamento conforme o uso nunca expiram.
DestroyTime	String	2018-11-05T11:26:02Z	Horário de destruição da instância. O horário segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.
GuardDBInstanceId	String	rm-uf64zsuxxxxxxxxxx	ID da instância de recuperação de desastres. Este parâmetro é retornado apenas quando a instância é primária e possui uma instância de recuperação de desastres associada.
DedicatedHostNameForMaster	String	testmaster	Nome do host onde a instância primária reside.
ZoneId	String	cn-hangzhou-a	ID da zona à qual a instância pertence.
DBInstanceId	String	rm-uf6wjk5xxxxxxxxxx	ID da instância.
DedicatedHostIdForMaster	String	dh-bpxxxx	ID do host onde a instância primária reside.
TempDBInstanceId	String	rm-uf64zsuxxxxxxxxxx	ID da instância temporária. Este parâmetro é retornado apenas quando a instância é primária e possui uma instância temporária associada.
DBInstanceStorageType	String	ModuleList.4.ModuleCode	Tipo de armazenamento da instância.
ConnectionMode	String	Standard	Modo de conexão da instância. Valores válidos: Standard: modo padrão Safe: modo de proxy de banco de dados
LockMode	String	Unlock	Indica se a instância está bloqueada. Valores válidos: Unlock: A instância não está bloqueada. ManualLock: A instância foi bloqueada manualmente. LockByExpiration: A instância foi bloqueada automaticamente após a expiração. LockByRestoration: A instância foi bloqueada automaticamente antes da reversão (rollback). LockByDiskQuota: A instância foi bloqueada automaticamente após o esgotamento da capacidade de armazenamento. Released: A instância foi liberada. Após a liberação, a instância não pode ser desbloqueada. Restaure apenas os dados de backup da instância para uma nova instância. Esse processo exige um longo período de tempo.
VpcCloudInstanceId	String	rm-uf6wjk5xxxxxxx	ID da instância. Este parâmetro é retornado apenas quando a instância reside em uma VPC.
DedicatedHostZoneIdForSlave	String	cn-hangzhou-d	ID da zona à qual a instância secundária pertence.
DedicatedHostZoneIdForLog	String	cn-hangzhou-b	ID da zona do host onde a instância de logger reside.
DedicatedHostNameForSlave	String	testslave	Nome do host onde a instância secundária reside.
DBInstanceDescription	String	testdatabase	Descrição da instância.
DBInstanceNetType	String	Internet	Tipo de conexão de rede da instância. Valores válidos: Internet: Internet Intranet: rede interna
DBInstanceType	String	Primary	Função da instância. Valores válidos: Primary: instância primária Readonly: instância somente leitura Guard: instância de recuperação de desastres Temp: instância temporária
LockReason	String	instance_expired	Motivo do bloqueio da instância.
DBInstanceStatus	String	Running	Status da instância. Para mais informações, consulte Tabela de estados de instância.
RegionId	String	cn-hangzhou	ID da região da instância.
VSwitchId	String	vsw-uf6adz52c2pxxxxxxx	ID do vSwitch.
DedicatedHostIdForSlave	String	dh-bpxxxx	ID do host onde a instância secundária reside.
ResourceGroupId	String	rg-acfmyxxxxxxx	ID do grupo de recursos ao qual a instância pertence.
Category	String	Basic	Edição do RDS da instância. Valores válidos: Basic: Basic Edition HighAvailability: High-availability Edition Finance: Enterprise Edition Nota Este parâmetro é retornado apenas quando o parâmetro InstanceLevel está definido como 1.
Engine	String	MySQL	Motor de banco de dados executado pela instância.
DBInstanceClass	String	rds.mys2.small	Especificação da instância. Para mais informações, consulte Tipos de instância primária do ApsaraDB RDS.
ReadOnlyDBInstanceIds	Array of ReadOnlyDBInstanceId		Array composto pelos IDs das instâncias somente leitura anexadas à instância. Este parâmetro é retornado apenas quando a instância é primária e possui instâncias somente leitura associadas.
ReadOnlyDBInstanceId
DBInstanceId	String	rr-uf6wjk5xxxxxxx	ID da instância somente leitura.
DeletionProtection	Boolean	false	Indica se o recurso de proteção contra liberação está ativado para a instância somente leitura. Valores válidos: true: O recurso de proteção contra liberação está ativado. false: O recurso de proteção contra liberação está desativado.
NextToken	String	o7PORW5o2TJg**********	Token usado para exibir a próxima página. Se as entradas retornadas estiverem distribuídas em várias páginas, a próxima página será exibida ao chamar esta operação novamente com o parâmetro NextToken especificado.

Exemplos

Exemplos de solicitações

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeDBInstancesResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>A436D75C-30B0-1F34-8544-4B46F4407CC1</RequestId>
    <NextToken>o7PORW5owHNg**********</NextToken>
    <PageNumber>1</PageNumber>
    <Items>
        <DBInstance>
            <EngineVersion>10.0</EngineVersion>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ResourceGroupId>rg-acfmyiu********</ResourceGroupId>
            <DBInstanceNetType>Intranet</DBInstanceNetType>
            <DBInstanceClass>pg.n2.small.2c</DBInstanceClass>
            <CreateTime>2021-02-02T09:14:48Z</CreateTime>
            <VSwitchId>vsw-bp10aqj6o4lcl********</VSwitchId>
            <TipsLevel>0</TipsLevel>
            <DBInstanceType>Primary</DBInstanceType>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <DeletionProtection>false</DeletionProtection>
            <MutriORsignle>false</MutriORsignle>
            <InstanceNetworkType>VPC</InstanceNetworkType>
            <InsId>1</InsId>
            <VpcId>vpc-bp1opxu1zkhn0********</VpcId>
            <DBInstanceId>pgm-bp10re7n********</DBInstanceId>
            <ConnectionMode>Standard</ConnectionMode>
            <ReadOnlyDBInstanceIds>
            </ReadOnlyDBInstanceIds>
            <VpcCloudInstanceId>pgm-bp10re7n********</VpcCloudInstanceId>
            <RegionId>cn-hangzhou</RegionId>
            <ConnectionString>pgm-bp10re7n**************.pg.rds.aliyuncs.com</ConnectionString>
            <ExpireTime>2021-02-03T09:14:48Z</ExpireTime>
            <Engine>PostgreSQL</Engine>
        </DBInstance>
    </Items>
</DescribeDBInstancesResponse>

Formato JSON

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

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 1,
  "RequestId" : "A436D75C-30B0-1F34-8544-4B46F4407CC1",
  "NextToken" : "o7PORW5owHNg**********",
  "PageNumber" : 1,
  "Items" : {
    "DBInstance" : [ {
      "EngineVersion" : "10.0",
      "ZoneId" : "cn-hangzhou-h",
      "DBInstanceStatus" : "Running",
      "ResourceGroupId" : "rg-acfmyiu********",
      "DBInstanceNetType" : "Intranet",
      "DBInstanceClass" : "pg.n2.small.2c",
      "CreateTime" : "2021-02-02T09:14:48Z",
      "VSwitchId" : "vsw-bp10aqj6o4lcl********",
      "TipsLevel" : 0,
      "DBInstanceType" : "Primary",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "DeletionProtection" : false,
      "MutriORsignle" : false,
      "InstanceNetworkType" : "VPC",
      "InsId" : 1,
      "VpcId" : "vpc-bp1opxu1zkhn0********",
      "DBInstanceId" : "pgm-bp10re7n********",
      "ConnectionMode" : "Standard",
      "ReadOnlyDBInstanceIds" : {
        "ReadOnlyDBInstanceId" : [ ]
      },
      "VpcCloudInstanceId" : "pgm-bp10re7n********",
      "RegionId" : "cn-hangzhou",
      "ConnectionString" : "pgm-bp10re7n**************.pg.rds.aliyuncs.com",
      "ExpireTime" : "2021-02-03T09:14:48Z",
      "Engine" : "PostgreSQL"
    } ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.NextToken	The parameter NextToken is invalid.	Mensagem de erro retornada porque o valor do parâmetro NextToken é inválido.
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter"DBInstanceType" is not valid.	Mensagem de erro retornada porque o tipo de instância especificado é inválido. Especifique um tipo de instância válido.

Para obter uma lista de códigos de erro, visite o Error Center.