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

A lista de instâncias de conjunto de réplicas e autônomas é exibida quando o parâmetro DBInstanceType utiliza o valor padrão replicate. Para consultar a lista de instâncias de cluster fragmentado, defina o parâmetro DBInstanceType como sharding.

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	Operação a ser executada. Defina o valor como DescribeDBInstances.
RegionId	String	Não	cn-hangzhou	ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
PageNumber	Integer	Não	1	Número da página a ser retornada. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.
PageSize	Integer	Não	30	Número de entradas a serem retornadas em cada página. Valor padrão: 30. Valores válidos: 30 50 100
DBInstanceId	String	Não	dds-bp199659b178****	ID da instância.
ReplicationFactor	String	Não	3	Número de nós na instância de conjunto de réplicas. Valores válidos: 3 5 7
DBInstanceDescription	String	Não	testdatabase	Nome da instância. Regras de nomenclatura: Deve começar com uma letra. Pode conter dígitos, letras, sublinhados (_) e hifens (-). Deve ter entre 2 e 256 caracteres.
ExpireTime	String	Não	2019-12-26T16:00Z	Horário de expiração da instância.
DBInstanceStatus	String	Não	Running	Estado da instância. Para obter mais informações sobre os valores válidos, consulte Estados da instância.
DBInstanceType	String	Não	sharding	Arquitetura da instância. Valor padrão: replicate. Valores válidos: sharding: instância de cluster fragmentado replicate: instância de conjunto de réplicas ou autônoma
DBInstanceClass	String	Não	dds.mongo.mid	Tipo da instância. Para obter mais informações sobre os valores válidos, consulte Tipos de instância.
Engine	String	Não	MongoDB	Motor de banco de dados da instância. Defina o valor como MongoDB.
EngineVersion	String	Não	4.0	Versão do motor de banco de dados da instância. Valores válidos: 5.0 4.4 4.2 4.0 3.4
NetworkType	String	Não	VPC	Tipo de rede da instância. Valores válidos: Classic: rede clássica VPC: Virtual Private Cloud (VPC)
VpcId	String	Não	vpc-bp1n3i15v90el48nx****	ID da VPC.
VSwitchId	String	Não	vsw-bp1vj604nj5a9zz74****	ID do vSwitch.
ChargeType	String	Não	PrePaid	Método de faturamento da instância. Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
ZoneId	String	Não	cn-hangzhou-b	ID da zona da instância. Chame a operação DescribeRegions para consultar a lista de zonas mais recente.
Expired	String	Não	true	Indica se a instância expirou. Valores válidos: true: a instância expirou. false: a instância não expirou.
ConnectionDomain	String	Não	dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com	Endpoint do nó. Utilize a operação DescribeDBInstanceAttribute para consultar o endpoint do nó.
ResourceGroupId	String	Não	rg-acfmyiu4ekp****	ID do grupo de recursos.
Tag.N.Key	String	Não	testdatabase	Chave da tag N da instância. Valores válidos para N: de 1 a 20. A chave não pode começar com `aliyun`, `acs:`, `http://` ou `https://`. A chave pode ter até 64 caracteres. A chave não pode ser uma string vazia.
Tag.N.Value	String	Não	apitest	Valor da tag N da instância. Valores válidos para N: de 1 a 20. O valor não pode começar com `aliyun`, `acs:`, `http://` ou `https://`. O valor pode ter até 128 caracteres. O valor pode ser uma string vazia.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Integer	5	Número total de instâncias nos resultados da consulta.
RequestId	String	0E4FE33F-5510-5758-8FA7-A6672CDE****	ID da solicitação.
PageSize	Integer	30	Número de entradas retornadas por página.
PageNumber	Integer	1	Número da página retornada.
DBInstances	Array of DBInstance		Detalhes das instâncias.
DBInstance
CreationTime	String	2021-03-25T02:18:00Z	Horário de criação da instância. Segue o formato aaaa-MM-ddTHH:mm:ssZ e é exibido em UTC.
ChargeType	String	PrePaid	Método de faturamento da instância. Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
Tags	Array of Tag		Detalhes das tags de recurso.
Tag
Key	String	test	Chave da tag do recurso.
Value	String	api	Valor da tag do recurso.
VpcAuthMode	String	Close	Indica se o acesso sem senha dentro de uma VPC está ativado. Valores válidos: Open: acesso sem senha ativado. Close: acesso sem senha desativado.
NetworkType	String	Classic	Tipo de rede da instância. Valores válidos: Classic: rede clássica VPC: VPC
LockMode	String	Unlock	Estado de bloqueio da instância. Valores válidos: Unlock: o cluster não está bloqueado. ManualLock: a instância foi bloqueada manualmente. LockByExpiration: bloqueio automático devido à expiração da instância. LockByRestoration: bloqueio automático antes de uma reversão (rollback). LockByDiskQuota: bloqueio automático por esgotamento da capacidade de armazenamento. Released: a instância foi liberada. Após a liberação, não é possível desbloqueá-la; resta apenas restaurar os dados de backup em uma nova instância, processo que demanda tempo considerável.
EngineVersion	String	4.2	Versão do motor de banco de dados da instância. Valores válidos: 5.0 4.4 4.2 4.0 3.4
MongosList	Array of MongosAttribute		Detalhes dos nós mongos. Nota Este parâmetro é retornado apenas para instâncias de cluster fragmentado.
MongosAttribute
NodeClass	String	dds.mongos.standard	Tipo do nó mongos.
NodeDescription	String	testmongosnode	Descrição do nó mongos.
NodeId	String	s-bp10e3b0d02f****	ID do nó mongos.
DBInstanceDescription	String	testdatabase	Descrição da instância.
ExpireTime	String	2021-11-25T16:00Z	Horário de expiração da instância. Segue o formato aaaa-MM-ddTHH:mmZ e é exibido em UTC.
DBInstanceType	String	sharding	Arquitetura da instância. sharding: instância de cluster fragmentado replicate: instância de conjunto de réplicas ou autônoma
LastDowngradeTime	String	2021-05-08	Data da última operação de downgrade.
ShardList	Array of ShardAttribute		Detalhes dos nós shard. Nota Este parâmetro é retornado apenas para instâncias de cluster fragmentado.
ShardAttribute
NodeClass	String	dds.shard.mid	Tipo do nó shard.
NodeDescription	String	testshardnode	Descrição do nó shard.
NodeStorage	Integer	10	Capacidade de armazenamento do nó shard. Unidade: GB.
NodeId	String	d-bp1cac6f2083****	ID do nó shard.
ReadonlyReplicas	Integer	2	Número de nós somente leitura no nó shard. Valores válidos: de 0 a 5.
DestroyTime	String	2021-12-10T16:00:00Z	Horário em que os dados da instância foram destruídos. Segue o formato aaaa-MM-ddTHH:mm:ssZ e é exibido em UTC. Nota Instâncias por assinatura são liberadas 15 dias após a expiração. Após a liberação, os dados são excluídos permanentemente e não podem ser restaurados. Instâncias de pagamento conforme o uso são bloqueadas após 24 horas de atraso no pagamento e liberadas após 15 dias. Os dados de instâncias liberadas são excluídos permanentemente e não podem ser restaurados.
DBInstanceStatus	String	Running	Estado da instância. Para obter mais informações, consulte Estados da instância.
RegionId	String	cn-hangzhou	ID da região da instância.
DBInstanceStorage	Integer	20	Capacidade de armazenamento da instância.
ResourceGroupId	String	rg-acfmyiu4ekp****	ID do grupo de recursos.
ZoneId	String	cn-hangzhou-g	ID da zona da instância.
DBInstanceId	String	dds-bp18b0934e70****	ID da instância.
DBInstanceClass	String	dds.mongo.mid	Tipo da instância.
Engine	String	MongoDB	Motor de banco de dados da instância.
ReplicationFactor	String	3	Número de nós na instância. Nota Este parâmetro é retornado apenas para instâncias de conjunto de réplicas.
KindCode	String	1	Código de tipo da instância. Valores válidos: 0: máquina física 1: instância do Elastic Compute Service (ECS) 2: cluster Docker 18: cluster Kubernetes
CapacityUnit	String	100	Throughput de E/S consumido pela instância. Nota Este parâmetro é retornado quando a instância é do tipo Serverless.
StorageType	String	local_ssd	Tipo de armazenamento da instância. Valores válidos: cloud_essd: SSD aprimorado (ESSD) local_ssd: SSD local
SecondaryZoneId	String	cn-hangzhou-i	ID da zona secundária 1 da instância. Valores válidos: cn-hangzhou-g: Hangzhou Zona G cn-hangzhou-h: Hangzhou Zona H cn-hangzhou-i: Hangzhou Zona I cn-hongkong-b: Hong Kong Zona B cn-hongkong-c: Hong Kong Zona C cn-hongkong-d: Hong Kong Zona D cn-wulanchabu-a: Ulanqab Zona A cn-wulanchabu-b: Ulanqab Zona B cn-wulanchabu-c: Ulanqab Zona C ap-southeast-1a: Singapura Zona A ap-southeast-1b: Singapura Zona B ap-southeast-1c: Singapura Zona C ap-southeast-5a: Jacarta Zona A ap-southeast-5b: Jacarta Zona B ap-southeast-5c: Jacarta Zona C eu-central-1a: Frankfurt Zona A eu-central-1b: Frankfurt Zona B eu-central-1c: Frankfurt Zona C Nota Este parâmetro é retornado para instâncias de conjunto de réplicas ou cluster fragmentado que executam MongoDB 4.4 ou 5.0 com implantação multizona. Disponível apenas no site da China (aliyun.com).
HiddenZoneId	String	cn-hangzhou-h	ID da zona secundária 2 da instância. Valores válidos: cn-hangzhou-g: Hangzhou Zona G cn-hangzhou-h: Hangzhou Zona H cn-hangzhou-i: Hangzhou Zona I cn-hongkong-b: Hong Kong Zona B cn-hongkong-c: Hong Kong Zona C cn-hongkong-d: Hong Kong Zona D cn-wulanchabu-a: Ulanqab Zona A cn-wulanchabu-b: Ulanqab Zona B cn-wulanchabu-c: Ulanqab Zona C ap-southeast-1a: Singapura Zona A ap-southeast-1b: Singapura Zona B ap-southeast-1c: Singapura Zona C ap-southeast-5a: Jacarta Zona A ap-southeast-5b: Jacarta Zona B ap-southeast-5c: Jacarta Zona C eu-central-1a: Frankfurt Zona A eu-central-1b: Frankfurt Zona B eu-central-1c: Frankfurt Zona C Nota Este parâmetro é retornado para instâncias de conjunto de réplicas ou cluster fragmentado que executam MongoDB 4.4 ou 5.0 com implantação multizona. Disponível apenas no site da China (aliyun.com).

