All Products
Search
Document Center

Intelligent Media Services:ListRecognitionSamples

Last Updated:Dec 23, 2025

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

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:ListRecognitionSamplesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AlgorithmstringYes

The type of recognition algorithm. Valid values:

  • landmark
  • object
  • logo
  • face
landmark
LibIdstringYes

The ID of the recognition library.

xxxxxxxxxxx
EntityIdstringYes

The ID of the entity.

e6b985c05174412dbc77c92496b7373b
PageNumberintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

xxx-xxxx-xxxxx-xxxx
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountlong

The total number of samples.

5
Samplesarray<object>

The samples.

CustomViewobject

The sample.

SampleIdstring

The sample ID.

xxxxxxxxxxxxx
ImageUrlstring

The URL of the image sample.

https://example.com/sample.png

Examples

Sample success responses

JSONformat

{
  "RequestId": "xxx-xxxx-xxxxx-xxxx",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 5,
  "Samples": {
    "CustomView": [
      {
        "SampleId": "xxxxxxxxxxxxx",
        "ImageUrl": "https://example.com/sample.png"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
500InternalErrorerrorMsg:%s

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

Change history

Change timeSummary of changesOperation
2025-11-17The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details