You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /veImageX/API 参考/离线转码/获取任务队列
获取任务队列
最近更新时间：2024.08.14 11:29:16首次发布时间：2023.12.25 16:48:05
我的收藏

本接口支持获取当前账号下已创建的任务队列详情。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 超时时间：超时时间为 10 秒。
  • 服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

  • 请求方式：GET
  • 请求地址：https://imagex.volcengineapi.com/?Action=GetImageTranscodeQueues&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是GetImageTranscodeQueues接口名称。当前 API 的名称为 GetImageTranscodeQueues。
VersionString是2023-05-01接口版本。当前 API 的版本为 2023-05-01。
RegionString否cn队列所在地区。默认取值 cn，表示国内。
SearchPtnString否offline返回队列名称或队列描述中包含该值的队列。默认为空，不传则返回所有队列。
LimitString是10分页条数，取值范围为(0,100]。
OffsetString否0分页偏移量，默认为 0。取值为 1 时，表示跳过第一条数据，从第二条数据取值。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数类型示例值描述
QueuesArray of Queues-当前分页队列详细信息
TotalInteger2符合条件的队列总数

Queues

参数类型示例值描述
IdString63db57e36**cce1ffee11bb1队列 ID
NameStringdefault队列名称
DescString离线转码队列描述

Status

String

Pending

队列状态。取值如下所示：

  • Pending：排队中
  • Running：执行中

Type

String

default

队列类型。取值如下所示：

  • default：表示账号默认队列，每个账号一个
  • user：表示用户创建队列，个数将有配额限制
CreateAtString2023-02-02 14:27:47队列创建时间

EnableCallback

Boolean

false

是否启用回调，取值如下所示：

  • true：启用
  • false：不启用
CallbackConfObject of CallbackConf-队列回调设置

CallbackConf

参数类型示例值描述
MethodStringHTTP回调方式。仅支持取值 HTTP。
EndpointStringhttps://demo.com回调 HTTP 请求地址，用于接收转码结果详情。支持使用 https 和 http 协议。

DataFormat

String

JSON

回调数据格式。取值如下所示：

  • XML
  • JSON
ArgsStringproduct id 业务自定义回调参数，将在回调消息的callback_args中透传出去。具体回调参数请参考回调内容。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageTranscodeQueues&Version=2023-05-01&Limit=10&Offset=0&Region=cn&SearchPtn=offline

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306271632015C6D5DA688505318A600",
        "Action": "GetImageTranscodeQueues",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Queues": [
            {
                "Id": "649a9dbc3**64d44cf5b0",
                "Name": "offline",
                "Desc": "",
                "Status": "Pending",
                "Type": "user",
                "CreateAt": "2023-06-27 16:28:44",
                "EnableCallback": true,
                "CallbackConf": {
                    "Method": "HTTP",
                    "Endpoint": "https://demo.com",
                    "DataFormat": "JSON",
                    "Args": ""
                }
            },
            {
                "Id": "63db57e36**cce1ffee11bb1",
                "Name": "default",
                "Desc": "",
                "Status": "Pending",
                "Type": "default",
                "CreateAt": "2023-02-02 14:27:47",
                "EnableCallback": false,
                "CallbackConf": {
                    "Method": "HTTP",
                    "Endpoint": "12",
                    "DataFormat": "JSON",
                    "Args": ""
                }
            }
        ],
        "Total": 2
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

历史版本

2018-08-01 版本 GetImageTranscodeQueues 接口文档现已停止维护，建议您参考本文档使用最新版本。