この API は、MongoDB インスタンス名を変更する場合に呼び出すことができます。

デバッグ

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

リクエストパラメータ

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

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

DBInstanceDescription String はい testdata

インスタンスの名前。

  • 先頭文字列を http:// または https:// にすることはできません。
  • 先頭は文字である必要があります。
  • 文字、アンダースコア(_)、ハイフン(-)、および数字を含めることができます。 長さは 2 ~ 256 文字である必要があります。
DBInstanceId String はい dds-bpxxxxxxxx

インスタンス ID。

NodeId は、レプリカセットインスタンスの shard または mongos ノードの名前を変更する必要がある場合、 指定する必要があります。
NodeId String いいえ d-bpxxxxxxxx

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

このパラメーターは、DBInstanceId がシャードクラスターインスタンスのIDである場合にのみ使用できます。
AccessKeyId String いいえ LTAIgbTGpxxxxxx

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

レスポンスパラメータ

パラメータ タイプ 説明
RequestId String 06F8F642-4009-4FFC-80C4-9D67DBF7B74E

リクエスト ID。

リクエストの例


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

通常のレスポンスの例

XML 形式

<ModifyDBInstanceDescriptionResponse> 
  <RequestId>06F8F642-4009-4FFC-80C4-9D67DBF7B74E</RequestId> 
</ModifyDBInstanceDescriptionResponse>

JSON 形式

{
	"RequestId":"06F8F642-4009-4FFC-80C4-9D67DBF7B74E"
}

エラーコード

エラーコードの表示