edit-icon download-icon

DescribeDBInstanceAttribute

Last Updated: Jan 29, 2018

Description

This API supports both replica set instances and sharded cluster instances.

Input parameters

NameTypeRequired or notDescription
ActionStringYesRequired parameter; value: DescribeDBInstanceAttribute.
DBInstanceIdStringYesInstance ID. Multiple instance names can be entered at one time and are separated by commas (,).
Up to 30 instance names can be entered.

Response parameters

NameTypeDescription
Public response parameters-For more information, see public response parameters.
DBInstancesList<DBInstance>-

DBInstance parameters

NameTypeDescription
DBInstanceIdStringInstance ID
DBInstanceDescriptionStringInstance description
RegionIdStringID of the region to which the instance belongs
ZoneIdStringID of the zone to which the instance belongs
EngineStringDatabase type
EngineVersionStringDatabase version
DBInstanceClassStringInstance type
DBInstanceStorageStringInstance disk
DBInstanceStatusStringInstance status. For more information, see the instance status table.
ChargeTypeStringBilling method:
- PrePaid: Yearly/monthly subscription
- Postpaid: Pay-As-You-Go
ReplicaSetNameStringName of the instance replica set
CreationTimeStringInstance creation time
ExpireTimeStringExpiration time. Pay-As-You-Go instances never expire.
MaintainStartTimeStringMaintenance start time
MaintainEndTimeStringMaintenance end time
NetworkTypeString- Classic: Classic network
- VPC: VPC
DBInstanceTypeStringSharding or replicate
LastDowngradeTimeIntegerTime of the latest downgrade
MongosListList<MongosAttribute>Mongos list, which is not left blank when DBInstanceType is set to sharding.
ShardListList<ShardAttribute>Shard list, which is not left blank when DBInstanceType is set to sharding.
NameTypeDescription
Public response parameters-For more information, see public response parameters.
OrderIdStringOrder ID

MongosAttribute parameters

NameTypeDescription
NodeIdStringMongos instance ID
NodeDescriptionStringMongos instance description
NodeClassStringMongos instance specification
ConnectStingStringMongos instance connection string
PortStringMongos instance port

ShardAttribute parameters

NameTypeDescription
NodeIdStringShard instance ID
NodeDescriptionStringShard instance description
NodeClassStringShard instance specification
OrderIdStringOrder ID
NodeStorageStringShard storage space
Thank you! We've received your feedback.