SearchMediaByFace - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information about media assets that are related to a specific face.

Operation description

If you have questions about how to use the media asset search feature in Intelligent Media Services (IMS), contact technical support in the DingTalk group (ID 30415005038).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:SearchMediaByFace	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 50.	10
EntityId	string	No	The ID of the entity.	2d3bf1e35a1e42b5ab338d701efa****
PersonImageUrl	string	Yes	The URL of the face image.	https://**.oss-cn-shanghai.aliyuncs.com/input/huangxuan**.jpg
FaceSearchToken	string	Yes	The token that is used to identify the query. You can use this parameter in the SearchMediaClipByFace operation to specify the same query conditions.	zxtest-huangxuan-2023-3-7-V1
SearchLibName	string	No	The name of the search library.	test1
MediaType	string	No	The type of the media asset. Valid values: image video	video

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	7CA7D615-CFB1-5437-9A12-2D185C3EE6CB
Success	string	Indicates whether the request was successful. Valid values: true false	true
Code	string	The status code returned.	200
MediaInfoList	array<object>	The media assets that meet the conditions.
MediaInfo	object	The information about the media assets.
MediaId	string	The ID of the media asset.	3b187b3620c8490886cfc2a9578c****
Total	long	The total number of data records that meet the specified filter condition.	163

Examples

Sample success responses

JSONformat

{
  "RequestId": "7CA7D615-CFB1-5437-9A12-2D185C3EE6CB",
  "Success": "true",
  "Code": "200",
  "MediaInfoList": [
    {
      "MediaId": "3b187b3620c8490886cfc2a9578c****"
    }
  ],
  "Total": 163
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-12	The request parameters of the API has changed	View Change Details