Query the image list
Updated at：2025-10-20
This API retrieves all image-related information of the user.
- The retrieved image data includes public images, custom images, and service integrated images.
- Filters queries using the imageType parameter, which is optional. The default value "All" queries all image types.
- Supports filtering queries by imageName, returning images whose names include the given string. This parameter is optional.
Request structure
Plain Text
1GET /v{version}/image?marker={marker}&maxKeys={maxKeys}&imageType={imageType}&imageName={imageName} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization stringRequest headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | int | No | Query | The maximum number of items per page is 1,000, with a default value of 1,000. |
| imageType | String | No | Query | Specify the type of image to query, including: All (all), System (system images/public images), BbcSystem (BBC system images/BBC public images), Custom (custom images), Integration (service integration images), Sharing (shared images), GpuBccSystem (GPU-specific public images), GpuBccCustom (GPU-specific custom images), FpgaBccSystem (FPGA-specific public images), FpgaBccCustom (FPGA-specific custom images). The default value is All |
| imageName | String | No | Query | Filter and query images, returning images whose names contain the specified string |
Response headers
No special headers beyond common headers
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | "True" means there is more data available, and "False" means this is the last page. |
| nextMarker | String | The marker value needed to retrieve the next page. This field does not appear if isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| images | List<[ImageModel](BCC/API Reference/Appendix.md#ImageModel)> | Returned image list |
Request example
Plain Text
1GET /v2/image?marker=m-nky7qeom&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Date: Wed, 01 Mar 2006 12:00:00 GMT
5Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "maxKeys":1,
8 "marker":"m-nky7qeom",
9 "isTruncated":true,
10 "nextMarker":"m-I88RTNWG",
11 "images":[
12 {
13 "id": "m-nky7qeom",
14 "createTime": "2015-06-17T10:37:02Z",
15 "name": "ubuntu-14.04.1-server-amd64-201506171832",
16 "type": "System",
17 "osType": "linux",
18 "osVersion": "14.04.1 LTS",
19 "osName": "Ubuntu",
20 "osBuild": "2015061700",
21 "osArch": "x86_64 (64bit)",
22 "status": "Available",
23 "desc": null
24 }
25 ]
26}