All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeDBInstanceAttribute

Last Updated:Jan 17, 2023

Queries the details of an ApsaraDB for MongoDB instance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
dds:DescribeDBInstanceAttribute READ
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    without
without

Request parameters

Parameter Type Required Description Example
Engine string No

The database engine of the instance. The value is set to MongoDB.

MongoDB
DBInstanceId string Yes

The ID of the instance.

dds-bp11483712c1****
ResourceGroupId string No

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

Note This parameter is available only if you use the China site (aliyun.com).
rg-acfmyiu4ekp****

Response parameters

Parameter Type Description Example
object
RequestId string

The ID of the request.

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

Details of the instance.

object
CreationTime string

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

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

Details of the replica set instance.

Note This parameter is returned if the instance is a replica set instance.
object
VSwitchId string

The ID of the vSwitch.

Note This parameter is returned if the network type of the instance is Virtual Private Cloud (VPC).
vpc-bp1jk5vwkcri27qme****
ConnectionPort string

The port number that is used to connect to the node.

3717
ReplicaSetRole string

The role of the node. Valid values:

  • Primary
  • Secondary
Primary
ConnectionDomain string

The endpoint of the node.

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

The ID of the instance.

Note This parameter is returned if the network type of the instance is VPC.
dds-bp11483712c1****
NetworkType string

The network type of the instance. Valid values:

  • Classic: classic network
  • VPC: VPC
VPC
VPCId string

The ID of the VPC.

Note This parameter is returned if the network type of the instance is VPC.
vpc-bp1jk5vwkcri27qme****
ReplacateId string

The logical ID of the replica instance.

Note ApsaraDB for MongoDB does not support new instances of this type. This parameter applies only to previous-version replica instances.
bls-m****
Tags array

Details of the instance tags.

object
Key string

The tag key of the instance.

test
Value string

The tag value of the instance.

api
VpcAuthMode string

Indicates whether password-free access within the VPC is enabled. Valid values:

  • Open: Password-free access is enabled.
  • Close: Password-free access is disabled, and you must use a password for access.
  • NotSupport: Password-free access is not supported.
Open
NetworkType string

The network type of the instance. Valid values:

  • Classic: classic network
  • VPC: VPC
VPC
LockMode string

The lock state of the instance. Valid values:

  • Unlock: The instance is not locked.
  • ManualLock: The instance is manually locked.
  • LockByExpiration: The instance is automatically locked due to instance expiration.
  • LockByRestoration: The instance is automatically locked before it is rolled back.
  • LockByDiskQuota: The instance is automatically locked due to exhausted storage capacity.
  • Released: The instance is released.
Unlock
EngineVersion string

The database engine version of the instance. Valid values:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
4.4
MaxIOPS integer

The maximum IOPS of the instance.

1000
VPCCloudInstanceIds string

The ID of the instance.

Note This parameter is returned if the network type of the instance is VPC.
dds-bp11483712c1****
MongosList array

Details of the mongos nodes.

Note This parameter is returned if the instance is a sharded cluster instance.
object
VpcCloudInstanceId string

The ID of the mongos node.

s-bp1d8c262a158****
MaxIOPS integer

The maximum IOPS of the mongos node.

800
VSwitchId string

The ID of the vSwitch.

Note This parameter is returned if the network type of the instance is VPC.
vsw-bp1vj604nj5a9zz74****
NodeClass string

The type of the mongos node.

dds.mongos.mid
MaxConnections integer

The maximum number of connections to the mongos node.

1000
Port integer

The port number that is used to connect to the mongos node.

3717
VPCId string

The ID of the VPC.

Note This parameter is returned if the network type of the instance is VPC.
vpc-bp1n3i15v90el48nx****
ConnectSting string

The endpoint of the mongos node.

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 state of the mongos node. For more information, see Instance states.

Running
ProtocolType string

The access protocol type of the instance. Valid values:

  • mongodb: the MongoDB protocol
  • dynamodb: the DynamoDB protocol
Note This parameter is returned if the instance is a sharded cluster instance.
mongodb
DBInstanceDescription string

The name of the instance.

my mongodb.
CurrentKernelVersion string

The minor version of the current database in the instance.

