获取任务列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取任务列表

最近更新时间：2024.01.31 14:31:35首次发布时间：2023.12.28 11:22:02

本接口支持分页查询账号下已创建的所有离线评估任务列表。

注意事项

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

请求说明

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

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageAnalyzeTasks`	接口名称。当前 API 的名称为 `GetImageAnalyzeTasks`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Region	String	否	`cn`	任务地区。默认为 `cn`，表示国内。
SearchPtn	String	否	`test`	返回任务名称或描述中包含该值的任务。
Limit	String	否	`100`	分页条数。取值范围为 (0,100]，默认值为 100。
Offset	String	否	`0`	分页偏移量，默认为 0。取值为 1 时，表示跳过第一条数据，从第二条数据取值。

返回参数

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

参数	类型	示例值	描述
Tasks	Array of Tasks	`-`	任务
Total	Integer	`2`	查询到任务数量

Tasks

参数	类型	示例值	描述
Name	String	`test`	离线评估任务名称
Desc	String	`备注`	任务描述
Type	String	`UriFile`	任务类型，取值如下所示： `UrlFile`：在线提交 URL 离线评估 `UriFile`：在线提交 URI 离线评估
ServiceId	String	`5t**4x`	所在服务的服务 ID
Tpl	String	`tplv-5t**4x-12.image`	`Type` 取值 `UriFile` 时，指定的模版名称。
ResUri	String	`["tos-cn-i-5t**4x/demo.txt"]`	txt 评估文件的 Store URI。
EvalPerStage	Boolean	`false`	是否模拟模板每阶段输出，取值如下所示： `true`：是 `false`：否
TaskId	String	`640000200205055079`	该条评估任务的任务 ID
Status	String	`Done`	任务状态，取值如下所示： `Pending`：排队中 `Done`：已完成 `Running`：进行中
CreateAt	String	`2023-09-15T06:28:07.267Z`	评估任务创建时间
UpdateAt	String	`2023-09-15T06:28:07.267Z`	评估任务更新时间

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAnalyzeTasks&Version=2023-05-01&Limit=100&Offset=0&Region=cn&SearchPtn=test

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetImageAnalyzeTasks",
    "Version": "2023-05-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "Tasks": [
      {
        "Id": "653891761**234a65e2ce94",
        "Name": "test",
        "Desc": "备注",
        "ServiceId": "4u**7a",
        "Type": "UrlFile",
        "Tpl": "",
        "ResUri": [
          "tos-cn-i-4u**7a/StoreUri.txt"
        ],
        "EvalPerStage": false,
        "CreateAt": "2023-10-25T03:54:30.814Z",
        "UpdateAt": "2023-10-26T07:22:25.885Z",
        "Status": "Pending"
      },
      {
        "Id": "6503f977**e077722be798e",
        "Name": "test",
        "Desc": "",
        "ServiceId": "5t**4x",
        "Type": "UriFile",
        "Tpl": "tplv-5t**4x-12.image",
        "ResUri": [
          "tos-cn-i-5t**4x/demo.txt"
        ],
        "EvalPerStage": false,
        "CreateAt": "2023-09-15T06:28:07.267Z",
        "UpdateAt": "2023-09-15T06:28:07.267Z",
        "Status": "Done"
      }
    ],
    "Total": 2
  }
}

错误码

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

服务端 SDK

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