Exemplos

Exemplos de solicitações

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstances
&DBInstanceType=sharding
&NetworkType=classic
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeDBInstancesResponse>
    <TotalCount>5</TotalCount>
    <RequestId>0E4FE33F-5510-5758-8FA7-A6672CDE****</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <DBInstances>
        <CreationTime>2021-03-25T02:18:00Z</CreationTime>
        <ChargeType>PrePaid</ChargeType>
        <Tags>
            <Key>test</Key>
            <Value>api</Value>
        </Tags>
        <VpcAuthMode>Close</VpcAuthMode>
        <NetworkType>Classic</NetworkType>
        <LockMode>Unlock</LockMode>
        <EngineVersion>4.2</EngineVersion>
        <MongosList>
            <NodeClass>dds.mongos.standard</NodeClass>
            <NodeDescription>testmongosnode</NodeDescription>
            <NodeId>s-bp10e3b0d02f****</NodeId>
        </MongosList>
        <DBInstanceDescription>testdatabase</DBInstanceDescription>
        <ExpireTime>2021-11-25T16:00Z</ExpireTime>
        <DBInstanceType>sharding</DBInstanceType>
        <LastDowngradeTime>2021-05-08</LastDowngradeTime>
        <ShardList>
            <NodeClass>dds.shard.mid</NodeClass>
            <NodeDescription>testshardnode</NodeDescription>
            <NodeStorage>10</NodeStorage>
            <NodeId>d-bp1cac6f2083****</NodeId>
            <ReadonlyReplicas>2</ReadonlyReplicas>
        </ShardList>
        <DestroyTime>2021-12-10T16:00:00Z</DestroyTime>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <RegionId>cn-hangzhou</RegionId>
        <DBInstanceStorage>20</DBInstanceStorage>
        <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <DBInstanceId>dds-bp18b0934e70****</DBInstanceId>
        <DBInstanceClass>dds.mongo.mid</DBInstanceClass>
        <Engine>MongoDB</Engine>
        <ReplicationFactor>3</ReplicationFactor>
        <KindCode>1</KindCode>
        <CapacityUnit>100</CapacityUnit>
        <StorageType>local_ssd</StorageType>
    </DBInstances>
