企业版实例接口
更新时间：2024-04-12
创建CCR实例
接口描述
创建一个CCR企业版实例。
请求结构
POST /v1/instances HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"name":"{name}",
"type":"{type}",
"bucket":"{bucket}",
"tags": [
{
"tagKey":"{tagKey}",
"tagValue":"{tagValue}"
}
]
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | 是 | Body参数 | 实例名称 |
| type | String | 是 | Body参数 | 实例类型，取值范围：BASIC、STANDARD、ADVANCED，分别表示基础版、标准版、高级版 |
| bucket | String | 否 | Body参数 | bos bucket，默认会在用户账号下自动创建出bos bucket |
| tags | List<LogicalTag> | 否 | Body参数 | 待创建的标签键值对列表 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceID | String | 实例ID |
请求示例
POST /v1/instances HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5
{
"name":"demo-instance",
"type":"BASIC"
}响应示例
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:25:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb
{
"instanceID": "ccr-4k74gw7d"
}列举CCR实例
接口描述
列举CCR实例列表。
请求结构
GET /v1/instances?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&acrossregion={acrossregion} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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> | 结果列表 |
请求示例
GET /v1/instances HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5响应示例
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:25:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb
{
"total": 1,
"pageNo": 1,
"pageSize": 10,
"instances": [
{
"id": "ccr-4k74gw7d",
"instanceType": "BASIC",
"name": "demo-instance",
"status": "running",
"createTime": "2022-07-25T19:28:45+08:00",
"region": "bd",
"publicURL": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com"
"tags":[
{
"tagKey":"key",
"tagValue":"value"
}
]
}
]
}查询单个CCR实例详情
接口描述
列举CCR实例列表。
请求结构
GET /v1/instances/{instanceId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| bucket | String | bos bucket |
| region | String | 地域 |
| info | Instance | 实例详情 |
| statistic | InstanceStatistic | 实例统计 |
| quota | InstanceQuota | 实例限额 |
请求示例
GET /v1/instances/ccr-4k74gw7d HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5响应示例
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:25:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb
{
"info": {
"id": "ccr-4k74gw7d",
"instanceType": "BASIC",
"name": "demo-instance",
"status": "running",
"createTime": "2022-07-25T19:28:45+08:00",
"region": "",
"publicURL": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com"
"tags":[
{
"tagKey":"key",
"tagValue":"value"
}
]
},
"statistic": {
"repo": 6,
"chart": 0,
"namespace": 6,
"storage": 79026796
},
"quota": {
"repo": 1000,
"chart": 1000,
"namespace": 50
},
"bucket": "ccr-4k74gw7d",
"region": "bd"
}更改CCR实例信息
接口描述
更改CCR实例信息。
请求结构
PUT /v1/instances/{instanceId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"name":"{name}"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| name | String | 是 | Body参数 | 实例名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 实例ID |
| name | String | 实例名称 |
| instanceType | String | 实例类型 |
| publicURL | String | 公共访问地址 |
| region | String | 地域 |
| status | String | 实例状态 |
| createTime | String | 创建时间 |
| tags | LogicalTag | 标签信息 |
请求示例
PUT /v1/instances/ccr-4k74gw7d HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5
{
"name":"demo-instance"
}响应示例
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:25:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb
{
"id": "ccr-4k74gw7d",
"instanceType": "BASIC",
"name": "demo-instance",
"status": "running",
"createTime": "2022-07-25T19:28:45+08:00",
"region": "bd",
"publicURL": "ccr-4k74gw7d-pub.cnc.bd.baidubce.com"
"tags": [
{
"tagKey":"tagKey",
"tagValue":"tagValue"
}
}升级CCR实例
接口描述
升级CCR企业版实例规格。
请求结构
PUT /v1/instances/{instanceId}/upgrade HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"type":"{type}"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| type | String | 是 | Body参数 | 实例类型，可取值有STANDARD、ADVANCED，分别表示标准版、高级版 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无
请求示例
PUT /v1/instances/ccr-4k74gw7d/upgrade HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5
{
"type":"STANDARD"
}响应示例
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:25:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb更改CCR实例标签
接口描述
更改CCR企业版实例标签。
请求结构
PUT /v1/instances/{instanceId}/tags HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"tags": [
{
"tagKey":"{tagKey}",
"tagValue":"{tagValue}"
}
]
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| tags | List<LogicalTag> | 是 | Body参数 | 标签键值对信息 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无
请求示例
PUT /v1/instances/ccr-4k74gw7d/tags HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/687882a4ec614bf788766895ecebb7f5/2022-07-29T06:01:42Z/1800/content-type;host/119caf7a75eae7423aebefca3648374053a0fe3817ae11a1664b33af7d57dfa5
{
"tags": [
{
"tagKey":"key",
"tagValue":"value"
}
]
}响应示例
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:25:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb