DescribeDcdnRefreshTasks - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

DescribeDcdnRefreshTasks 操作を呼び出して、更新/プリフェッチタスクのステータスをクエリします。過去 3 日以内に生成されたデータをクエリできます。

操作説明

タスク ID または URL でタスクをクエリできます。
TaskId と ObjectPath の両方を指定できます。TaskId または ObjectPath を指定しない場合、デフォルトで、システムは過去 3 日以内に生成されたデータの最初のページ (20 エントリ) をクエリします。
過去 3 日以内に生成されたデータをクエリできます。
DomainName または Status を指定する場合、ObjectType も指定する必要があります。
1 人のユーザーが 1 秒あたりに行える呼び出しの最大数は 5 です。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dcdn:DescribeDcdnRefreshTasks

get

domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	任意	タスクの ID。更新またはプリフェッチタスクを作成すると、タスク ID が返されます。	704225667
ObjectPath	string	任意	クエリするオブジェクトのパス。パスは完全に一致する必要があります。	http://example.com/examplefile.txt
PageNumber	integer	任意	返されるページ番号。有効値: 1～100000。	2
ObjectType	string	任意	タスクのタイプ。有効値: file: URL を更新します。 directory: ディレクトリを更新します。 regex: 正規表現に基づいてコンテンツを更新します。 preload: URL をプリフェッチします。 DomainName または Status を指定する場合、このパラメーターは必須です。	file
DomainName	string	任意	高速化ドメイン名。ドメイン名は 1 つだけ指定できます。このパラメーターを指定しない場合、すべての高速化ドメイン名がクエリされます。	example.com
Status	string	任意	タスクのステータス。有効値: Complete: タスクは完了しました。 Refreshing: タスクは進行中です。 Failed: タスクは失敗しました。	Complete
PageSize	integer	任意	各ページで返されるエントリの数。デフォルト値: 20。最大値: 50。有効値: 1～50。	20
StartTime	string	任意	クエリする時間範囲の開始時刻。ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。	2017-01-01T12:12:20Z
EndTime	string	任意	クエリする時間範囲の終了時刻。ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。説明終了時刻は開始時刻より後である必要があります。	2017-01-01T12:13:20Z

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

{
  "RequestId": "174F6032-AA26-470D-B90E-36F0EB205BEE",
  "PageNumber": 2,
  "PageSize": 2,
  "TotalCount": 20,
  "Tasks": {
    "Task": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "10",
        "Description": "InternalError",
        "ObjectPath": "http://example.com/examplefile.txt",
        "TaskId": "123"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType 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 parameter is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.
429	TooManyRequests	The server is busy. Please try again later.

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

変更履歴

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