You need to enable JavaScript to run this app.
导航
同步批量处理
最近更新时间:2024.04.19 11:54:39首次发布时间:2023.12.25 18:52:45

本接口支持执行批量处理同步操作,一次同步请求支持批量处理最多 1000 个资源。

注意事项

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

请求说明

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

请求参数

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

调试

Query

参数类型是否必选示例值描述
ActionStringGetBatchProcessResult接口名称。当前 API 的名称为 GetBatchProcessResult
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01
ServiceIdStringf0**5k指定同步批处理的服务 ID。

Body

参数类型是否必选示例值描述
BatchingInfoArray of BatchingInfo-待批量处理的资源链接信息

BatchingInfo

参数类型是否必选示例值描述

Action

String

meta

批处理能力,取值如下所示:

  • meta:获取资源元信息
  • preload:源站图片预热

注意

如需批量预热源站图片,请 提交工单联系技术支持开启。

UrlStringhttp://test.com/tos-cn-i-f0**5k/demo.png指定服务下待批处理资源的可访问 URL

返回参数

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

参数类型示例值描述
DataArray of Data-批处理结果

Data

参数类型示例值描述
UrlString http://test.com/tos-cn-i-f0**5k/demo.png资源 URL
SizeInteger230000该资源的文件大小,单位为 byte。
ActionStringmeta该资源使用的批处理能力
ErrStringfail to get url,err no useful response got该资源执行批处理操作时的错误描述
StatusCodeInteger403访问该资源时返回的 HTTP 状态码

请求示例

POST https://imagex.volcengineapi.com/?Action=GetBatchProcessResult&Version=2023-05-01

{
    "BatchingInfo": [
        {
            "Action": "meta",
            "Url": "http://test.com/tos-cn-i-f0**5k/demo.png"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetBatchProcessResult",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "Url": "http://test.com/tos-cn-i-f0**5k/demo.png",
                "Size": 234000,
                "Err": "fail to get url,err no useful response got",
                "StatusCode": 403,
                "Action": "meta"
            }
        ]
    }
}

错误码

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

服务端 SDK

veImageX 提供了配套的开发工具集 SDK,已支持 Java SDK,帮助您更方便的调用 API。