RegisterCustomFace-阿里云帮助中心

Operation description

You can register one custom face per API call.
You can register up to 10 images for a single custom face.

QPS limit

The per-user QPS limit for this operation is 100 calls per second. Exceeding this limit triggers rate limiting, which may affect your business. Call this API appropriately. For more information, see QPS limits.

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

mts:RegisterCustomFace

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CategoryId	string	Yes	The unique ID for a custom figure library. The caller generates this ID and must ensure it is unique. Save this ID to use when you call other APIs. Important This ID cannot be the same as a system figure library ID. If the IDs match, the system figure library is used by default. The ID can be up to 120 characters long, is case-insensitive, and supports characters from any language.	CategoryId001-****
PersonId	string	Yes	The ID of the custom person. This ID uniquely identifies a custom person. You generate this ID and ensure its uniqueness. Store it securely for use with other API calls. Note Supports up to 120 characters, supports Chinese and English characters, is case-insensitive, and returns FaceId as a String.	PersonId001-****
ImageUrl	string	Yes	The public URL of the image containing the face to register. The image must contain exactly one frontal face.	http://example-****.jpeg
PersonName	string	No

Response elements

Element	Type	Description	Example
	object	The response data.
FaceId	string	The ID of the registered face.	c6cc71cb44a9491093818faf9d60****
RequestId	string	The ID of the request.	91AEA76D-25B5-50DF-9126-AA6BB10FDAF4

Examples

Success response

JSON format

{
  "FaceId": "c6cc71cb44a9491093818faf9d60****",
  "RequestId": "91AEA76D-25B5-50DF-9126-AA6BB10FDAF4"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	errorMsg:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.