ModifyInstanceSpec - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

ApsaraDB for Tair (Redis® OSS 互換) データベースインスタンスの仕様を変更します。

操作説明

説明

仕様変更の実行プロセス、影響、特徴の制限、課金に関する詳細については、「インスタンス設定の変更」を参照してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:ModifyInstanceSpec

update

*DBInstance。

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。利用可能なリージョンをクエリするには、 DescribeRegions を呼び出します。このパラメーターを使用して、仕様を変更するインスタンスのリージョンを指定します。	cn-hangzhou
InstanceId	string	必須	インスタンスの ID。インスタンス ID をクエリするには、 DescribeInstances を呼び出します。	r-bp1zxszhcgatnx****
InstanceClass	string	任意	新しいインスタンスタイプ。インスタンスが存在するゾーンで仕様変更に使用できるインスタンスタイプをクエリするには、 DescribeAvailableResource を呼び出します。説明インスタンスタイプの詳細については、「インスタンスタイプナビゲーション」を参照してください。	redis.master.small.default
BusinessInfo	string	任意	アクティビティ ID およびビジネス情報。	000000001
CouponNo	string	任意	クーポンコード。デフォルト値: `youhuiquan_promotion_option_id_for_blank`。	youhuiquan_promotion_option_id_for_blank
ForceUpgrade	boolean	任意	強制的に仕様を変更するかどうかを指定します。有効な値: false: 仕様を強制変更しません。 true: 仕様を強制変更します。これがデフォルト値です。	true
EffectiveTime	string	任意	仕様変更が効果を持つ時間。有効な値: Immediately: 仕様変更は直ちに有効になります。これがデフォルト値です。 MaintainTime: 仕様変更はインスタンスのメンテナンスウィンドウ中に有効になります。メンテナンスウィンドウを変更するには、 ModifyInstanceMaintainTime を呼び出します。	Immediately
AutoPay	boolean	任意	自動支払いを有効にするかどうかを指定します。有効な値: true: 自動支払いが有効です。これがデフォルト値です。 false: 自動支払いが無効です。このパラメーターを false に設定した場合、コンソールでインスタンスの有効期限切れ前に手動更新する必要があります。詳細については、「手動更新」を参照してください。	true
OrderType	string	任意	仕様変更のタイプ。サブスクリプションインスタンスの仕様を変更する場合、このパラメーターは必須です。有効な値: UPGRADE: スペックアップ。これがデフォルト値です。 DOWNGRADE: スペックダウン。説明サブスクリプションインスタンスをスペックダウンする場合は、このパラメーターを DOWNGRADE に設定する必要があります。ターゲットインスタンスタイプの価格が現在のインスタンスタイプの価格より高い場合、変更はスペックアップとなります。それ以外の場合、変更はスペックダウンとなります。たとえば、読み書き分離 8 GB エディション (読み取り専用ノード 5 個) の価格は 16 GB クラスターエディションの価格より高いため、後者から前者への変更はスペックアップとなります。列挙値: DOWNGRADE : DOWNGRADE。 UPGRADE : UPGRADE。	DOWNGRADE
MajorVersion	string	任意	クラシックインスタンスをスペックアップするためのメジャーエンジンバージョン。有効な値: 2.8、4.0、5.0。説明バージョンをスペックアップする場合、InstanceClass パラメーターは必須です。これは、この操作がインスタンスの仕様変更と同時に行う場合にのみバージョンのスペックアップをサポートすることを示しています。インスタンスのバージョンのみをスペックアップする場合は、 ModifyInstanceMajorVersion を呼び出してください。	5.0
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字を超えることはできません。	ETnLKlblzczshOTUbOCz****
SourceBiz	string	任意	リクエストのソース。このパラメーターは内部メンテナンス専用であり、指定する必要はありません。	SDK
ShardCount	integer	任意	シャードの数。このパラメーターはクラウドネイティブクラスターインスタンスにのみ適用されます。このパラメーターを使用して、カスタムのシャード数をセットできます。説明クラウドネイティブクラスターインスタンスを標準アーキテクチャに変更するには、ShardCount を 1 にセットし、インスタンスタイプをスタンダードインスタンスタイプにセットします。クラウドネイティブスタンダードインスタンスをクラスタアーキテクチャに変更するには、ShardCount を 1 より大きい値にセットし、インスタンスタイプをクラスターインスタンスタイプにセットします。	8
ReplicaCount	integer	任意	プライマリゾーンのレプリカノードの数。このパラメーターはクラウドネイティブクラスターマルチレプリカインスタンスにのみ適用されます。このパラメーターを使用して、カスタムのレプリカノード数を指定できます。有効な値: 1～4。説明マルチゾーンインスタンスの場合、このパラメーターを SlaveReplicaCount パラメーターと一緒に使用して、プライマリゾーンおよびセカンダリゾーンのレプリカノード数を指定できます。このパラメーターと SlaveReplicaCount パラメーターの合計は 4 を超えることはできません。	1
SlaveReplicaCount	integer	任意	セカンダリゾーンのレプリカノードの数。	1
ReadOnlyCount	integer	任意	プライマリゾーンの読み取り専用ノードの数。このパラメーターはクラウドネイティブ読み書き分離インスタンスにのみ適用されます。標準アーキテクチャインスタンスの場合、有効な値は 0～9 です。値 0 は読み書き分離がシャットダウンされ、インスタンスが標準アーキテクチャに切り替わることを示します。クラスターアーキテクチャインスタンスの場合、有効な値は 1～4 で、データシャードあたりの読み取り専用ノード数を指定します。説明マルチゾーンインスタンスの場合、このパラメーターを SlaveReadOnlyCount パラメーターと一緒に使用して、プライマリゾーンおよびセカンダリゾーンの読み取り専用ノード数を指定できます。標準アーキテクチャインスタンスの場合、このパラメーターと SlaveReadOnlyCount の合計は 9 を超えることはできません。クラスターアーキテクチャインスタンスの場合、このパラメーターと SlaveReadOnlyCount の合計は 4 を超えることはできません。	5
SlaveReadOnlyCount	integer	任意	セカンダリゾーンの読み取り専用ノードの数。	2
ForceTrans	boolean	任意	強制転送を有効にするかどうかを指定します。有効な値: false (デフォルト): 仕様変更の前に、システムはインスタンスの現在のマイナーエンジンバージョンを確認します。マイナーエンジンバージョンが古すぎる場合、エラーが返されます。マイナーエンジンバージョンをスペックアップしてリトライする必要があります。 true: チェックをスキップし、仕様変更操作を直接実行します。	false
NodeType	string	任意	ノードタイプ。有効な値: MASTER_SLAVE: 高可用性 (デュアルレプリカ) STAND_ALONE: シングルレプリカ double: デュアルレプリカ single: シングルレプリカ説明クラウドネイティブインスタンスの場合は、MASTER_SLAVE または STAND_ALONE を選択します。クラシックインスタンスの場合は、double または single を選択します。	MASTER_SLAVE
StorageType	string	任意	ストレージタイプ。有効な値: essd_pl1、essd_pl2、essd_pl3。説明このパラメーターは、InstanceType が tair_essd に設定されており、インスタンスが Tair ESSD ベースのクラウドディスクインスタンスである場合にのみ必須です。	essd_pl1
Storage	integer	任意	クラウドディスクインスタンスのストレージ容量。有効な値はインスタンスタイプによって異なります。詳細については、「クラウドディスクベースのインスタンスタイプ」を参照してください。説明このパラメーターは、InstanceType が tair_essd に設定されており、Tair ESSD ベースのクラウドディスクインスタンスを作成している場合にのみ必須です。Tair SSD ベースのクラウドディスクインスタンスの場合、ストレージ容量はインスタンスタイプに基づく固定値であるため、このパラメーターを指定する必要はありません。	60
SecondaryZoneId	string	任意	セカンダリゾーンの ID。シングルゾーンインスタンスの仕様を変更してマルチゾーン Deployment に移行する場合、このパラメーターは必須です。利用可能なゾーンをクエリするには、 DescribeZones を呼び出します。説明このパラメーターの値は ZoneId パラメーターの値と異なる必要があります。このパラメーターをマルチゾーンの ID にセットしないでください。	cn-hangzhou-h

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
OrderId	string	注文 ID。	20722623431****
RequestId	string	リクエスト ID。	0DA1D7EF-C80D-432C-8758-7D225182626B

