調用DescribeDBInstanceAttribute介面查詢MongoDB執行個體詳情。
調試
前往【API Explorer】線上調試,API Explorer 提供線上調用 API、動態產生 SDK Example 代碼和快速檢索介面等能力,能顯著降低使用雲 API 的難度,強烈推薦使用。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBInstanceAttribute |
要執行的操作,取值:DescribeDBInstanceAttribute。 |
DBInstanceId | String | 是 | dds-bpxxxxxxxx |
執行個體ID。 |
Engine | String | 否 | MongoDB |
資料庫引擎,取值:MongoDB。 |
RegionId | String | 否 | cn-hangzhou |
地區ID,可調用DescribeRegions查詢。 |
AccessKeyId | String | 否 | LTAIgbTGpxxxxxx |
阿里雲頒發給使用者的訪問服務所用的密鑰ID。 |
返回參數
名稱 | 類型 | 樣本值 | 描述 |
---|---|---|---|
RequestId | String | C373EED9-5125-4DD9-89DB-FB1ECD2C2B4F |
請求ID。 |
DBInstances |
執行個體詳情資訊列表。 |
||
└ChargeType | String | PostPaid |
執行個體的付費類型。
|
└CreationTime | String | 2018-11-21T05:10:00Z |
執行個體建立的時間,格式為yyyy-MM-ddTHH:mmZ(UTC時間)。 |
└CurrentKernelVersion | String | mongodb_20180914_1.1.5 |
執行個體當前資料庫的小版本號碼。 |
└DBInstanceClass | String | dds.mongo.mid |
執行個體規格。 |
└DBInstanceDescription | String | 測試 |
執行個體名稱。 |
└DBInstanceId | String | dds-bpxxxxxxxx |
執行個體ID。 |
└DBInstanceStatus | String | Running |
執行個體狀態,詳情請參見執行個體狀態表。 |
└DBInstanceStorage | Integer | 10 |
執行個體儲存空間。 |
└DBInstanceType | String | replicate |
執行個體類型。
|
└Engine | String | MongoDB |
資料庫引擎。 |
└EngineVersion | String | 3.4 |
資料庫版本。 |
└ExpireTime | String | 2019-04-08T16:00Z |
訂用帳戶執行個體的到期時間,格式為yyyy-MM-ddTHH:mmZ(UTC時間)。 说明 當執行個體的付費類型為訂用帳戶時返回該參數。
|
└LastDowngradeTime | String | 2019-03-08 |
執行個體最近一次降配時間。 |
└LockMode | String | Unlock |
執行個體的鎖定狀態。
|
└MaintainEndTime | String | 03:00Z |
執行個體可維護時間段的結束時間,格式為HH:mmZ(UTC時間)。 |
└MaintainStartTime | String | 02:00Z |
執行個體可維護時間段的開始時間,格式為HH:mmZ(UTC時間)。 |
└MaxConnections | Integer | 500 |
執行個體最大串連數。 |
└MaxIOPS | Integer | 1000 |
執行個體最大IOPS。 |
└MongosList |
Mongos節點資訊列表。 说明 當執行個體類型為分區叢集執行個體時返回該參數。
|
||
└ConnectSting | String | s-bpxxxxxxxx.mongodb.rds.aliyuncs.com |
Mongos節點串連地址。 |
└NodeClass | String | dds.mongos.mid |
Mongos節點規格。 |
└NodeDescription | String | mongos1 |
Mongos節點名稱。 |
└NodeId | String | s-bpxxxxxxxx |
Mongos節點ID。 |
└Port | Integer | 3717 |
Mongos節點串連連接埠。 |
└NetworkType | String | VPC |
執行個體的網路類型。
|
└RegionId | String | cn-hangzhou |
執行個體所屬地區ID。 |
└ReplacateId | String | bls-mxxxxxxxx |
BLS通道ID。 |
└ReplicaSetName | String | mgset-10xxxxxxxx |
執行個體的複本集名稱。 说明 當執行個體類型為複本集執行個體時,返回該參數。
|
└ReplicaSets |
複本集資訊。 说明 當執行個體類型為複本集執行個體時,返回該參數。
|
||
└ConnectionDomain | String | dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com |
節點的串連地址。 |
└ConnectionPort | String | ConnectionPort |
節點的串連連接埠。 |
└NetworkType | String | VPC |
節點的網路類型。
|
└ReplicaSetRole | String | Primary |
節點的角色。
|
└VPCCloudInstanceId | String | vpc-xxxxxxxx |
專用網路執行個體ID。 |
└VPCId | String | vpc-bpxxxxxxxx |
節點的專用網路ID。 |
└VSwitchId | String | vsw-bpxxxxxxxx |
節點的專用網路中交換器ID。 |
└ReplicationFactor | String | 3 |
執行個體的節點數。 说明 當執行個體類型為複本集執行個體時返回該參數。
|
└ResourceGroupId | String | rg-axxxxxxxx |
執行個體所屬資源群組ID。 |
└ShardList |
Shard節點資訊列表。 说明 當執行個體類型為分區叢集執行個體時返回該參數。
|
||
└NodeClass | String | dds.shard.mid |
Shard節點規格。 |
└NodeDescription | String | testshard |
Shard節點名稱。 |
└NodeId | String | d-bpxxxxxxxx |
Shard節點ID。 |
└NodeStorage | Integer | 10 |
Shard節點的儲存空間。 |
└Tags |
執行個體的標籤資訊列表。 |
||
└Key | String | test |
執行個體的標籤鍵。 |
└Value | String | api |
執行個體的標籤值。 |
└VPCId | String | vpc-bpxxxxxxxx |
專用網路ID。 |
└VSwitchId | String | vsw-bpxxxxxxxx |
專用網路的交換器ID。 |
└VpcAuthMode | String | Open |
內網免密訪問模式。
|
└ZoneId | String | cn-hangzhou-b |
執行個體所屬可用性區域ID。 |
樣本
請求樣本
http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=dds-bpxxxxxxxx
&<公用請求參數>
正常返回樣本
XML
格式
<DescribeDBInstanceAttributeResponse>
<RequestId>9E7B90E1-AD90-4DD9-B1FB-E3BE2E0FDD48</RequestId>
<DBInstances>
<DBInstance>
<CurrentKernelVersion>mongodb_20190408_3.0.12</CurrentKernelVersion>
<ZoneId>cn-hangzhou-b</ZoneId>
<MongosList/>
<VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
<Engine>MongoDB</Engine>
<ReplicationFactor>3</ReplicationFactor>
<NetworkType>VPC</NetworkType>
<VPCId>vpc-bpxxxxxxxx</VPCId>
<MaintainStartTime>18:00Z</MaintainStartTime>
<MaxConnections>500</MaxConnections>
<ReplicaSets>
<ReplicaSet>
<NetworkType>VPC</NetworkType>
<VPCId>vpc-bpxxxxxxxx</VPCId>
<ConnectionPort>3717</ConnectionPort>
<ReplicaSetRole>Primary</ReplicaSetRole>
<ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
<VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
<VPCCloudInstanceId>dds-bpxxxxxxxx</VPCCloudInstanceId>
</ReplicaSet>
<ReplicaSet>
<NetworkType>VPC</NetworkType>
<VPCId>vpc-bpxxxxxxxx</VPCId>
<ConnectionPort>3717</ConnectionPort>
<ReplicaSetRole>Secondary</ReplicaSetRole>
<ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
<VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
<VPCCloudInstanceId>dds-bpxxxxxxxx</VPCCloudInstanceId>
</ReplicaSet>
</ReplicaSets>
<DBInstanceType>replicate</DBInstanceType>
<VpcAuthMode>Open</VpcAuthMode>
<EngineVersion>4.0</EngineVersion>
<DBInstanceStatus>Running</DBInstanceStatus>
<ChargeType>PostPaid</ChargeType>
<LockMode>Unlock</LockMode>
<MaxIOPS>1000</MaxIOPS>
<MaintainEndTime>22:00Z</MaintainEndTime>
<DBInstanceClass>dds.mongo.mid</DBInstanceClass>
<DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
<ResourceGroupId>rg-xxxxxxxx</ResourceGroupId>
<DBInstanceDescription>測試資料庫</DBInstanceDescription>
<DBInstanceStorage>10</DBInstanceStorage>
<CreationTime>2019-04-23T03:52:01Z</CreationTime>
<Tags/>
<RegionId>cn-hangzhou</RegionId>
<StorageEngine>WiredTiger</StorageEngine>
<ShardList/>
<ReplicaSetName>mgset-xxxxxxxx</ReplicaSetName>
</DBInstance>
</DBInstances>
</DescribeDBInstanceAttributeResponse>
JSON
格式
{
"RequestId":"9E7B90E1-AD90-4DD9-B1FB-E3BE2E0FDD48",
"DBInstances":{
"DBInstance":[
{
"CurrentKernelVersion":"mongodb_20190408_3.0.12",
"ZoneId":"cn-hangzhou-b",
"MongosList":{
"MongosAttribute":[]
},
"VSwitchId":"vsw-bpxxxxxxxx",
"Engine":"MongoDB",
"ReplicationFactor":"3",
"NetworkType":"VPC",
"VPCId":"vpc-bpxxxxxxxx",
"MaxConnections":500,
"MaintainStartTime":"18:00Z",
"DBInstanceType":"replicate",
"ReplicaSets":{
"ReplicaSet":[
{
"NetworkType":"VPC",
"VPCId":"vpc-bpxxxxxxxx",
"ConnectionPort":"3717",
"ReplicaSetRole":"Primary",
"ConnectionDomain":"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
"VSwitchId":"vsw-bpxxxxxxxx",
"VPCCloudInstanceId":"dds-bpxxxxxxxx"
},
{
"NetworkType":"VPC",
"VPCId":"vpc-bpxxxxxxxx",
"ConnectionPort":"3717",
"ReplicaSetRole":"Secondary",
"ConnectionDomain":"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
"VSwitchId":"vsw-bpxxxxxxxx",
"VPCCloudInstanceId":"dds-bpxxxxxxxx"
}
]
},
"VpcAuthMode":"Open",
"EngineVersion":"4.0",
"DBInstanceStatus":"Running",
"ChargeType":"PostPaid",
"LockMode":"Unlock",
"MaxIOPS":1000,
"MaintainEndTime":"22:00Z",
"DBInstanceClass":"dds.mongo.mid",
"DBInstanceId":"dds-bpxxxxxxxx",
"ResourceGroupId":"rg-xxxxxxxx",
"DBInstanceDescription":"測試資料庫",
"DBInstanceStorage":10,
"CreationTime":"2019-04-23T03:52:01Z",
"Tags":{
"Tag":[]
},
"RegionId":"cn-hangzhou",
"StorageEngine":"WiredTiger",
"ShardList":{
"ShardAttribute":[]
},
"ReplicaSetName":"mgset-xxxxxxxx"
}
]
}
}