DescribeDBInstanceAttribute - 查詢ApsaraDB for MongoDB執行個體的資訊 -

查詢ApsaraDB for MongoDB 執行個體的資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeDBInstanceAttribute

get

*dbinstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
Engine	string	否	資料庫引擎，固定取值：MongoDB。	MongoDB
DBInstanceId	string	是	執行個體 ID。	dds-bp11483712c1****
ResourceGroupId	string	否	資源群組 ID。資源群組詳情請參見查看資源群組基本資料。說明目前僅中國站支援配置該參數。	rg-acfmyiu4ekp****
IsDelete	boolean	否	執行個體是否已刪除，取值說明： false：執行個體正常運行，查詢運行中執行個體資訊。 true：執行個體已刪除，查詢被刪除執行個體的資訊。	false

返回參數

名稱	類型	描述	樣本值
	object	執行個體詳細資料。
RequestId	string	請求 ID。	A935A8EE-A6CC-53DE-98BA-20ABAA7E632B
DBInstances	object
DBInstance	array<object>	執行個體詳細資料。
	array<object>	執行個體詳細資料。
CreationTime	string	執行個體的建立時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2022-01-02T07:43:59Z
ReplicaSets	object
ReplicaSet	array<object>	複本集執行個體資訊。說明當執行個體類型為複本集執行個體時，返回該參數。
	object	複本集執行個體資訊。說明當執行個體類型為複本集執行個體時，返回該參數。
VSwitchId	string	交換器 ID。說明當執行個體的網路類型為專用網路時，返回該參數。	vpc-bp1jk5vwkcri27qme****
ConnectionPort	string	節點的串連連接埠。	3717
ReplicaSetRole	string	節點的角色，取值說明： Primary：主節點。 Secondary：從節點。	Primary
ConnectionDomain	string	節點的串連地址。	dds-bp11483712c1****.mongodb.rds.aliyuncs.com
VPCCloudInstanceId	string	複本集節點的 vpc 執行個體 ID。說明當執行個體的網路類型為專用網路時，返回該參數。	dds-bp11483712c1****
NetworkType	string	網路類型，取值說明： Classic：傳統網路。 VPC：專用網路。	VPC
VPCId	string	專用網路 ID。說明當執行個體的網路類型為專用網路時，返回該參數。	vpc-bp1jk5vwkcri27qme****
ReplacateId	string	全球多活執行個體的邏輯 ID。說明 MongoDB 當前不支援新購該類型執行個體，該參數僅適用於老版本全球多活執行個體。	bls-m****
Tags	object
Tag	array<object>	執行個體的標籤資訊列表。
	object	執行個體的標籤資訊列表。
Key	string	執行個體的標籤鍵。	test
Value	string	執行個體的標籤值。	api
VpcAuthMode	string	私網免密訪問模式，取值說明： Open：開啟私網免密訪問。 Close：關閉私網免密訪問，需要使用密碼訪問。 NotSupport：不支援該功能。	Open
NetworkType	string	執行個體的網路類型，取值說明： Classic：傳統網路。 VPC：專用網路。	VPC
LockMode	string	執行個體的鎖定狀態，取值說明： Unlock：正常，沒有被鎖定。 ManualLock：手動觸發鎖定。 LockByExpiration：執行個體到期自動鎖定。 LockByRestoration：執行個體復原前自動鎖定。 LockByDiskQuota：執行個體空間滿自動鎖定。	Unlock
EngineVersion	string	資料庫大版本。	4.4
MaxIOPS	integer	執行個體最大 IOPS。	1000
MaxMBPS	integer	執行個體的最大雲端硬碟輸送量，單位 MB/s。	350
VPCCloudInstanceIds	string	vpc 執行個體的 ID。說明當執行個體的網路類型為專用網路時，返回該參數。重要參數已廢棄	dds-bp11483712c1****
MongosList	object
MongosAttribute	array<object>	Mongos 節點資訊列表。說明當執行個體類型為分區叢集執行個體時，返回該參數。
	object	Mongos 節點資訊列表。說明當執行個體類型為分區叢集執行個體時，返回該參數。
