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

Consulta a visão geral de uma ou mais instâncias do ApsaraDB for MongoDB.

Descrição da operação

Se você não especificar nenhuma instância, a operação retornará informações de visão geral de todas as instâncias na região de destino associada à sua conta Alibaba Cloud.
Os resultados desta operação não são paginados.

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:DescribeDBInstancesOverview

list

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Chame DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
InstanceIds	string	Não	O ID da instância cuja visão geral você deseja consultar. Nota Se você não especificar este parâmetro, uma visão geral de todas as instâncias na sua conta Alibaba Cloud será retornada. Você pode especificar vários IDs de instância. Separe os IDs com vírgulas (,).	dds-bp12c5b040dc****
InstanceStatus	string	Não	O status da instância. Para mais informações, consulte Estados da instância.	Running
ChargeType	string	Não	O método de cobrança da instância. Valores válidos: PrePaid: assinatura PostPaid: pay-as-you-go	PostPaid
NetworkType	string	Não	O tipo de rede da instância. Valores válidos: Classic: rede clássica VPC: virtual private cloud (VPC)	Classic
EngineVersion	string	Não	A versão do mecanismo de banco de dados da instância. Valores válidos: 5.0, 4.4, 4.2, 4.0 e 3.4.	4.0
InstanceClass	string	Não	O tipo de instância. Para mais informações sobre os tipos de instância disponíveis para diferentes arquiteturas de instância, consulte: Tipos de instância autônoma Tipos de instância de conjunto de réplicas Tipos de instância de cluster fragmentado	dds.mongo.2xlarge
VpcId	string	Não	O ID da VPC.	vpc-bp1nme44gek34slfc****
VSwitchId	string	Não	O ID do vSwitch.	vsw-bp1e7clcw529l773d****
InstanceType	string	Não	A arquitetura da instância. Valores válidos: sharding: instância de cluster fragmentado replicate: instância de conjunto de réplicas ou autônoma Nota Defina este parâmetro conforme necessário. Por exemplo, para consultar a visão geral de uma instância de cluster fragmentado, defina este parâmetro como sharding. Se você não especificar este parâmetro, uma visão geral de todas as instâncias será retornada.	replicate
ZoneId	string	Não	O ID da zona.	cn-hangzhou-b
ResourceGroupId	string	Não	O ID do grupo de recursos. Para mais informações sobre grupos de recursos, consulte Visualizar informações básicas sobre um grupo de recursos.	rg-acfmyiu4ekp****
ShowTags	boolean	Não	Especifica se as tags da instância devem ser retornadas. O valor padrão é false.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	string	O número de instâncias retornadas.	1
RequestId	string	O ID da solicitação.	52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
DBInstances	array<object>	Uma lista de detalhes das instâncias.
	array<object>	Uma lista de detalhes das instâncias.
CreationTime	string	A hora em que a instância foi criada. A hora está no formato aaaa-MM-ddTHH:mm:ssZ. A hora está em UTC.	2022-01-05T03:18:53Z
ExpireTime	string	A hora de expiração da instância de assinatura. A hora está no formato aaaa-MM-ddTHH:mmZ. A hora está em UTC.	2022-02-05T16:00Z
Tags	array<object>	As tags da instância.
	object	As tags da instância.
Key	string	The tag key. The key cannot start with `aliyun`, `acs:`, `http://`, or `https://`. The key can be up to 64 characters in length. The key cannot be an empty string.	testdatabase
Value	string	The tag value. The value cannot start with `aliyun`, `acs`:, `http://`, or `https://`. The value can be up to 128 characters in length. The value can be an empty string.	apitest
LastDowngradeTime	string	A hora em que a instância foi rebaixada pela última vez.	2021-05-08
ShardList	array<object>	Os detalhes dos nós de fragmento. Nota Este parâmetro é retornado apenas para instâncias de cluster fragmentado.
	object	Os detalhes dos nós de fragmento. Nota Este parâmetro é retornado apenas para instâncias de cluster fragmentado.
