镜像访问控制接口
更新时间：2025-05-26
使用前提
- 已成功创建企业版实例。
添加私有网络
接口描述
添加私有网络，将指定的私有网络关联到CCR实例上，添加成功以后就可以在私有网络内通过内网域名访问CCR实例。
请求结构
Plain Text
1POST /v1/instances/{instanceId}/privatelinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "subnetID": "{subnetID}",
7 "vpcID": "{vpcID}",
8 "ipType": "{ipType}",
9 "ipAddress": "{ipAddress}",
10 "autoDnsResolve": {autoDnsResolve}
11}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| vpcID | String | 是 | Body参数 | 私有网络ID |
| subnetID | String | 是 | Body参数 | 私有网络子网ID |
| ipType | String | 是 | Body参数 | IP分配方式，取值范围：auto、manual，分别表示自动分配、手动指定 |
| ipAddress | String | 否 | Body参数 | 当ipType为manual为必填，子网内可用的IP |
| autoDnsResolve | Boolean | 是 | Body参数 | 自动DNS解析，取值范围：true、false |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
Plain Text
1POST /v1/instances/ccr-4k74gw7d/privatelinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "subnetID": "sbn-qeimde0m7wyp",
7 "vpcID": "vpc-9070rw5u03rs",
8 "ipType": "auto",
9 "ipAddress": "",
10 "autoDnsResolve": true
11}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7获取私有网络列表
接口描述
查询当前CCR实例关联的私有网络列表。
请求结构
Plain Text
1GET /v1/instances/{instanceId}/privatelinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| domain | String | 私有网络域名 |
| items | List<Privatelinks> | 私有网络结果列表 |
请求示例
Plain Text
1GET /v1/instances/ccr-4k74gw7d/privatelinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
6
7{
8 "domain": "ccr-4k74gw7d-vpc.cnc.bd.baidubce.com",
9 "items": [
10 {
11 "vpcID": "vpc-x83j8k5dh9w9",
12 "subnetID": "sbn-cc2kfp5qzmz3",
13 "serviceNetID":"",
14 "status": "failed",
15 "ipAddress": "192.168.145.2"
16 },
17 {
18 "vpcID": "vpc-9070rw5u03rs",
19 "subnetID": "sbn-qeimde0m7wyp",
20 "serviceNetID":""
21 "status": "failed",
22 "ipAddress": ""
23 }
24 ]
25}删除私有网络
接口描述
删除指定私有网络与当前CCR实例的关联关系，删除以后私有网络内部无法访问CCR实例。
请求结构
Plain Text
1DELETE /v1/instances/{instanceId}/privatelinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "vpcID": "{vpcID}",
7 "subnetID": "{subnetID}"
8}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| vpcID | String | 是 | Body参数 | 私有网络ID |
| subnetID | String | 是 | Body参数 | 私有网络子网ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
Plain Text
1DELETE /v1/instances/ccr-4k74gw7d/privatelinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4{
5 "vpcID": "vpc-9070rw5u03rs",
6 "subnetID": "sbn-qeimde0m7wyp"
7}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7获取公有网络
接口描述
获取当前CCR实例的公有网络配置信息。
请求结构
Plain Text
1GET /v1/instances/{instanceId}/publiclinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| domain | String | 公网访问域名 |
| status | String | 公网访问入口状态， |
| whitelist | List<Whitelist> | 白名单列表 |
请求示例
Plain Text
1GET /v1/instances/ccr-4k74gw7d/publiclinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
6
7{
8 "domain": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com",
9 "status": "opened",
10 "whitelist": [
11 {
12 "ipAddr": "0.0.0.0/0",
13 "description": ""
14 },
15 {
16 "ipAddr": "192.168.1.1",
17 "description": ""
18 },
19 {
20 "ipAddr": "192.168.0.1/24",
21 "description": "test"
22 }
23 ]
24}更新公有网络
接口描述
更新CCR实例的公有网络，支持的操作包括开启或关闭公网。
请求结构
Plain Text
1PUT /v1/instances/{instanceId}/publiclinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "action":"{action}"
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| action | String | 是 | Body参数 | 更新共有网络动作，取值范围：open、close，分别表示开启公有网络访问入口、关闭公有网络入口 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
Plain Text
1GET /v1/instances/ccr-4k74gw7d/publiclinks HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "action":"open"
7}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7公有网络添加白名单
接口描述
给当前CCR实例添加公有网络访问白名单。
请求结构
Plain Text
1POST /v1/instances/{instanceId}/publiclinks/whitelist HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "ipAddr": "{ipAddr}",
7 "description": "{description}"
8}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例D |
| ipAddr | String | 是 | Body参数 | 白名单IP地址 |
| description | String | 是 | Body参数 | 白名单描述 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
Plain Text
1POST /v1/instances/ccr-4k74gw7d/publiclinks/whitelist HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "ipAddr": "220.181.108.178",
7 "description": "office ip"
8}
9
10 响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7公有网络删除白名单
接口描述
给当前CCR实例删除公有网络访问白名单。
请求结构
Plain Text
1DELETE /v1/instances/{instanceId}/publiclinks/whitelist HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "items":{items}
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| items | List<String> | 是 | Body参数 | 白名单IP数组 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
Plain Text
1DELETE /v1/instances/ccr-4k74gw7d/publiclinks/whitelist HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "items":[
7 "220.198.76.116",
8 "192.168.0.1/24"
9 ]
10}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7