Query the Image List
Last Updated：2020-07-20
- This API is used to query all image information of users.
- The queried image information includes system image, custom image and service integration image.
- It supports the filter query by imageType. This parameter is not required, and it is all by default, i.e., query all types of images.
Request Structure
GET /v{version}/image?marker={marker}&maxKeys={maxKeys}&imageType={imageType} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
…Request Header Field
There are no other special header fields except the public header field.
Request Parameters
| Parameter Name | Type | Required | Parameter Position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query parameters | The start position of query to obtain the list by batch, which is a character string generated by the system. |
| maxKeys | int | No | Query parameters | Maximum number of master instances per page, which usually does not exceed 1,000. The default value is 1000. |
| imageType | String | No | Query parameters | It specifies what type of image to query, including All, System (system image/public image), Custom (custom image), Integration (service integration image), Sharing (shared image), GpuBccSystem (GPU dedicated public image), GpuBccCustom (GPU dedicated custom image), FpgaBccSystem (FPGA dedicated public image) and FpgaBccCustom (FPGA dedicated custom image), and the default value is All. |
Return Header Field
Other special header fields are not available, except for common header fields.
Return a parameter
| Parameter Name | Type | Description |
|---|---|---|
| marker | String | Mark the starting position of the query |
| isTruncated | boolean | True means there is still data behind, and false means it is already the last page. |
| nextMarker | String | Get the marker value to be passed on the next page. This field does not appear when “isTruncated” is false. |
| maxKeys | int | Maximum number of master instances per page |
| images | List<ImageModel> | Image list returned |
Request Instance
GET /v2/image?marker=m-nky7qeom&maxKeys=1 HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Date: Wed, 01 Mar 2006 12:00:00 GMT
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deReturn Instance
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"maxKeys":1,
"marker":"m-nky7qeom",
"isTruncated":true,
"nextMarker":"m-I88RTNWG",
"images":[
{
"id": "m-nky7qeom",
"createTime": "2015-06-17T10:37:02Z",
"name": "ubuntu-14.04.1-server-amd64-201506171832",
"type": "System",
"osType": "linux",
"osVersion": "14.04.1 LTS",
"osName": "Ubuntu",
"osBuild": "2015061700",
"osArch": "x86_64 (64bit)",
"status": "Available",
"desc": null
}
]
}