すべてのプロダクト
Search
ドキュメントセンター

:DescribeDBInstanceAttribute

最終更新日:Dec 16, 2025

ApsaraDB for MongoDB インスタンスの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeDBInstanceAttribute

get

*dbinstance

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Engine

string

任意

データベースエンジン。値を MongoDB に設定します。

MongoDB

DBInstanceId

string

必須

インスタンス ID。

dds-bp11483712c1****

ResourceGroupId

string

任意

リソースグループの ID。詳細については、「リソースグループの基本情報の表示」をご参照ください。

説明

このパラメーターは、Alibaba Cloud 中国サイト (www.aliyun.com) でのみ設定できます。

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

vSwitch ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

vpc-bp1jk5vwkcri27qme****

ConnectionPort

string

ノードの接続ポート。

3717

ReplicaSetRole

string

ノードのロール。有効値:

  • Primary:プライマリノード。

  • Secondary:セカンダリノード。

Primary

ConnectionDomain

string

ノードのエンドポイント。

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

VPCCloudInstanceId

string

レプリカセットノードの VPC インスタンス ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

dds-bp11483712c1****

NetworkType

string

ネットワークタイプ。有効値:

  • Classic:クラシックネットワーク。

  • VPC:VPC。

VPC

VPCId

string

VPC ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

vpc-bp1jk5vwkcri27qme****

ReplacateId

string

Redis グローバル分散キャッシュインスタンスの論理 ID。

説明

このタイプの新しいインスタンスは購入できなくなりました。このパラメーターは、既存の Redis グローバル分散キャッシュインスタンスに対してのみ返されます。

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。

VPC

LockMode

string

インスタンスのロックステータス。有効値:

  • Unlock:インスタンスはロックされていません。

  • ManualLock:インスタンスは手動でロックされています。

  • LockByExpiration:インスタンスは期限切れのため自動的にロックされます。

  • LockByRestoration:インスタンスはロールバックの前に自動的にロックされます。

  • LockByDiskQuota:ディスク領域が使い果たされたため、インスタンスは自動的にロックされます。

Unlock

EngineVersion

string

データベースエンジンのメジャーバージョン。

4.4

MaxIOPS

integer

インスタンスの最大 IOPS (1 秒あたりの I/O 操作)。

1000

MaxMBPS

integer

ディスクの最大スループット (MB/s)。

350

VPCCloudInstanceIds

string

VPC インスタンス ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

重要 このパラメーターは非推奨です。

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

vSwitch ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

vsw-bp1vj604nj5a9zz74****

NodeClass

string

Mongos ノードのインスタンスタイプ。

dds.mongos.mid

MaxConnections

integer

Mongos ノードへの最大接続数。

1000

Port

integer

Mongos ノードの接続ポート。

3717

VPCId

string

VPC ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

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>

シャードノード情報のリスト。

説明

このパラメーターは、インスタンスがシャードクラスターインスタンスの場合に返されます。

object

シャードノード情報のリスト。

説明

このパラメーターは、インスタンスがシャードクラスターインスタンスの場合に返されます。

LockMode

string

クラスターのロックモード。有効値:

  • Unlock:クラスターはロックされていません。

  • ManualLock:クラスターは手動でロックされています。

  • LockByExpiration:クラスターは期限切れのため自動的にロックされます。

  • LockByRestoration:クラスターはロールバックの前に自動的にロックされます。

  • LockByDiskQuota:ディスク領域が使い果たされたため、クラスターは自動的にロックされます。

Unlock

MaxIOPS

integer

シャードノードの最大 IOPS。

8000

ConnectString

string

シャードノードのエンドポイント。

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

NodeClass

string

シャードノードのインスタンスタイプ。

dds.shard.mid

MaxConnections

integer

シャードノードへの最大接続数。

8000

Port

integer

シャードノードのポート。

3717

NodeDescription

string

シャードノードの名前。

testshard

NodeId

string

シャードノードの ID。

d-bp16e09d9c5d****

NodeStorage

integer

シャードノードのストレージ容量。単位:GB。

10

ReadonlyReplicas

integer

シャードノード内の読み取り専用ノードの数。有効値:0 から 5 までの整数。

0

Status

string

シャードノードのステータス。詳細については、「インスタンスの状態」をご参照ください。

Running

MaxDiskMbps

string

シャードノードの最大ディスクスループット。

350

CurrentKernelVersion

string

MongoDB ノードのマイナーエンジンバージョン。

mongodb_20220518_4.0.21

ReplicaSetName

string

シャードノードの名前。

mgset-xxxx

MaintainEndTime

string

メンテナンスウィンドウの終了時刻。時間は HH:mmZ 形式で、UTC で表示されます。

03:00Z

DBInstanceStatus

string

インスタンスのステータス。詳細については、「インスタンスの状態」をご参照ください。

Running

VPCId

string

VPC ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

vpc-bp1n3i15v90el48nx****

RegionId

string

インスタンスのリージョン ID。

cn-hangzhou

DBInstanceStorage

integer

インスタンスのストレージ容量。

10

ReplicaSetName

string

レプリカセットインスタンスの名前。

説明

このパラメーターは、インスタンスがレプリカセットインスタンスの場合に返されます。

mgset-10ace****

VSwitchId

string

vSwitch ID。

説明

このパラメーターは、インスタンスのネットワークタイプが VPC の場合に返されます。

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。

説明

このパラメーターは、Alibaba Cloud 中国サイト (www.aliyun.com) でのみ返されます。

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:Enhanced SSD (ESSD) PL1 ディスク。 cloud_essd2:ESSD PL2 ディスク。 cloud_essd3:ESSD PL3 ディスク。 local_ssd:ローカル SSD。 cloud_essd_dbfs_s:DBFS ベースの共有ストレージディスク。

cloud_essd1

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 のままである場合、送信中に問題が発生しました。システムは自動的に再試行します。

  • インスタンスのステータスは、インスタンスがプロビジョニング中または完了した場合にのみ変更されます。たとえば、ステータスは Upgrading または Running に変わります。

all_completed

Encrypted

boolean

ディスク暗号化が有効になっているかどうかを示します。

true

EncryptionKey

string

ディスク暗号化に使用される KMS キーの ID。

07609cc3-3109-408f-a35e-c548e776da0b

SyncPercent

string

データ同期の進捗率。インスタンスが構成変更中の場合、データ同期が必要です。このパラメーターを確認して同期の進捗状況を表示できます。

0.8

UseClusterBackup

boolean

クラスターバックアップモードが有効になっているかどうかを示します。有効値:

  • true:クラスターバックアップモードが有効です。

  • false:クラスターバックアップモードが無効です。

true

BurstingEnabled

boolean

バースト機能が有効になっているかどうかを示します。

true

ProvisionedIops

integer

プロビジョニングされたパフォーマンス。

1960

DisasterRecoveryInfo

string

Redis グローバル分散キャッシュインスタンスのソースインスタンスと宛先インスタンスに関する情報。

{"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

成功レスポンス

JSONJSON

{
  "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",
        "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 ステータスコード

エラーコード

エラーメッセージ

説明

400 VpcCloudInstanceIdNumError Get vpcCloudInstanceId number error.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。