ModifyTaskInfo - 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:ModifyTaskInfo

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスがデプロイされているリージョン ID。	cn-hangzhou
TaskId	string	必須	タスク ID。複数のタスク ID はカンマ (,) で区切ります。最大 30 個のタスク ID を指定できます。	t-0mq3kfhn8i1nlt****
StepName	string	任意	現在のステップ名。	do_pause
TaskAction	string	任意	アクション名。値を modifySwitchTime に設定します。この値は、切り替え時間または復元時間を変更することを指定します。	modifySwitchTime
ActionParams	string	任意	アクションに関連する JSON 形式のパラメーター。TaskAction パラメーターが modifySwitchTime に設定されている場合、このパラメーターを `{"recoverMode": "xxx", "recoverTime": "xxx"}` に設定します。 recoverMode: タスクの復元モードを指定します。有効な値: timePoint: 指定された時点にタスクを実行します。 immediate: タスクを直ちに実行します。 maintainTime: メンテナンスウィンドウ内でタスクを実行します。 recoverTime: 復元する時点を指定します。時刻は ISO 8601 規格の yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時刻は協定世界時 (UTC) である必要があります。recoverMode パラメーターが timePoint に設定されている場合、このパラメーターは必須です。	{"recoverMode":"immediate"}

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ
RequestId	string	リクエスト ID。	2B98499B-E62B-56D4-8D7F-3D6D4DB260F2
ErrorTaskId	string	失敗したタスクの ID。タスクが失敗した場合にこのパラメーターが返されます。	t-0mqaj5hnyofczv****
SuccessCount	string	完了したタスクの数。	2
ErrorCode	string	タスクが失敗した場合に返されるエラーコード。	mst.errorcode.success.errormessage

例

成功レスポンス

JSONJSON

{
  "RequestId": "2B98499B-E62B-56D4-8D7F-3D6D4DB260F2",
  "ErrorTaskId": "t-0mqaj5hnyofczv****",
  "SuccessCount": "2",
  "ErrorCode": "mst.errorcode.success.errormessage"
}

エラーコード

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

変更履歴

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