本文为您介绍IncreaseList接口的语法及示例，用于向图像搜索实例中查看批量任务列表。

使用说明

本接口用于向图像搜索实例中查询批量任务。

说明 如需了解更多产品详情和获取技术支持，请单击在线咨询或通过钉钉群（35035130）联系我们。

QPS限制

查询操作默认的并发量为1，也就是每秒钟最多处理1个请求。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 IncreaseList

系统规定参数。取值：IncreaseList。
InstanceName String 是 demoinstance1

图搜实例名称。最多支持20个字符。

如果已经购买图搜实例可登录图像搜索管控台查看。

如果没有购买图搜实例可参考开通服务和创建实例。

说明 这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。
Id Long 否 500

批量任务ID。

说明 批量任务ID，需要先执行批量操作从返回值得到。
BucketName String 否 bucketName

Bucket名称。
Path String 否 /xxx/xxx

OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。
PageSize Integer 否 10

返回结果的数目。默认值为10。
PageNumber Integer 否 1

返回结果的起始位置。默认值为1。

返回数据

名称 类型 示例值 描述
RequestId String B3137727-7D6E-488C-BA21-0E034C38A879

请求ID。
Data Object

批量任务信息返回。
Increments Array of Instance

批量任务集合。
Instance
Msg String sucess

错误信息。
Status String SUCCESS

任务状态。

  • PROCESSING：任务处理中。
  • FAIL：任务执行失败。
  • SUCCESS：任务已完成。
UtcModified Long 1629095760000

任务更新时间。单位毫秒。
BucketName String bucketName

Bucket名称。
UtcCreate String 1629095713000

任务创建时间。单位毫秒。
Code String 0

错误码。

  • 0：成功。
  • 非0：失败。
Path String /xx/xx

OSS中increment.meta文件的绝对路径。必须"/"开头，非"/"结尾。
ErrorUrl String https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx

结果下载地址。有效期两个小时。
Id Long 500

任务ID。
CallbackAddress String http://xxxxx

任务回调地址。
PageSize Integer 10

查询结果数目。
PageNumber Integer 1

结果当前页数。
TotalCount Long 15

任务总数量。

示例

请求示例

{
	"InstanceName":"xxxx",
  "Id":500,
  "PageSize":1,
  "PageNumber":1
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "Increments" : {
      "Instance" : [ {
        "BucketName" : "BucketName",
        "Code" : "0",
        "ErrorUrl" : "https://imageSearchName.oss-cn-shanghai.aliyuncs.com/xxxx",
        "Id" : 1257,
        "Msg" : "success",
        "Path" : "/xxx/xxx",
        "Status" : "NORMAL",
        "UtcCreate" : "1631067749000",
        "UtcModified" : 1631068020000
      } ]
    },
    "PageNumber" : 1,
    "PageSize" : 1,
    "TotalCount" : 43
  },
  "RequestId" : "A4A84E43-BB93-13EA-9D02-B282035821C1"
}

错误码

请参见错误码。