ListCustomViews-阿里云帮助中心

Operation description

This API is available in the China North 2 (Beijing), China East 2 (Shanghai), and China East 1 (Hangzhou) regions. It is not available in other regions.

QPS limits

You can make up to 50 queries per second (QPS) to this API. If you exceed the limit, rate limiting is applied to your API calls, which may affect your services. Make API calls only as needed. 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:ListCustomViews

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Algorithm	string	Yes	The custom type. Valid values: landmark: a custom landmark. object: a custom object.	landmark
CustomGroupId	string	Yes	The ID of the custom library.	1
CustomEntityId	string	Yes	The entity ID in the custom library.	1
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page. The maximum value is 50.	10

Response elements

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The unique ID of the request.	580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	1
CustomViews	object
CustomView	array<object>	The images in the custom library.
	object	The details of the image.
CustomViewId	string	The ID of the view image in the custom library.	1
ImageUrl	string	The URL of the image.	http://127.66../photo.jpeg

Examples

Success response

JSON format

{
  "RequestId": "580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "CustomViews": {
    "CustomView": [
      {
        "CustomViewId": "1",
        "ImageUrl": "http://127.66.**.**/photo.jpeg"
      }
    ]
  }
}

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.