NodeClass	string	The instance type of the shard node.	dds.shard.mid
NodeDescription	string	The description of the shard node.	Test shard node
NodeStorage	integer	The storage capacity of the shard node, in GB.	10
NodeId	string	The ID of the shard node.	d-bp1cac6f2083****
ReadonlyReplicas	integer	The number of read-only nodes in the shard. Valid values: 0 to 5.	2
DBInstanceType	string	A arquitetura da instância. Valores válidos: sharding: instância de cluster fragmentado replicate: instância de conjunto de réplicas ou autônoma	replicate
DestroyTime	string	A hora em que os dados da instância foram destruídos. A hora está no formato aaaa-MM-ddTHH:mm:ssZ. A hora está em UTC.	2021-12-10T16:00:00Z
ChargeType	string	O método de cobrança da instância. Valores válidos: PrePaid: assinatura PostPaid: pay-as-you-go	PrePaid
CapacityUnit	string	A taxa de transferência de leitura/gravação da instância. Nota Este parâmetro é retornado apenas para instâncias Serverless. As instâncias Serverless estão disponíveis apenas no site da China (aliyun.com).	100
VpcAuthMode	string	Indica se o acesso sem senha por meio de uma VPC está ativado. Valores válidos: Open: ativado Close: desativado	Open
DBInstanceStatus	string	O status da instância. Para mais informações, consulte Estados da instância.	Running
NetworkType	string	O tipo de rede da instância. Valores válidos: Classic: rede clássica VPC: virtual private cloud (VPC)	VPC
LockMode	string	O modo de bloqueio da instância. Unlock: A instância não está bloqueada. ManualLock: A instância está bloqueada manualmente. LockByExpiration: A instância é bloqueada automaticamente após a expiração. LockByRestoration: A instância é bloqueada automaticamente antes de uma reversão. LockByDiskQuota: A instância é bloqueada automaticamente após seu espaço de armazenamento ser esgotado. Released: A instância foi liberada. Você não pode desbloquear uma instância liberada. Você só pode restaurar os dados da instância para uma nova instância. A restauração pode levar muito tempo.	Unlock
EngineVersion	string	A versão do mecanismo de banco de dados da instância.	4.2
MongosList	array<object>	Os detalhes dos nós mongos. Nota Este parâmetro é retornado apenas para instâncias de cluster fragmentado.
	object	Os detalhes dos nós mongos. Nota Este parâmetro é retornado apenas para instâncias de cluster fragmentado.
NodeClass	string	The instance type of the mongos node.	dds.mongos.standard
NodeDescription	string	The description of the mongos node.	Test mongos node
NodeId	string	The ID of the mongos node.	s-bp10e3b0d02f****
RegionId	string	O ID da região da instância.	cn-hangzhou
DBInstanceStorage	integer	A capacidade de armazenamento da instância, em GB.	20
ResourceGroupId	string	O ID do grupo de recursos ao qual a instância pertence.	rg-acfm22cdcgc****
ZoneId	string	A zona da instância.	cn-hangzhou-i
DBInstanceId	string	O ID da instância.	dds-bp12c5b040dc****
DBInstanceClass	string	O tipo de instância. Para mais informações sobre os tipos de instância disponíveis para diferentes arquiteturas de instância, consulte: Tipos de instância autônoma Tipos de instância de conjunto de réplicas Tipos de instância de cluster fragmentado	dds.mongo.mid
Engine	string	O mecanismo de banco de dados. O valor é MongoDB.	MongoDB
ReplicationFactor	string	O número de nós na instância. Nota Este parâmetro é retornado apenas para instâncias de conjunto de réplicas.	3
DBInstanceDescription	string	A descrição da instância.	Test database
KindCode	string	A edição da instância. Valores válidos: 0: servidor físico 1: ECS 2: DOCKER 18: instância na nova arquitetura baseada em Kubernetes	0

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": "1",
  "RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances": [
    {
      "CreationTime": "2022-01-05T03:18:53Z",
      "ExpireTime": "2022-02-05T16:00Z",
      "Tags": [
        {
          "Key": "testdatabase",
          "Value": "apitest"
        }
      ],
      "LastDowngradeTime": "2021-05-08",
      "ShardList": [
        {
          "NodeClass": "dds.shard.mid",
          "NodeDescription": "Test shard node",
          "NodeStorage": 10,
          "NodeId": "d-bp1cac6f2083****",
          "ReadonlyReplicas": 2
        }
      ],
      "DBInstanceType": "replicate",
      "DestroyTime": "2021-12-10T16:00:00Z",
      "ChargeType": "PrePaid",
      "CapacityUnit": "100",
      "VpcAuthMode": "Open",
      "DBInstanceStatus": "Running",
      "NetworkType": "VPC",
      "LockMode": "Unlock",
      "EngineVersion": "4.2",
      "MongosList": [
        {
          "NodeClass": "dds.mongos.standard",
          "NodeDescription": "Test mongos node",
          "NodeId": "s-bp10e3b0d02f****"
        }
      ],
      "RegionId": "cn-hangzhou",
      "DBInstanceStorage": 20,
      "ResourceGroupId": "rg-acfm22cdcgc****",
      "ZoneId": "cn-hangzhou-i",
      "DBInstanceId": "dds-bp12c5b040dc****",
      "DBInstanceClass": "dds.mongo.mid",
      "Engine": "MongoDB",
      "ReplicationFactor": "3",
      "DBInstanceDescription": "Test database",
      "KindCode": "0"
    }
  ]
}

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.