VpcCloudInstanceId	string	Mongos 節點的 vpc 執行個體 ID。	s-bp1d8c262a158****
LockMode	string	執行個體的鎖定狀態，取值說明： Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：執行個體到期自動鎖定。 LockByRestoration：執行個體復原前自動鎖定。 LockByDiskQuota：執行個體空間滿自動鎖定。	Unlock
MaxIOPS	integer	Mongos 節點的最大 IOPS。	800
VSwitchId	string	交換器 ID。說明當執行個體的網路類型為專用網路時，返回該參數。	vsw-bp1vj604nj5a9zz74****
NodeClass	string	Mongos 節點的規格。	dds.mongos.mid
MaxConnections	integer	Mongos 節點的最大串連數。	1000
Port	integer	Mongos 節點的串連連接埠。	3717
VPCId	string	專用網路 ID。說明當執行個體的網路類型為專用網路時，返回該參數。	vpc-bp1n3i15v90el48nx****
ConnectSting	string	Mongos 節點的串連地址。警告此參數即將下線，請替換使用 ConnectString 參數	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
NodeDescription	string	Mongos 節點的名稱。	mongos1
NodeId	string	Mongos 節點的 ID。	s-bp1d8c262a15****
Status	string	Mongos 節點的狀態。具體請參見執行個體狀態表。	Running
CurrentKernelVersion	string	MongoDB 節點當前核心小版本號碼。	mongodb_20220518_4.0.21
ConnectString	string	Mongos 節點的串連地址。	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
ProtocolType	string	執行個體的訪問協議類型，取值說明： mongodb：MongoDB 協議。 dynamodb：DynamoDB 協議。說明當執行個體類型為分區叢集執行個體時，返回該參數。	mongodb
DBInstanceDescription	string	執行個體名稱。	測試資料庫
CurrentKernelVersion	string	執行個體當前資料庫的小版本號碼。	5.0.5-20220721143518_0
DBInstanceReleaseProtection	boolean	是否開啟執行個體釋放保護，取值說明： true：已開啟。 false：未開啟。	false
ExpireTime	string	訂用帳戶執行個體的到期時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。說明當執行個體的付費類型為訂用帳戶時返回該參數。	2022-02-05T16:00Z
MaintainStartTime	string	執行個體可維護時間段的開始時間，格式為HH:mmZ（UTC 時間）。	18:00Z
DBInstanceType	string	執行個體類型，取值說明： replicate：複本集執行個體。 sharding：分區叢集執行個體。	replicate
LastDowngradeTime	string	執行個體最近一次降配時間。	2022-01-08
ShardList	object
ShardAttribute	array<object>	Shard 節點資訊列表。說明當執行個體類型為分區叢集執行個體時返回該參數。
	object	Shard 節點資訊列表。說明當執行個體類型為分區叢集執行個體時返回該參數。
LockMode	string	叢集的鎖定模式，取值說明： Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：叢集到期自動鎖定。 LockByRestoration：叢集復原前的自動鎖定。 LockByDiskQuota：叢集空間滿自動鎖定。	Unlock
MaxIOPS	integer	Shard 節點的最大 IOPS。	8000
ConnectString	string	Shard 節點的串連地址。	d-bp1af0680a9c6d3**.mongodb.rds.aliyuncs.com:**
NodeClass	string	Shard 節點的規格。	dds.shard.mid
MaxConnections	integer	Shard 節點的最大串連數。	8000
Port	integer	Shard 節點的連接埠。	3717
NodeDescription	string	Shard 節點的名稱。	testshard
NodeId	string	Shard 節點的 ID。	d-bp16e09d9c5d****
NodeStorage	integer	Shard 節點的儲存空間，單位為 GB。	10
ReadonlyReplicas	integer	Shard 節點中唯讀節點的個數，取值範圍為 0~5（整數）。	0
Status	string	Shard 節點的狀態，具體請參見執行個體狀態表。	Running
MaxDiskMbps	string	shard 節點的最大雲端硬碟輸送量。	350
CurrentKernelVersion	string	MongoDB 節點當前核心小版本號碼。	mongodb_20220518_4.0.21
ReplicaSetName	string	Shard 節點的名稱。	mgset-xxxx
MaintainEndTime	string	執行個體可維護時間段的結束時間，格式為HH:mmZ（UTC 時間）。	03:00Z
DBInstanceStatus	string	執行個體狀態，具體請參見執行個體狀態表。	Running
VPCId	string	專用網路 ID。說明當執行個體的網路類型為專用網路時，返回該參數。	vpc-bp1n3i15v90el48nx****
RegionId	string	執行個體所屬地區 ID。	cn-hangzhou
DBInstanceStorage	integer	執行個體儲存空間。	10
ReplicaSetName	string	複本集執行個體的名稱。說明當執行個體類型為複本集執行個體時，返回該參數。	mgset-10ace****
VSwitchId	string	交換器 ID。說明當執行個體的網路類型為專用網路時，返回該參數。	vsw-bp1oo2a7isyrb8igf****
StorageEngine	string	執行個體的儲存引擎類型。	WiredTiger
ConfigserverList	object
ConfigserverAttribute	array<object>	Configserver 節點資訊列表。說明當執行個體類型為分區叢集執行個體時，返回該參數。
	object	Configserver 節點的資訊列表。說明當執行個體類型為分區叢集執行個體時，返回該參數。
