镜像访问控制接口
更新时间：2022-08-23
使用前提
- 已成功创建企业版实例。
创建一个私有网络
接口描述
创建一个私有网络。
请求结构
POST /v1/instances/{instanceId}/privatelinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"subnetID": "{subnetID}",
"vpcID": "{vpcID}",
"ipType": "{ipType}",
"ipAddress": "{ipAddress}",
"autoDnsResolve": {autoDnsResolve}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| 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 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
POST /v1/instances/ccr-4k74gw7d/privatelinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"subnetID": "sbn-qeimde0m7wyp",
"vpcID": "vpc-9070rw5u03rs",
"ipType": "auto",
"ipAddress": "",
"autoDnsResolve": true
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7获取私有网络列表
接口描述
查询私有网络列表。
请求结构
GET /v1/instances/{instanceId}/privatelinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| domain | String | 私有网络域名 |
| items | List<Privatelinks> | 私有网络结果列表 |
请求示例
GET /v1/instances/ccr-4k74gw7d/privatelinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
{
"domain": "ccr-4k74gw7d-vpc.cnc.bd.baidubce.com",
"items": [
{
"vpcID": "vpc-x83j8k5dh9w9",
"subnetID": "sbn-cc2kfp5qzmz3",
"serviceNetID":"",
"status": "failed",
"ipAddress": "192.168.145.2"
},
{
"vpcID": "vpc-9070rw5u03rs",
"subnetID": "sbn-qeimde0m7wyp",
"serviceNetID":""
"status": "failed",
"ipAddress": ""
}
]
}释放一个私有网络
接口描述
释放（删除）一个私有网络。
请求结构
DELETE /v1/instances/{instanceId}/privatelinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"vpcID": "{vpcID}",
"subnetID": "{subnetID}"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| vpcID | String | 是 | Body参数 | 私有网络ID |
| subnetID | String | 是 | Body参数 | 私有网络子网ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
DELETE /v1/instances/ccr-4k74gw7d/privatelinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"vpcID": "vpc-9070rw5u03rs",
"subnetID": "sbn-qeimde0m7wyp"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7获取公有网络
接口描述
获取公有网络信息。
请求结构
GET /v1/instances/{instanceId}/publiclinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| domain | String | 公网访问域名 |
| status | String | 公网访问入口状态， |
| whitelist | List<Whitelist> | 白名单列表 |
请求示例
GET /v1/instances/ccr-4k74gw7d/publiclinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
{
"domain": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com",
"status": "opened",
"whitelist": [
{
"ipAddr": "0.0.0.0/0",
"description": ""
},
{
"ipAddr": "192.168.1.1",
"description": ""
},
{
"ipAddr": "192.168.0.1/24",
"description": "test"
}
]
}更新公有网络
接口描述
更新网络信息。
请求结构
PUT /v1/instances/{instanceId}/publiclinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"action":"{action}"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| action | String | 是 | Body参数 | 更新共有网络动作，取值范围：open、close，分别表示开启公有网络访问入口、关闭公有网络入口 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
GET /v1/instances/ccr-4k74gw7d/publiclinks HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"action":"open"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7公有网络添加白名单
接口描述
公有网络添加访问白名单。
请求结构
POST /v1/instances/{instanceId}/publiclinks/whitelist HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"ipAddr": "{ipAddr}",
"description": "{description}"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例D |
| ipAddr | String | 是 | Body参数 | 白名单IP地址 |
| description | String | 是 | Body参数 | 白名单描述 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
POST /v1/instances/ccr-4k74gw7d/publiclinks/whitelist HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"ipAddr": "220.181.108.178",
"description": "office ip"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7公有网络删除白名单
接口描述
公有网络删除访问白名单。
请求结构
DELETE /v1/instances/{instanceId}/publiclinks/whitelist HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"items":{items}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| items | List<String> | 是 | Body参数 | 白名单IP数组 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
DELETE /v1/instances/ccr-4k74gw7d/publiclinks/whitelist HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"items":[
"220.198.76.116",
"192.168.0.1/24"
]
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7