すべてのプロダクト
Search
ドキュメントセンター

:ModifyDBInstanceSpec

最終更新日:Dec 16, 2025

ApsaraDB for MongoDB のスタンドアロンインスタンス、レプリカセットインスタンス、またはサーバーレスインスタンスのインスタンスタイプまたはストレージ容量を変更します。サーバーレスインスタンスは Alibaba Cloud China Website (www.aliyun.com) でのみ利用可能です。

操作説明

この操作を呼び出す前に、ApsaraDB for MongoDB の課金方法と料金を理解していることを確認してください。

この操作は、ApsaraDB for MongoDB のスタンドアロンインスタンスおよびレプリカセットインスタンスにのみ適用されます。シャードクラスターインスタンスの構成を変更するには、ModifyNodeSpecCreateNodeDeleteNode、または ModifyNodeSpecBatch 操作を呼び出します。

今すぐお試しください

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

update

*Instance

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBInstanceId

string

必須

インスタンス ID。

dds-bp1ea17b41ab****

DBInstanceClass

string

任意

インスタンスタイプ。詳細については、「インスタンスタイプ」をご参照ください。DescribeAvailableResource 操作を呼び出してインスタンスタイプをクエリすることもできます。

  • スタンドアロンインスタンスとレプリカセットインスタンスの場合、このパラメーターはインスタンスタイプを指定します。詳細については、「インスタンスタイプ」をご参照ください。DescribeAvailableResource 操作を呼び出して、スタンドアロンインスタンスとレプリカセットインスタンスのインスタンスタイプをクエリすることもできます。

  • サーバーレスインスタンスの場合、このパラメーターはコンピューティング性能を指定します。有効値:100~8000。

説明

このパラメーターと DBInstanceStorage パラメーターの少なくとも 1 つを指定する必要があります。

dds.sn4.xlarge.1

DBInstanceStorage

string

任意

インスタンスのストレージ容量。値は 10 GB から 3,000 GB の範囲である必要があります。ステップサイズは 10 GB です。特定の値はインスタンスタイプによって制約されます。詳細については、「インスタンスタイプ」をご参照ください。

説明
  • このパラメーターと DBInstanceClass パラメーターの少なくとも 1 つを指定する必要があります。

  • ストレージ容量を減らすことはできません。

50

OrderType

string

任意

構成変更のタイプ。有効値:

  • UPGRADE:インスタンスの構成をアップグレードします。これはデフォルト値です。

  • DOWNGRADE:インスタンスの構成をダウングレードします。

説明

このパラメーターは、サブスクリプションインスタンスでのみ使用できます。

UPGRADE

AutoPay

boolean

任意

インスタンスの自動支払いを有効にするかどうかを指定します。有効値:

  • true:自動支払いが有効になります。これはデフォルト値です。アカウントに十分な残高があることを確認してください。

  • false:手動支払いが必要です。注文の支払いを行うには、ApsaraDB for MongoDB コンソールにログインします。ページの右上隅で、[費用] > [費用とコスト] を選択します。左側のナビゲーションウィンドウで、[注文管理] をクリックします。[プロダクト注文] ページで注文を見つけ、支払いを完了します。

true

BusinessInfo

string

任意

ビジネス情報。

