Detail - 查询实例状态-图像搜索(Image Search)-阿里云帮助中心

本文为您介绍Detail接口的语法及示例，用于根据名称查询图像搜索实例的相关信息。

接口说明

使用说明

本接口用于向图像搜索实例中查询实例信息。

说明

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

QPS 限制

查询操作默认的并发量为 1，也就是每秒钟最多处理 1 个请求。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

imagesearch:Detail

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceName	string	是	图搜实例名称。最多支持 20 个字符。如果已经购买图搜实例可登录图像搜索管控台查看。如果没有购买图搜实例可参考开通服务和创建实例。说明这里的实例名称并非实例 ID，且实例名称同区域内唯一不可重复，使用时请区分。	imagesearchName

返回参数

名称	类型	描述	示例值
	object	结果返回。
RequestId	string	请求 ID。	36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
Success	boolean	请求是否成功。	true
Instance	object	实例信息。
Capacity	integer	套餐容量。单位万。	10
UtcExpireTime	string	实例到期时间。单位毫秒。	1623081600000
UtcCreate	string	实例创建时间。单位毫秒。	1620382716000
ServiceType	integer	图搜模型。 0：商品搜索；1：通用图片搜索；2：布料搜索；3、7：商标搜索；4：版权搜索；5：家具搜索；6：五金搜索。	0
Region	string	地域信息。	cn-shanghai
Name	string	实例名称。	imagesearchName
TotalCount	integer	图片数量。	10063
Qps	integer	套餐 QPS。	1

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	DeniedRequest	Your request was denied due to instance flow control.
400	InvalidInstance	The specified instance name is invalid.	实例名错误
400	Console.BadRequest	The request has invalid parameters.	非法请求，请检查请求参数。
400	Console.InstanceNotFound	The specified ImageSearch instance is not found.	查找不到实例，检查购买的实例ID是否正确。
401	Console.LoginError	Check login failed.	登录失败，请检查用户名、密码、邮箱是否输入有误。
500	Console.InternalError	The request processing has failed due to some unknown error.	服务器内部错误，请登录阿里云控制台提交工单。
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.	用户订单错误，请确认订单处于有效状态
409	Console.IncrementStatusError	Current Increment status not supported this opreate.	增量更新状态错误，请确认当前实例增量状态。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。