すべてのプロダクト
Search

このプロダクト

    Edge Security Acceleration:DescribePurgeTasks

    ドキュメントセンター

    Edge Security Acceleration:DescribePurgeTasks

    最終更新日:Jul 02, 2026

    リフレッシュタスクの実行ステータスを照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    esa:DescribePurgeTasks

    get

    *サイト。

    acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SiteId

    integer

    任意

    サイト ID。 ListSites 操作を呼び出して取得できます。

    重要 SiteId は常に指定する必要があります。SiteId を指定しない場合、エラーが報告されます。

    123456789****
    Content

    string

    任意

    クエリコンテンツ。完全に一致が使用されます。

    http://a.com/1.jpg?b=1
    Type

    string

    任意

    タスクタイプ。有効な値:

    • file (デフォルト): ファイルリフレッシュ。

    • cachetag: キャッシュタグリフレッシュ。

    • directory: ディレクトリ更新。

    • ignoreParams: パラメーター無視リフレッシュ。

    • hostname: ホスト名リフレッシュ。

    • purgeall: サイト配下のすべてのキャッシュを消去。

    列挙値:

    • cachetag :

      キャッシュタグリフレッシュ。

    • hostname :

      ホスト名リフレッシュ。

    • file :

      ファイルリフレッシュ。

    • cachekey :

      キャッシュキーリフレッシュ。

    • purgeall :

      すべて消去。

    • ignoreparams :

      パラメーター無視リフレッシュ。

    • directory :

      ディレクトリ更新。

    file
    PageNumber

    integer

    任意

    返すページ番号。有効な値: 1～100000。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。デフォルト値: 20。最大値: 50。有効な値: 1～50 の任意の整数。

    20
    StartTime

    string

    任意

    開始時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットで時間を指定します。時間は協定世界時 (UTC) である必要があります。

    2022-11-16T05:33:00Z
    EndTime

    string

    任意

    終了時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットで時間を指定します。時間は協定世界時 (UTC) である必要があります。

    説明

    終了時刻は開始時刻より後である必要があります。

    2022-11-18T15:59:59Z
    Status

    string

    任意

    タスク実行ステータス。有効な値:

    • Complete: 完了。

    • Refreshing: リフレッシュ中。

    • Failed: リフレッシュ失敗した。

    列挙値:

    • Refreshing :

      リフレッシュ中。

    • Complete :

      完了。

    • Failed :

      リフレッシュ失敗した。

    Complete

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    15C66C7B-671A-4297-9187-2C4477247A123425345
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    20
    TotalCount

    integer

    エントリの総数。

    15
    Tasks

    array<object>

    タスクリスト。

    object

    Status

    string

    ステータス。有効な値:

    • Complete: 完了。

    • Refreshing: リフレッシュ中。

    • Failed: リフレッシュ失敗した。

    Complete
    CreateTime

    string

    ISO 8601 フォーマットの作成時間 (例: 2024-01-01T00:00:00+Z)。

    2023-07-26T01:56:15Z
    Type

    string

    リフレッシュタスクタイプ。有効な値:

    • file (デフォルト): ファイルリフレッシュ。

    • cachetag: キャッシュタグリフレッシュ。

    • directory: ディレクトリ更新。

    • ignoreParams: パラメーター無視リフレッシュ。

    • hostname: ホスト名リフレッシュ。

    • purgeall: サイト配下のすべてのキャッシュを消去。

    file
    Process

    string

    タスクの完了進捗率 (パーセント)。

    100%
    Description

    string

    リフレッシュタスクが失敗した場合に返されるエラーの説明。

    Internal Error
    Content

    string

    リフレッシュオブジェクト。

    http://a.com/1.jpg?b=1
    TaskId

    string

    タスク ID。

    16346513304

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 15,
  "Tasks": [
    {
      "Status": "Complete",
      "CreateTime": "2023-07-26T01:56:15Z",
      "Type": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "Content": "http://a.com/1.jpg?b=1",
      "TaskId": "16346513304"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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 MissingParameter.ObjectType The ObjectType parameter is required if DomainName or ObjectType is specified.
    400 InvalidStationParameter The specified Station is invalid.
    400 TooManyRequests Too many requests.Please try again later.
    400 InvalidTaskId.Malformed The specified taskId is invalid.
    400 InvalidParameters.InvalidUrls The specified urls are invalid.

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

    変更履歴

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