プリフェッチタスクの詳細を DescribePreloadTasks でクエリ - ESA

時間、タスクステータス、またはプリフェッチ URL を指定して、プリフェッチタスクの詳細を照会します。

今すぐお試しください

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

get

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	任意	サイト ID。ID を取得するには、ListSites 操作を呼び出します。	123456789****
Content	string	任意	プリフェッチ対象のコンテンツ。完全一致による照会が可能です。	http://a.com/1.jpg?b=2
PageNumber	integer	任意	ページ番号。有効な値は 1 ～ 100000 です。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりの表示件数。デフォルト値は 20 です。有効な値は 1 ～ 50 です。	20
StartTime	string	任意	開始時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。	2023-03-22T17:00:00Z
EndTime	string	任意	終了時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。説明終了時刻は、開始時刻より後である必要があります。	2023-03-23T06:23:00Z
Status	string	任意	タスクステータス。有効な値は以下のとおりです。 Complete：タスクが完了しました。 Refreshing：タスクが実行中です。 Failed：タスクが失敗しました。	Complete

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりの表示件数。	10
TotalCount	integer	返された合計件数。	83
Tasks	array<object>	タスク一覧。
	object
Status	string	タスクステータス。 Complete：タスクが完了しました。 Refreshing：タスクが進行中です。 Failed：タスクが失敗しました。	Complete
CreateTime	string	タスクの作成時刻。	2023-03-28 14:28:57
Process	string	タスクの進捗率（パーセンテージ）。	100%
Description	string	プリフェッチタスクの失敗時に返されるエラーメッセージ。有効な値は以下のとおりです。 Internal Error Origin Timeout Origin Return StatusCode 5XX	Internal Error
Content	string	プリフェッチ対象のコンテンツ。	http://a.com/1.jpg?b=2
TaskId	string	照会対象のタスク ID。	1597854579687428

例

成功レスポンス

JSONJSON

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 83,
  "Tasks": [
    {
      "Status": "Complete",
      "CreateTime": "2023-03-28 14:28:57",
      "Process": "100%",
      "Description": "Internal Error",
      "Content": "http://a.com/1.jpg?b=2",
      "TaskId": "1597854579687428"
    }
  ]
}

エラーコード

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.

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

変更履歴

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