DocsICP FilingConsole
Documentation

DescribeDBInstanceAttribute

Updated at:
Copy as MD
Product
My Favorites

Queries the details of an ApsaraDB for MongoDB instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeDBInstanceAttribute

get

*dbinstance

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

 None None

Request parameters

Parameter

Type

Required

Description

Example
Engine

string

No

The database engine. Set the value to MongoDB.

Valid values:

  • MongoDB :

    The MongoDB database engine.

MongoDB
DBInstanceId

string

Yes

The instance ID.

dds-bp11483712c1****
ResourceGroupId

string

No

The resource group ID. For more information about resource groups, see View the basic information of a resource group.

Note

This parameter is supported only on the Alibaba Cloud China site.

rg-acfmyiu4ekp****
IsDelete

boolean

No

Specifies whether the instance is deleted. Valid values:

  • false: The instance is running. Queries the information of running instances.

  • true: The instance is deleted. Queries the information of deleted instances.

false

Response elements

Element

Type

Description

Example

object

The instance details.

RequestId

string

The request ID.

A935A8EE-A6CC-53DE-98BA-20ABAA7E632B
DBInstances

object

DBInstance

array<object>

The instance details.

array<object>

The instance details.

CreationTime

string

The time when the instance was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

2022-01-02T07:43:59Z
ReplicaSets

object

ReplicaSet

array<object>

The replica set instance information.

Note

This parameter is returned when the instance is a replica set instance.

object

The replica set instance information.

Note

This parameter is returned when the instance is a replica set instance.

VSwitchId

string

The vSwitch ID.

Note

This parameter is returned when the network type of the instance is VPC.

vpc-bp1jk5vwkcri27qme****
ConnectionPort

string

The connection port of the node.

3717
ReplicaSetRole

string

The role of the node. Valid values:

  • Primary: primary node

  • Secondary: secondary node

Primary
ConnectionDomain

string

The connection endpoint of the node.

dds-bp11483712c1****.mongodb.rds.aliyuncs.com
VPCCloudInstanceId

string

The VPC instance ID of the replica set node.

Note

This parameter is returned when the network type of the instance is VPC.

dds-bp11483712c1****
NetworkType

string

The network type. Valid values:

  • Classic: classic network

  • VPC: VPC

VPC
VPCId

string

The VPC ID.

Note

This parameter is returned when the network type of the instance is VPC.

vpc-bp1jk5vwkcri27qme****
ReplacateId

string

The logical ID of the global multi-active instance.

Note

MongoDB does not support purchasing this type of instance. This parameter applies only to legacy global multi-active instances.

bls-m****
Tags

object

Tag

array<object>

The list of tags for the instance.

object

The list of tags for the instance.

Key

string

The tag key of the instance.

test
Value

string

The tag value of the instance.

api
VpcAuthMode

string

The password-free access mode over the internal network. Valid values:

  • Open: Password-free access over the internal network is enabled.

  • Close: Password-free access over the internal network is disabled. A password is required for access.

  • NotSupport: This feature is not supported.

Open
NetworkType

string

The network type of the instance. Valid values:

  • Classic: classic network

  • VPC: VPC

VPC
LockMode

string

The lock status of the instance. Valid values:

  • Unlock: Normal. The instance is not locked.

  • ManualLock: The instance is manually locked.

  • LockByExpiration: The instance is automatically locked upon expiration.

  • LockByRestoration: The instance is automatically locked before a rollback.

  • LockByDiskQuota: The instance is automatically locked when its storage space is exhausted.

Unlock
EngineVersion

string

The major engine version.

4.4
MaxIOPS

integer

The maximum IOPS of the instance.

1000
MaxMBPS

integer

The maximum cloud disk throughput of the instance. Unit: MB/s.

350
VPCCloudInstanceIds

string

The VPC instance ID.

Note

This parameter is returned when the network type of the instance is VPC.

Important This parameter is deprecated.

