MongoDB シャード＆Config ノードのプライベートエンドポイント有効化 - MongoDB

操作説明

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

説明

割り当てられたエンドポイントは、内部アクセスにのみ使用できます。インターネット経由でアクセスするには、AllocatePublicNetworkAddress 操作を呼び出してパブリックエンドポイントを申請する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:AllocateNodePrivateNetworkAddress

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ZoneId	string	任意	インスタンスが属するゾーンの ID。説明 DescribeDBInstanceAttribute 操作を呼び出して、インスタンスのゾーン ID をクエリできます。	cn-hangzhou-b
DBInstanceId	string	必須	シャードクラスターインスタンスの ID。	dds-bp1fa5efaa93****
NodeId	string	必須	シャードノードまたは ConfigServer ノードの ID。説明 DescribeDBInstanceAttribute 操作を呼び出して、シャードノードまたは ConfigServer ノードの ID をクエリできます。	d-bp124beeb0ac****
AccountName	string	任意	アカウントのユーザー名。説明ユーザー名は 4～16 文字で、小文字、数字、アンダースコア (_) を使用できます。ユーザー名は小文字で始まる必要があります。シャードノードまたは ConfigServer ノードのエンドポイントを初めて申請する場合にのみ、アカウントとパスワードを設定する必要があります。アカウントとパスワードは、すべてのシャードノードと ConfigServer ノードで必須です。このアカウントの権限は読み取り専用に固定されています。	shardcsaccount
AccountPassword	string	任意	アカウントのパスワード。パスワードには、大文字、小文字、数字、特殊文字の 4 種類のうち、3 種類以上を含める必要があります。特殊文字には、`! # $ % ^ & * ( ) _ + - =` が含まれます。パスワードの長さは 8～32 文字である必要があります。	Test123456

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	60EEBD77-227C-5B39-86EA-D89163C5****

例

成功レスポンス

JSONJSON

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidAccountName.Forbid	Specified account name is a keyword.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。