企业版实例接口
更新时间：2025-05-26
列举CCR实例
接口描述
列举CCR实例列表。
请求结构
Plain Text
1GET /v1/instances?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&acrossregion={acrossregion} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 当前页 |
| pageSize | Integer | 否 | Query参数 | 每页记录数，默认10 |
| keywordType | String | 否 | Query参数 | 关键字类型，取值范围：id、name，分别表示按实例ID查询、或按实例名称查询 |
| keyword | String | 否 | Query参数 | 关键字 |
| acrossregion | String | 否 | Query参数 | 是否在全区域内搜索,取值范围：true、false，默认为false |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| total | Integer | 记录总数 |
| pageNo | Integer | 当前页 |
| pageSize | Integer | 每页记录数 |
| instances | List<Instance> | 结果列表 |
请求示例
Plain Text
1GET /v1/instances HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5响应示例
Plain Text
1 Content-Type: application/json; charset=utf-8
2 Date: Thu, 28 Jul 2022 03:25:43 GMT
3 X-Bce-Gateway-Region: BJ
4 X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb
5
6{
7 "total": 1,
8 "pageNo": 1,
9 "pageSize": 10,
10 "instances": [
11 {
12 "id": "ccr-4k74gw7d",
13 "instanceType": "BASIC",
14 "name": "demo-instance",
15 "status": "running",
16 "createTime": "2022-07-25T19:28:45+08:00",
17 "region": "bd",
18 "publicURL": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com"
19 "tags":[
20 {
21 "tagKey":"key",
22 "tagValue":"value"
23 }
24 ]
25 }
26 ]
27}查询单个CCR实例详情
接口描述
列举CCR实例列表。
请求结构
Plain Text
1GET /v1/instances/{instanceId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| bucket | String | bos bucket |
| region | String | 地域 |
| info | Instance | 实例详情 |
| statistic | InstanceStatistic | 实例统计 |
| quota | InstanceQuota | 实例限额 |
请求示例
Plain Text
1GET /v1/instances/ccr-4k74gw7d HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5响应示例
Plain Text
1 Content-Type: application/json; charset=utf-8
2 Date: Thu, 28 Jul 2022 03:25:43 GMT
3 X-Bce-Gateway-Region: BJ
4 X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb
5
6{
7 "info": {
8 "id": "ccr-4k74gw7d",
9 "instanceType": "BASIC",
10 "name": "demo-instance",
11 "status": "running",
12 "createTime": "2022-07-25T19:28:45+08:00",
13 "region": "",
14 "publicURL": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com"
15 "tags":[
16 {
17 "tagKey":"key",
18 "tagValue":"value"
19 }
20 ]
21 },
22 "statistic": {
23 "repo": 6,
24 "chart": 0,
25 "namespace": 6,
26 "storage": 79026796
27 },
28 "quota": {
29 "repo": 1000,
30 "chart": 1000,
31 "namespace": 50
32 },
33 "bucket": "ccr-4k74gw7d",
34 "region": "bd"
35}更改CCR实例信息
接口描述
更改CCR实例信息。
请求结构
Plain Text
1PUT /v1/instances/{instanceId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "name":"{name}"
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| name | String | 是 | Body参数 | 实例名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 实例ID |
| name | String | 实例名称 |
| instanceType | String | 实例类型 |
| publicURL | String | 公共访问地址 |
| region | String | 地域 |
| status | String | 实例状态 |
| createTime | String | 创建时间 |
| tags | LogicalTag | 标签信息 |
请求示例
Plain Text
1PUT /v1/instances/ccr-4k74gw7d HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5
4{
5 "name":"demo-instance"
6}响应示例
Plain Text
1 Content-Type: application/json; charset=utf-8
2 Date: Thu, 28 Jul 2022 03:25:43 GMT
3 X-Bce-Gateway-Region: BJ
4 X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb
5
6{
7 "id": "ccr-4k74gw7d",
8 "instanceType": "BASIC",
9 "name": "demo-instance",
10 "status": "running",
11 "createTime": "2022-07-25T19:28:45+08:00",
12 "region": "bd",
13 "publicURL": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com"
14 "tags": [
15 {
16 "tagKey":"tagKey",
17 "tagValue":"tagValue"
18 }
19}更改CCR实例标签
接口描述
更改CCR企业版实例标签。
请求结构
Plain Text
1PUT /v1/instances/{instanceId}/tags HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "tags": [
7 {
8 "tagKey":"{tagKey}",
9 "tagValue":"{tagValue}"
10 }
11 ]
12}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| tags | List<LogicalTag> | 是 | Body参数 | 标签键值对信息 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无
请求示例
Plain Text
1PUT /v1/instances/ccr-4k74gw7d/tags HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5
4{
5 "tags": [
6 {
7 "tagKey":"key",
8 "tagValue":"value"
9 }
10 ]
11}响应示例
Plain Text
1 Content-Type: application/json; charset=utf-8
2 Date: Thu, 28 Jul 2022 03:25:43 GMT
3 X-Bce-Gateway-Region: BJ
4 X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb