DescribeDBInstanceAttribute - - Alibaba Cloud ドキュメントセンター

この API は、MongoDB インスタンスの詳細をクエリする場合に呼び出すことができます。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ

パラメータ	データ型	必須	例	説明
Action	String	はい	DescribeDBInstanceAttribute	実行する操作。値を DescribeDBInstanceAttributeに設定します。
DBInstanceId	String	はい	dds-bpxxxxxxxx	インスタンス ID。
AccessKeyId	String	いいえ	LTAI****************	Alibaba Cloud から提供された AccessKey ID。
Engine	String	いいえ	MongoDB	データベースエンジン。値を MongoDB に設定します。

レスポンスパラメータ

パラメータ	タイプ	例	説明
RequestId	String	C373EED9-5125-4DD9-89DB-FB1ECD2C2B4F	リクエスト ID。
DBInstances			インスタンスの詳細リスト。
└ChargeType	String	PostPaid	インスタンスの課金方法。 PrePaid：サブスクリプション PostPaid：従量課金
└CreationTime	String	2018-11-21T05:10:00Z	インスタンスが作成された時間。時刻形式：yyyy-MM-ddTHH:mmZ。
└CurrentKernelVersion	String	mongodb_20180914_1.1.5	インスタンスの現行データベースのマイナーバージョン番号。
└DBInstanceClass	String	dds.mongo.mid	インスタンスの種類。
└DBInstanceDescription	String	test	インスタンスの名前。
└DBInstanceId	String	dds-bpxxxxxxxx	インスタンス ID。
└DBInstanceStatus	String	Running	インスタンスの状態。詳細は、インスタンスタイプをご参照ください。
└DBInstanceStorage	Integer	10	インスタンスのストレージスペース。
└DBInstanceType	String	replicate	インスタンスの種類 replicate ：レプリカセットインスタンス sharding ：シャードクラスターインスタンス
└Engine	String	MongoDB	データベースのエンジン。
└EngineVersion	String	3.4	データベースのバージョン番号。
└ExpireTime	String	2019-04-08T16:00Z	サブスクリプションインスタンスの有効期限。説明このパラメーターは、インスタンスの課金方法がサブスクリプションの場合に返されます。
└LastDowngradeTime	String	2019-03-08	インスタンスが最後にダウングレードされた時間。
└LockMode	String	Unlock	インスタンスのロック状態。 Unlock ：インスタンスはロックされていません。 ManualLock：インスタンスは手動でロックされています。 LockByExpiration：有効期限が切れたため、インスタンスはロックされています。 LockByRestoration ：インスタンスは、インスタンスのロールバックの前にロックされています。 LockByDiskQuota：インスタンスは、容量がいっぱいのためロックされています。 Released: インスタンスが解放されました。インスタンスが解放された状態の場合、ロックを解除できません。新しいインスタンスを作成するには、バックアップデータを使用する必要があります。新しいインスタンスの作成には時間がかかる場合があります。
└MaintainEndTime	String	03:00Z	インスタンスメンテナンス期間の終了時刻。
StartMaintainStartTime	String	02:00Z	インスタンスメンテナンス期間の開始時刻。
└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	インスタンスのネットワークタイプ。有効値： Classic 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	ノードのネットワークタイプ。有効値： Classic VPC
└ReplicaSetRole	String	Primary	ノードのロール。 Primary Secondary
└VPCCloudInstanceId	String	vpc-xxxxxxxx	VPC インスタンスの ID。
└VPCId	String	vpc-bpxxxxxxxx	インスタンスが属する VPC の ID。
└VSwitchId	String	vsw-bpxxxxxxxx	ノードが属する VPC の VSwitch ID。
└ReplicationFactor	String	3	インスタンス内のノード数。説明インスタンスタイプがレプリカセットである場合、このパラメータが返されます。
└ResourceGroupId	String	rg-axxxxxxxx	インスタンスが属するリソースグループの ID。
└ShardList			シャード情報のリスト。説明インスタンスタイプがシャードクラスタである場合、このパラメータが返されます。
└NodeClass	String	dds.shard.mid	シャードのインスタンスタイプ。
└NodeDescription	String	testshard	シャードの名前。
└NodeId	String	d-bpxxxxxxxx	タスクの ID。
└NodeStorage	Integer	10	シャードのストレージスペース。
└Tags			インスタンスタグのリスト。
└Key	String	test	インスタンスタグのキー。
└Value	String	api	インスタンスタグの値。
└VPCId	String	vpc-bpxxxxxxxx	VPC の ID。
└VSwitchId	String	vsw-bpxxxxxxxx	VPC の VSwitch ID。
└VpcAuthMode	String	Open	VPC 内のパスワードなしアクセスモード。有効値： Open ：パスワードなしが有効になっています。 Close ：パスワードなしが無効になっています。 NotSupport ：パスワードなしがサポートされていません。
└ZoneId	String	cn-hangzhou-d	インスタンスが属するゾーン ID

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=DescribeDBInstanceAttribute
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

通常のレスポンスの例

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>Test database</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":"Test database",
				"DBInstanceStorage":10,
				"CreationTime":"2019-04-23T03:52:01Z",
				"Tags":{
					"Tag":[]
				},
				"RegionId":"cn-hangzhou",
				"StorageEngine":"WiredTiger",
				"ShardList":{
					"ShardAttribute":[]
				},
				"ReplicaSetName":"mgset-xxxxxxxx"
			}
		]
	}
}

エラーコード

エラーコードの表示