文档中心

获取任务详情

最近更新时间：2024.01.31 15:20:01

首次发布时间：2023.01.12 18:13:52

本接口支持查询近 30 天内内容管理任务详情列表。

请求说明

接口名称：GetImageContentTaskDetail
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageContentTaskDetail&Version=2018-08-01
请求频率：单用户请求频率是 10 次/秒。
数据延迟：暂无数据延迟。

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为 2018-08-01。

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	描述
TaskType	String	否	内容管理任务类型，取值如下所示： `refresh`：刷新任务，包含刷新 URL 和刷新目录。 `refresh_url`：刷新 URL `block_url`：禁用 URL `unblock_url`：解禁 URL `preload_url`：预热 URL `refresh_dir`：目录刷新（支持根目录刷新）
TaskId	String	否	待查询任务 ID
State	String	否	内容管理资源状态，取值如下所示： `submitting`：提交中 `running`：执行中 `succeed`：成功 `failed`：失败
Order	String	否	按时间排序，取值如下所示： `asc`：正序 `desc`：逆序
StartTime	Integer	是	查询开始时间，unix 时间戳，单位为秒。
EndTime	Integer	是	查询结束时间，unix 时间戳，单位为秒。
Url	String	否	资源 URL 或者目录，可精确匹配，取值为空时表示查询全部任务。
PageNum	Integer	否	页码，系统将仅返回该页面上的任务。默认值为 1。
PageSize	Integer	否	每页最大记录数，取值范围是[10,1000]。默认值为 100。

返回参数

参数	类型	描述
Total	Integer	总记录数
PageNum	Integer	当前页码
PageSize	Integer	每页最大记录数
Data	Array of Data	具体数据

Data

参数	类型	描述
Url	String	任务指定的 URL 或目录
TaskType	String	资源任务类型，取值如下所示： `refresh`：刷新任务 `refresh_url`：刷新 URL `block_url`：禁用 URL `unblock_url`：解禁 URL `preload_url`：预热 URL `refresh_dir`：目录刷新
TaskId	String	任务 ID
State	String	资源任务状态，取值如下所示： `submitting`：提交中 `running`：执行中 `succeed`：成功 `failed`：失败
Msg	String	完成结果提示信息
Process	String	任务进度
CreateTime	Integer	任务的创建时间
UpdateTime	Integer	任务的更新时间

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageContentTaskDetail&Version=2018-08-01&ServiceId=WMKp6UXe*
{
    "TaskType": "refresh_url",
    "TaskId": "******",
    "StartTime": 891,
    "EndTime": 208,
    "Url": "http://village.bb/cold",
    "PageNum": 4,
    "PageSize": 10,
    "State": "succeed",
    "Order": "asc"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019052718260801022507411159839",
        "Action": "GetImageContentTaskDetail",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 40,
        "PageNum": 4,
        "PageSize": 10,
        "Data": [
            {
                "Url": "http://village.bb/cold",
                "TaskType": "refresh_url",
                "TaskId": "******",
                "State": "succeed",
                "Process": "100%",
                "Msg": "",
                "CreateTime": 37,
                "UpdateTime": 494
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019052718331201022507411142148",
        "Action": "GetImageContentTaskDetail",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "CodeN": 604004,
            "Code": "",
            "Message": "image url invalid"
        }
    }
}

错误码

访问错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：