{“ActivityId":"000000000"}

ReplicationFactor

string

任意

インスタンス内のノード数。デフォルト値は 3 です。

  • レプリカセットインスタンスの場合、有効値は 357 です。

  • スタンドアロンインスタンスの場合、値は 1 に固定されます。

  • 共有ストレージを使用するレプリカセットインスタンス (Alibaba Cloud China Website (www.aliyun.com) でのみ利用可能) の場合、値は 2 に固定されます。

説明

サーバーレスインスタンスにはこのパラメーターを設定しないでください。サーバーレスインスタンスは Alibaba Cloud China Website (www.aliyun.com) でのみ利用可能です。

3

ReadonlyReplicas

string

任意

読み取り専用ノードの数。有効値:05

インスタンスがクラシックネットワークと VPC のみを使用して接続されている場合は、読み取り専用ノードの数を変更する前に、インターネットエンドポイントを有効にするか、クラシックネットワークエンドポイントをリリースしてください。

説明

ApsaraDB for MongoDB コンソールにログインし、[データベース接続] ページで有効になっているネットワークタイプを確認してください。

1

CouponNo

string

任意

クーポンを使用するかどうかを指定します。有効値:

  • default または null:クーポンを使用します。これはデフォルト値です。

  • youhuiquan_promotion_option_id_for_blank:クーポンを使用しません。

default

EffectiveTime

string

任意

構成変更が有効になる時間。有効値:

  • Immediately:変更はすぐに有効になります。これはデフォルト値です。

  • MaintainTime:変更はインスタンスの運用保守期間中に有効になります。

Immediately

ExtraParam

string

任意

追加パラメーター。有効値:

  • async:仕様変更の注文が作成された後に結果が返されます。

  • sync:インスタンスの仕様が変更された後に結果が返されます。

列挙値:

  • async :

    async

  • sync :

    sync

async

TargetZoneId

string

任意

インスタンスの移行先ゾーン。インスタンスの仕様を変更し、インスタンスをゾーン間で移行するときにこのパラメーターを指定します。

重要 このパラメーターはクラウドディスクインスタンスでのみ有効です。
重要 このパラメーターの値は、`TargetSecondaryZoneId` または `TargetHiddenZoneId` パラメーターの値と同じにすることはできません。

説明
  • このパラメーターは、インスタンスの仕様を変更し、インスタンスをゾーン間で移行する場合にのみ必要です。

  • 移行先ゾーンは、インスタンスの現在のゾーンと同じリージョンにある必要があります。

  • DescribeRegions 操作を呼び出してゾーン ID をクエリします。

cn-hangzhou-j

TargetSecondaryZoneId

string

任意

セカンダリノードの移行先ゾーン。インスタンスの仕様を変更し、インスタンスをゾーン間で移行するときにこのパラメーターを指定します。

重要 このパラメーターはクラウドディスクインスタンスでのみ有効です。
重要 このパラメーターの値は、`TargetZoneId` または `TargetHiddenZoneId` パラメーターの値と同じにすることはできません。

説明
  • このパラメーターは、インスタンスの仕様を変更し、インスタンスをゾーン間で移行する場合にのみ必要です。

  • このパラメーターは、マルチゾーン移行でのみ使用できます。

  • 移行先ゾーンは、インスタンスの現在のゾーンと同じリージョンにある必要があります。

  • DescribeRegions 操作を呼び出してゾーン ID をクエリします。

cn-hangzhou-h

TargetHiddenZoneId

string

任意

非表示ノードの移行先ゾーン。インスタンスの仕様を変更し、インスタンスをゾーン間で移行するときにこのパラメーターを指定します。

重要 このパラメーターはクラウドディスクインスタンスでのみ有効です。
重要 このパラメーターの値は、`TargetZoneId` または `TargetSecondaryZoneId` パラメーターの値と同じにすることはできません。

説明
  • このパラメーターは、インスタンスの仕様を変更し、インスタンスをゾーン間で移行する場合にのみ必要です。

  • このパラメーターは、マルチゾーン移行でのみ使用できます。

  • 移行先ゾーンは、インスタンスの現在のゾーンと同じリージョンにある必要があります。

  • DescribeRegions 操作を呼び出してゾーン ID をクエリします。

cn-hangzhou-i

TargetVswitchId

string

任意

移行先の vSwitch の ID。インスタンスの仕様を変更し、インスタンスをゾーン間で移行するときにこのパラメーターを指定します。

重要 このパラメーターはクラウドディスクインスタンスでのみ有効です。

説明
  • このパラメーターは、インスタンスの仕様を変更し、インスタンスをゾーン間で移行する場合にのみ必要です。

vsw-bp1buy0h9myt5i9e7****

SearchNodeClass

string

任意

検索ノードの仕様。

mdb.shard.2x.xlarge.d

SearchNodeStorage

integer

任意

検索ノードのストレージ容量。

20

SearchNodeCount

integer

任意

検索ノードの数。

2

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

1E9F1104-19E7-59F0-AB7F-F4EBFDEA****

OrderId

string

注文 ID。

21012408824****

成功レスポンス

JSONJSON

{
  "RequestId": "1E9F1104-19E7-59F0-AB7F-F4EBFDEA****",
  "OrderId": "21012408824****"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 MissingParameter The input parameters DBInstanceClass and DBInstanceStorage all blank or no change.
400 InvalidDBInstanceClass.ValueNotSupported The specified parameter DBInstanceClass is not valid.
400 InvalidDBInstanceStorage.ValueNotSupported The specified parameter DBInstanceStorage is not valid.
400 LX_REQUEST_TOKEN_CONFLICT The request token is conflict.
400 TradeConfirmPayError BIZ_ERROR - degrade refund error
400 PRICE.ORIGIN_PRICE_ERROR Origin lingxiao price request error.
400 ErrorInsufficientResource There is not enough resource for your operation, requestId: %s.
403 OperationDenied The resource is out of usage.
403 InvaildDBInstanceClassInRegion.NotAvailable The DBInstanceClass in the Region is not available.
404 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in our records.

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

変更履歴

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