# 查询刷新预热任务 - ShowHistoryTasks #### 功能介绍 查询刷新预热任务。 - 单租户调用频率：30次/s。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cdn/cdn_02_0019.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cdn/cdn_02_0020.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cdn:configuration:queryCacheHistoryTask | List | - | - | - | - | #### URI GET /v1.0/cdn/historytasks 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 当用户开启企业项目功能时，该参数生效，表示查询资源所属项目，"all"表示所有项目。注意：当使用子账号调用接口时，该参数必传。 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id。 | | page_size | 否 | Integer | 单页最大数量，取值范围为1-10000。page_size和page_number必须同时传值。默认值30。 | | page_number | 否 | Integer | 当前查询第几页，取值范围为1-65535。默认值1。 | | status | 否 | String | 任务状态。 task_inprocess 表示任务处理中，task_done表示任务完成。 | | start_date | 否 | Long | 查询起始时间，相对于UTC 1970-01-01到当前时间相隔的毫秒数。 | | end_date | 否 | Long | 查询结束时间，相对于UTC 1970-01-01到当前时间相隔的毫秒数。 | | order_field | 否 | String | 用来排序的字段，支持的字段有"task_type"：任务的类型，"total"：url总数，"processing"：处理中的url个数， "succeed"：成功处理的url个数，"failed"：处理失败的url个数，"create_time"：任务的创建时间。order_field和order_type必须同时传值，否则使用默认值"create_time" 和 "desc"：降序。 | | order_type | 否 | String | desc：降序，或者asc：升序。默认值desc。 | | file_type | 否 | String | 文件类型，file：文件；directory：目录。 | | task_type | 否 | String | 任务类型，refresh：刷新任务；preheating：预热任务。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总共的任务个数。 | | tasks | Array of [TasksObject] objects | 日志列表数据 | 表4TasksObject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 任务id。 | | task_type | String | 任务的类型， 其值可以为refresh：刷新任务，或preheating：预热任务。 | | status | String | 任务执行结果，task_done表示成功 ，task_inprocess表示执行中。 | | processing | Integer | 处理中的url个数。 | | succeed | Integer | 成功处理的url个数。 | | failed | Integer | 处理失败的url个数。 | | total | Integer | url总数。 | | create_time | Long | 任务的创建时间，相对于UTC 1970-01-01到当前时间相隔的毫秒数。 | | file_type | String | 文件类型，file：文件；directory：目录。 | #### 请求示例 ``` GET https://cdn.myhuaweicloud.com/v1.0/cdn/historytasks?status=task_inprocess&page_size=30&page_number=1&enterprise_project_id=0 ``` #### 响应示例 **状态码：200** OK ``` { "total" : 2, "tasks" : [ { "id" : "ff8080xxxxxxxxxxxxd816ff0128", "status" : "task_inprocess", "processing" : 2, "succeed" : 0, "failed" : 0, "task_type" : "refresh", "total" : 2, "create_time" : 1534240233215, "file_type" : "file" }, { "id" : "ff8080xxxxxxxxxxx4fe64797", "status" : "task_inprocess", "processing" : 1, "succeed" : 0, "failed" : 0, "task_type" : "refresh", "total" : 1, "create_time" : 1534240219944, "file_type" : "file" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cdn.v2.region.CdnRegion; import com.huaweicloud.sdk.cdn.v2.*; import com.huaweicloud.sdk.cdn.v2.model.*; public class ShowHistoryTasksSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CdnClient client = CdnClient.newBuilder() .withCredential(auth) .withRegion(CdnRegion.valueOf("")) .build(); ShowHistoryTasksRequest request = new ShowHistoryTasksRequest(); try { ShowHistoryTasksResponse response = client.showHistoryTasks(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcdn.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = CdnClient.new_builder() \ .with_credentials(credentials) \ .with_region(CdnRegion.value_of("")) \ .build() try: request = ShowHistoryTasksRequest() response = client.show_history_tasks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cdn.CdnClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cdn.NewCdnClient(hcClient) request := &model.ShowHistoryTasksRequest{} response, err := client.ShowHistoryTasks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CDN/sdk?api=ShowHistoryTasks&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cdn/ErrorCode.html)。