使用Detail接口按名称查询实例信息-图像搜索-阿里云

使用说明

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

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

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action

String

是

Detail

系统规定参数。取值：Detail。

InstanceName

String

是

imagesearchName

图搜实例名称。最多支持20个字符。

如果已经购买图搜实例可登录图像搜索管控台查看。

如果没有购买图搜实例可参考开通服务和创建实例。

说明这里的实例名称并非实例ID，且实例名称同区域内唯一不可重复，使用时请区分。

返回数据

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

示例

请求示例

{
	"InstanceName":"xxxx"
}

正常返回示例

XML格式

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

<DetailResponse>
    <RequestId>36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1</RequestId>
    <Success>true</Success>
    <Instance>
        <Name>imagesearchName</Name>
        <UtcExpireTime>1623081600000</UtcExpireTime>
        <TotalCount>10063</TotalCount>
        <UtcCreate>1620382716000</UtcCreate>
        <Capacity>10</Capacity>
        <Qps>1</Qps>
        <ServiceType>0</ServiceType>
        <Region>cn-shanghai</Region>
    </Instance>
</DetailResponse>

JSON格式

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

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

错误码

请参见错误码。