CreateNode によるシャードクラスターへのシャードまたは Mongos ノードの追加 - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

ApsaraDB for MongoDB のシャードクラスターインスタンスにシャードノードまたは mongos ノードを追加します。

操作説明

この API を呼び出す前に、ApsaraDB for MongoDB の課金方法と料金についてご確認ください。

この API はシャードクラスターインスタンスにのみ適用されます。

今すぐお試しください

この 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:CreateNode

create

*dbinstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	シャードクラスターインスタンスの ID を指定します。	dds-bp11501cd7b5****
NodeClass	string	必須	シャードまたは mongos ノードのインスタンスタイプを指定します。詳細については、「シャードクラスターインスタンスタイプ」をご参照ください。	dds.shard.mid
NodeStorage	integer	任意	ノードのストレージ容量を指定します。単位： GB。このパラメータの有効な値は、インスタンスのストレージタイプによって異なります。詳細については、「シャードクラスターインスタンスタイプ」をご参照ください。説明ノードタイプが shard の場合、このパラメータは必須です。	20
NodeType	string	必須	ノードタイプを指定します。有効な値： shard：シャードノード。 mongos： mongos ノード。	shard
ClientToken	string	任意	リクエストのべき等性を保証するために、クライアントが生成するクライアントトークンを指定します。トークンは、リクエスト間で一意であり、ASCII 文字のみを含み、かつ 64 文字以内でなければなりません。	ETnLKlblzczshOTUbOCz****
AutoPay	boolean	任意	自動支払いを有効にするかどうかを指定します。有効な値： true： (デフォルト) 自動支払いを有効にします。アカウントに十分な残高があることを確認してください。 false：自動支払いを無効にします。この場合、ノードの料金を手動で支払う必要があります。支払いを行うには、ApsaraDB for MongoDB コンソールにログインします。ページの右上隅で、[課金] > [課金管理] を選択します。左側のナビゲーションペインで、 [注文管理] をクリックします。[製品注文] ページで、注文を見つけて支払いを完了します。説明サブスクリプションインスタンスの場合、このパラメータは必須です。	true
ReadonlyReplicas	integer	任意	シャードノード内の読み取り専用ノードの数を指定します。有効値： 0～5。デフォルト値は 0 です。説明このパラメータは、中国サイト (aliyun.com) でのみ利用可能です。	5
BusinessInfo	string	任意	追加のビジネス情報を指定します。	{“ActivityId":"000000000"}
CouponNo	string	任意	クーポンを使用するかどうかを指定します。有効な値： default または null： (デフォルト) 利用可能なクーポンが自動的に適用されます。 youhuiquan_promotion_option_id_for_blank：クーポンを使用しません。	default
ShardDirect	boolean	任意	シャードノードのパブリックエンドポイントを有効にするかどうかを指定します。有効な値： true：シャードノードのパブリックエンドポイントを有効にします。 false： (デフォルト) シャードノードのパブリックエンドポイントを有効にしません。	false
AccountName	string	任意	アカウント名を指定します。アカウント名は次の要件を満たす必要があります：小文字で始まる必要があります。小文字、数字、アンダースコア (_) のみで構成されている必要があります。 4 ～ 16 文字である必要があります。説明 ApsaraDB for MongoDB のキーワードをアカウント名として使用することはできません。アカウントには読み取り専用権限があります。シャードノードのパブリックエンドポイントを初めて有効にする場合にのみ、アカウント名とパスワードを設定する必要があります。以降のリクエストでは、これらのパラメータは不要です。	ceshi
AccountPassword	string	任意	アカウントのパスワードを指定します。パスワードは次の要件を満たす必要があります：大文字、小文字、数字、特殊文字のうち、少なくとも 3 種類の文字を含む必要があります。特殊文字には `!@#$%^&*()_+-=` が含まれます。 8 ～ 32 文字である必要があります。説明 ApsaraDB for MongoDB は、シャードノードのアカウントパスワードのリセットをサポートしていません。	123+abc

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメータ。
RequestId	string	リクエスト ID。	7D48FB19-20CA-4725-A870-3D8F5CE6****
NodeId	string	ノード ID。	d-bp1b234bf7a4****
OrderId	string	注文 ID。	20951063702****

例

成功レスポンス

JSONJSON

{
  "RequestId": "7D48FB19-20CA-4725-A870-3D8F5CE6****",
  "NodeId": "d-bp1b234bf7a4****",
  "OrderId": "20951063702****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	SSLNotSupportAddNode	Instance with SSL certificate can't add node, please contact us to solve this problem.
400	ErrorInsufficientResource	There is not enough resource for your operation, requestId: %s.

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

変更履歴

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