dds-bp11483712c1****
MongosList

object

MongosAttribute

array<object>

The list of Mongos node information.

Note

This parameter is returned when the instance is a sharded cluster instance.

object

The list of Mongos node information.

Note

This parameter is returned when the instance is a sharded cluster instance.

VpcCloudInstanceId

string

The VPC instance ID of the Mongos node.

s-bp1d8c262a158****
LockMode

string

The lock status of the instance. Valid values:

  • Unlock: Normal.

  • ManualLock: The instance is manually locked.

  • LockByExpiration: The instance is automatically locked upon expiration.

  • LockByRestoration: The instance is automatically locked before a rollback.

  • LockByDiskQuota: The instance is automatically locked when its storage space is exhausted.

Unlock
MaxIOPS

integer

The maximum IOPS of the Mongos node.

800
VSwitchId

string

The vSwitch ID.

Note

This parameter is returned when the network type of the instance is VPC.

vsw-bp1vj604nj5a9zz74****
NodeClass

string

The instance type of the Mongos node.

dds.mongos.mid
MaxConnections

integer

The maximum number of connections to the Mongos node.

1000
Port

integer

The connection port of the Mongos node.

3717
VPCId

string

The VPC ID.

Note

This parameter is returned when the network type of the instance is VPC.

vpc-bp1n3i15v90el48nx****
ConnectSting

string

The connection endpoint of the Mongos node.

Warning This parameter will be deprecated soon. Use the ConnectString parameter instead.

s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
NodeDescription

string

The name of the Mongos node.

mongos1
NodeId

string

The ID of the Mongos node.

s-bp1d8c262a15****
Status

string

The status of the Mongos node. For more information, see Instance statuses.

Running
CurrentKernelVersion

string

The current minor engine version of the MongoDB node.

mongodb_20220518_4.0.21
ConnectString

string

The connection endpoint of the Mongos node.

s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
ProtocolType

string

The access protocol type of the instance. Valid values:

  • mongodb: MongoDB protocol

  • dynamodb: DynamoDB protocol

Note

This parameter is returned when the instance is a sharded cluster instance.

mongodb
DBInstanceDescription

string

The name of the instance.

Test database
CurrentKernelVersion

string

The current minor engine version of the instance.

5.0.5-20220721143518_0
DBInstanceReleaseProtection

boolean

Indicates whether release protection is enabled for the instance. Valid values:

  • true: Enabled.

  • false: Disabled.

false
ExpireTime

string

The expiration time of the subscription instance. The time is displayed in the yyyy-MM-ddTHH:mmZ format in UTC.

Note

This parameter is returned when the billing method of the instance is subscription.

2022-02-05T16:00Z
MaintainStartTime

string

The start time of the maintenance window for the instance. The time is displayed in the HH:mmZ format in UTC.

18:00Z
DBInstanceType

string

The instance type. Valid values:

  • replicate: replica set instance

  • sharding: sharded cluster instance

  • serverless: serverless instance

replicate
LastDowngradeTime

string

The time of the last downgrade for the instance. The time is displayed in the YYYY-MM-DD format.

2022-01-08
ShardList

object

ShardAttribute

array<object>

The list of shard node information.

Note

This parameter is returned when the instance is a sharded cluster instance.

object

The list of shard node information.

Note

This parameter is returned when the instance is a sharded cluster instance.

LockMode

string

The lock status of the cluster. Valid values:

  • Unlock: Normal.

  • ManualLock: The cluster is manually locked.

  • LockByExpiration: The cluster is automatically locked upon expiration.

  • LockByRestoration: The cluster is automatically locked before a rollback.

  • LockByDiskQuota: The cluster is automatically locked when its storage space is exhausted.

Unlock
MaxIOPS

integer

The maximum IOPS of the shard node.

8000
ConnectString

string

The connection endpoint of the shard node.

d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****
NodeClass

string

The instance type of the shard node.

dds.shard.mid
MaxConnections

