この API を呼び出して、ApsaraDB for MongoDB シャードクラスターインスタンスの接続情報をクエリできます。

この API は、シャードクラスターインスタンスのみをサポートします。

デバッグ

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

リクエストパラメータ

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

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

DBInstanceI String はい dds-bpxxxxxxxx

インスタンス ID。

NodeId String いいえ d-bpxxxxxxxx

特定のシャードクラスターインスタンス内の mongos または Shard の ID。

AccessKeyId String いいえ LTAIgbTGpxxxxxx

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

レスポンスパラメータ

パラメータ タイプ 例 説明
NetworkAddresses

インスタンス接続アドレスのリスト。

└ExpiredTime String 2591963

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

└IPAddress String 10.140.xxx.xx

IP アドレス。

└NetworkAddress String s-bpxxxxxxxx.mongodb.rds.aliyuncs.com

接続アドレス（文字列）。

└NetworkType String VPC

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

  • VPC
  • Classic
  • Public
└NodeId String s-bpxxxxxxxx

mongos の ID。

└Port String 3717

ポート番号。

└VPCId String vpc-bpxxxxxxxx

VPC の ID。

注 このパラメーターは、ネットワークタイプが VPC の場合に返されます。
└VswitchId String vsw-bpxxxxxxxx

VPC の VSwitch ID。

注 このパラメーターは、ネットワークタイプが VPC の場合に返されます。
RequestId String 18D8AAFD-6BEB-420F-8164-810CB0C0AA39

リクエスト ID。

例

リクエストの例


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

通常のレスポンスの例

XML 形式 

<DescribeShardingNetworkAddressResponse>
  <NetworkAddresses>
    <NetworkAddress>
      <NetworkType>VPC</NetworkType>
      <NodeId>s-bpxxxxxxxx</NodeId>
      <Port>3717</Port>
      <VPCId>vpc-bpxxxxxxxx</VPCId>
      <IPAddress>192.168.xxx.xx</IPAddress>
      <VswitchId>vsw-bpxxxxxxxx</VswitchId>
      <NetworkAddress>s-bp1xxxxxxxx.mongodb.rds.aliyuncs.com</NetworkAddress> 
    </NetworkAddress>
    <NetworkAddress>
      <NetworkType>VPC</NetworkType>
      <NodeId>s-bpxxxxxxxx</NodeId>
      <Port>3717</Port>
      <VPCId>vpc-bpxxxxxxxx</VPCId>
      <IPAddress>192.168.xxx.xx</IPAddress>
      <VswitchId>vsw-bpxxxxxxxx</VswitchId>
      <NetworkAddress>s-bpxxxxxxxx.mongodb.rds.aliyuncs.com</NetworkAddress>
    </NetworkAddress>
  </NetworkAddresses> 
  <RequestId>B4B78989-6D75-4930-BC26-635C3BB3A33B</RequestId> 
</DescribeShardingNetworkAddressResponse>

JSON 形式 

{
	"NetworkAddresses":{
		"NetworkAddress":[
			{
				"NetworkType":"VPC",
				"Port":"3717",
				"NodeId":"s-bpxxxxxxxx",
				"VPCId":"vpc-bpxxxxxxxx",
				"IPAddress":"192.168.xxx.xx",
				"NetworkAddress":"s-bp1xxxxxxxx.mongodb.rds.aliyuncs.com",
				"VswitchId":"vsw-bpxxxxxxxx"
			},
			{
				"NetworkType":"VPC",
				"Port":"3717",
				"NodeId":"s-bpxxxxxxxx",
				"VPCId":"vpc-bpxxxxxxxx",
				"IPAddress":"192.168.xxx.xx",
				"NetworkAddress":"s-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
				"VswitchId":"vsw-bpxxxxxxxx"
			}
		]
	},
	"RequestId":"B4B78989-6D75-4930-BC26-635C3BB3A33B"
}

エラーコード

エラーコードの表示