IncreaseList-Image Search(Image Search)-阿里云帮助中心

Queries the batch tasks in an Image Search instance.

Operation description

Usage notes

This operation queries batch tasks in an Image Search instance.

Note

For more product details and technical support, click Online Consultation or contact us through the DingTalk group (35035130).

QPS limits

The default concurrency for query operations is 1. A maximum of 1 request can be processed per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imagesearch:IncreaseList

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	Yes	The name of the Image Search instance. The name can be up to 20 characters in length. If you have purchased an Image Search instance, you can log on to the Image Search console to view the instance name. If you have not purchased an Image Search instance, refer to Activate the service and Create an instance. Note The instance name is not the instance ID. The instance name must be unique within a region. Distinguish between the two when you use them.	demoinstance1
Id	integer	No	The ID of the batch task. Note To obtain the batch task ID, you must first perform a batch operation and extract the ID from the response.	500
BucketName	string	No	The name of the bucket.	bucketName
Path	string	No	The absolute path of the increment.meta file in OSS. The path must start with a forward slash (/) and cannot end with a forward slash.	/xxx/xxx
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
PageNumber	integer	No	The page number of the returned results. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	B3137727-7D6E-488C-BA21-0E034C38A879
Data	object	The returned batch task information.
Increments	object
Instance	array<object>	The collection of batch tasks.
	object	The details of the batch task.
Msg	string	The error message.	sucess
Status	string	The status of the task. Valid values: PROCESSING: The task is being processed. FAIL: The task failed. SUCCESS: The task is completed.	SUCCESS
UtcModified	integer	The time when the task was updated. Unit: milliseconds.	1629095760000
BucketName	string	The name of the bucket.	bucketName
UtcCreate	string	The time when the task was created. Unit: milliseconds.	1629095713000
Code	string	The error code. Valid values: 0: Success. Non-zero: Failure.	0
Path	string	The absolute path of the increment.meta file in OSS. The path must start with a forward slash (/) and cannot end with a forward slash.	/xx/xx
ErrorUrl	string	The download URL of the results. The URL is valid for 2 hours.	https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx
Id	integer	The ID of the task.	500
CallbackAddress	string	The callback URL of the task.	http://xxxxx
PageSize	integer	The number of returned entries.	10
PageNumber	integer	The current page number of the returned results.	1
TotalCount	integer	The total number of tasks.	15

Examples

Success response

JSON format

{
  "RequestId": "B3137727-7D6E-488C-BA21-0E034C38A879",
  "Data": {
    "Increments": {
      "Instance": [
        {
          "Msg": "sucess",
          "Status": "SUCCESS",
          "UtcModified": 1629095760000,
          "BucketName": "bucketName",
          "UtcCreate": "1629095713000",
          "Code": "0",
          "Path": "/xx/xx",
          "ErrorUrl": "https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx",
          "Id": 500,
          "CallbackAddress": "http://xxxxx"
        }
      ]
    },
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 15
  }
}

Error codes

HTTP status code	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.	Invalid request. Check the request parameters.
400	Console.InstanceNotFound	The specified ImageSearch instance is not found.	The specified instance ID does not exist. Check the instance ID and try again.
401	Console.LoginError	Check login failed.	Login failed, please check whether the user name, password and email address are entered incorrectly.
500	Console.InternalError	The request processing has failed due to some unknown error.	The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.
500	Console.CallServiceError	Fail to call service.
403	Console.NoPermission	You are not authorized to this operation.
409	Console.InstanceStatusError	Current Instance status not supported this opreate.
409	Console.OrderStatusError	Current Order status not supported this opreate.	User order error, please confirm that the order is valid
409	Console.IncrementStatusError	Current Increment status not supported this opreate.	incremental update status error, please confirm the current examples of incremental state.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.