DescribeTasks - PolarDB - Alibaba Cloud ドキュメントセンター

API操作に基づいて生成されるタスクの詳細を照会します。たとえば、この操作を呼び出して、クラスターの作成時にタスクの詳細を表示できます。

この操作を呼び出して、特定のAPI操作またはコンソールで生成されたタスクの詳細を表示できます。コンソールで操作を実行すると、システムは特定のAPI操作を呼び出します。たとえば、コンソールでCreateDBCluster操作を呼び出したり、クラスターを作成したりすると、タスクの詳細を表示できます。
CreateDBCluster操作を呼び出してクラスターを作成し、CreationOptionがCreateGdnStandbyに設定されていない場合にのみ、生成されたタスクの詳細を表示できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	データ型	必須	例	説明
Action	String	必須	DescribeTasks	実行する操作です。値をDescribeTasksに設定します。
DBClusterId	String	任意	pc-****************	クラスターの ID。説明 `DBNodeId`または`DBClusterId`を指定する必要があります。 DescribeDBClustersを呼び出して、Alibaba Cloudアカウントに属するクラスターの詳細 (クラスターIDなど) を照会できます。
DBNodeId	String	任意	pi-***************	ノードの ID です。説明 `DBNodeId`または`DBClusterId`を指定する必要があります。 DescribeDBClustersを呼び出して、Alibaba Cloudアカウントに属するクラスターの詳細 (クラスターIDなど) を照会できます。
StartTime	String	必須	2020-11-30T00:00Z	照会する期間の開始時刻です。 `yyyy-MM-ddTHH:mmZ`形式で時刻を指定します。時刻は UTC である必要があります。
EndTime	String	必須	2020-12-02T03:00Z	照会する期間の終了時刻を設定します。 `YYYY-MM-DDThh:mmZ`形式で時刻を指定します。時刻は UTC である必要があります。終了時刻は開始時刻よりも後の時刻にする必要があります。
Status	String	任意	Running	クエリするタスクの状態。有効な値：待機中: タスクは保留中です。実行中: タスクは実行中です。完了: タスクが完了しました。 Closed: タスクは終了しています。一時停止: タスクが中断されました。停止: タスクが中断されました。説明このパラメーターを指定しない場合、操作はクラスターまたはノードの待機中または実行中の状態にあるタスクのみの詳細を返します。複数のタスクステータスを入力でき、各ステータスはカンマで照会できます。
PageSize	Integer	任意	30	各ページで返されるエントリ数。有効な値: 30、50、または100。デフォルト値: 30
PageNumber	Integer	いいえ	1	返されるページ数です。値は0より大きい整数でなければなりません。デフォルト値: 1

レスポンスパラメーター

