DescribeTasks で API 呼び出しタスクの進捗をクエリ - PolarDB

クラスターの作成など、API 呼び出しによって生成されたタスクの進捗詳細を照会します。

操作説明

CreateDBCluster などの直接的な API 呼び出し、またはクラスターの作成などの PolarDB コンソールでの操作によって生成されたタスクの進捗詳細を表示できます。
現在、この操作は、CreateDBCluster 操作を呼び出してクラスターを作成する際に生成されたタスクの進捗詳細の表示のみをサポートしています。ただし、CreationOption パラメーターが CreateGdnStandby に設定されていない場合に限ります。

今すぐお試しください

この 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:DescribeTasks

get

*dbcluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	任意	クラスター ID。説明 `DBNodeId` または `DBClusterId` のいずれかを指定する必要があります。DescribeDBClusters 操作を呼び出して、アカウント内のすべてのクラスターの詳細 (クラスター ID を含む) を照会できます。	pc-***************
DBNodeId	string	任意	ノード ID。説明 `DBNodeId` または `DBClusterId` のいずれかを指定する必要があります。DescribeDBClusters 操作を呼び出して、アカウント内のすべてのクラスターの詳細 (ノード ID を含む) を照会できます。	pi-***************
StartTime	string	必須	照会する時間範囲の開始時刻。時刻は `YYYY-MM-DDThh:mmZ` の形式で指定する必要があります。時刻は UTC である必要があります。	2020-11-30T00:00Z
EndTime	string	必須	照会する時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時刻は `YYYY-MM-DDThh:mmZ` の形式で指定する必要があります。時刻は UTC である必要があります。	2020-12-02T03:00Z
Status	string	任意	タスクのステータス。有効な値： Waiting：タスクは実行を待機しています。 Running：タスクは実行中です。 Finished：タスクは完了しました。 Closed：タスクは終了しました。 Pause：タスクは一時停止しています。 Stop：タスクは中断されました。説明このパラメーターを空のままにすると、現在のクラスターまたはノードの Waiting または Running 状態のすべてのタスクの詳細が返されます。複数の状態のタスクを照会するには、状態名をコンマ (,) で区切ります。	Running
PageSize	integer	任意	各ページに返すエントリ数。有効な値：30、50、100。デフォルト値：30。	30
PageNumber	integer	任意	ページ番号。値は 0 より大きく、Integer データ型の最大値を超えない整数である必要があります。デフォルト値：1。	1

レスポンスフィールド

フィールド	型	説明	例
	object
TotalRecordCount	integer	返されたエントリの総数。	1
PageRecordCount	integer	現在のページで返されたエントリ数。	30
Tasks	object
Task	array<object>	タスクの詳細。
	object
FinishTime	string	タスクが完了した時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式です。時刻は UTC で表示されます。	2020-12-02T02:40:15Z
StepsInfo	string	サブタスクの詳細。	[{\"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}]
Progress	integer	タスクの進捗状況 (パーセンテージ)。	100
ExpectedFinishTime	string	タスクの推定終了時刻。このパラメーターは、通常の状況では空です。	null
BeginTime	string	タスクが開始された時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式です。時刻は UTC で表示されます。	2020-12-02T02:39:15Z
TaskErrorCode	string	エラーが発生したときに返されるエラーコード。説明このパラメーターは、タスクのステータスが Stop の場合にのみ返されます。	null
ProgressInfo	string	タスクの進捗状況の説明。タスクに進捗状況の説明がない場合、このパラメーターは空です。	null
CurrentStepName	string	現在のサブタスクの名前。	create_instance
StepProgressInfo	string	サブタスクの進捗状況。たとえば、`1/4` は、タスクが 4 つのサブタスクで構成され、最初のサブタスクが進行中であることを示します。	1/4
TaskErrorMessage	string	エラーが発生したときに返されるエラーメッセージ。説明このパラメーターは、タスクのステータスが Stop の場合にのみ返されます。	null
TaskAction	string	`CreateDBInstance` など、タスクに使用される API 操作。	CreateDBInstance
DBName	string	データベース名。説明このパラメーターは、データベース操作に関連するタスクに対してのみ返されます。	test
Remain	integer	タスクの推定残り時間。単位：秒。	1767
TaskId	string	タスク ID。	111111111
EndTime	string	照会する時間範囲の終了時刻。	2020-12-02T03:00Z
RequestId	string	リクエスト ID。	4352AD99-9FF5-41A6-A319-068089******
PageNumber	integer	ページ番号。	1
StartTime	string	照会する時間範囲の開始時刻。	2020-11-30T00:00Z
DBClusterId	string	タスクが属するクラスターの ID。	pc-***************

例

成功レスポンス

JSONJSON

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "Tasks": {
    "Task": [
      {
        "FinishTime": "2020-12-02T02:40:15Z",
        "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}]",
        "Progress": 100,
        "ExpectedFinishTime": "null",
        "BeginTime": "2020-12-02T02:39:15Z",
        "TaskErrorCode": "null",
        "ProgressInfo": "null",
        "CurrentStepName": "create_instance",
        "StepProgressInfo": "1/4",
        "TaskErrorMessage": "null",
        "TaskAction": "CreateDBInstance",
        "DBName": "test",
        "Remain": 1767,
        "TaskId": "111111111"
      }
    ]
  },
  "EndTime": "2020-12-02T03:00Z",
  "RequestId": "4352AD99-9FF5-41A6-A319-068089******",
  "PageNumber": 1,
  "StartTime": "2020-11-30T00:00Z",
  "DBClusterId": "pc-***************"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
400	InvalidStatus.Malformed	The specified parameter Status is not valid.

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

変更履歴

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