ListRecognitionSamples - Intelligent Media Services - Alibaba Cloud Documentation Center

Retrieves all samples of a custom entity. Pagination is supported.

Operation description

This API is supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.
You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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

ice:ListRecognitionSamples

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Algorithm	string	Yes	The type of recognition algorithm. Valid values: landmark object logo face	landmark
LibId	string	Yes	The library ID. If you specify this parameter, the system performs an exact match. You can specify multiple library IDs. Separate them with commas (,).	lib1,lib2,lib3
EntityId	string	Yes	The entity ID. If you set this parameter to ANY, the system queries by EntityName.	************544cb84754**********
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	10
EntityName	string	No	The entity name.	custom_person

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of samples.	5
Samples	object
Sample	array<object>	The samples.
	object	A sample.
SampleId	string	The sample ID.	************4d2ba728e2f************
ImageUrl	string	The URL of the image sample.	https://example.com/sample.png
EntityId	string	The entity ID.	*****49ff-9b15****
LibId	string	The library ID.	********23da4529998**********

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 5,
  "Samples": {
    "Sample": [
      {
        "SampleId": "**************4d2ba728e2f**************",
        "ImageUrl": "https://example.com/sample.png",
        "EntityId": "*******49ff-9b15******",
        "LibId": "**********23da4529998************"
      }
    ]
  }
}

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.