DescribeRefreshTasks でプリフェッチタスクのステータスをクエリ - CDN - Alibaba Cloud -

DescribeRefreshTasks を呼び出すと、ネットワーク全体のリフレッシュタスクおよびプリフェッチタスクのステータスを確認できます。

操作説明

タスク ID または URL でタスクをクエリできます。
TaskId パラメータと ObjectPath パラメータの両方を指定できます。TaskId と ObjectPath のいずれも指定しない場合、このオペレーションはデフォルトで、直近 3 日間の先頭 20 件のタスクを返します。
クエリできるのは、直近 3 日間のデータのみです。
タスクステータスは非同期に更新されます。最新のステータスを取得するには、API を呼び出す必要があります。
OSS コンソールで CDN の自動キャッシュ更新を有効にしている場合、DescribeRefreshTasks インターフェイスはこれらのタスクを返しません。
単一ユーザーの呼び出し頻度は、1 秒あたり 5 回に制限されています。より高い頻度が必要な場合は、タスク ID のみでタスクをクエリする DescribeRefreshTaskById インターフェイスを使用してください。

今すぐお試しください

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

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	任意	照会するタスクの ID です。	1234321
ObjectPath	string	任意	照会するオブジェクトパスです。このパラメーターは完全一致が必要です。	http://example.com/1.txt
PageNumber	integer	任意	返されるページ番号です。有効な値：1～100000。	1
ObjectType	string	任意	タスクタイプです。有効な値： file：ファイルリフレッシュ。 directory：ディレクトリリフレッシュ。 regex：正規表現リフレッシュ。 preload：プリロード。 block：URL ブロック。 unblock：URL ブロック解除。説明 DomainName または Status を指定する場合、このパラメーターは必須です。	file
DomainName	string	任意	高速化ドメイン名です。一度に照会できるドメイン名は 1 つのみです。このパラメーターを指定しない場合、すべての高速化ドメイン名のタスクが返されます。	example.com
Status	string	任意	タスクステータスです。有効な値： Complete：タスクは正常に完了しました。 Refreshing：タスクは処理中です。 Timeout：タスクはタイムアウトし、実行されませんでした。 Canceled：タスクはキャンセルされました。 Failed：タスクは失敗しました。	Complete
PageSize	integer	任意	1 ページあたりに返されるタスク数です。デフォルト値：20。最大値：100。有効な値：1～100。	20
StartTime	string	任意	クエリ時間範囲の開始時刻です。時刻は ISO 8601 フォーマット `yyyy-MM-ddTHH:mm:ssZ` で指定します。時刻は UTC である必要があります。	2017-12-21T08:00:00Z
EndTime	string	任意	クエリ時間範囲の終了時刻です。時刻は ISO 8601 フォーマット `yyyy-MM-ddTHH:mm:ssZ` で指定します。時刻は UTC である必要があります。説明終了時刻は開始時刻より後である必要があります。	2017-12-22T08:00:00Z
ResourceGroupId	string	任意	リソースグループ ID です。	rg-acfmyuji4b6r4**

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	174F6032-AA26-470D-B90E-36F0EB205BEE
PageNumber	integer	ページ番号です。	10
PageSize	integer	ページサイズです。	1
TotalCount	integer	総数です。	2
Tasks	object
CDNTask	array<object>	タスクリストです。
	object
Status	string	タスクのステータスです。有効な値： Complete：タスクは完了しています。 Refreshing：タスクは実行中です。 Failed：タスクは失敗しています。	Complete
CreationTime	string	タスクが作成された時刻です。時刻は UTC です。	2014-11-27T08:23:22Z
ObjectType	string	タスクのタイプです。有効な値： file：URL directory：ディレクトリ regex：正規表現 preload：プリフェッチ	file
Process	string	タスクの進捗状況をパーセンテージで示します。	100%
Description	string	リフレッシュタスクまたはプリフェッチタスクが失敗した場合に返されるエラーメッセージです。 InternalError：内部エラーが発生しました。 OriginTimeout：オリジンサーバーがタイムアウトしました。 OriginReturnStatusCode 5XX：オリジンサーバーが HTTP 5xx ステータスコードを返しました。	Internal Error
ObjectPath	string	リフレッシュ対象のオブジェクトパスです。	http://example.com/1.txt
TaskId	string	タスク ID です。	704225667

例

成功レスポンス

JSONJSON

{
  "RequestId": "174F6032-AA26-470D-B90E-36F0EB205BEE",
  "PageNumber": 10,
  "PageSize": 1,
  "TotalCount": 2,
  "Tasks": {
    "CDNTask": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "100%",
        "Description": "Internal Error",
        "ObjectPath": "http://example.com/1.txt",
        "TaskId": "704225667"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or Status is specified.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidTime	The query time cannot exceed the last 3 days.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
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	InvalidParams	The parameter you provided is invalid.
429	TooManyRequests	The server is busy. Please try again later.

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

変更履歴

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