Query available public image based on instance specifications
Updated at：2025-10-20
This API is designed to retrieve available public image details based on instance specifications.
Request structure
Plain Text
1GET /v{version}/image/getAvailableImagesBySpec 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 | Maximum number of items per page, defaulting to 10, maximum 100 |
| spec | String | Yes | Query | Instance specification. |
| osName | String | No | Query | Image OS name. Examples include: Windows, CentOS, Ubuntu, etc. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| images | List<[SystemImageModel](BCC/API Reference/Appendix.md#SystemImageModel)> | Returned public image list |
Request example
Plain Text
1GET /v2/image/getAvailableImagesBySpec?maxKeys=1&spec=bcc.ic4.c1m1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Date: Wed, 06 Sep 2023 07:39:43 GMT
5Authorization: bce-auth-v1/8179c90f19ec49f79164110c18e8eff4/2023-09-06T07:39:43****Response example
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 106fa628c-320c-4ddd-b3bc-579cda4b287d
3 Date: Wed, 06 Sep 2023 07:39:45 GMT
4 Content-Type: application/json;charset=UTF-8
5 Server: BWS
6 {
7 "isTruncated": true,
8 "marker": "m-xuP01Lfw",
9 "maxKeys": 1,
10 "nextMarker": "m-QtDM9yPo",
11 "images": [
12 {
13 "imageId": "m-xuP01Lfw",
14 "imageName": "16.04 LTS amd64 (64bit)-CUDA8.0",
15 "osType": "linux",
16 "osVersion": "7.5",
17 "osArch": "x86_64 (64bit)",
18 "osName": "CentOS",
19 "osLang": "ENG",
20 "minSizeInGiB": 20
21 }
22 ]
23 }