integer

The maximum number of connections to the shard node.

8000
Port

integer

The port of the shard node.

3717
NodeDescription

string

The name of the shard node.

testshard
NodeId

string

The ID of the shard node.

d-bp16e09d9c5d****
NodeStorage

integer

The storage space of the shard node. Unit: GB.

10
ReadonlyReplicas

integer

The number of read-only nodes in the shard node. Valid values: 0 to 5.

0
Status

string

The status of the shard node. For more information, see Instance statuses.

Running
MaxDiskMbps

string

The maximum cloud disk throughput of the shard node.

350
CurrentKernelVersion

string

The current minor engine version of the MongoDB node.

mongodb_20220518_4.0.21
ReplicaSetName

string

The name of the shard node.

mgset-xxxx
EcsIOPS

integer

The compute IOPS.

0
EbsIOPS

integer

The cloud disk IOPS.

0
EcsBandwidth

integer

The compute MBPS.

0
EbsBandwidth

integer

The compute MBPS.

0
MaintainEndTime

string

The end time of the maintenance window for the instance. The time is displayed in the HH:mmZ format in UTC.

03:00Z
DBInstanceStatus

string

The status of the instance. For more information, see Instance statuses.

Running
VPCId

string

The VPC ID.

Note

This parameter is returned when the network type of the instance is VPC.

vpc-bp1n3i15v90el48nx****
RegionId

string

The region ID of the instance.

cn-hangzhou
DBInstanceStorage

integer

The instance storage.

10
ReplicaSetName

string

The name of the replica set instance.

Note

This parameter is returned when the instance is a replica set instance.

mgset-10ace****
VSwitchId

string

The vSwitch ID.

Note

This parameter is returned when the network type of the instance is VPC.

vsw-bp1oo2a7isyrb8igf****
StorageEngine

string

The storage engine type of the instance.

WiredTiger
ConfigserverList

object

ConfigserverAttribute

array<object>

The list of Configserver node information.

Note

This parameter is returned when the instance is a sharded cluster instance.

object

The information list of Configserver nodes.

Note

This parameter is returned when the instance is a sharded cluster instance.

MaxIOPS

integer

The maximum IOPS of the Configserver node.

1000
LockMode

string

The lock status of the instance. Valid values:

  • Unlock: Normal.

  • ManualLock: The instance is manually locked.

  • LockByExpiration: The instance is automatically locked upon expiration.

  • LockByRestoration: The instance is automatically locked before a rollback.

  • LockByDiskQuota: The instance is automatically locked when its storage space is exhausted.

Unlock
ConnectString

string

The endpoint of the Configserver node.

dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
NodeClass

string

The specifications of the Configserver node.

dds.cs.mid
MaxConnections

integer

The maximum number of connections to the Configserver node.

1000
Port

integer

The port of the Configserver node.

3717
NodeDescription

string

The name of the Configserver node.

testConfigserver
NodeId

string

The ID of the Configserver node.

dds-bp11483712c1****-cs
NodeStorage

integer

The storage capacity of the Configserver node. Unit: GB.

20
Status

string

The status of the Configserver node. For more information, see Instance statuses.

Running
CurrentKernelVersion

string

The current minor engine version of the MongoDB node.

mongodb_20220518_4.0.21
ResourceGroupId

string

The ID of the resource group to which the instance belongs.

Note

This parameter is returned only on the Alibaba Cloud China site.

rg-acfmyiu4ekp****
ZoneId

string

The ID of the zone to which the instance belongs.

cn-hangzhou-b
MaxConnections

integer

The maximum number of connections to the instance.

500
DBInstanceId

string

The instance ID.

dds-bp11483712c1****
DBInstanceClass

string

The instance specifications.

dds.mongo.mid
Engine

string

The database engine.

MongoDB
ReadonlyReplicas

string

The number of read-only nodes in the instance.

1
ReplicationFactor

string

The number of nodes in the instance.

