Detail - Image Search - Alibaba Cloud Documentation Center

Usage notes

This operation queries instance details.

QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process only 1 request every second.

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


Name	Type	Required	Example	Description
Action	String	Yes	Detail	The operation that you want to perform. Set the value to Detail.
InstanceName	String	Yes	imagesearchName	The name of the instance.

Response parameters


Name	Type	Example	Description
RequestId	String	36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1	The ID of the request.
Success	Boolean	true	Indicates whether the request is successful.
Instance	Object		The details about the instance.
Capacity	Integer	10	The capacity of the plan. Unit: × 10,000 images.
UtcExpireTime	String	1623081600000	The time when the instance expires. Unit: milliseconds.
UtcCreate	String	1620382716000	The time when the instance was created. Unit: milliseconds.
ServiceType	Integer	0	The Image Search model. 0: commodity search. 1: generic image search.
Region	String	cn-shanghai	The information about the region.
Name	String	imagesearchName	The name of the instance.
TotalCount	Long	10063	The number of images.
Qps	Integer	1	The number of queries per second supported by the plan.

Examples

Sample requests

{
	"InstanceName":"xxxx"
}

Sample success responses

JSON format

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

{
  "RequestId" : "XXXX-8CF3-XXXXX-B146-XXXXX",
  "Instance" : {
    "Name" : "XXXXXX",
    "UtcExpireTime" : 1623081600000,
    "TotalCount" : 10063,
    "UtcCreate" : 1620382716000,
    "Capacity" : 10,
    "Qps" : 1,
    "ServiceType" : 0,
    "Region" : "cn-shanghai"
  }
}

Error codes


HttpCode	Error code	Error message	Description
400	DeniedRequest	Your request was denied due to instance flow control.	The error message returned because your request has been denied due to throttling.
400	InvalidInstance	The specified instance name is invalid.	The error message returned because the instance name is invalid.
400	Console.BadRequest	The request has invalid parameters.	The error message returned because the request is invalid. Check the parameter values.
400	Console.InstanceNotFound	The specified ImageSearch instance is not found.	The error message returned because the specified instance cannot be found. Check the instance ID.
401	Console.LoginError	Check login failed.	The error message returned because the logon failed. Check the username, password, and email address.
403	Console.NoPermission	You are not authorized to this operation.	The error message returned because you are not authorized to perform this operation. Acquire the required permissions from the administrator.
409	Console.InstanceStatusError	Current Instance status not supported this opreate.	The error message returned because the status of the instance does not support this operation. Check the instance status.
409	Console.OrderStatusError	Current Order status not supported this opreate.	The error message returned because the order is invalid. Check whether the order is valid.
409	Console.IncrementStatusError	Current Increment status not supported this opreate.	The error message returned because 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.	The error message returned because a server error occurred. Log on to the Alibaba Cloud Management Console and submit a ticket.

For a list of error codes, visit the API Error Center.

Error codes

For a list of error codes, visit the API Error Center.