5.0.5-20220721143518_0
DBInstanceReleaseProtection boolean

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

  • true: Release protection is enabled.
  • false: Release protection is disabled.
false
ExpireTime string

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

Note This parameter is returned if the instance is a subscription instance.
2022-02-05T16:00Z
MaintainStartTime string

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

18:00Z
DBInstanceType string

The architecture of the instance. Valid values:

  • replicate: replica set instance
  • sharding: sharded cluster instance
replicate
LastDowngradeTime string

The date when the last downgrade operation was performed.

2022-01-08
ShardList array

Details of the shard nodes.

Note This parameter is returned if the instance is a sharded cluster instance.
object
MaxIOPS integer

The maximum IOPS of the shard node.

8000
ConnectString string

The endpoint of the shard node.

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

The type of the shard node.

dds.shard.mid
MaxConnections integer

The maximum number of connections to the shard node.

8000
Port integer

The port number that is used to connect to 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 capacity of the shard node.

10
ReadonlyReplicas integer

The number of read-only nodes in the shard node. Valid values: 0 to 5. The value must be an integer.

0
Status string

The state of the shard node. For more information, see Instance states.

Running
MaintainEndTime string

The end time of the maintenance window of the instance.

03:00Z
DBInstanceStatus string

The state of the instance. For more information, see Instance states.

Running
VPCId string

The ID of the VPC.

Note This parameter is returned if the network type of the instance is VPC.
vpc-bp1n3i15v90el48nx****
RegionId string

The region ID of the instance.

cn-hangzhou
DBInstanceStorage integer

The storage capacity of the instance.

10
ReplicaSetName string

The name of the replica set instance.

Note This parameter is returned if the instance is a replica set instance.
mgset-10ace****
VSwitchId string

The ID of the vSwitch.

Note This parameter is returned if the network type of the instance is VPC.
vsw-bp1oo2a7isyrb8igf****
StorageEngine string

The storage engine of the instance.

WiredTiger
ConfigserverList array

Details of the Configserver nodes.

Note This parameter is returned if the instance is a sharded cluster instance.
object
MaxIOPS integer

The maximum IOPS of the Configserver node.

1000
ConnectString string

The endpoint of the Configserver node.

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

The type of the Configserver node.

dds.cs.mid
MaxConnections integer

The maximum number of connections to the Configserver node.

1000
Port integer

The port number that is used to connect to 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.

20
Status string

The state of the Configserver node. For more information, see Instance states.

Running
ResourceGroupId string

The ID of the resource group.

Note This parameter is returned only if you use the Chine site (aliyun.com).
rg-acfmyiu4ekp****
ZoneId string

The zone ID of the instance.

cn-hangzhou-b
MaxConnections integer

The maximum number of connections to the instance.

500
DBInstanceId string

The ID of the instance.

dds-bp11483712c1****
DBInstanceClass string

The instance type.

dds.mongo.mid
Engine string

The database engine of the instance.

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 if the instance is a replica set instance.
3
KindCode string

The kind code of the instance. Valid values:

  • 0: physical machine
  • 1: Elastic Compute Service (ECS) instance
  • 2: Docker cluster
  • 18: Kubernetes cluster
1
CapacityUnit string

The I/O 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 of the instance. Valid values:

  • cloud_essd: enhanced SSD (ESSD)
  • local_ssd: local SSD
cloud_essd1
SecondaryZoneId string

The ID of the secondary zone 1 of the instance. Valid values:

  • cn-hangzhou-g: Hangzhou Zone G
  • cn-hangzhou-h: Hangzhou Zone H
  • cn-hangzhou-i: Hangzhou Zone I
  • cn-hongkong-b: Hongkong Zone B
  • cn-hongkong-c: Hongkong Zone C
  • cn-hongkong-d: Hongkong Zone D
  • cn-wulanchabu-a: Ulanqab Zone A
  • cn-wulanchabu-b: Ulanqab Zone B
  • cn-wulanchabu-c: Ulanqab Zone C
  • ap-southeast-1a: Singapore Zone A
  • ap-southeast-1b: Singapore Zone B
  • ap-southeast-1c: Singapore Zone C
  • ap-southeast-5a: Jakarta Zone A
  • ap-southeast-5b: Jakarta Zone B
  • ap-southeast-5c: Jakarta Zone C
  • eu-central-1a: Frankfurt Zone A
  • eu-central-1b: Frankfurt Zone B
  • eu-central-1c: Frankfurt Zone C
