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

クラスターの作成などの API オペレーションによって生成されたタスクの進行状況の詳細を照会します。

操作説明

CreateDBCluster などの API オペレーションを直接呼び出して生成されたタスク、または PolarDB コンソールでクラスターの作成などの特徴を使用しているときにシステムが対応する API オペレーションを呼び出して生成されたタスクのビューを確認できます。
現在、クラスターの作成時、つまり 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

*dbクラスター

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	任意	ページ番号。値は、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\":\"タスク初期化\",\"progress\":100},{\"remain\":1764,\"name\":\"インスタンス作成\",\"progress\":0},{\"remain\":1,\"name\":\"クラスター初期化\",\"progress\":0},{\"remain\":2,\"name\":\"バックアップ作成\",\"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	クエリの終了時刻。時間は ISO 8601 標準の協定世界時 (UTC) タイムゾーン (フォーマット: YYYY-MM-DDTHH:mmZ) です。	2020-12-02T03:00Z
RequestId	string	リクエスト ID。	4352AD99-9FF5-41A6-A319-068089******
PageNumber	integer	ページ番号。	1
StartTime	string	クエリの開始時刻。時間は ISO 8601 標準の協定世界時 (UTC) タイムゾーン (フォーマット: YYYY-MM-DDTHH:mmZ) です。	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.	指定された DBNodeId パラメーターは無効です。
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	指定された StartTime パラメーターは無効です。
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	指定された EndTime パラメーターは無効です。
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定されたパラメーター PageSize は無効です。
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定されたパラメーター PageNumber は無効です。
400	InvalidStatus.Malformed	The specified parameter Status is not valid.	指定された Status パラメーターは無効です。

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

変更履歴

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