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

Tair (Redis® OSS-Compatible):ModifyInstanceSpec

最終更新日:Mar 30, 2026

Tair (Redis OSS-compatible) インスタンスの構成を変更します。

操作説明

説明

この操作の手順、影響、制限事項、および料金に関する詳細については、「インスタンスの構成変更」をご参照ください。

今すぐお試しください

この 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 に設定する必要があります。

  • 構成変更後にインスタンスの価格が上がった場合はスペックアップ、下がった場合はスペックダウンとなります。たとえば、5 台の読み取り専用レプリカを備えた 8 GB 読み書き分離インスタンスの価格は、16 GB クラスターインスタンスよりも高くなります。16 GB クラスターインスタンスを 5 台の読み取り専用レプリカを備えた 8 GB 読み書き分離インスタンスに変更する場合は、スペックアップが必要です。

列挙値:

  • DOWNGRADE :

    DOWNGRADE

  • UPGRADE :

    UPGRADE

DOWNGRADE

MajorVersion

string

任意

アップグレード対象のクラシックインスタンスのメジャーバージョンです。有効な値は 2.84.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 パラメーターの合計値は 4 を超えることはできません。

  • ReplicaCount または ReadOnlyCount のいずれか一方のみを指定できます。

  • マスターレプリカインスタンスには複数のレプリカノードを含めることはできません。

1

SlaveReplicaCount

integer

任意

複数ゾーンにデプロイされたクラウドネイティブマルチレプリカクラスターインスタンスを作成する際のセカンダリゾーン内のレプリカノード数です。このパラメーターと ReplicaCount パラメーターの合計値は 4 を超えることはできません。

説明

複数ゾーンにデプロイされたクラウドネイティブマルチレプリカクラスターインスタンスを作成する場合は、SlaveReplicaCount と SecondaryZoneId の両方を指定する必要があります。

1

ReadOnlyCount

integer

任意

プライマリゾーン内の読み取り専用レプリカの数です。有効な値は 0 ~ 5 です。このパラメーターは次のシナリオにのみ適用されます。

  • インスタンスがクラウドネイティブスタンダードインスタンスの場合、このパラメーターを 0 より大きい値に設定することで、読み書き分離アーキテクチャを有効にできます。

  • インスタンスがクラウドネイティブ読み書き分離インスタンスの場合、このパラメーターを使用して読み取り専用レプリカの数をカスタマイズできます。また、このパラメーターを 0 に設定することで、読み書き分離アーキテクチャを無効にしてスタンダードアーキテクチャに切り替えることもできます。

5

SlaveReadOnlyCount

integer

任意

複数ゾーンにデプロイされた読み書き分離インスタンスを作成する際のセカンダリゾーン内の読み取り専用レプリカの数です。有効な値は 1 ~ 9 です。このパラメーターと ReadOnlyCount パラメーターの合計値は 9 を超えることはできません。

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_pl1essd_pl2、および essd_pl3 です。

説明

このパラメーターは、InstanceType パラメーターを tair_essd に設定して ESSD ベースのインスタンスを作成する場合にのみ必要です。

essd_pl1

Storage

integer

任意

ESSD/SSD ベースのインスタンスのストレージ容量です。有効な値はインスタンスタイプによって異なります。詳細については、「ESSD/SSD ベースのインスタンス」をご参照ください。

説明

このパラメーターは、InstanceType パラメーターを tair_essd に設定して ESSD ベースのインスタンスを作成する場合にのみ必要です。Tair SSD ベースのインスタンスを作成する場合は、Storage パラメーターは定義済みの仕様に基づいて自動的に設定されるため、指定する必要はありません。

60

レスポンスフィールド

フィールド

説明

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.

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

変更履歴

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