タスクセンター内のタスク一覧を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
kvstore:DescribeHistoryTasks |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID です。最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出します。 |
cn-beijing |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数です。有効な値は 10~100 です。デフォルト値は 10 です。 |
10 |
| PageNumber |
integer |
任意 |
ページ番号です。ページは 1 から始まります。デフォルト値は 1 です。 |
1 |
| InstanceType |
string |
任意 |
値を Instance に設定します。 |
Instance |
| Status |
string |
任意 |
タスクのステータスです。有効な値は以下のとおりです。
説明
このパラメーターはデフォルトで空欄です。これは、すべてのステータスのタスクが照会されることを意味します。複数のステータスを指定する場合は、カンマ (,) で区切ります。 |
Scheduled |
| InstanceId |
string |
任意 |
インスタンス ID です。このパラメーターはデフォルトで空欄です。これは、無制限のインスタンス ID を指定できることを意味します。複数のインスタンス ID を指定する場合は、カンマ (,) で区切ります。最大 30 個のインスタンス ID を指定できます。 |
r-uf62br2491p5l**** |
| TaskId |
string |
任意 |
タスク ID です。このパラメーターはデフォルトで空欄です。これは、無制限のタスク ID を指定できることを意味します。複数のタスク ID を指定する場合は、カンマ (,) で区切ります。最大 30 個のタスク ID を指定できます。 |
t-83br18hloy3faf**** |
| TaskType |
string |
任意 |
タスクの種類です。このパラメーターはデフォルトで空欄です。これは、無制限のタスク種類を指定できることを意味します。
説明
複数のタスク種類を指定する場合は、カンマ (,) で区切ります。 |
ModifyInsSpec |
| FromStartTime |
string |
必須 |
照会対象の期間の開始時刻です。ISO 8601 標準に従った yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。開始時刻は、現在時刻より最大 30 日前まで遡ることができます。 |
2022-01-02T11:31:03Z |
| ToStartTime |
string |
必須 |
照会対象の期間の終了時刻です。ISO 8601 標準に従った yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。このパラメーターで指定した時刻以前または等しい開始時刻を持つタスクのみが照会されます。 |
2022-02-02T11:31:03Z |
| FromExecTime |
integer |
任意 |
タスクの最小実行時間です。このパラメーターを使用して、実行時間が最小実行時間を超えるタスクをフィルター処理します。単位は秒です。デフォルト値は 0 であり、制限がないことを意味します。 |
0 |
| ToExecTime |
integer |
任意 |
タスクの最大実行時間です。このパラメーターを使用して、実行時間が最大実行時間以下であるタスクをフィルター処理します。単位は秒です。デフォルト値は 0 であり、制限がないことを意味します。 |
0 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageNumber |
integer |
返されたページのページ番号です。 |
1 |
| RequestId |
string |
リクエスト ID です。 |
5D622714-AEDD-4609-9167-F5DDD3D1**** |
| PageSize |
integer |
1 ページあたりに返される最大エントリ数です。 |
10 |
| TotalCount |
integer |
ページネーションを考慮せずに、これらの制約を満たすタスクの合計数です。 |
5 |
| Items |
array<object> |
照会されたタスクオブジェクトです。 |
|
|
object |
|||
| Status |
string |
タスクのステータスです。
|
Running |
| TaskId |
string |
タスク ID です。 |
t-83br18hloy3faf**** |
| CurrentStepName |
string |
現在のステップ名です。このパラメーターが空欄の場合、タスクは開始されていません。 |
exec_task |
| StartTime |
string |
タスクの開始時刻です。ISO 8601 標準に従った yyyy-MM-ddTHH:mm:ssZ 形式で表示され、協定世界時 (UTC) で表示されます。 |
2022-02-03T11:31:03Z |
| EndTime |
string |
タスクの終了時刻です。ISO 8601 標準に従った yyyy-MM-ddTHH:mm:ssZ 形式で表示され、協定世界時 (UTC) で表示されます。 |
2022-02-03T12:06:17Z |
| TaskType |
string |
タスクの種類です。
|
ModifyInsSpec |
| RemainTime |
integer |
タスク完了までの推定残り時間です。単位は秒です。値が 0 の場合、タスクは完了しています。 |
1000 |
| Progress |
number |
タスクの進捗状況です。有効な値は 0~100 です。 |
79.0 |
| RegionId |
string |
リージョン ID です。 |
cn-shanghai |
| InstanceType |
string |
インスタンスタイプです。戻り値は Instance です。 |
Instance |
| InstanceId |
string |
インスタンス ID です。 |
r-bp1zxszhcgatnx**** |
| InstanceName |
string |
インスタンス名です。 |
dba-tair-test-qcloud |
| DbType |
string |
データベースタイプです。戻り値は redis です。 |
redis |
| Product |
string |
プロダクトです。戻り値は kvstore です。 |
kvstore |
| TaskDetail |
string |
タスクの詳細です。詳細内容はタスクの種類によって異なります。 |
{\"callerUid\":\"test\"} |
| ReasonCode |
string |
現在のタスクが開始された理由です。 |
小版本升级 |
| ActionInfo |
string |
タスクに対して実行可能な操作のセットです。システムは、タスクの現在のステップ名およびステータスを ActionInfo で指定された利用可能な操作と照合します。一致する操作が見つからない場合、そのタスクの現在のステータスでは操作がサポートされていません。例:
システムがサポートする操作は、以下のとおりです。
|
{"steps":[{"action_info":{"Waiting":["modifySwitchTime"]},"step_name":"exec_task"}]} |
| Uid |
string |
リソースが属するユーザーの ID です。 |
141345906006**** |
| CallerSource |
string |
リクエストを発行したユーザーの ID です。CallerSource が User に設定されている場合、CallerUid はそのユーザーの一意の ID(UID)を示します。 |
141345906006**** |
| CallerUid |
string |
リクエストの発信元です。有効な値は以下のとおりです。
|
User |
例
成功レスポンス
JSONJSON
{
"PageNumber": 1,
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
"PageSize": 10,
"TotalCount": 5,
"Items": [
{
"Status": "Running",
"TaskId": "t-83br18hloy3faf****",
"CurrentStepName": "exec_task",
"StartTime": "2022-02-03T11:31:03Z",
"EndTime": "2022-02-03T12:06:17Z",
"TaskType": "ModifyInsSpec",
"RemainTime": 1000,
"Progress": 79,
"RegionId": "cn-shanghai",
"InstanceType": "Instance",
"InstanceId": "r-bp1zxszhcgatnx****",
"InstanceName": "dba-tair-test-qcloud",
"DbType": "redis",
"Product": "kvstore",
"TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
"ReasonCode": "小版本升级",
"ActionInfo": "{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}",
"Uid": "141345906006****",
"CallerSource": "141345906006****",
"CallerUid": "User"
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Param.Invalid | Param invalid | |
| 400 | Param.Invalid.TimeEndBeforeStart | Param invalid. End time before start time |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。