DescribeTaskInfo によるタスク情報のクエリ - AnalyticDB

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeTaskInfo

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	クラスターが存在するリージョンの ID です。説明最新のリージョン一覧を照会するには、DescribeRegions 操作をご利用ください。	cn-hongkong
DBClusterId	string	必須	AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの ID です。説明指定したリージョン内にあるすべての AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの ID を照会するには、DescribeDBClusters 操作をご利用ください。	am-bp1xxxxxxxx47
TaskId	integer	必須	タスクの ID です。	225685759

レスポンスフィールド

フィールド	型	説明	例
	object
TaskInfo	object	照会されたタスクの情報です。
Status	string	ステータスです。有効な値は以下のとおりです。 Waiting Running Finished Failed Closed Cancel Retry Pause Stop	Finished
FinishTime	string	タスクの終了時刻です。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。	2020-01-07T08:08:50Z
Progress	string	タスクの進捗状況です。単位は % です。	100
BeginTime	string	タスクの開始時刻です。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。	2020-01-07T07:39:56Z
TaskId	integer	タスクの ID です。	225685759
RequestId	string	リクエスト ID です。	1AD222E9-E606-4A42-BF6D-8A4442913CEF

例

成功レスポンス

JSONJSON

{
  "TaskInfo": {
    "Status": "Finished",
    "FinishTime": "2020-01-07T08:08:50Z",
    "Progress": "100",
    "BeginTime": "2020-01-07T07:39:56Z",
    "TaskId": 225685759
  },
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

変更履歴

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