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

Queries the information about an Image Search instance by name.

Operation description

Usage notes

This operation queries the information about an Image Search instance.

Note

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

QPS limit

The default concurrency for query operations is 1, which means 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:Detail

*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 already purchased an Image Search instance, you can log on to the Image Search console to view the 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. Pay attention to the difference when you use it.	imagesearchName

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
Success	boolean	Indicates whether the request is successful.	true
Instance	object	The instance information.
Capacity	integer	The capacity of the service plan. Unit: 10,000.	10
UtcExpireTime	string	The time when the instance expires. Unit: milliseconds.	1623081600000
UtcCreate	string	The creation time of the instance. Unit: milliseconds.	1620382716000
ServiceType	integer	The Image Search model. 0: product image search. 1: generic image search. Valid values: 0: product image search. 1: generic image search. 2: fabric search. 3 and 7: trademark search. 4: copyright search. 5: furniture search. 6: hardware search.	0
Region	string	The region information.	cn-shanghai
Name	string	The instance name.	imagesearchName
TotalCount	integer	The number of images.	10063
Qps	integer	The QPS of the service plan.	1

Examples

Success response

JSON format

{
  "RequestId": "36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1",
  "Success": true,
  "Instance": {
    "Capacity": 10,
    "UtcExpireTime": "1623081600000",
    "UtcCreate": "1620382716000",
    "ServiceType": 0,
    "Region": "cn-shanghai",
    "Name": "imagesearchName",
    "TotalCount": 10063,
    "Qps": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	DeniedRequest	Your request was denied due to instance flow control.
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.