MaxIOPS	integer	Configserver 節點的最大 IOPS。	1000
LockMode	string	執行個體的鎖定狀態，取值說明： Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：執行個體到期自動鎖定。 LockByRestoration：執行個體復原前自動鎖定。 LockByDiskQuota：執行個體空間滿自動鎖定。	Unlock
ConnectString	string	Configserver 節點的串連地址。	dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
NodeClass	string	Configserver 節點的規格。	dds.cs.mid
MaxConnections	integer	Configserver 節點的最大串連數。	1000
Port	integer	Configserver 節點的連接埠。	3717
NodeDescription	string	Configserver 節點的名稱。	testConfigserver
NodeId	string	Configserver 節點 ID。	dds-bp11483712c1****-cs
NodeStorage	integer	Configserver 節點的儲存空間，單位為 GB。	20
Status	string	ConfigServer 節點的狀態。具體請參見執行個體狀態表。	Running
CurrentKernelVersion	string	MongoDB 節點當前核心小版本號碼。	mongodb_20220518_4.0.21
ResourceGroupId	string	執行個體所屬資源群組 ID。說明目前僅中國站支援返回該參數。	rg-acfmyiu4ekp****
ZoneId	string	執行個體所屬可用性區域 ID。	cn-hangzhou-b
MaxConnections	integer	執行個體最大串連數。	500
DBInstanceId	string	執行個體 ID。	dds-bp11483712c1****
DBInstanceClass	string	執行個體規格。	dds.mongo.mid
Engine	string	資料庫引擎。	MongoDB
ReadonlyReplicas	string	執行個體的唯讀節點個數。	1
ReplicationFactor	string	執行個體節點數量。說明執行個體類型為複本集執行個體時，返回該參數。	3
KindCode	string	執行個體的類型，取值說明： 0：本地碟版執行個體。 3：單節點執行個體。 18：雲端硬碟版執行個體。	18
CapacityUnit	string	執行個體消耗的讀寫輸送量。	100
ChargeType	string	執行個體的付費類型，取值說明： PrePaid：預付費，訂用帳戶。 PostPaid：後付費，隨用隨付。	PostPaid
StorageType	string	儲存類型，取值說明： cloud_essd1：ESSD PL1 雲端硬碟。 cloud_essd2：ESSD PL2 雲端硬碟。 cloud_essd3：ESSD PL3 雲端硬碟。 local_ssd：SSD 本地碟。 cloud_essd_dbfs_s：DBFS 共用儲存雲端硬碟。	cloud_essd1
SecondaryZoneId	string	實現多可用性區域部署時，執行個體的備可用性區域 1，取值說明： cn-hangzhou-g：杭州可用性區域 G。 cn-hangzhou-h：杭州可用性區域 H。 cn-hangzhou-i：杭州可用性區域 I。 cn-hongkong-b：香港可用性區域 B。 cn-hongkong-c：香港可用性區域 C。 cn-hongkong-d：香港可用性區域 D。 cn-wulanchabu-a：烏蘭察布可用性區域 A。 cn-wulanchabu-b：烏蘭察布可用性區域 B。 cn-wulanchabu-c：烏蘭察布可用性區域 C。 ap-southeast-1a：新加坡可用性區域 A。 ap-southeast-1b：新加坡可用性區域 B。 ap-southeast-1c：新加坡可用性區域 C。 ap-southeast-5a：雅加達可用性區域 A。 ap-southeast-5b：雅加達可用性區域 B。 ap-southeast-5c：雅加達可用性區域 C。 eu-central-1a：法蘭克福可用性區域 A。 eu-central-1b：法蘭克福可用性區域 B。 eu-central-1c：法蘭克福可用性區域 C。說明當執行個體為 4.4 或 5.0 版本的多可用性區域複本集執行個體或分區叢集執行個體時，返回該參數。目前僅中國站支援返回該參數。	cn-hangzhou-i
HiddenZoneId	string	實現多可用性區域部署時，執行個體的備可用性區域 2，取值說明： cn-hangzhou-g：杭州可用性區域 G。 cn-hangzhou-h：杭州可用性區域 H。 cn-hangzhou-i：杭州可用性區域 I。 cn-hongkong-b：香港可用性區域 B。 cn-hongkong-c：香港可用性區域 C。 cn-hongkong-d：香港可用性區域 D。 cn-wulanchabu-a：烏蘭察布可用性區域 A。 cn-wulanchabu-b：烏蘭察布可用性區域 B。 cn-wulanchabu-c：烏蘭察布可用性區域 C。 ap-southeast-1a：新加坡可用性區域 A。 ap-southeast-1b：新加坡可用性區域 B。 ap-southeast-1c：新加坡可用性區域 C。 ap-southeast-5a：雅加達可用性區域 A。 ap-southeast-5b：雅加達可用性區域 B。 ap-southeast-5c：雅加達可用性區域 C。 eu-central-1a：法蘭克福可用性區域 A。 eu-central-1b：法蘭克福可用性區域 B。 eu-central-1c：法蘭克福可用性區域 C。說明當執行個體為 4.4 或 5.0 版本的多可用性區域複本集執行個體或分區叢集執行個體時，返回該參數。目前僅中國站支援返回該參數。	cn-hangzhou-h
DestroyTime	string	執行個體資料銷毀時間，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-12-10T16:00:00Z
DBInstanceOrderStatus	string	當前該執行個體已產生的訂單狀態，取值說明： all_completed：所有訂單均處於生產中或已經生產完成。 order_unpaid：當前有未支付的訂單。 order_wait_for_produce：當前有正在下發生產的訂單。說明訂單生產流程依次為使用者下單、支付訂單、訂單下發生產、進行生產和完成生產。如果訂單狀態長時間處於order_wait_for_produce，說明下發生產流程遇到了問題，系統會自動重試。訂單在進行生產和完成生產時，執行個體狀態才會發生變化，例如變更配置中和運行中。	all_completed
Encrypted	boolean	是否開啟雲端硬碟加密	true
EncryptionKey	string	雲端硬碟加密對應的 kms-key	07609cc3-3109-408f-a35e-c548e776da0b
SyncPercent	string	資料同步進度百分比。當執行個體處在變更配置中時，需要進行資料同步等操作，可以通過該欄位判斷同步進度。	0.8
UseClusterBackup	boolean	是否使用叢集備份模式。取值說明： true：啟用叢集備份模式。 false 未啟用叢集備份模式。	true
BurstingEnabled	boolean	是否已開啟突發	true
ProvisionedIops	integer	預配置效能	1960
DisasterRecoveryInfo	string	全球多活的源執行個體與目標執行個體資訊	{"relations":[{"destInsName":"dds-bp11483712c1**","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c**","srcRegionId":"cn-guangzhou"}]}
SearchNodeClass	string	變更配置的 Search-節點規格	mdb.shard.2x.xlarge.d
SearchNodeStorage	integer	變更配置的 Search-節點容量	20
SearchNodeCount	integer	變更配置的 Search-節點數	2

樣本

正常返回樣本

JSON格式

{
  "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": "測試資料庫",
        "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"
            }
          ]
        },
        "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",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "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
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	VpcCloudInstanceIdNumError	Get vpcCloudInstanceId number error.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。