例

成功レスポンス

JSONJSON

{
  "OrderId": "20722623431****",
  "RequestId": "0DA1D7EF-C80D-432C-8758-7D225182626B"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	PaymentMethodNotFound	No payment method has been registered on the account.
400	HasRenewChangeOrder	This instance has a renewChange order.
400	%s	Warn: {%s} are not supported after upgraded. you can set forceUpgrade=true to force upgrade.
400	GdcInstanceNotSupport	The gdc custins trans not support.
400	AbnormalResourceStatusForRenew	Abnormal resource status for renew.
400	MissingRedisShardingUnsupportPerfItem	The metadb is missing redis sharding unsupoort command perf item.
400	IllegalParamError	Action or resource must not be null.
400	IncorrectTargetMajorVersion	Current target majorversion does not support this operation.
400	IncorrectMinorVersion	Current engine minor version does not support operations.
400	DirectTargetLevelNotSupport	The direct custins tranfer target instance level does not support.
400	DirectTransPreCheckError	The direct custins trans pre check IsAddReduceNodes error.
400	DtsOpendNotSupportTrans	The custins DtsSyncStatus opend does not support trans.
400	DirectTransNodeDoubleLevelError	The direct custins tranfer node double target level error.
400	DirectTransUpgradeMajorVersionNotSupport	The direct custins tranfer does not support upgrade major version.
403	TargetMemoryLessThanCurrentUsed	The target instance memory size below the current instance used memory.

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

変更履歴

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