この操作を呼び出して、ApsaraDB for MongoDB シャードクラスターインスタンスのシャードまたは Configserver ノードのイントラネットエンドポイントを申請できます。

この API は、シャードクラスターインスタンスにのみ適用されます。 詳細については、「シャードまたは Configserver ノードのエンドポイントの申請」をご参照ください。

注 リクエストされたエンドポイントには、イントラネット経由でのみアクセスできます。 インターネット経由でエンドポイントにアクセスする場合は、AllocatePublicNetworkAddress 操作を呼び出して、インターネットエンドポイントを申請してください。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須項目 例 説明
DBInstanceId String 必須 dds-bpxxxxxxxx

シャードクラスターインスタンスの ID。
NodeId String 必須 d-bpxxxxxxxx

シャードまたは Configserver ノードの ID。

注 DescribeDBInstanceAttribute 操作を呼び出して、シャードまたは Configserver ノードの ID を照会できます。
Action String 必須 AllocateNodePrivateNetworkAddress

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

ZoneId String 任意 cn-hangzhou-d

インスタンスのゾーン ID。

注 DescribeDBInstanceAttribute 操作を呼び出して、インスタンスのゾーン ID を照会できます。
AccountName String 任意 shardcsaccount

アカウントの名前。

注
  • アカウント名は 4〜16 文字で、英小文字、数字、およびアンダースコア (_) を使用できます。 また、英小文字で始める必要があります。
  • アカウントとパスワードを設定する必要があるのは、シャードまたは Configserver ノードのエンドポイントを初めて申請する場合のみです。 アカウントとパスワードは、すべてのシャードおよび Configserver ノードに必要です。
  • このアカウントの権限は読み取り専用に固定されています。
AccountPassword String 任意 Test123456

アカウントのパスワード。

  • パスワードには、大文字、小文字、数字、特殊文字の少なくとも 3 種類の文字が含まれる必要があります。 特殊文字：! # $ % ^ & * ( ) _ + - =
  • パスワードの長さは 8 文字から 32 文字とする必要があります。
AccessKeyId String 任意 LTAIgbTGpxxxxxx

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

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String EFD65226-08CC-4C4D-B6A4-CB3C382F67B0

リクエストの ID。

例

リクエストの例


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

通常のレスポンス例

XML 形式 

<AllocateNodePrivateNetworkAddressResponse>
	  <RequestId>EFD65226-08CC-4C4D-B6A4-CB3C382F67B0</RequestId>
</AllocateNodePrivateNetworkAddressResponse>

JSON 形式 

{
	"RequestId":"0FDDC511-7252-4A4A-ADDA-5CB1BF63873D"
}

エラーコード

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