Query the key pair list
Updated at：2025-10-20
This API retrieves a list of key pairs.
Request structure
Plain Text
1GET /v{version}/keypair?marker={marker}&maxKeys={maxKeys} 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. |
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 |
| keypairs | List<[KeypairModel](BCC/API Reference/Appendix.md#KeypairModel)> | Key pair result set |
Error codes
No special error codes are returned
Request example
Plain Text
1GET /v2/keypair?marker=k-IyWRtII7&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: 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 "nextMarker": "k-xktdeMSf",
8 "marker": "k-IyWRtII7",
9 "maxKeys": 1,
10 "isTruncated": true,
11 "keypairs": [
12 {
13 "keypairId": "k-IyWRtII7",
14 "createTime": "2018-01-27T13:23:13Z",
15 "name": "instance-j93wzbn1",
16 "regionId":"bj",
17 "instanceCount":3
18 }
19 ]
20}