获取目标的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeWatchItems

系统规定参数。取值:DescribeWatchItems

PageNumber Long 1

获取第几个分页。

PageSize Long 10

获取的分页大小,最大100。

WatchPolicyId String 300f7e67c82e42b48a197894f512343b

关注策略ID。

WatchItemIds String ["30f6XXXX","7c2eXXXX","b4a1XXXX"]

目标ID列表,JSON数组格式,一次支持操作1000个。不指定时,返回该策略下的全部目标。

返回数据

名称 类型 示例值 描述
RequestId String 46329898-489C-4E63-9BA1-C1DA5C5D0986

请求ID。

Success Boolean true

是否调用成功。

Code String 200

响应code。

Message String OK

返回消息。

Data Object

返回数据。

TotalCount Long 32

结果总数。

PageSize Long 10

每个分页大小。

PageNumber Long 1

当前是第几个分页。

Records Array of Record

节点名称: Record。

WatchItemId String 30f6XXXX

目标ID,每个策略中唯一,不同策略可以重复。

WatchItemName String example

目标名称。

ItemAttributes String String [ { "Key":"HairColor", "Value":["4","1"], "Score":0.81 }, { "Key":"GenderCode", "Value":["1"], "Score":0.92 }]

目标的属性,和图片二选一。

ItemImageUrl String http:/www.aliyun.com/file2

目标图图片 url,和属性二选一。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeWatchItems
&PageNumber=1
&PageSize=10
&WatchPolicyId=300f7e67c82e42b48a197894f512343b
&WatchItemIds=["30f6XXXX","7c2eXXXX","b4a1XXXX"]
&公共请求参数

正常返回示例

XML格式

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

<DescribeWatchItemsResponse>
    <RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>OK</Message>
    <Data>
        <TotalCount>32</TotalCount>
        <PageSize>10</PageSize>
        <PageNumber>1</PageNumber>
        <Records>
            <WatchItemId>30f6XXXX</WatchItemId>
            <WatchItemName>example</WatchItemName>
            <ItemAttributes>String	[	{  "Key":"HairColor", 	"Value":["4","1"], 	"Score":0.81	 }, 	{  "Key":"GenderCode",   "Value":["1"],   "Score":0.92 	}]</ItemAttributes>
            <ItemImageUrl>http:/www.aliyun.com/file2</ItemImageUrl>
        </Records>
    </Data>
</DescribeWatchItemsResponse>

JSON格式

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

{
  "RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "Success" : true,
  "Code" : "200",
  "Message" : "OK",
  "Data" : {
    "TotalCount" : 32,
    "PageSize" : 10,
    "PageNumber" : 1,
    "Records" : [ {
      "WatchItemId" : "30f6XXXX",
      "WatchItemName" : "example",
      "ItemAttributes" : "String\t[\t{  \"Key\":\"HairColor\", \t\"Value\":[\"4\",\"1\"], \t\"Score\":0.81\t }, \t{  \"Key\":\"GenderCode\",   \"Value\":[\"1\"],   \"Score\":0.92 \t}]",
      "ItemImageUrl" : "http:/www.aliyun.com/file2"
    } ]
  }
}

错误码

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