You need to enable JavaScript to run this app.
导航
获取异步压缩任务详情
最近更新时间:2024.04.17 14:40:53首次发布时间:2023.07.14 14:45:08

本接口支持通过指定服务 ID 和异步压缩任务 ID 获取压缩任务详情。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 超时时间:超时时间约为 10 秒

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=GetCompressTaskInfo&Version=2018-08-01

说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetCompressTaskInfo接口名称。当前 API 的名称为 GetCompressTaskInfo
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01
TaskIdString82370***12102异步任务 ID

ServiceId

String

7j**6

服务 ID。

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

返回参数

参数类型示例值描述

Status

String

Running

异步任务状态,取值如下所示:

  • Pending:排队中

  • Running:进行中

  • Failed:执行失败

  • Success:执行成功

TaskIdString82370***12102异步任务 ID
ProcessCountInteger4任务处理进度,即已处理的文件数量。
OutputUriString8dhosd***2703g压缩文件包的存储 key
ErrMsgString压缩失败错误信息。仅当StatusFailed时,该值不为空。
ErrCodeInteger604026错误码。仅当StatusFailed时,该值不为 0。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetCompressTaskInfo&Version=2018-08-01&ServiceId=7j%2A%2A6&TaskId=82370%2A%2A%2A12102

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetCompressTaskInfo",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
      "Status": "Running",
      "TaskId": "82370***12102",
      "ProcessCount": 4,
      "OutputUri": "8dhosd***2703g",
      "ErrMsg": "压缩失败",
      "ErrCode": 604026
  }
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。

服务端 SDK

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