パラメーター	データ型	例	説明
TotalRecordCount	Integer	1	エントリの総数。
PageRecordCount	Integer	30	1 ページあたりで返されるエントリ数です。
Tasks	タスクの配列		タスクの詳細。
Task
FinishTime	String	2020-12-02T02:40:15Z	タスクが完了した時刻。時刻は`YYYY-MM-DDThh:mm:ssZ`形式です。時刻は UTC で表示されます。
StepsInfo	String	[{\"remain\":0,\"name\":\"init_task\",\"progress\":100 },{\ "remain\":1764,\"name\":\"create_instance\",\"progress\":0 },{" remain\":1,\" name\":\" init_\ "\" progress\":0 },{\" remain\":2,\" name\":\" create_backup\",\" progress\":0}]	サブタスクの詳細。
Progress	Integer	100	タスクの進行状況 (パーセンテージ) 。
ExpectedFinishTime	String	null	推定終了時刻。ほとんどの場合、このパラメーターは空です。
BeginTime	String	2020-12-02T02:39:15Z	タスクが開始された時刻。時刻は`YYYY-MM-DDThh:mm:ssZ`形式です。時刻は UTC で表示されます。
TaskErrorCode	String	null	エラーが発生したときに返されるエラーコード。説明このパラメーターは、タスクが [停止] 状態の場合にのみ返されます。
ProgressInfo	String	null	タスクの進行状況に関する説明。タスクの進行状況の説明がない場合、このパラメーターは空です。
CurrentStepName	String	create_instance	現在のステップの名前。
StepProgressInfo	String	1/4	サブタスクの進行状況。たとえば、`1/4`の値は、タスクが4つのサブタスクで構成され、最初のサブタスクが進行中であることを示します。
TaskErrorMessage	String	null	エラーが発生したときに返されるエラーメッセージ。説明このパラメーターは、タスクが [停止] 状態の場合にのみ返されます。
TaskAction	String	CreateDBInstance	`CreateDBInstance`など、タスクによって使用されるAPI操作。
DBName	String	test	照会するテーブルのデータベースの名前。説明このパラメーターは、データベース操作を伴うタスクに対してのみ返されます。
Remain	Integer	1767	タスクの推定残り時間。単位は秒です。
TaskId	String	111111111	タスクのID。
EndTime	String	2020-12-02T03:00Z	時間範囲の終わり。
RequestId	String	4352AD99-9FF5-41A6-A319-068089 ******	リクエストの ID。
PageNumber	Integer	1	返されたページの数です。
StartTime	String	2020-11-30T00:00Z	時間範囲の始まり。
DBClusterId	String	pc-****************	タスクが作成されたクラスターのID。

例

リクエストの例

http(s)://polardb.aliyuncs.com/?Action=DescribeTasks
&EndTime=2020-11-30T00:00Z
&StartTime=2020-12-01T10:00Z
&<Common request parameters>

成功レスポンスの例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTasksResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>30</PageRecordCount>
<Tasks>
    <Task>
        <StepProgressInfo>1/4</StepProgressInfo>
        <Progress>25</Progress>
        <TaskId>111111111</TaskId>
        <Remain>1767</Remain>
        <FinishTime>2020-12-02T02:40:15Z</FinishTime>
        <TaskAction>CreateDBInstance</TaskAction>
        <StepsInfo>[{"remain":0,"name":"init_task","progress":100},{"remain":1764,"name":"create_instance","progress":0},{"remain":1,"name":"init_cluster","progress":0},{"remain":2,"name":"create_backup","progress":0}]</StepsInfo>
        <CurrentStepName>create_instance</CurrentStepName>
        <BeginTime>2020-12-02T02:39:15Z</BeginTime>
    </Task>
</Tasks>
<RequestId>45CE02A1-1766-42E3-9E5F-24B576******</RequestId>
<EndTime>2020-12-02T03:00Z</EndTime>
<PageNumber>1</PageNumber>
<StartTime>2020-11-30T00:00Z</StartTime>
<DBClusterId>pc-*****************</DBClusterId>
</DescribeTasksResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 30,
  "Tasks" : {
    "Task" : [ {
      "StepProgressInfo" : "1/4",
      "Progress" : 25,
      "TaskId" : "111111111",
      "Remain" : 1767,
      "FinishTime" : "2020-12-02T02:40:15Z",
      "TaskAction" : "CreateDBInstance",
      "StepsInfo" : "[{\"remain\":0,\"name\":\"init_task\",\"progress\":100},{\"remain\":1764,\"name\":\"create_instance\",\"progress\":0},{\"remain\":1,\"name\":\"init_cluster\",\"progress\":0},{\"remain\":2,\"name\":\"create_backup\",\"progress\":0}]",
      "CurrentStepName" : "create_instance",
      "BeginTime" : "2020-12-02T02:39:15Z"
    } ]
  },
  "RequestId" : "45CE02A1-1766-42E3-9E5F-24B576******",
  "EndTime" : "2020-12-02T03:00Z",
  "PageNumber" : 1,
  "StartTime" : "2020-11-30T00:00Z",
  "DBClusterId" : "pc-*****************"
}

エラーコード

エラーコードのリストについては、「API エラーセンター」を参照してください。