Queries images by page from a specified image library.
Operation description
Use this operation to retrieve a paginated list of images stored in an image library. Each image entry includes its primary key ID, image URL, and thumbnail URL. This operation is free of charge.
For details on constructing HTTP requests, see Request structure. For SDK examples, see SDK overview.
QPS limits
10 calls per second per account. Exceeding this limit triggers throttling, which may affect your business.
Request parameters
For common request parameters required by all Content Moderation API requests, see Common parameters.
The following parameters are specific to this operation.
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| ImageLibId | Integer | Yes | 2147 | The primary key ID of the image library. |
| CurrentPage | String | No | 1 | The page number to return. |
| PageSize | Integer | Yes | 10 | The number of entries per page. |
| TotalCount | Integer | No | 12 | The number of images to return. |
Response elements
For common response parameters, see Common response parameters.
| Parameter | Type | Example | Description |
|---|---|---|---|
| TotalCount | Integer | 12 | The number of returned images. |
| CurrentPage | Integer | 1 | The current page number. |
| PageSize | Integer | 10 | The number of entries per page. |
| ImageFromLibList | JSONArray | — | The list of images. See the following table for the structure of each item. |
ImageFromLibList
| Parameter | Type | Example | Description |
|---|---|---|---|
| Id | Integer | 0 | The primary key ID of the image. |
| Image | String | https://example.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg | The URL of the image. |
| Thumbnail | String | https://example.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg | The thumbnail URL of the image. |
Examples
Sample request
http(s)://green.cn-shanghai.aliyuncs.com/?Action=DescribeImageFromLib&ServiceModule=open_api
&<Common request parameters>
{
"ImageLibId": "2147",
"PageSize": 10
}Sample response
{
"code": 200,
"requestId": "73133169-C2FC-4A42-82FC-9C197BC5DCDE",
"data": {
"TotalCount": 12,
"PageSize": 10,
"CurrentPage": 1,
"ImageFromLibList": [
{
"Id": 0,
"Image": "https://example.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
"Thumbnail": "https://example.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
},
{
"Id": 1,
"Image": "https://example.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
"Thumbnail": "https://example.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
},
{
"Id": 2,
"Image": "https://example.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
"Thumbnail": "https://example.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
}
]
}
}