</DescribeDBInstancesResponse>

Formato JSON

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

{
  "TotalCount" : 5,
  "RequestId" : "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize" : 30,
  "PageNumber" : 1,
  "DBInstances" : {
    "CreationTime" : "2021-03-25T02:18:00Z",
    "ChargeType" : "PrePaid",
    "Tags" : {
      "Key" : "test",
      "Value" : "api"
    },
    "VpcAuthMode" : "Close",
    "NetworkType" : "Classic",
    "LockMode" : "Unlock",
    "EngineVersion" : 4.2,
    "MongosList" : {
      "NodeClass" : "dds.mongos.standard",
      "NodeDescription": "testmongosnode"
      "NodeId" : "s-bp10e3b0d02f****"
    },
    "DBInstanceDescription": "testdatabase",
    "ExpireTime" : "2021-11-25T16:00Z",
    "DBInstanceType" : "sharding",
    "LastDowngradeTime" : "2021-05-08",
    "ShardList" : {
      "NodeClass" : "dds.shard.mid",
      "NodeDescription": "testshardnode"
      "NodeStorage" : 10,
      "NodeId" : "d-bp1cac6f2083****",
      "ReadonlyReplicas" : 2
    },
    "DestroyTime" : "2021-12-10T16:00:00Z",
    "DBInstanceStatus" : "Running",
    "RegionId" : "cn-hangzhou",
    "DBInstanceStorage" : 20,
    "ResourceGroupId" : "rg-acfmyiu4ekp****",
    "ZoneId" : "cn-hangzhou-g",
    "DBInstanceId" : "dds-bp18b0934e70****",
    "DBInstanceClass" : "dds.mongo.mid",
    "Engine" : "MongoDB",
    "ReplicationFactor" : 3,
    "KindCode" : 1,
    "CapacityUnit" : 100,
    "StorageType" : "local_ssd"
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.