Note
  • This parameter is returned if the instance is a replica set or sharded cluster instance that runs MongoDB 4.4 or 5.0 and uses multi-zone deployment.
  • This parameter is returned only if you use the Chine site (aliyun.com).
cn-hangzhou-i
HiddenZoneId string

The ID of the secondary zone 2 of the instance. Valid values:

  • cn-hangzhou-g: Hangzhou Zone G
  • cn-hangzhou-h: Hangzhou Zone H
  • cn-hangzhou-i: Hangzhou Zone I
  • cn-hongkong-b: Hongkong Zone B
  • cn-hongkong-c: Hongkong Zone C
  • cn-hongkong-d: Hongkong Zone D
  • cn-wulanchabu-a: Ulanqab Zone A
  • cn-wulanchabu-b: Ulanqab Zone B
  • cn-wulanchabu-c: Ulanqab Zone C
  • ap-southeast-1a: Singapore Zone A
  • ap-southeast-1b: Singapore Zone B
  • ap-southeast-1c: Singapore Zone C
  • ap-southeast-5a: Jakarta Zone A
  • ap-southeast-5b: Jakarta Zone B
  • ap-southeast-5c: Jakarta Zone C
  • eu-central-1a: Frankfurt Zone A
  • eu-central-1b: Frankfurt Zone B
  • eu-central-1c: Frankfurt Zone C
Note
  • This parameter is returned if the instance is a replica set or sharded cluster instance that runs MongoDB 4.4 or 5.0 and uses multi-zone deployment.
  • This parameter is returned only if you use the Chine site (aliyun.com).
cn-hangzhou-h
DestroyTime string

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

Note
  • Subscription instances are released 15 days after expiration. After an instance is released, its data is deleted and cannot be restored.
  • Pay-as-you-go instances are locked after the payments have been overdue for longer than 24 hours. The instances are released after the payments have been overdue for longer than 15 days. The data of released instances is deleted and cannot be restored.
  • 2021-12-10T16:00:00Z

    Example

    Normal return example

    JSONFormat

    {
      "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,
            "VPCCloudInstanceIds": "dds-bp11483712c1****",
            "MongosList": {
              "MongosAttribute": [
                {
                  "VpcCloudInstanceId": "s-bp1d8c262a158****",
                  "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"
                }
              ]
            },
            "ProtocolType": "mongodb",
            "DBInstanceDescription": "my mongodb.",
            "CurrentKernelVersion": "5.0.5-20220721143518_0",
            "DBInstanceReleaseProtection": true,
            "ExpireTime": "2022-02-05T16:00Z",
            "MaintainStartTime": "18:00Z",
            "DBInstanceType": "replicate",
            "LastDowngradeTime": "2022-01-08",
            "ShardList": {
              "ShardAttribute": [
                {
                  "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"
                }
              ]
            },
            "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,
                  "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"
                }
              ]
            },
            "ResourceGroupId": "rg-acfmyiu4ekp****",
            "ZoneId": "cn-hangzhou-b",
            "MaxConnections": 500,
            "DBInstanceId": "dds-bp11483712c1****",
            "DBInstanceClass": "dds.mongo.mid",
            "Engine": "MongoDB",
            "ReadonlyReplicas": "1",
            "ReplicationFactor": "3",
            "KindCode": "1",
            "CapacityUnit": "100",
            "ChargeType": "PostPaid",
            "StorageType": "cloud_essd1",
            "SecondaryZoneId": "cn-hangzhou-i",
            "HiddenZoneId": "cn-hangzhou-h",
            "DestroyTime": "2021-12-10T16:00:00Z"
          }
        ]
      }
    }

    Error codes

    Http code Error code Error message
    400 VpcCloudInstanceIdNumError Get vpcCloudInstanceId number error.

    For a list of error codes, visit the API error center.

    Change history

    Change time Summary of changes Operate
    No change history