ListRecognitionLibs

Updated at:

Queries all custom recognition library information of the current user by paging.

Operation description

  • This API operation currently supports the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions. Other regions are not supported.

  • The queries per second (QPS) limit for a single user is 50. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation properly. 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

ice:ListRecognitionLibs

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Algorithm

string

Yes

The recognition type. Valid values:

  • landmark: custom landmark

  • object: custom object

  • logo: custom logo

  • face: custom face

  • label: custom label

landmark

PageNumber

integer

Yes

The page number.

1

PageSize

integer

Yes

The number of entries per page. The maximum number of entries per page is 50.

10

LibId

string

No

The ID of the library. If you specify this parameter, the system queries the specified library. You can specify multiple IDs separated by commas (,).

lib1,lib2,lib3

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.

10

TotalCount

integer

The total number of entries.

180

Libs

object

Lib

array<object>

The list of recognition libraries.

object

LibId

string

The ID of the recognition library.

*************24b47865c6**************

LibName

string

The name of the recognition library.

acp

LibDescription

string

The description of the recognition library.

Library for commodity identification

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 180,
  "Libs": {
    "Lib": [
      {
        "LibId": "*************24b47865c6**************",
        "LibName": "acp",
        "LibDescription": "Library for commodity identification"
      }
    ]
  }
}

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.