DescribeRefreshTasks API を呼び出して、更新またはプリロードタスクの状態を照会できます。
- タスク ID または URL でステータス情報を照会できます。
- TaskId または ObjectPath パラメーターを指定しない場合、最初のページの直近 3 日間のデータが返されます。 デフォルトでは、1 ページあたり最大 20 エントリが表示されます。
- TaskId パラメーターと ObjectPath パラメーターは同時に指定できます。
- DomainName または TaskStatus パラメーターを指定する場合、ObjectType パラメーターも指定する必要があります。
- 過去3日以内のデータのみ照会できます。
デバッグ
Alibaba Cloud は、API の使用を簡素化するためにOpenAPI Explorerを提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。
リクエストパラメーター
パラメータ | タイプ | 必須/省略可能 | 説明 |
---|---|---|---|
Action | String | はい | 実行する操作 (DescribeRefreshTasks) を設定します。 |
TaskId | String | いいえ | 照会するタスクの ID を設定します。 |
ObjectPath | String | 任意 | オブジェクトのパスを設定します。完全一致の条件として使用されます。 |
DomainName | String | 任意 | CDN ドメインの名前を指定します。 |
ObjectType | String | 任意 | タスクの ID を設定します。 設定可能な値は次のとおりです。
|
Status | String | 任意 | タスクの実行ステータス 設定可能な値は次のとおりです。
|
StartTime | String | 任意 | データを照会する期間を指定します。 ISO 8601 標準に従って、yyyy-MM-ddTHH:mm:ssZ の形式で設定します (例:2017-01-01T12:12:20Z)。 |
EndTime | String | 任意 | データを照会する期間の開始日時を指定します。 ISO 8601 標準に従って、yyyy-MM-ddTHH:mm:ssZ の形式で設定します (例:2017-01-01T12:12:20Z)。 |
PageSize | Integer | 任意 | 返されるページ毎のエントリ数を設定します。 デフォルト値は 20 です。 設定可能な値は1 から 50です。 |
PageNumber | Integer | 任意 | 返されるページ数を設定します。 設定可能な値は1 から 100です。 |
応答パラメーター
パラメーター | データ型 | 説明 |
---|---|---|
タスク | Struct | タスクに関する詳細情報を示します。 |
PageSize | Integer | 返されたページ毎のエントリ数を示します。 |
PageNumber | Integer | 返されたページ数を示します。 |
TotalCount | Integer | 返されたエントリの総数を示します。 |
TaskItem のパラメーター
パラメーター | データ型 | 説明 |
---|---|---|
TaskId | String | タスクのID。 |
ObjectPath | String | オブジェクトのタイプを示します。 |
Status | String | タスクの実行ステータスを示します。
|
Process | String | タスクの進捗状況 (%) を示します。 |
ObjectType | String | タスクの ID を示します。
|
CreationTime | DateTime | インスタンスが作成された日時を示します。 時刻は UTC で表示されます。 |
説明 | String | 更新またはプリロードタスクが失敗した場合に返されたエラーのタイプを示します。
|
例
リクエスト例
https://cdn.aliyuncs.com?&Action=DescribeRefreshTasks&ObjectPath=&PageNumber=1&PageSize=10&<Common request parameters>
正常に処理された場合のレスポンス例
JSON
形式
{
"Tasks" : {
"CDNTask" : [{
"CreationTime" : "2014-11-27T08:23:22Z",
"ObjectPath" : "http://example1.com/1.txt",
"Status" : "Complete",
"TaskId" : "704225667",
"ObjectType" : "file",
"Process" : "100%"
}, {
"CreationTime" : "2014-11-27T08:18:38Z",
"ObjectPath" : "http://example2.com/1.txt",
"Status" : "Complete",
"TaskId" : "704222904",
"ObjectType" : "file",
"Process" : "100%"
}
]
},
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 2,
"RequestId" : "174F6032-AA26-470D-B90E-36F0EB205BEE"
}
エラーコード
エラーコード | エラーメッセージ | HTTP ステータスコード | 説明 |
---|---|---|---|
Throttling | Request was denied due to request throttling. | 503 | 帯域幅調整が行われ、リクエストが拒否された場合に返されるエラーメッセージです。 |
OperationDenied | Your account does not open CDN service yet. | 403 | ご利用中のアカウントで CDN の利用を開始していない場合に返されるエラーメッセージです。 |
OperationDenied | Your CDN service is suspended. | 403 | ご利用中のアカウントの CDN が一時停止された場合に返されるエラーメッセージです。 |
InvalidTaskId.Malformed | Specified TaskId is malformed. | 400 | 設定された TaskId パラメーターが正しくない場合に返されるエラーメッセージです。 |