All Products
Search
Document Center

Image Search:IncreaseInstance

Last Updated:May 23, 2025

This topic describes the syntax of the IncreaseInstance operation and provides examples of this operation. You can call this operation to create a batch task for an Image Search instance.

Usage notes

This operation creates a batch task for an Image Search instance.

QPS limits

You can run only one batch task at a time.

Note

You cannot create a new batch task for an Image Search instance when the previous batch task created for the Image Search instance does not finish running.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

IncreaseInstance

The operation that you want to perform. Set the value to IncreaseInstance.

InstanceName

String

Yes

imagesearchName

The name of the Image Search instance. The name can be up to 20 characters in length.

If an Image Search instance is purchased, you can log on to the Image Search console to view the instance.

If no Image Search instance is purchased, you must purchase an instance. For more information, see Activate Image Search and Create an Image Search instance.

Note

The instance name is not the instance ID.

BucketName

String

Yes

bucketName

The name of the bucket.

Note

The bucket must be in the same region as the Image Search instance.

Path

String

Yes

/xxx/xxx

The absolute path to the increment.meta file in the bucket. The path must start with a forward slash (/) and cannot end with a forward slash (/).

Note

You must prepare the increment.meta file in advance. For more information, see Perform batch operations.

CallbackAddress

String

No

http://xxxxx

The callback address.

Response parameters

Parameter

Type

Example

Description

RequestId

String

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

The request ID.

Success

Boolean

true

Indicates whether the request was successful.

Data

Object

The information about the task.

IncrementStatus

String

PROCESSING

The status of the batch task.

  • PROCESSING

  • FAIL

  • SUCCESS

Id

String

500

The task ID.

Examples

Sample requests

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

Sample success responses

JSON format

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

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

Error codes

HttpCode

Error code

Error message

Description

400

InvalidInstance

The specified instance name is invalid.

The instance name is invalid.

400

Console.BadRequest

The request has invalid parameters.

The request is invalid. Check the request parameters.

400

Console.InstanceNotFound

The specified ImageSearch instance is not found.

The instance cannot be found. Check the instance ID.

401

Console.LoginError

Check login failed.

The logon failed. Check the username, password, and email address.

409

Console.OrderStatusError

Current Order status not supported this operation.

The order is invalid. Check the status of the order.

409

Console.IncrementStatusError

Current Increment status not supported this operation.

The incremental update status is invalid. Check the increment update status of the instance.

500

Console.InternalError

The request processing has failed due to some unknown error.

A server error occurred. Log on to the Alibaba Cloud Management Console and submit a ticket.

For a list of error codes, see Service error codes.

Error codes

For more information, see Error codes