Consulta as informações de uma instância do ApsaraDB for MongoDB.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
dds:DescribeDBInstanceAttribute |
get |
*dbinstance.
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| Engine |
string |
Não |
O mecanismo de banco de dados. Defina o valor como MongoDB. Valores válidos:
|
MongoDB |
| DBInstanceId |
string |
Sim |
O ID da instância. |
dds-bp11483712c1**** |
| ResourceGroupId |
string |
Não |
O ID do grupo de recursos. Para obter mais informações sobre grupos de recursos, consulte Visualizar informações básicas de um grupo de recursos. Nota
Este parâmetro é suportado apenas no site da China. |
rg-acfmyiu4ekp**** |
| IsDelete |
boolean |
Não |
Especifica se a instância foi excluída. Valores válidos:
|
false |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os detalhes da instância. |
||
| RequestId |
string |
O ID da solicitação. |
A935A8EE-A6CC-53DE-98BA-20ABAA7E632B |
| DBInstances |
object |
||
| DBInstance |
array<object> |
Os detalhes da instância. |
|
|
array<object> |
Os detalhes da instância. |
||
| CreationTime |
string |
A hora em que a instância foi criada. A hora está no formato yyyy-MM-ddTHH:mm:ssZ (hora UTC). |
2022-01-02T07:43:59Z |
| ReplicaSets |
object |
||
| ReplicaSet |
array<object> |
As informações da instância do conjunto de réplicas. Nota
Este parâmetro é retornado quando o tipo de instância é conjunto de réplicas. |
|
|
object |
As informações da instância do conjunto de réplicas. Nota
Este parâmetro é retornado quando o tipo de instância é conjunto de réplicas. |
||
| VSwitchId |
string |
O ID do vSwitch. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ConnectionPort |
string |
A porta de conexão do nó. |
3717 |
| ReplicaSetRole |
string |
A função do nó. Valores válidos:
|
Primary |
| ConnectionDomain |
string |
O endpoint do nó. |
dds-bp11483712c1****.mongodb.rds.aliyuncs.com |
| VPCCloudInstanceId |
string |
O ID da instância VPC do nó do conjunto de réplicas. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. |
dds-bp11483712c1**** |
| NetworkType |
string |
O tipo de rede. Valores válidos:
|
VPC |
| VPCId |
string |
O ID da VPC. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ReplacateId |
string |
O ID lógico da instância multi-ativa global. Nota
O MongoDB não oferece mais suporte à compra deste tipo de instância. Este parâmetro se aplica apenas a instâncias multi-ativas globais legadas. |
bls-m**** |
| Tags |
object |
||
| Tag |
array<object> |
A lista de tags da instância. |
|
|
object |
A lista de tags da instância. |
||
| Key |
string |
A chave da tag da instância. |
test |
| Value |
string |
O valor da tag da instância. |
api |
| VpcAuthMode |
string |
O modo de acesso sem senha em uma rede privada. Valores válidos:
|
Open |
| NetworkType |
string |
O tipo de rede da instância. Valores válidos:
|
VPC |
| LockMode |
string |
O status de bloqueio da instância. Valores válidos:
|
Unlock |
| EngineVersion |
string |
A versão principal do mecanismo de banco de dados. |
4.4 |
| MaxIOPS |
integer |
O IOPS máximo da instância. |
1000 |
| MaxMBPS |
integer |
A taxa de transferência máxima do disco em nuvem da instância. Unidade: MB/s. |
350 |
| VPCCloudInstanceIds |
string |
O ID da instância VPC. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. Importante Este parâmetro foi descontinuado. |
dds-bp11483712c1**** |
| MongosList |
object |
||
| MongosAttribute |
array<object> |
A lista de informações do nó Mongos. Nota
Este parâmetro é retornado quando o tipo de instância é cluster fragmentado. |
|
|
object |
A lista de informações do nó Mongos. Nota
Este parâmetro é retornado quando o tipo de instância é cluster fragmentado. |
||
| VpcCloudInstanceId |
string |
O ID da instância VPC do nó Mongos. |
s-bp1d8c262a158**** |
| LockMode |
string |
O status de bloqueio da instância. Valores válidos:
|
Unlock |
| MaxIOPS |
integer |
O IOPS máximo do nó Mongos. |
800 |
| VSwitchId |
string |
O ID do vSwitch. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. |
vsw-bp1vj604nj5a9zz74**** |
| NodeClass |
string |
O tipo de instância do nó Mongos. |
dds.mongos.mid |
| MaxConnections |
integer |
O número máximo de conexões para o nó Mongos. |
1000 |
| Port |
integer |
A porta de conexão do nó Mongos. |
3717 |
| VPCId |
string |
O ID da VPC. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. |
vpc-bp1n3i15v90el48nx**** |
| ConnectSting |
string |
O endpoint do nó Mongos. Aviso Este parâmetro será desativado. Substitua-o pelo parâmetro ConnectString. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| NodeDescription |
string |
O nome do nó Mongos. |
mongos1 |
| NodeId |
string |
O ID do nó Mongos. |
s-bp1d8c262a15**** |
| Status |
string |
O status do nó Mongos. Para obter mais informações, consulte Tabela de status da instância. |
Running |
| CurrentKernelVersion |
string |
A versão secundária atual do mecanismo do nó MongoDB. |
mongodb_20220518_4.0.21 |
| ConnectString |
string |
O endpoint do nó Mongos. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| ProtocolType |
string |
O tipo de protocolo de acesso da instância. Valores válidos:
Nota
Este parâmetro é retornado quando o tipo de instância é cluster fragmentado. |
mongodb |
| DBInstanceDescription |
string |
O nome da instância. |
Test database |
| CurrentKernelVersion |
string |
A versão secundária atual do mecanismo do banco de dados da instância. |
5.0.5-20220721143518_0 |
| DBInstanceReleaseProtection |
boolean |
Indica se a proteção contra liberação está ativada para a instância. Valores válidos:
|
false |
| ExpireTime |
string |
A hora de expiração da instância por assinatura. A hora está no formato yyyy-MM-ddTHH:mmZ (hora UTC). Nota
Este parâmetro é retornado quando o método de cobrança da instância é por assinatura. |
2022-02-05T16:00Z |
| MaintainStartTime |
string |
A hora de início da janela de manutenção. A hora está no formato HH:mmZ (hora UTC). |
18:00Z |
| DBInstanceType |
string |
O tipo de instância. Valores válidos:
|
replicate |
| LastDowngradeTime |
string |
A hora mais recente em que a instância foi rebaixada. A hora está no formato YYYY-MM-DD. |
2022-01-08 |
| ShardList |
object |
||
| ShardAttribute |
array<object> |
A lista de informações do nó Shard. Nota
Este parâmetro é retornado quando o tipo de instância é cluster fragmentado. |
|
|
object |
A lista de informações do nó Shard. Nota
Este parâmetro é retornado quando o tipo de instância é cluster fragmentado. |
||
| LockMode |
string |
O modo de bloqueio do cluster. Valores válidos:
|
Unlock |
| MaxIOPS |
integer |
O IOPS máximo do nó Shard. |
8000 |
| ConnectString |
string |
O endpoint do nó Shard. |
d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:**** |
| NodeClass |
string |
O tipo de instância do nó Shard. |
dds.shard.mid |
| MaxConnections |
integer |
O número máximo de conexões para o nó Shard. |
8000 |
| Port |
integer |
A porta do nó Shard. |
3717 |
| NodeDescription |
string |
O nome do nó Shard. |
testshard |
| NodeId |
string |
O ID do nó Shard. |
d-bp16e09d9c5d**** |
| NodeStorage |
integer |
A capacidade de armazenamento do nó Shard. Unidade: GB. |
10 |
| ReadonlyReplicas |
integer |
O número de nós somente leitura no nó Shard. Valores válidos: 0 a 5 (números inteiros). |
0 |
| Status |
string |
O status do nó Shard. Para obter mais informações, consulte Tabela de status da instância. |
Running |
| MaxDiskMbps |
string |
A taxa de transferência máxima do disco em nuvem do nó Shard. |
350 |
| CurrentKernelVersion |
string |
A versão secundária atual do mecanismo do nó MongoDB. |
mongodb_20220518_4.0.21 |
| ReplicaSetName |
string |
O nome do nó Shard. |
mgset-xxxx |
| EcsIOPS |
integer |
O IOPS do host. |
0 |
| EbsIOPS |
integer |
O IOPS do disco. |
0 |
| EcsBandwidth |
integer |
A taxa de transferência do host em MB/s. |
0 |
| EbsBandwidth |
integer |
A taxa de transferência do host em MB/s. |
0 |
| MaintainEndTime |
string |
A hora de término da janela de manutenção. A hora está no formato HH:mmZ (hora UTC). |
03:00Z |
| DBInstanceStatus |
string |
O status da instância. Para obter mais informações, consulte Tabela de status da instância. |
Running |
| VPCId |
string |
O ID da VPC. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. |
vpc-bp1n3i15v90el48nx**** |
| RegionId |
string |
O ID da região da instância. |
cn-hangzhou |
| DBInstanceStorage |
integer |
O armazenamento da instância. |
10 |
| ReplicaSetName |
string |
O nome da instância do conjunto de réplicas. Nota
Este parâmetro é retornado quando o tipo de instância é conjunto de réplicas. |
mgset-10ace**** |
| VSwitchId |
string |
O ID do vSwitch. Nota
Este parâmetro é retornado quando o tipo de rede da instância é VPC. |
vsw-bp1oo2a7isyrb8igf**** |
| StorageEngine |
string |
O tipo de mecanismo de armazenamento da instância. |
WiredTiger |
| ConfigserverList |
object |
||
| ConfigserverAttribute |
array<object> |
A lista de informações dos nós Configserver. Nota
Este parâmetro é retornado quando o tipo de instância é um cluster fragmentado. |
|
|
object |
A lista de informações dos nós Configserver. Nota
Este parâmetro é retornado quando o tipo de instância é um cluster fragmentado. |
||
| MaxIOPS |
integer |
O IOPS máximo do nó Configserver. |
1000 |
| LockMode |
string |
O status de bloqueio da instância. Valores válidos:
|
Unlock |
| ConnectString |
string |
O endpoint do nó Configserver. |
dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com |
| NodeClass |
string |
As especificações do nó Configserver. |
dds.cs.mid |
| MaxConnections |
integer |
O número máximo de conexões para o nó Configserver. |
1000 |
| Port |
integer |
A porta do nó Configserver. |
3717 |
| NodeDescription |
string |
O nome do nó Configserver. |
testConfigserver |
| NodeId |
string |
O ID do nó Configserver. |
dds-bp11483712c1****-cs |
| NodeStorage |
integer |
A capacidade de armazenamento do nó Configserver. Unidade: GB. |
20 |
| Status |
string |
O status do nó ConfigServer. Para mais informações, consulte Tabela de status da instância. |
Running |
| CurrentKernelVersion |
string |
A versão secundária atual do mecanismo do nó MongoDB. |
mongodb_20220518_4.0.21 |
| ResourceGroupId |
string |
O ID do grupo de recursos ao qual a instância pertence. Nota
Atualmente, este parâmetro é retornado apenas no site da China. |
rg-acfmyiu4ekp**** |
| ZoneId |
string |
O ID da zona à qual a instância pertence. |
cn-hangzhou-b |
| MaxConnections |
integer |
O número máximo de conexões para a instância. |
500 |
| DBInstanceId |
string |
O ID da instância. |
dds-bp11483712c1**** |
| DBInstanceClass |
string |
O tipo de instância. |
dds.mongo.mid |
| Engine |
string |
O mecanismo de banco de dados. |
MongoDB |
| ReadonlyReplicas |
string |
O número de nós somente leitura na instância. |
1 |
| ReplicationFactor |
string |
O número de nós na instância. Nota
Este parâmetro é retornado quando o tipo de instância é um conjunto de réplicas. |
3 |
| KindCode |
string |
O tipo da instância. Valores válidos:
|
18 |
| CapacityUnit |
string |
O throughput de leitura e gravação consumido pela instância. |
100 |
| ChargeType |
string |
O método de cobrança da instância. Valores válidos:
|
PostPaid |
| StorageType |
string |
O tipo de armazenamento. Valores válidos: cloud_essd1: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD local. cloud_essd_dbfs_s: disco em nuvem de armazenamento compartilhado DBFS. |
cloud_essd1 |
| DestroyTime |
string |
A hora da destruição dos dados da instância, no formato yyyy-MM-ddTHH:mm:ssZ (UTC). |
2021-12-10T16:00:00Z |
| DBInstanceOrderStatus |
string |
O status dos pedidos gerados para a instância. Valores válidos:
Nota
O fluxo de trabalho de processamento de pedidos prossegue da seguinte forma: fazer o pedido, pagar o pedido, enviar o pedido para processamento, processar o pedido e concluir o pedido.
|
all_completed |
| Encrypted |
boolean |
Especifica se a criptografia de disco em nuvem está ativada. |
true |
| EncryptionKey |
string |
A chave KMS usada para criptografia de disco em nuvem. |
07609cc3-3109-408f-a35e-c548e776da0b |
| SyncPercent |
string |
O progresso de sincronização de dados em porcentagem. Quando a instância está sendo modificada, operações como sincronização de dados são necessárias. Use este campo para verificar o progresso da sincronização. |
0.8 |
| UseClusterBackup |
boolean |
Especifica se o modo de backup de cluster está ativado. Valores válidos:
|
true |
| BurstingEnabled |
boolean |
Especifica se o burst de E/S está ativado. |
true |
| ProvisionedIops |
integer |
O desempenho provisionado. |
1960 |
| DisasterRecoveryInfo |
string |
As informações da instância de origem e da instância de destino para georredundância ativa global. |
{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]} |
| SearchNodeClass |
string |
As especificações do nó Search após uma alteração de especificação. |
mdb.shard.2x.xlarge.d |
| SearchNodeStorage |
integer |
A capacidade de armazenamento do nó Search após uma alteração de especificação. |
20 |
| SearchNodeCount |
integer |
O número de nós Search após uma alteração de especificação. |
2 |
| ColdDataEnabled |
boolean |
Especifica se o recurso de arquivamento de dados frios está ativado. |
|
| AIGatewayEnabled |
boolean |
Especifica se o gateway de IA está ativado para a instância. |
|
| ShardSearchNodes |
object |
||
| ShardSearchNodes |
array<object> |
A lista de informações dos nós Search associadas a cada nó Shard na instância de cluster fragmentado. |
|
|
object |
|||
| NodeId |
string |
O ID do nó Shard. |
|
| SearchNodeId |
string |
O ID do nó Search. |
|
| SearchNodeClass |
string |
As especificações do nó Search. |
|
| SearchNodeStorage |
string |
A capacidade de armazenamento do nó Search. |
|
| SearchNodeCount |
string |
O número de nós Search. |
|
| EcsIOPS |
integer |
O IOPS do host. |
0 |
| EbsIOPS |
integer |
O IOPS do disco. |
0 |
| EcsBandwidth |
integer |
A taxa de transferência do host em MB/s. |
0 |
| EbsBandwidth |
integer |
O throughput do disco em MB/s. |
0 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "A935A8EE-A6CC-53DE-98BA-20ABAA7E632B",
"DBInstances": {
"DBInstance": [
{
"CreationTime": "2022-01-02T07:43:59Z",
"ReplicaSets": {
"ReplicaSet": [
{
"VSwitchId": "vpc-bp1jk5vwkcri27qme****",
"ConnectionPort": "3717",
"ReplicaSetRole": "Primary",
"ConnectionDomain": "dds-bp11483712c1****.mongodb.rds.aliyuncs.com",
"VPCCloudInstanceId": "dds-bp11483712c1****",
"NetworkType": "VPC",
"VPCId": "vpc-bp1jk5vwkcri27qme****"
}
]
},
"ReplacateId": "bls-m****",
"Tags": {
"Tag": [
{
"Key": "teste",
"Value": "api"
}
]
},
"VpcAuthMode": "Open",
"NetworkType": "VPC",
"LockMode": "Unlock",
"EngineVersion": "4.4",
"MaxIOPS": 1000,
"MaxMBPS": 350,
"VPCCloudInstanceIds": "dds-bp11483712c1****",
"MongosList": {
"MongosAttribute": [
{
"VpcCloudInstanceId": "s-bp1d8c262a158****",
"LockMode": "Unlock",
"MaxIOPS": 800,
"VSwitchId": "vsw-bp1vj604nj5a9zz74****",
"NodeClass": "dds.mongos.mid",
"MaxConnections": 1000,
"Port": 3717,
"VPCId": "vpc-bp1n3i15v90el48nx****",
"ConnectSting": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
"NodeDescription": "mongos1",
"NodeId": "s-bp1d8c262a15****",
"Status": "Running",
"CurrentKernelVersion": "mongodb_20220518_4.0.21",
"ConnectString": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com"
}
]
},
"ProtocolType": "mongodb",
"DBInstanceDescription": "Banco de dados de teste",
"CurrentKernelVersion": "5.0.5-20220721143518_0",
"DBInstanceReleaseProtection": false,
"ExpireTime": "2022-02-05T16:00Z",
"MaintainStartTime": "18:00Z",
"DBInstanceType": "replicate",
"LastDowngradeTime": "2022-01-08",
"ShardList": {
"ShardAttribute": [
{
"LockMode": "Unlock",
"MaxIOPS": 8000,
"ConnectString": "d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****",
"NodeClass": "dds.shard.mid",
"MaxConnections": 8000,
"Port": 3717,
"NodeDescription": "testshard",
"NodeId": "d-bp16e09d9c5d****",
"NodeStorage": 10,
"ReadonlyReplicas": 0,
"Status": "Running",
"MaxDiskMbps": "350",
"CurrentKernelVersion": "mongodb_20220518_4.0.21",
"ReplicaSetName": "mgset-xxxx",
"EcsIOPS": 0,
"EbsIOPS": 0,
"EcsBandwidth": 0,
"EbsBandwidth": 0
}
]
},
"MaintainEndTime": "03:00Z",
"DBInstanceStatus": "Running",
"VPCId": "vpc-bp1n3i15v90el48nx****",
"RegionId": "cn-hangzhou",
"DBInstanceStorage": 10,
"ReplicaSetName": "mgset-10ace****",
"VSwitchId": "vsw-bp1oo2a7isyrb8igf****",
"StorageEngine": "WiredTiger",
"ConfigserverList": {
"ConfigserverAttribute": [
{
"MaxIOPS": 1000,
"LockMode": "Unlock",
"ConnectString": "dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com",
"NodeClass": "dds.cs.mid",
"MaxConnections": 1000,
"Port": 3717,
"NodeDescription": "testConfigserver",
"NodeId": "dds-bp11483712c1****-cs",
"NodeStorage": 20,
"Status": "Running",
"CurrentKernelVersion": "mongodb_20220518_4.0.21"
}
]
},
"ResourceGroupId": "rg-acfmyiu4ekp****",
"ZoneId": "cn-hangzhou-b",
"MaxConnections": 500,
"DBInstanceId": "dds-bp11483712c1****",
"DBInstanceClass": "dds.mongo.mid",
"Engine": "MongoDB",
"ReadonlyReplicas": "1",
"ReplicationFactor": "3",
"KindCode": "18",
"CapacityUnit": "100",
"ChargeType": "PostPaid",
"StorageType": "cloud_essd1",
"DestroyTime": "2021-12-10T16:00:00Z",
"DBInstanceOrderStatus": "all_completed",
"Encrypted": true,
"EncryptionKey": "07609cc3-3109-408f-a35e-c548e776da0b",
"SyncPercent": "0.8",
"UseClusterBackup": true,
"BurstingEnabled": true,
"ProvisionedIops": 1960,
"DisasterRecoveryInfo": "{\"relations\":[{\"destInsName\":\"dds-bp11483712c1****\",\"destRegionId\":\"cn-hangzhou\",\"srcInsName\":\"dds-7xv054b9c43c****\",\"srcRegionId\":\"cn-guangzhou\"}]}",
"SearchNodeClass": "mdb.shard.2x.xlarge.d",
"SearchNodeStorage": 20,
"SearchNodeCount": 2,
"ColdDataEnabled": false,
"AIGatewayEnabled": false,
"ShardSearchNodes": {
"ShardSearchNodes": [
{
"NodeId": "",
"SearchNodeId": "",
"SearchNodeClass": "",
"SearchNodeStorage": "",
"SearchNodeCount": ""
}
]
},
"EcsIOPS": 0,
"EbsIOPS": 0,
"EcsBandwidth": 0,
"EbsBandwidth": 0
}
]
}
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | VpcCloudInstanceIdNumError | Get vpcCloudInstanceId number error. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.