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

PolarClaw 非同期タスクの状態を照会します。

今すぐお試しください

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

get

* すべてのリソース

*

なし

リクエスト構文

POST HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApplicationId	文字列	必須	アプリケーション ID です。	pa-**************
TaskId	文字列	必須	非同期タスク ID です。	0ee00f56-f467-4d41-858c-ca4ede2c770e

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト	レスポンスオブジェクトです。
RequestId	文字列	リクエスト ID です。	C890995A-CF06-4F4D-8DB8-DD26C2******
Message	文字列	レスポンスメッセージです。	successful
Code	整数	ステータスコードです。	200
ApplicationId	文字列	アプリケーション ID です。	pa-**************
Task	オブジェクト	タスクオブジェクトです。
TaskId	文字列	タスク ID です。UUID で表されます。	5956e600-ce6e-4d11-9648-939ef3286e94
State	文字列	タスクの状態です。有効な値は `pending` (保留中)、`running` (実行中)、`succeeded` (成功)、`failed` (失敗) です。	running
Operation	文字列	オペレーション名です。	LoginPolarClawChannel
CreatedAtMs	整数	タスクが作成されたミリ秒単位のタイムスタンプです。	1778564698304
UpdatedAtMs	整数	タスクが最後に更新されたミリ秒単位のタイムスタンプです。	1778564750541
Result	オブジェクト	タスク結果オブジェクトです。このパラメーターは、タスクが成功した場合にのみ返されます。このオブジェクトの内容は、オペレーションによって異なります。	{}
Error	オブジェクト	エラーオブジェクトです。このパラメーターは、タスクが失敗した場合にのみ返されます。
Code	文字列	エラーコードです。	INVALID_REQUEST
Message	文字列	エラーメッセージです。	channelId format invalid

例

成功レスポンス

JSONJSON

{
  "RequestId": "C890995A-CF06-4F4D-8DB8-DD26C2******",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "Task": {
    "TaskId": "5956e600-ce6e-4d11-9648-939ef3286e94",
    "State": "failed",
    "Operation": "LoginPolarClawChannel",
    "CreatedAtMs": 1778564698304,
    "UpdatedAtMs": 1778564750541,
    "Error": {
      "Code": "INVALID_REQUEST",
      "Message": "channelId format invalid"
    }
  }
}

エラーコード

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

変更履歴

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