批量操作

本文为您介绍IncreaseInstance接口的语法及示例,用于根据名称新建图像搜索实例批量任务。

使用说明

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

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

QPS限制

同一时间,只能运行一个批量任务。

说明 当上一个批量任务没有完成时,无法提交新的批量任务。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String IncreaseInstance

系统规定参数。取值:IncreaseInstance

InstanceName String imagesearchName

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

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

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

说明 这里的实例名称并非实例ID,使用时请区分。
BucketName String bucketName

Bucket名称。

说明 仅支持实例同区域的BucketName。
Path String /xxx/xxx

OSS中increment.meta文件的绝对路径。必须"/"开头,非"/"结尾。

说明 需要您提前准备increment.meta文件。具体请参见批量操作
CallbackAddress String http://xxxxx

任务回调地址。

返回数据

名称

类型

示例值

描述

RequestId String 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1

请求ID。

Success Boolean true

请求是否成功。

Data Object

任务执行返回。

IncrementStatus String PROCESSING

批量任务状态。

  • PROCESSING:任务处理中。
  • FAIL:任务执行失败。
  • SUCCESS:任务已完成。
Id String 500

任务ID。

示例

请求示例

{
  "InstanceName":"xxxx",
  "BucketName":"xx",
  "Path":"/xxxx"
}

正常返回示例

JSON格式

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

{
  "RequestId" : "XXXX-D6D9-XXXX-930D-XXXX",
  "Data" : {
    "IncrementStatus" : "PROCESSING",
    "Id" : "500"
  },
  "Success" : true
}

错误码

请参见错误码