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

DescribeRefreshTaskById を呼び出すと、ネットワーク全体の更新タスクとプリフェッチタスクのステータスを照会できます。

操作説明

過去 3 日間のデータを照会できます。
各ユーザーは、1 秒あたり最大 30 回の呼び出しを実行できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cdn:DescribeRefreshTaskById

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	必須	照会するタスクの ID。 RefreshObjectCaches 操作を呼び出して、更新タスクまたはプリフェッチタスクのタスク ID を取得します。その後、タスク ID を使用してタスクのステータスを照会できます。複数のタスク ID を指定できます。コンマ (,) で区切ります。最大 10 個のタスク ID を指定できます。	12345678

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	タスクの総数。	2
RequestId	string	リクエスト ID。	E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
Tasks	array<object>	タスクのリスト。
	object
Status	string	タスクのステータス。有効な値: Complete: タスクは完了しました。 Refreshing: タスクは進行中です。 Failed: タスクは失敗しました。	Complete
CreationTime	string	タスクが作成された時刻。時刻は UTC です。	2020-08-03T08:54:23Z
ObjectType	string	タスクのタイプ。有効な値: file: 単一のファイルを更新します。 directory: ディレクトリを更新します。 preload: 単一のファイルをプリフェッチします。 regex: 正規表現に基づいてコンテンツを更新します。	file
Process	string	タスクの進捗状況 (パーセンテージ)。	100%
Description	string	更新タスクまたはプリフェッチタスクが失敗した場合のエラーの説明。有効な値: Internal Error: 内部エラーが発生しました。 Origin Timeout: オリジンサーバーがタイムアウトしました。 Origin Return StatusCode 5XX: オリジンサーバーが 5xx ステータスコードを返しました。	Internal Error
ObjectPath	string	タスクオブジェクトのパス。	http://example.com/abc.jpg
TaskId	string	タスク ID。	24840

例

成功レスポンス

JSONJSON

{
  "TotalCount": 2,
  "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
  "Tasks": [
    {
      "Status": "Complete",
      "CreationTime": "2020-08-03T08:54:23Z",
      "ObjectType": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "ObjectPath": "http://example.com/abc.jpg",
      "TaskId": "24840"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.
400	InvalidEndTime.ValueNotSupported	The specified EndTime is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidParameters	The parameters you provided are invalid.
400	InvalidTime	The query time cannot exceed the last 3 days.
429	TooManyRequests	Too many requests, please try again later

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

変更履歴

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