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

注 詳細については、「 View the zone of a node」をご参照ください 。

この API はレプリカセットインスタンスとシャードクラスタインスタンスに対して使用できますが、スタンドアロンインスタンスでは使用できません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この API は、OpenAPI Explorerで呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK に用意されている API のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター タイプ 必須/任意 例 説明
DBInstanceId String 必須 dds-bpxxxxxxxx

インスタンスの ID。
Action String 任意 DescribeRoleZoneInfo

実行する API (DescribeRegions) を設定します。

AccessKeyId String 任意 LTAIgbTGpxxxxxx

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

レスポンスパラメーター

Parameter データ型 例 説明
RequestId String 728B9A96-E262-4AE5-915E-3A51CCE2FDA9

リクエストの ID。
ZoneInfos

ゾーン内のノードの分散。
InsName String dds-bpxxxxxxxx

ノードの ID。
NodeType String normal

ノードの種類。 有効値：

  • normal
  • configServer
  • shard
  • mongos
注 レプリカセットインスタンスの有効値は normal です。 レプリカセットインスタンスの有効値は、 configServer 、shard、およびmongos です。
RoleId String 83xxxxx

ロールの名前。
RoleType String Primary

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

  • Primary
  • Secondary
  • Hidden
ZoneId String cn-hangzhou

ノードのロール ID。

コーディング例

例


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

通常のレスポンス例

XML 形式 

<DescribeRoleZoneInfoResponse>
	  <ZoneInfos>
		    <ZoneInfo>
			      <RoleType>Primary</RoleType>
			      <Type>Normal</Type>
			      <InsName>dds-bpxxxxxxxx</InsName>
			      <ZoneId>cn-hangzhou-e</ZoneId>
			      <RoleId>83xxxxx</RoleId>
		    </ZoneInfo>
		    <ZoneInfo>
			      <RoleType>Secondary</RoleType>
			      <NodeType>normal</NodeType>
			      <InsName>dds-bpxxxxxxxx</InsName>
			      <ZoneId>cn-hangzhou-f</ZoneId>
			      <RoleId>55xxxxx</RoleId>
		    </ZoneInfo>
		    <ZoneInfo>
			      <RoleType>Hidden</RoleType>
			      <NodeType>normal</NodeType>
			      <InsName>dds-bpxxxxxxxx</InsName>
			      <ZoneId>cn-hangzhou-b</ZoneId>
			      <RoleId>83xxxxx</RoleId>
		    </ZoneInfo>
	  </ZoneInfos>
	  <RequestId>728B9A96-E262-4AE5-915E-3A51CCE2FDA9</RequestId>
</DescribeRoleZoneInfoResponse>

JSON 形式 

{
	"ZoneInfos":{
		"ZoneInfo":[
			{
				"NodeType":"normal",
				"RoleType":"Primary",
				"InsName":"dds-bpxxxxxxxx",
				"ZoneId":"cn-hangzhou-e",
				"RoleId":"83xxxxx"
			},
			{
				"NodeType":"normal",
				"RoleType":"Secondary",
				"InsName":"dds-bpxxxxxxxx",
				"ZoneId":"cn-hangzhou-f",
				"RoleId":"83xxxxx"
			},
			{
				"NodeType":"normal",
				"RoleType":"Hidden",
				"InsName":"dds-bpxxxxxxxx",
				"ZoneId":"cn-hangzhou-b",
				"RoleId":"83xxxxx"
			}
		]
	},
	"RequestId":"728B9A96-E262-4AE5-915E-3A51CCE2FDA9"
}

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。