ModifyDBClusterPrimaryZone API でプライマリゾーンを変更 - PolarDB

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:ModifyDBClusterPrimaryZone

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。説明 DescribeDBClusters 操作を呼び出すと、ターゲットリージョン内のすべてのクラスターの詳細 (クラスター ID を含む) をクエリできます。	pc-**************
ZoneId	string	必須	新しいゾーンの ID。説明 DescribeRegions 操作を呼び出すと、利用可能なゾーンをクエリできます。	cn-hangzhou-g
ZoneType	string	任意	ゾーンのタイプ。有効な値： Primary：プライマリゾーン。 Standby：セカンダリゾーン。	Primary
VSwitchId	string	任意	ターゲットゾーンの vSwitch ID。説明このパラメーターは、PolarDB for Oracle および PolarDB for PostgreSQL クラスターで必須です。 PolarDB for MySQL クラスターの場合、ターゲットゾーンに vSwitch が作成されていれば、このパラメーターは必須です。vSwitch が作成されていない場合は、デフォルトの vSwitch が使用されるため、このパラメーターはオプションです。	vsw-**************
IsSwitchOverForDisaster	string	任意	元のゾーンにフェイルバックするかどうかを指定します。有効な値： true：元のゾーンにフェイルバックします。 false：元のゾーンにフェイルバックしません。	false
PlannedStartTime	string	任意	ゾーンを変更するスケジュールされたタスクを開始する最も早い時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で指定します。時刻は UTC である必要があります。説明開始時刻は、今後 24 時間以内の時刻である必要があります。たとえば、現在時刻が `2021-01-14T09:00:00Z` の場合、開始時刻は `2021-01-14T09:00:00Z` から `2021-01-15T09:00:00Z` までの値に設定できます。このパラメーターを指定しない場合、ゾーン変更タスクはすぐに実行されます。	2021-01-14T09:00:00Z
PlannedEndTime	string	任意	スケジュールされたタスクを開始する最も遅い時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で指定します。時刻は UTC である必要があります。説明最も遅い開始時刻は、最も早い開始時刻より少なくとも 30 分後である必要があります。 `PlannedStartTime` を指定し、このパラメーターを指定しない場合、タスクの最も遅い開始時刻は、デフォルトで `PlannedStartTime` の値に 30 分を加えた時刻になります。たとえば、`PlannedStartTime` を `2021-01-14T09:00:00Z` に設定し、このパラメーターを空のままにすると、タスクは `2021-01-14T09:30:00Z` までに開始されます。	2021-01-14T09:30:00Z
FromTimeService	boolean	任意	ゾーン変更をすぐに実行するか、スケジュールされた時刻に実行するかを指定します。有効な値： false (デフォルト)：ゾーン変更はスケジュールされた時刻に実行されます。 true：ゾーン変更はすぐに実行されます。	false
VPCId	string	任意	Virtual Private Cloud (VPC) の ID。	vpc-**********

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	ED12C6FF-3261-4571-AB57-3570F6******

例

成功レスポンス

JSONJSON

{
  "RequestId": "ED12C6FF-3261-4571-AB57-3570F6******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ScheduleTaskExist	The specified cluster already has a scheduled task.
400	InvalidZoneId.Malformed	The specified parameter ZoneId is not valid.
400	InvalidZoneId.Same	The specified parameter ZoneId is same with origin zoneId.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	ActionUnauthorized	The specified action is not available for you.
403	OperationDenied.MutexLock	The operation is not permitted due to the mutex lock.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InsufficientResource	The specified target zone has insufficient resources.

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

変更履歴

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