Note

This parameter is returned when the instance is a replica set instance.

3
KindCode

string

The type of the instance. Valid values:

  • 0: Instance with local disks.

  • 3: Single-node instance.

  • 18: Instance with cloud disks.

18
CapacityUnit

string

The read and write throughput consumed by the instance.

100
ChargeType

string

The billing method of the instance. Valid values:

  • PrePaid: Subscription.

  • PostPaid: Pay-as-you-go.

PostPaid
StorageType

string

The storage type. Valid values:

cloud_essd1: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. local_ssd: Local SSD. cloud_essd_dbfs_s: DBFS shared storage cloud disk.

cloud_essd1
DestroyTime

string

The time of data destruction for the instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2021-12-10T16:00:00Z
DBInstanceOrderStatus

string

The status of the generated orders for the instance. Valid values:

  • all_completed: All orders are being processed or have been processed.

  • order_unpaid: Unpaid orders exist.

  • order_wait_for_produce: Orders are being dispatched for processing.

Note

The order processing flow includes placing an order, paying for the order, dispatching the order for processing, processing the order, and completing the processing.

  • If the order status remains order_wait_for_produce for a long time, an issue occurred during the dispatch process, and the system will automatically retry.

  • The instance status changes, such as to changing specifications or running, only when the order is being processed or has been processed.

all_completed
Encrypted

boolean

Indicates whether cloud disk encryption is enabled.

true
EncryptionKey

string

The KMS key used for cloud disk encryption.

07609cc3-3109-408f-a35e-c548e776da0b
SyncPercent

string

The data synchronization progress in percentage. When the instance is changing specifications, operations such as data synchronization are required. You can use this field to check the synchronization progress.

0.8
UseClusterBackup

boolean

Indicates whether the cluster backup mode is used. Valid values:

  • true: The cluster backup mode is enabled.

  • false: The cluster backup mode is not enabled.

true
BurstingEnabled

boolean

Indicates whether the burst feature is enabled.

true
ProvisionedIops

integer

The provisioned performance.

1960
DisasterRecoveryInfo

string

The information about the source and target instances for active geo-redundancy.

{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]}
SearchNodeClass

string

The node specifications of the Search node after the upgrade/downgrade.

mdb.shard.2x.xlarge.d
SearchNodeStorage

integer

The storage capacity of the Search node after the specification change.

20
SearchNodeCount

integer

The number of Search nodes after the specification change.

2
ColdDataEnabled

boolean

Indicates whether the data archiving feature is enabled.

AIGatewayEnabled

boolean

Indicates whether the AI gateway is enabled for the instance.

ShardSearchNodes

object

ShardSearchNodes

array<object>

The list of Search node information associated with each Shard node in a sharded cluster instance.

object

NodeId

string

The ID of the Shard node.

d-bp1b234bf7a4****
SearchNodeId

string

The ID of the Search node.

SearchNodeClass

string

The node specifications of the Search node.

mdb.shard.2x.xlarge.d
SearchNodeStorage

string

The storage capacity of the Search node.

20
SearchNodeCount

string

The number of Search nodes.

2
EcsIOPS

integer

The compute IOPS.

0
EbsIOPS

integer

The cloud disk IOPS.

0
EcsBandwidth

integer

The compute MBPS.

0
EbsBandwidth

integer

The disk MBPS.

0

Examples

Success response

JSON format

{
  "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": "test",
              "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": "Test database",
        "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": "d-bp1b234bf7a4****",
              "SearchNodeId": "",
              "SearchNodeClass": "mdb.shard.2x.xlarge.d",
              "SearchNodeStorage": "20",
              "SearchNodeCount": "2"
            }
          ]
        },
        "EcsIOPS": 0,
        "EbsIOPS": 0,
        "EcsBandwidth": 0,
        "EbsBandwidth": 0
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description
400 VpcCloudInstanceIdNumError Get vpcCloudInstanceId number error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.