搜索目标。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SearchTarget | 系统规定参数。取值:SearchTarget。 |
CorpId | String | 是 | 44B0E0XXXX | 项目ID,指定在哪个项目中搜索。 |
PageNumber | Long | 是 | 1 | 当前页码,最大不超过100。 |
PageSize | Long | 是 | 10 | 每页请求最大返回结果的数量,最大不超过100。 |
TargetType | String | 否 | Face | 搜索目标类型,可选值: Face Body Motor NonMotor Event AIoT |
TargetAttributes | String | 否 | [ { "Key":"HairColor", "Value":["4","1"], "Score":0.81 }, { "Key":"GenderCode", "Value":["1"], "Score":0.92 }] | 搜索的属性,最多同时指定20个属性,多个属性需同时满足,才会返回结果。 |
TargetImageUrl | String | 否 | http:/www.aliyun.com/file1 | 待搜索的图片url,url最长1024字符,对应图片最大500KB。 |
TargetImageData | String | 否 | 略 | 图片的Base64编码,最大500KB。 |
OrderBy | String | 否 | [{"Key":"Timestamp","Type":"Asc"}] | 按属性搜索才支持此字段,表示结果的排序方法,格式为{ "key": "排序规则"}。 |
DeviceList | String | 否 | ["1C44674CC97AXXXX", "915E4ACA5866XXXX"] | 设备ID列表,指定要在哪些设备产出的数据中搜索。 |
ModelId | String | 否 | 12345 | 设备ID对应使用的模型ID。 |
BeginTime | String | 否 | 2021-01-27T12:00:00Z | 搜索的数据记录开始时间,需和结束时间配对使用,未配对则忽略。 |
EndTime | String | 否 | 2021-01-27T20:00:00Z | 搜索的数据记录结束时间,需和开始时间配对使用,未配对则忽略。 |
SimilarityThreshold | double | 否 | 0.92 | 待搜索图片的相似度阈值,支持0.00, 0.99范围的小数。 |
返回数据
示例
请求示例
http(s)://[Endpoint]/?Action=SearchTarget
&CorpId=44B0E0XXXX
&PageNumber=1
&PageSize=10
&TargetType=Face
&TargetAttributes=[ { "Key":"HairColor", "Value":["4","1"], "Score":0.81 }, { "Key":"GenderCode", "Value":["1"], "Score":0.92 }]
&TargetImageUrl=http:/www.aliyun.com/file1
&TargetImageData=略
&OrderBy=[{"Key":"Timestamp","Type":"Asc"}]
&DeviceList=["1C44674CC97AXXXX", "915E4ACA5866XXXX"]
&ModelId=12345
&BeginTime=2021-01-27T12:00:00Z
&EndTime=2021-01-27T20:00:00Z
&SimilarityThreshold=0.92
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SearchTargetResponse>
<RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
<Success>true</Success>
<Code>200</Code>
<Message>OK</Message>
<Data>
<Records>
<TargetType>Face</TargetType>
<Timestamp>2021-09-14T12:00:00Z</Timestamp>
<DeviceId>001</DeviceId>
<TargetAttributes>[{"Key":"HairColor","Value":"1","Score":0.81},{"Key":"GenderCode","Value":"1","Score":0.92}]</TargetAttributes>
<TargetImageUrl>http:/www.aliyun.com/file2</TargetImageUrl>
<SourceImageUrl>http:/www.aliyun.com/file1</SourceImageUrl>
<LeftTopX>10</LeftTopX>
<LeftTopY>10</LeftTopY>
<RightBottomX>10</RightBottomX>
<RightBottomY>10</RightBottomY>
<TargetImageSimilarity>0.92</TargetImageSimilarity>
</Records>
<TotalCount>30</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
</Data>
</SearchTargetResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"Success" : true,
"Code" : "200",
"Message" : "OK",
"Data" : {
"Records" : [ {
"TargetType" : "Face",
"Timestamp" : "2021-09-14T12:00:00Z",
"DeviceId" : "001",
"TargetAttributes" : "[{\"Key\":\"HairColor\",\"Value\":\"1\",\"Score\":0.81},{\"Key\":\"GenderCode\",\"Value\":\"1\",\"Score\":0.92}]",
"TargetImageUrl" : "http:/www.aliyun.com/file2",
"SourceImageUrl" : "http:/www.aliyun.com/file1",
"LeftTopX" : 10,
"LeftTopY" : 10,
"RightBottomX" : 10,
"RightBottomY" : 10,
"TargetImageSimilarity" : 0.92
} ],
"TotalCount" : 30,
"PageSize" : 10,
"PageNumber" : 1
}
}
错误码
访问错误中心查看更多错误码。