この API を呼び出して、MongoDB インスタンスのロールおよび接続情報をクエリできます。

この API は、レプリカセットインスタンスとシャードクラスタインスタンスの両方をサポートします。 DescribeReplicaSetRole は、スタンドアロンインスタンスでは実行できません。

デバッグ

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

リクエストパラメータ

パラメータ データ型 必須 例 説明
Action String はい DescribeReplicaSetRole

実行する操作。 値を DescribeReplicaSetRole に設定します。

DBInstanceId String はい dds-bpxxxxxxxx

インスタンス ID。

AccessKeyId String いいえ LTAIgbTGpxxxxxx

Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメータ

パラメータ タイプ 例 説明
RequestId String DB4A0595-FCA9-437F-B2BB-25DBFC009D3E

リクエスト ID。

DBInstanceId String dds-bpxxxxxxxx

インスタンス ID。

ReplicaSets

レプリカセットのロール。

└ConnectionDomain String dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com

ノードの接続アドレス。

└ConnectionPort String 3717

ノードのポート。

└ExpiredTime String 1209582

クラシックネットワークアドレスの残り期間。 単位：秒

└NetworkType String VPC

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

  • VPC
  • Classic
  • Public
└ReplicaSetRole String Primary

レプリカセット内のノードのロール。

  • Primary
  • Secondary
└RoleId String 651xxxxx

ノードのロール ID。

例

リクエストの例


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

通常のレスポンスの例

XML 形式 

<DescribeReplicaSetRoleResponse>
  <RequestId>7762D0FF-F34D-4DAF-9D06-6C1C28CC98CD</RequestId> 
  <DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
  <ReplicaSets>
    <ReplicaSet>
      <NetworkType>Classic</NetworkType>
      <ConnectionPort>3717</ConnectionPort>
      <ReplicaSetRole>Primary</ReplicaSetRole>
      <ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
      <ExpiredTime>12xxxxx</ExpiredTime>
      <RoleId>55xxxxx</RoleId>
    </ReplicaSet>
    <ReplicaSet>
      <NetworkType>Classic</NetworkType>
      <ConnectionPort>3717</ConnectionPort>
      <ReplicaSetRole>Secondary</ReplicaSetRole>
      <ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
      <ExpiredTime>12xxxxx</ExpiredTime>
      <RoleId>55xxxxx</RoleId>
    </ReplicaSet>
    <ReplicaSet>
      <NetworkType>VPC</NetworkType>
      <ConnectionPort>3717</ConnectionPort>
      <ReplicaSetRole>Primary</ReplicaSetRole>
      <ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
      <RoleId>55xxxxx</RoleId>
    </ReplicaSet>
    <ReplicaSet>
      <NetworkType>VPC</NetworkType>
      <ConnectionPort>3717</ConnectionPort>
      <ReplicaSetRole>Secondary</ReplicaSetRole>
      <ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
      <RoleId>55xxxxx</RoleId>
    </ReplicaSet>
  </ReplicaSets>
</DescribeReplicaSetRoleResponse>

JSON 形式 

{
	"ReplicaSets":{
		"ReplicaSet":[
			{
				"NetworkType":"Classic",
				"ConnectionPort":"3717",
				"ReplicaSetRole":"Primary",
				"ConnectionDomain":"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
				"ExpiredTime":"12xxxxx",
				"RoleId":"55xxxxx"
			},
			{
				"NetworkType":"Classic",
				"ConnectionPort":"3717",
				"ReplicaSetRole":"Secondary",
				"ConnectionDomain":"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
				"ExpiredTime":"12xxxxx",
				"RoleId":"55xxxxx"
			},
			{
				"NetworkType":"VPC",
				"ConnectionPort":"3717",
				"ReplicaSetRole":"Primary",
				"ConnectionDomain":"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
				"RoleId":"55xxxxx"
			},
			{
				"NetworkType":"VPC",
				"ConnectionPort":"3717",
				"ReplicaSetRole":"Secondary",
				"ConnectionDomain":"dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
				"RoleId":"55xxxxx"
			}
		]
	},
	"DBInstanceId":"dds-bpxxxxxxxx",
	"RequestId":"7762D0FF-F34D-4DAF-9D06-6C1C28CC98CD"
}

エラーコード

エラーコードの表示