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

リフレッシュまたはプリフェッチタスクがネットワーク全体で効果を発揮しているかどうかを照会します。

操作説明

タスク ID または URL でクエリできます。
TaskId と ObjectPath の両方を指定できます。TaskId も ObjectPath も指定しない場合、デフォルトで過去 3 日間のデータの最初のページ (20 エントリ) が返されます。
過去 3 日間のデータのみをクエリできます。
タスクステータスは、非同期更新の API リクエストによってトリガーされる必要があります。
OSS コンソールで CDN キャッシュの自動リフレッシュを有効にした場合、DescribeRefreshTasks 操作を使用して OSS の自動キャッシュリフレッシュタスクをビューすることはできません。
ユーザーあたりの最大呼び出し周波数: 1 秒あたり 5 回。より高い呼び出し周波数が必要な場合は、 DescribeRefreshTaskById 操作を使用してください。この操作はタスク ID によるリフレッシュおよびプリフェッチタスク情報のクエリのみをサポートしています。

今すぐお試しください

この 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 を指定する場合、ObjectType は必須です。	file
DomainName	string	任意	高速化ドメイン名。単一のドメイン名のみを指定できます。デフォルトでは、すべての高速化ドメイン名が照会されます。	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 ページあたりのエントリ数。	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: ファイルリフレッシュ。 directory: ディレクトリ更新。 regex: 正規表現ベースのリフレッシュ。 preload: ファイルプリフェッチ。	file
Process	string	進捗率 (パーセント)。	100%
Description	string	リフレッシュまたはプリフェッチタスクが失敗した場合に返されるエラーの説明。 InternalError: 内部エラーが発生しました。 OriginTimeout: オリジンサーバーが時間切れになりました。 OriginReturnStatusCode 5XX: オリジンサーバーが 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.

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

変更履歴

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