タスクセンターのタスクリストをクエリします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dds:DescribeHistoryTasks |
list |
*Instance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
未処理イベントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 |
cn-beijing |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。 有効値:10~100。 デフォルト値:10。 |
10 |
| PageNumber |
integer |
任意 |
返すページ番号。 値は正の整数である必要があります。 デフォルト値:1。 |
1 |
| InstanceType |
string |
任意 |
インスタンスのインスタンスタイプ。 値を Instance に設定します。 |
Instance |
| Status |
string |
任意 |
タスクステータス。 有効値:
複数の状態をコンマ (,) で区切ります。 このパラメーターはデフォルトで空で、すべての状態のタスクがクエリされることを示します。 |
Succeed,Running,Waiting |
| InstanceId |
string |
任意 |
インスタンス ID。 複数のインスタンス ID をコンマ (,) で区切ります。 最大 30 個のインスタンス ID を指定できます。 このパラメーターはデフォルトで空で、すべてのインスタンスのタスクがクエリされることを示します。 |
dds-8vb38f0e7933xxxx |
| TaskId |
string |
任意 |
タスク ID。 複数のタスク ID をコンマ (,) で区切ります。 最大 30 個のタスク ID を指定できます。 このパラメーターはデフォルトで空で、すべてのタスクがクエリされることを示します。 |
t-0mq1yyhm3ffl2bxxxx |
| TaskType |
string |
任意 |
タスクタイプ。 このパラメーターはデフォルトで空のままになり、すべてのタイプのタスクがクエリされることを示します。 有効値:
|
DeleteInsNode |
| FromStartTime |
string |
必須 |
実行する O&M タスクの開始時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定します。 時刻は UTC である必要があります。 過去 30 日以内のデータをクエリできます。 |
2023-03-15T03:41:26Z |
| ToStartTime |
string |
必須 |
実行する O&M タスクの終了時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定します。 時刻は UTC である必要があります。 過去 30 日以内のデータをクエリできます。 |
2023-03-16T07:21:31Z |
| FromExecTime |
integer |
任意 |
タスクの最小実行時間。 このパラメーターは、実行時間が最小実行時間より長いタスクをフィルターするために使用されます。 単位:秒。 デフォルト値は 0 で、クエリに制限が課されないことを示します。 |
0 |
| ToExecTime |
integer |
任意 |
タスクの最大実行時間。 このパラメーターは、実行時間が最大実行時間以下のタスクをフィルターするために使用されます。 単位:秒。 デフォルト値は 0 で、クエリに制限が課されないことを示します。 |
0 |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-aek2inrfrnw3xby |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageNumber |
integer |
返されたページのページ番号。 |
1 |
| RequestId |
string |
リクエスト ID。 |
3C4A2494-XXXX-XXXX-93CF-548DB3375193 |
| PageSize |
integer |
1 ページあたりに返されるエントリの最大数。 |
10 |
| TotalCount |
integer |
ページネーションを考慮しない、これらの条件を満たすタスクの総数。 |
5 |
| Items |
array<object> |
タスクオブジェクト。 |
|
|
object |
|||
| Status |
string |
タスクステータス。 有効値:
|
Succeed |
| TaskId |
string |
タスク ID。 |
t-0mq1yyhm3ffl2bxxxx |
| CurrentStepName |
string |
現在のステップの名前。 このパラメーターが空の場合、タスクは開始されていません。 |
exec_task |
| StartTime |
string |
実行された O&M タスクの開始時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。 |
2023-02-11T02:33Z |
| EndTime |
string |
実行された O&M タスクの終了時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。 |
2023-03-16T02:59Z |
| TaskType |
string |
タスクタイプ。
|
CreateIns |
| RemainTime |
integer |
推定残り実行時間。 単位:秒。 値 0 はタスクが完了したことを示します。 |
1000 |
| Progress |
number |
タスクの現在の進捗。 有効値の範囲は 0~100 です。 |
100.0 |
| RegionId |
string |
インスタンスのリージョン ID。 |
cn-hangzhou |
| InstanceType |
string |
インスタンスのインスタンスタイプ。 値は Instance に固定されています。 |
Instance |
| InstanceId |
string |
インスタンス ID |
dds-t4n18194768fxxxx |
| InstanceName |
string |
インスタンスの名前。 |
test-dds |
| DbType |
string |
データベースタイプ。 値は mongodb に固定されています。 |
mongodb |
| Product |
string |
プロダクト。 値は dds に固定されています。 |
dds |
| TaskDetail |
string |
タスクの詳細。 タスクの詳細は、taskType パラメーターの値によって異なります。 |
{\"callerUid\":\"test\"} |
| ReasonCode |
string |
現在のタスクが開始された理由。 |
小版本升级 |
| ActionInfo |
string |
タスクに対して実行できる許可された操作のセット。 システムは、タスクの現在のステップ名とステータスを、ActionInfo で指定された利用可能な操作と照合します。 一致する操作が見つからない場合、タスクの現在のステータスはどの操作もサポートしていません。 例:
システムは次の操作をサポートする場合があります:
|
`{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}` |
| Uid |
string |
リソースが属するユーザーの ID。 |
141345906006**** |
| CallerSource |
string |
リクエストソース。 有効値:System および User。 |
System |
| CallerUid |
string |
リクエストを行ったユーザーの ID。 CallerSource が User に設定されている場合、CallerUid はユーザーの一意の ID (UID) を示します。 |
141345906006**** |
例
成功レスポンス
JSONJSON
{
"PageNumber": 1,
"RequestId": "3C4A2494-XXXX-XXXX-93CF-548DB3375193",
"PageSize": 10,
"TotalCount": 5,
"Items": [
{
"Status": "Succeed",
"TaskId": "t-0mq1yyhm3ffl2bxxxx",
"CurrentStepName": "exec_task",
"StartTime": "2023-02-11T02:33Z",
"EndTime": "2023-03-16T02:59Z",
"TaskType": "CreateIns",
"RemainTime": 1000,
"Progress": 100,
"RegionId": "cn-hangzhou",
"InstanceType": "Instance",
"InstanceId": "dds-t4n18194768fxxxx",
"InstanceName": "test-dds",
"DbType": "mongodb",
"Product": "dds",
"TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
"ReasonCode": "小版本升级",
"ActionInfo": "`{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}`",
"Uid": "141345906006****",
"CallerSource": "System",
"CallerUid": "141345906006****"
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Param.Invalid | Param invalid | |
| 400 | Param.Invalid.TimeEndBeforeStart | Param invalid. End time before start time |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。