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

Consulta uma lista de instâncias do MongoDB.

Descrição da operação

Por padrão, esta operação consulta a lista de instâncias de conjunto de réplicas (incluindo instâncias de nó único). Se o parâmetro de solicitação DBInstanceType não for especificado, o valor padrão deste parâmetro é replicate. Para consultar a lista de instâncias de cluster fragmentado, defina DBInstanceType como sharding.

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

dds:DescribeDBInstances

get

*Instância.

acs:dds:{#regionId}:{#accountId}:dbinstance/*

*Instância.

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro positivo que não exceda o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 (padrão) 50 100 Valores válidos: 30 : 30 entradas por página. 50 : 50 entradas por página. 100 : 100 entradas por página.	30
DBInstanceId	string	Não	O ID da instância.	dds-bp199659b178****
ReplicationFactor	string	Não	O número de nós na instância de conjunto de réplicas. Valores válidos: 3 5 7	3
DBInstanceDescription	string	Não	O nome da instância. O nome deve atender aos seguintes requisitos: Deve começar com um caractere chinês ou uma letra. Pode conter dígitos, caracteres chineses, letras, sublinhados (_) e hifens (-). Deve ter de 2 a 256 caracteres de comprimento.	TestDatabase
ExpireTime	string	Não	A hora de expiração da instância no formato yyyy-MM-ddTHH:mm:ssZ (UTC). Este parâmetro é usado para filtrar instâncias cuja hora de expiração seja anterior ou igual à hora especificada.	2019-12-26T16:00:00Z
DBInstanceStatus	string	Não	O status da instância. Para mais detalhes sobre os valores válidos, consulte a Tabela de status da instância.	Running
DBInstanceType	string	Não	O tipo de instância. Valores válidos: sharding: instância de cluster fragmentado. replicate: valor padrão. Instância de conjunto de réplicas ou instância de nó único.	sharding
DBInstanceClass	string	Não	A especificação da instância. Para mais informações sobre os valores válidos, consulte Especificações da instância.	dds.mongo.mid
Engine	string	Não	O mecanismo de banco de dados. Defina o valor como MongoDB. Valores válidos: MongoDB : Mecanismo de banco de dados MongoDB.	MongoDB
EngineVersion	string	Não	A versão do mecanismo de banco de dados. Valores válidos: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.0
NetworkType	string	Não	O tipo de rede da instância. Valores válidos: Classic: rede clássica. VPC: VPC.	VPC
VpcId	string	Não	O ID da VPC.	vpc-bp1n3i15v90el48nx****
VSwitchId	string	Não	O ID do vSwitch da VPC.	vsw-bp1vj604nj5a9zz74****
ChargeType	string	Não	O método de cobrança da instância. Valores válidos: PrePaid: assinatura. PostPaid: pós-pago.	PrePaid
ZoneId	string	Não	O ID da zona. Você pode chamar a operação DescribeRegions para consultar o ID da zona.	cn-hangzhou-b
Expired	string	Não	O status de expiração da instância. Valores válidos: true: expirada. false: não expirada.	true
ConnectionDomain	string	Não	O endpoint do nó. Você pode chamar a operação DescribeDBInstanceAttribute para consultar o endpoint.	dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmyiu4ekp****
Tag	array<object>	Não	As tags.
	object	Não
Key	string	Não	A chave da tag da instância. Valores válidos de N: 1 a 20. A chave da tag não pode começar com `aliyun`, `acs:`, `http://` ou `https://`. A chave da tag pode ter até 64 caracteres de comprimento. A chave da tag não pode ser uma string vazia.	testdatabase
Value	string	Não	O valor da tag da instância. Valores válidos de N: 1 a 20. O valor da tag não pode começar com `aliyun`, `acs:`, `http://` ou `https://`. O valor da tag pode ter até 128 caracteres de comprimento. O valor da tag pode ser uma string vazia.	apitest
DBNodeType	string	Não	Especifica se devem ser filtradas instâncias padrão ou de teste. Instâncias de nó único e instâncias DBFS: customized Instâncias padrão (conjunto de réplicas e cluster fragmentado): standard Padrão (exibe todas as instâncias): default	default

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número de instâncias no resultado da consulta.	5
RequestId	string	O ID da solicitação.	0E4FE33F-5510-5758-8FA7-A6672CDE****
PageSize	integer	O número de registros por página.	30
PageNumber	integer	O número da página.	1
DBInstances	object
DBInstance	array<object>	A lista de informações da instância.
	array<object>
CreationTime	string	A hora em que a instância foi criada. A hora está no formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-03-25T02:18:00Z
ChargeType	string	O método de cobrança da instância. Valores válidos: PrePaid: assinatura. PostPaid: pós-pago.	PrePaid
Tags	object
Tag	array<object>	A lista de tags de recurso.
	object	A lista de tags de recurso.
Key	string	A chave da tag do recurso.	teste
Value	string	O valor da tag do recurso.	api
VpcAuthMode	string	Indica se o acesso sem senha pela VPC está ativado. Valores válidos: Open: ativado. Close: desativado.	Close
NetworkType	string	O tipo de rede da instância. Valores válidos: Classic: rede clássica. VPC: VPC.	Classic
LockMode	string	O status de bloqueio da instância. Valores válidos: Unlock: A instância não está bloqueada. ManualLock: A instância está bloqueada manualmente. LockByExpiration: A instância é bloqueada automaticamente porque expirou. LockByRestoration: A instância é bloqueada automaticamente antes de uma reversão. LockByDiskQuota: A instância é bloqueada automaticamente porque o armazenamento está cheio. Released: A instância foi liberada. Neste caso, a instância não pode ser desbloqueada. Você só pode usar dados de backup para criar uma nova instância. O processo de reconstrução leva muito tempo.	Unlock
EngineVersion	string	A versão do mecanismo de banco de dados. Valores válidos: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
MongosList	object
MongosAttribute	array<object>	A lista de informações do nó mongos. Nota Este parâmetro é retornado quando o tipo de instância é uma instância de cluster fragmentado.
	object	A lista de informações do nó mongos. Nota Este parâmetro é retornado quando o tipo de instância é uma instância de cluster fragmentado.
NodeClass	string	As especificações do nó mongos.	dds.mongos.standard
NodeDescription	string	A descrição do nó mongos.	Nó mongos de teste
NodeId	string	O ID do nó mongos.	s-bp10e3b0d02f****
DBInstanceDescription	string	A descrição ou observações da instância.	TestDatabase
ExpireTime	string	A hora em que a instância expira. A hora está no formato yyyy-MM-ddTHH:mmZ (UTC).	2021-11-25T16:00Z
DBInstanceType	string	O tipo de instância. Valores válidos: sharding: instância de cluster fragmentado. replicate: instância de conjunto de réplicas ou instância autônoma.	sharding
LastDowngradeTime	string	A última vez em que a instância foi rebaixada. A hora está no formato YYYY-MM-DD.	2021-05-08
ShardList	object
ShardAttribute	array<object>	A lista de informações do nó de fragmento. Nota Este parâmetro é retornado quando o tipo de instância é uma instância de cluster fragmentado.
	object	A lista de informações do nó de fragmento. Nota Este parâmetro é retornado quando o tipo de instância é uma instância de cluster fragmentado.
NodeClass	string	A classe do nó de fragmento.	dds.shard.mid
NodeDescription	string	A descrição do nó de fragmento.	Nó de fragmento de teste
NodeStorage	integer	A capacidade de armazenamento do nó de fragmento. Unidade: GB.	10
NodeId	string	O ID do nó de fragmento.	d-bp1cac6f2083****
ReadonlyReplicas	integer	O número de nós somente leitura no nó de fragmento. Valores válidos: 0 a 5.	2
DestroyTime	string	A hora de destruição dos dados da instância. A hora está no formato yyyy-MM-ddTHH:mm:ssZ (UTC). Nota Para instâncias de assinatura, os recursos de computação são liberados no 16º dia após a expiração da instância, e os dados são retidos por mais 7 dias. No 23º dia após a expiração da instância, os dados são excluídos e não podem ser recuperados. Para instâncias pós-pagas, os recursos de computação são liberados no 16º dia após a instância ter um pagamento em atraso, e os dados são retidos por mais 7 dias. No 23º dia após o pagamento em atraso, os dados são excluídos e não podem ser recuperados.	2021-12-10T16:00:00Z
DBInstanceStatus	string	O status da instância. Para obter detalhes, consulte a Tabela de status da instância.	Running
RegionId	string	O ID da região da instância.	cn-hangzhou
DBInstanceStorage	integer	A capacidade de armazenamento da instância.	20
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmyiu4ekp****
ZoneId	string	O ID da zona da instância.	cn-hangzhou-g
DBInstanceId	string	O ID da instância.	dds-bp18b0934e70****
DBInstanceClass	string	O tipo de instância.	dds.mongo.mid
Engine	string	O mecanismo de banco de dados.	MongoDB
ReplicationFactor	string	O número de nós na instância. Nota Este parâmetro é retornado quando o tipo de instância é uma instância de conjunto de réplicas.	3
KindCode	string	O tipo da instância. Valores válidos: 0: máquina física. 1: ECS. 2: DOCKER. 18: instância de nova arquitetura baseada em Kubernetes.	1
CapacityUnit	string	A taxa de transferência de leitura/gravação consumida pela instância. Nota Este parâmetro é retornado quando o tipo de instância é uma instância serverless.	100
StorageType	string	O tipo de armazenamento. Valores válidos: cloud_essd: disco em nuvem ESSD. local_ssd: SSD padrão local.	local_ssd
BackupRetentionPolicy	integer	A política de retenção de dados de backup. Valores válidos: 0: Todos os conjuntos de backup são excluídos imediatamente quando a instância é liberada. 1: Um backup automático é realizado quando a instância é liberada, e o conjunto de backup é retido para retenção de longo prazo (LTR). 2: Um backup automático é realizado quando a instância é liberada, e todos os conjuntos de backup do cluster são retidos para retenção de longo prazo (LTR).	1
ReleaseTime	string	A hora em que a instância é liberada. A hora está no formato YYYY-MM-DDTHH:mmZ (UTC).	2024-06-17T07:01Z

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 5,
  "RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2021-03-25T02:18:00Z",
        "ChargeType": "PrePaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Close",
        "NetworkType": "Classic",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "MongosList": {
          "MongosAttribute": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "测试mongos节点",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "测试数据库",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "测试shard节点",
              "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",
        "BackupRetentionPolicy": 1,
        "ReleaseTime": "2024-06-17T07:01Z"
      }
    ]
  }
}

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.