DescribeVodRefreshTasks - - Alibaba Cloud ドキュメントセンター

1 つ以上のリフレッシュタスクまたはプリフェッチタスクに関する情報をクエリします。

操作説明

この操作は、中国 (上海) リージョンでのみ利用可能です。
TaskId パラメーターまたは ObjectPath パラメーターを指定しない場合、過去 3 日間のデータが最初のページに返されます。デフォルトでは、1 ページに最大 20 件のエントリが表示されます。TaskId パラメーターと ObjectPath パラメーターは同時に指定できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:DescribeVodRefreshTasks

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	任意	クエリするタスクの ID。	70422****
ObjectPath	string	任意	オブジェクトのパス。パスは完全一致の条件として使用されます。	http://example.com/***.txt
PageNumber	integer	任意	ページ番号。	1
ObjectType	string	任意	タスクのタイプ。有効な値： file：1 つ以上のファイルをリフレッシュします。 directory：指定されたディレクトリ内のファイルをリフレッシュします。 preload：1 つ以上のファイルをプリフェッチします。説明 DomainName パラメーターまたは Status パラメーターを指定する場合は、ObjectType パラメーターも指定する必要があります。	file
DomainName	string	任意	ドメイン名。	example.com
Status	string	任意	タスクのステータス。有効な値： Complete：タスクは完了しています。 Refreshing：タスクは処理中です。 Failed：タスクは失敗しました。	Complete
PageSize	integer	任意	各ページで返すエントリ数。デフォルト値：20。最大値：50。	20
StartTime	string	任意	クエリする時間範囲の開始時刻。ISO 8601 形式 (yyyy-MM-ddTHH:mm:ssZ) で時刻を指定します。時刻は UTC である必要があります。説明過去 3 日間に収集されたデータをクエリできます。	2017-01-01T12:12:20Z
EndTime	string	任意	クエリする時間範囲の終了時刻。ISO 8601 形式 (yyyy-MM-ddTHH:mm:ssZ) で時刻を指定します。時刻は UTC である必要があります。	2017-01-01T12:30:20Z

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	174F6032-AA26-470D-****-36F0EB205BEE
PageNumber	integer	返されたページのページ番号。	1
PageSize	integer	ページごとに返されるエントリ数。	10
TotalCount	integer	返されたエントリの総数。	2
Tasks	object
Task	array<object>	返されたタスクに関する情報。
	object
Status	string	タスクのステータス。有効な値： Complete：タスクは完了しています。 Refreshing：タスクは処理中です。 Failed：タスクは失敗しました。 Pending：タスクは保留中です。	Complete
CreationTime	string	タスクが作成された時刻。時刻は ISO 8601 形式 (yyyy-MM-ddTHH:mm:ssZ) に準拠します。時刻は UTC で表示されます。	2014-11-27T08:23:22Z
ObjectType	string	タスクのタイプ。デフォルト値：file。有効な値： file：1 つ以上のファイルをリフレッシュします。 directory：指定されたディレクトリ内のファイルをリフレッシュします。 preload：1 つ以上のファイルをプリフェッチします。	file
Process	string	タスクの進捗状況 (パーセンテージ)。	100%
Description	string	リフレッシュタスクまたはプリフェッチタスクが失敗した場合に返されるエラーのタイプ。有効な値： Internal Error：内部エラーが発生しました。 Origin Timeout：オリジンサーバーからの応答がタイムアウトしました。 Origin Return StatusCode 5XX：オリジンサーバーが HTTP ステータスコード 5xx を返しました。	Internal Error
ObjectPath	string	リフレッシュされたオブジェクトの URL。	http://example.com/****.txt
TaskId	string	タスク ID。	704225667

例

成功レスポンス

JSONJSON

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

エラーコード

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

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

変更履歴

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