CreateFacesSearchingTask - Intelligent Media Management - Alibaba Cloud Documentation Center

Operation description

Before you use this operation, review the billing methods and pricing
Important The execution time of asynchronous tasks is not guaranteed.
For each input image, only the face with the largest bounding box is used for the face search.
This is an asynchronous operation. After a task starts, the task information is retained for 7 days and cannot be retrieved after this period. To retrieve task information, you can call the GetTask or ListTasks operation with the returned TaskId. Alternatively, you can configure the Notification parameter to receive asynchronous notifications that contain task information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imm:CreateFacesSearchingTask

list

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. For more information, see Create a project.	test-project
DatasetName	string	Yes	The name of the dataset. For more information, see Create a dataset.	test-dataset
UserData	string	No	Custom user information. This information is returned in the asynchronous notification message to help you associate the message with your system. The maximum length is 2048 bytes.	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Sources	array<object>	No	A list of images.
	object	No	An image object.
URI	string	No	The OSS URI of the image. The OSS URI must follow the format oss://${Bucket}/${Object}. `${Bucket}` is the name of the OSS bucket in the same region as the current project. `${Object}` is the full path of the file, including the file name extension.	oss://test-bucket/test-object
MaxResult	integer	No	The number of most similar faces to return. Valid values: 0 to 100. Default value: 5.	100
Notification	Notification	No	The notification configuration. For more information about the format of asynchronous notification messages, see Asynchronous notification message format.

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	B1E79399-05F7-06D8-95FE-EBE17BA*****
TaskId	string	The task ID.	CreateFacesSearchingTask-00bec802-073a-4b61-ba*****
EventId	string	The event ID.	0ED-1Bz8z71k5TtsUejT4UJ16****

Examples

Success response

JSON format

{
  "RequestId": "B1E79399-05F7-06D8-95FE-EBE17BA*****",
  "TaskId": "CreateFacesSearchingTask-00bec802-073a-4b61-ba*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.