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

今すぐお試しください

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

update

*DBInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TargetNetworkType	string	任意	切り替えるネットワークタイプを指定します。VPC ネットワークへ切り替える場合は、値を VPC に設定します。	VPC
VpcId	string	任意	切り替える先の VPC の ID を指定します。VPC ID を照会するには、DescribeVpcs 操作を呼び出します。説明 VPC とインスタンスは、同一リージョンにデプロイされている必要があります。このパラメーターを設定した場合は、VSwitchId パラメーターも併せて設定する必要があります。	vpc-bp1nme44gek34slfc****
VSwitchId	string	任意	切り替える先の VPC に属する vSwitch の ID を指定します。vSwitch ID を照会するには、DescribeVpcs 操作を呼び出します。説明 vSwitch とインスタンスは、同一ゾーンにデプロイされている必要があります。	vsw-bp1e7clcw529l773d****
InstanceId	string	必須	インスタンスの ID を指定します。インスタンス ID を照会するには、DescribeInstances 操作を呼び出します。	r-bp1zxszhcgatnx****
RetainClassic	string	任意	クラシックネットワークから VPC へ切り替えた後、元のクラシックネットワークエンドポイントを保持するかどうかを指定します。デフォルト値は False です。有効な値は以下のとおりです。 True：クラシックネットワークエンドポイントを保持します。 False：クラシックネットワークエンドポイントを保持しません。説明このパラメーターは、インスタンスのネットワークタイプがクラシックネットワークの場合のみ使用可能です。	True
ClassicExpiredDays	string	任意	クラシックネットワークエンドポイントの保持期間を指定します。有効な値は 14、30、60、120 です。単位は日です。説明このパラメーターは、RetainClassic パラメーターを True に設定した場合にのみ使用可能であり、その場合に必須となります。スイッチオーバー操作を完了した後でも、ModifyInstanceNetExpireTime 操作を呼び出して、クラシックネットワークエンドポイントの保持期間を変更できます。	30

レスポンスフィールド

フィールド	型	説明	例
	object
TaskId	string	タスクの ID を示します。	578678678
RequestId	string	リクエストの ID を示します。	F0997EE8-F4C2-4503-9168-85177ED78C70

例

成功レスポンス

JSONJSON

{
  "TaskId": "578678678",
  "RequestId": "F0997EE8-F4C2-4503-9168-85177ED78C70"
}

エラーレスポンス

JSONJSON

{
    "TaskId":"578678678",
    "requestId":"F0997EE8-F4C2-4503-9168-85177ED78C70"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidToken.Malformed	The Specified parameter Token is not valid.
400	VpcServiceError	Invoke vpc service failed.
400	IzNotSupportVpcError	Specify iz not support vpc.
400	IzNotSupportSwitchNetworkError	Specify iz not support switch network.
400	VpcVerifyError	VpcId is wrong.
400	VpcAndVSwitchNotChange	VpcId and vSwitchId not change.
403	ResourceAlreadyExists	Resource already exists.
403	InsufficientResourceCapacity	ip resource is conflict with other custins.
403	VpcFreePasswordNoSupport	The custins opend VPCFreePassword not support this operation.

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

変更履歴

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