Instance相关接口
更新时间：2025-04-09
CCE Instance OpenAPI
创建节点（集群扩容）
描述
为集群添加节点
请求结构
Plain Text
1POST /v2/cluster/{clusterID}/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterID | String | 是 | URL 参数 | 集群ID |
| 无（RequestBody 为数组） | List<InstanceSet> | 是 | RequestBody 参数 | 为集群增加的节点列表 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| cceInstanceIDs | List<String> | 是 | 新增节点的 ID 列表 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例：新建 BCC
Plain Text
1POST /v2/cluster/cce-f7zeyx1u/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5[ {
6 "instanceSpec" : {
7 "instanceName" : "",
8 "clusterRole" : "node",
9 "existed" : false,
10 "machineType" : "BCC",
11 "instanceType" : "N3",
12 "vpcConfig" : {
13 "vpcID" : "vpc-mwbgygrjb72w",
14 "vpcSubnetID" : "sbn-mnbvhnuupv1u",
15 "availableZone" : "zoneA",
16 "securityGroup": {
17 "customSecurityGroups": [],
18 "enableCCERequiredSecurityGroup": true,
19 "enableCCEOptionalSecurityGroup": true
20 }
21 },
22 "instanceResource" : {
23 "cpu" : 1,
24 "mem" : 4,
25 "rootDiskSize" : 40,
26 "localDiskSize" : 0,
27 "cdsList" : [ ]
28 },
29 "imageID" : "m-gTpZ1k6n",
30 "instanceOS" : {
31 "imageType" : "System"
32 },
33 "needEIP" : false,
34 "bid":false,
35 "adminPassword" : "test123!T",
36 "sshKeyName" : "k-3uvrdvVq",
37 "instanceChargingType" : "Postpaid",
38 "runtimeType" : "docker"
39 },
40 "count" : 1
41} ]请求示例：使用已有节点
- 添加 Node 机器配置时，设置
instanceSpec.existed为true并设置instanceSpec.existedOption.existedInstanceID为希望使用的已有节点 ID - 如果不希望重装系统，设置
instanceSpec.existedOption.rebuild为false并务必保证机器密码正确，否则节点会因无法部署相关服务而创建失败 - 如果不希望重装系统，无需设置
instanceSpec.instanceOS与instanceSpec.machineType - 其它参数参考 API 文档按需设置
Plain Text
1[
2 {
3 "instanceSpec":{
4 "existed":true,
5 "existedOption":{
6 "existedInstanceID":"i-M56Un1DO",
7 "rebuild":true
8 },
9 "machineType":"BCC",
10 "instanceOS": {
11 "imageName": "7.5 x86_64 (64bit)",
12 "imageType": "System",
13 "osType": "linux",
14 "osName": "CentOS",
15 "osVersion": "7.5",
16 "osArch": "x86_64 (64bit)"
17 },
18 "adminPassword":"test123!T"
19 }
20]请求示例：挂载CDS
有时我们希望在新建节点的同时为节点挂载 1 到多个 CDS，此时在创建集群时，为节点设置 CDS 参数和相关挂载路径即可。示例如下。
需要注意的是，每个路径下只能挂载一个 CDS，但一个路径的子路径下可以挂载另一个 CDS，例如 /a 目录下仅可挂载一个 CDS，但 /a/b 目录下可以挂载另一个 CDS。
已有节点仅可挂载 CDS 到指定路径，不会新建 CDS。因此当已有节点试图挂载 CDS 到指定 Path 但找不到满足条件的 CDS 时，将会忽略相关 CDS 配置。
Plain Text
1[
2 {
3 "instanceSpec":{
4 ......
5 "instanceResource": {
6 "cdsList": [
7 {diskPath: "/home/cce", storageType: "cloud_hp1", cdsSize: 60}
8 ]
9 },
10 ......
11 }
12 }
13]请求示例：新建 BBC
智能卡 BBC 需要使用普通子网，需要安全组 ID；非智能卡 BBC 需要使用 BBC 型子网，不能传安全组ID。
Plain Text
1POST /v2/cluster/cce-f7zeyx1u/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5[ {
6 "instanceSpec" : {
7 "instanceName" : "",
8 "clusterRole" : "node",
9 "existed" : false,
10 "machineType" : "BBC",
11 "vpcConfig" : {
12 "vpcSubnetID" : "sbn-mnbvhnuupv1u",
13 "securityGroupID" : "g-xh04bcdkq5n6"
14 },
15 "instanceResource" : {
16 "rootDiskSize" : 100,
17 "cdsList" : [ ]
18 },
19 "bbcOption": {
20 "flavor": "BBC-G4-02S",
21 "diskInfo": "NoRaid"
22 },
23 "imageID" : "m-zGnlzI5v",
24 "instanceOS" : {
25 "imageType" : "BbcSystem"
26 },
27 "adminPassword" : "test123!T",
28 "instanceChargingType" : "Postpaid",
29 "runtimeType" : "docker"
30 },
31 "count" : 1
32} ]返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 58868d06-2e79-4d68-9f62-389e70f54996
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "cceInstanceIDs": [
8 "cce-f7zeyx1u-7ombtu3j"
9 ],
10 "requestID": "58868d06-2e79-4d68-9f62-389e70f54996"
11}删除节点（集群缩容）
描述
为集群删除节点
请求结构
Plain Text
1PUT /v2/cluster/{clusterID}/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterID | String | 是 | URL参数 | 集群ID |
| deleteOption | DeleteOption | 否 | RequestBody 参数 | 删除选项. 为空时使用节点自身的 DeleteOption 配置 |
| instanceIDs | List<String> | 是 | RequestBody 参数 | 要删除的节点 ID 列表 |
| scaleDown | Boolean | 否 | RequestBody 参数 | 是否同时减少被删除节点所在节点组的期望节点数 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| requestID | String | 是 | 响应的请求的ID |
请求示例：将节点从集群中移出后同时删除相关资源
Plain Text
1PUT /v2/cluster/cce-f7zeyx1u/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "instanceIDs": [
7 "cce-f7zeyx1u-7ombtu3j"
8 ],
9
10 "deleteOption": {
11 "moveOut": false,
12 "deleteResource": true,
13 "deleteCDSSnapshot": true
14 }
15}请求示例：仅将节点从集群中移出
Plain Text
1PUT /v2/cluster/cce-f7zeyx1u/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "instanceIDs": [
7 "cce-f7zeyx1u-7ombtu3j"
8 ],
9
10 "deleteOption": {
11 "moveOut": true
12 }
13}返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 23a82d7e-954f-4539-b828-ce620eaa97b3
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "requestID": "23a82d7e-954f-4539-b828-ce620eaa97b3"
8}更新节点属性
描述
更新一个节点的某些配置信息。目前仅支持部分属性的更新。
请求结构
Plain Text
1PUT /v2/cluster/{clusterID}/instance/{instanceID} HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterID | String | 是 | URL 参数 | 集群 ID |
| instanceID | String | 是 | URL 参数 | 节点 ID |
| labels | Map<String,String> | 是 | RequestBody 参数 | 节点的标签 |
| annotations | Map<String,String> | 否 | RequestBody 参数 | 节点的注解 |
| taints | List<Taint> | 是 | RequestBody 参数 | 节点的污点 |
| cceInstancePriority | Integer | 是 | RequestBody 参数 | 节点的优先级 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| instance | Instance | 是 | 节点的查询结果 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
Plain Text
1PUT /v2/cluster/cce-oi0ihu53/instance/i-bn71n2eK HTTP/1.1
2Host: cce.hkg.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "labels": {
7 "cluster-id": "cce-b3gzxpwg",
8 "cluster-role": "node",
9 "new-label-key": "new-label-value"
10 },
11 "taints": [
12 {
13 "key": "testKey",
14 "value": "testValue",
15 "effect": "NoSchedule"
16 }
17 ],
18 "cceInstancePriority": 5
19}返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 60dae0e8-8fa0-443c-a5d5-45b1e7beea68
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "instance": {
8 "spec": {
9 "cceInstanceID": "cce-oi0ihu53-pfmx3lu6",
10 "instanceName": "cce-oi0ihu53-pfmx3lu6",
11 "runtimeType": "docker",
12 "runtimeVersion": "18.9.2",
13 "clusterID": "cce-oi0ihu53",
14 "clusterRole": "node",
15 "userID": "eca97e148cb74e9683d7b7240829d1ff",
16 "instanceGroupID": "",
17 "instanceGroupName": "",
18 "machineType": "BCC",
19 "instanceType": "N3",
20 "bbcOption": {},
21 "vpcConfig": {
22 "vpcID": "vpc-epyxw9mwjc18",
23 "vpcSubnetID": "sbn-11gfqpsax4jn",
24 "securityGroupID": "g-urmir67c35x3",
25 "vpcSubnetType": "BCC",
26 "VPCSubnetCIDR": "192.168.0.0/16",
27 "VPCSubnetCIDRIPv6": "",
28 "availableZone": "zoneA"
29 },
30 "instanceResource": {
31 "cpu": 4,
32 "mem": 12,
33 "rootDiskType": "hp1",
34 "rootDiskSize": 40
35 },
36 "deployCustomConfig": {
37 "dockerConfig": {}
38 },
39 "imageID": "m-Yp443gTZ",
40 "instanceOS": {
41 "imageType": "System",
42 "imageName": "centos-7u5-x86_64-20200601203742",
43 "osType": "linux",
44 "osName": "CentOS",
45 "osVersion": "7.5",
46 "osArch": "x86_64 (64bit)",
47 "osBuild": "2020060100"
48 },
49 "needEIP": false,
50 "eipOption": {},
51 "sshKeyID": "",
52 "instanceChargingType": "Postpaid",
53 "deleteOption": {
54 "deleteResource": true,
55 "deleteCDSSnapshot": true
56 },
57 "labels": {
58 "cluster-id": "cce-oi0ihu53",
59 "cluster-role": "node"
60 },
61 "cceInstancePriority": 5
62 },
63 "status": {
64 "machine": {
65 "instanceID": "i-bn71n2eK",
66 "instanceUUID": "60c466f2-929a-4cf9-af7c-52af00fa4476",
67 "orderID": "0fe2237296b644da8ef2b215b4ff19c8",
68 "vpcIP": "192.168.0.31"
69 },
70 "instancePhase": "running",
71 "machineStatus": "ACTIVE"
72 },
73 "createdAt": "2020-09-15T06:43:20Z",
74 "updatedAt": "2020-09-25T06:03:40Z"
75 },
76 "requestID": "60dae0e8-8fa0-443c-a5d5-45b1e7beea68"
77}获取节点详情
描述
获取一个节点的详细信息
请求结构
Plain Text
1GET /v2/cluster/{clusterID}/instance/{instanceID} HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterID | String | 是 | URL 参数 | 集群 ID |
| instanceID | String | 是 | URL 参数 | 节点 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| instance | Instance | 是 | 节点的查询结果 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
Plain Text
1GET /v2/cluster/cce-oi0ihu53/instance/i-bn71n2eK HTTP/1.1
2Host: cce.hkg.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: a13e8b5f-6878-4f1f-8746-3e986ee49a96
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "instance": {
8 "spec": {
9 "cceInstanceID": "cce-oi0ihu53-pfmx3lu6",
10 "instanceName": "cce-oi0ihu53-pfmx3lu6",
11 "runtimeType": "docker",
12 "runtimeVersion": "18.9.2",
13 "clusterID": "cce-oi0ihu53",
14 "clusterRole": "node",
15 "userID": "eca97e148cb74e9683d7b7240829d1ff",
16 "instanceGroupID": "",
17 "instanceGroupName": "",
18 "machineType": "BCC",
19 "instanceType": "N3",
20 "bbcOption": {},
21 "vpcConfig": {
22 "vpcID": "vpc-epyxw9mwjc18",
23 "vpcSubnetID": "sbn-11gfqpsax4jn",
24 "securityGroupID": "g-urmir67c35x3",
25 "vpcSubnetType": "BCC",
26 "VPCSubnetCIDR": "192.168.0.0/16",
27 "VPCSubnetCIDRIPv6": "",
28 "availableZone": "zoneA"
29 },
30 "instanceResource": {
31 "cpu": 4,
32 "mem": 12,
33 "rootDiskType": "hp1",
34 "rootDiskSize": 40
35 },
36 "deployCustomConfig": {
37 "dockerConfig": {}
38 },
39 "imageID": "m-Yp443gTZ",
40 "instanceOS": {
41 "imageType": "System",
42 "imageName": "centos-7u5-x86_64-20200601203742",
43 "osType": "linux",
44 "osName": "CentOS",
45 "osVersion": "7.5",
46 "osArch": "x86_64 (64bit)",
47 "osBuild": "2020060100"
48 },
49 "needEIP": false,
50 "eipOption": {},
51 "sshKeyID": "",
52 "instanceChargingType": "Postpaid",
53 "deleteOption": {
54 "deleteResource": true,
55 "deleteCDSSnapshot": true
56 },
57 "labels": {
58 "cluster-id": "cce-oi0ihu53",
59 "cluster-role": "node"
60 },
61 "cceInstancePriority": 5
62 },
63 "status": {
64 "machine": {
65 "instanceID": "i-bn71n2eK",
66 "instanceUUID": "60c466f2-929a-4cf9-af7c-52af00fa4476",
67 "orderID": "0fe2237296b644da8ef2b215b4ff19c8",
68 "vpcIP": "192.168.0.31"
69 },
70 "instancePhase": "running",
71 "machineStatus": "ACTIVE"
72 },
73 "createdAt": "2020-09-15T06:43:20Z",
74 "updatedAt": "2020-09-24T08:27:21Z"
75 },
76 "requestID": "74a74b2e-f439-4147-b27a-f473e3576338"
77}获取集群节点列表
描述
请求集群节点列表
请求结构
Plain Text
1GET /v2/cluster/{clusterID}/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterID | String | 是 | URL 参数 | 集群ID |
| keywordType | String | 否 | Query 参数 | 集群模糊查询字段，可选 [ instanceName, instanceID, clusterRole]，默认值为 instanceName |
| keyword | String | 否 | Query 参数 | 查询关键词 |
| orderBy | String | 否 | Query 参数 | 集群查询排序字段，可选 [ instanceName, instanceID, createdAt]，默认值为 instance_name |
| order | String | 否 | Query 参数 | 排序方式，可选 [ ASC, DESC ], ASC 为升序，DESC 为降序，默认值为 ASC |
| pageNo | Integer | 否 | Query 参数 | 页码，默认值为1 |
| pageSize | Integer | 否 | Query 参数 | 单页结果数，默认值为10 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| instancePage | InstancePage | 是 | 集群的节点查询结果 |
| requestID | String | 是 | 响应的请求的ID |
请求示例
Plain Text
1GET /v2/cluster/cce-f7zeyx1u/instances?keywordType=instanceName&keyword=&orderBy=createdAt&order=asc&pageNo=1&pageSize=10 HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: a13e8b5f-6878-4f1f-8746-3e986ee49a96
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "instancePage": {
8 "clusterID": "cce-f7zeyx1u",
9 "keywordType": "instanceName",
10 "keyword": "",
11 "orderBy": "createdAt",
12 "order": "ASC",
13 "pageNo": 1,
14 "pageSize": 10,
15 "totalCount": 1,
16 "instanceList": [
17 {
18 "spec": {
19 "cceInstanceID": "cce-f7zeyx1u-vbsry5uc",
20 "instanceName": "cce-f7zeyx1u-vbsry5uc",
21 "runtimeType": "docker",
22 "runtimeVersion": "18.9.2",
23 "clusterID": "cce-f7zeyx1u",
24 "clusterRole": "node",
25 "userID": "eca97e148cb74e9683d7b7240829d1ff",
26 "instanceGroupID": "",
27 "instanceGroupName": "",
28 "machineType": "BCC",
29 "instanceType": "N3",
30 "bbcOption": {},
31 "vpcConfig": {
32 "vpcID": "vpc-mwbgygrjb72w",
33 "vpcSubnetID": "sbn-mnbvhnuupv1u",
34 "securityGroupID": "g-xh04bcdkq5n6",
35 "vpcSubnetType": "BCC",
36 "VPCSubnetCIDR": "192.168.0.0/20",
37 "VPCSubnetCIDRIPv6": "",
38 "availableZone": "zoneA"
39 },
40 "instanceResource": {
41 "cpu": 1,
42 "mem": 4,
43 "rootDiskType": "hp1",
44 "rootDiskSize": 40
45 },
46 "deployCustomConfig": {
47 "dockerConfig": {}
48 },
49 "imageID": "m-gTpZ1k6n",
50 "instanceOS": {
51 "imageType": "System",
52 "imageName": "centos-7u3-x86_64-20191105104647",
53 "osType": "linux",
54 "osName": "CentOS",
55 "osVersion": "7.3",
56 "osArch": "x86_64 (64bit)",
57 "osBuild": "2019110600"
58 },
59 "needEIP": false,
60 "eipOption": {},
61 "sshKeyID": "",
62 "instanceChargingType": "Postpaid",
63 "deleteOption": {},
64 "labels": {
65 "cluster-id": "",
66 "cluster-role": "node"
67 }
68 },
69 "status": {
70 "machine": {
71 "instanceID": "i-HJitrtYn",
72 "orderID": "b49e015b819c4fd1887b8848c7a38025",
73 "vpcIP": "192.168.4.25"
74 },
75 "instancePhase": "running",
76 "machineStatus": "ACTIVE"
77 },
78 "createdAt": "2020-07-21T12:12:54Z",
79 "updatedAt": "2020-07-21T12:15:00Z"
80 }
81 ]
82 },
83 "requestID": "a13e8b5f-6878-4f1f-8746-3e986ee49a96"
84}获取节点组节点列表
描述
获取节点组节点列表
请求结构
Plain Text
1GET /v2/cluster/{clusterID}/instancegroup/{instanceGroupID}/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterID | String | 是 | URL 参数 | 集群 ID |
| instanceGroupID | String | 是 | URL 参数 | 节点组 ID |
| pageNo | Integer | 否 | Query 参数 | 页码，默认值为 0. 取值为 0 时返回节点组下的所有节点 |
| pageSize | Integer | 否 | Query 参数 | 单页结果数，默认值为 0. 取值为 0 时返回节点组下的所有节点 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| page | ListInstancesByInstanceGroupIDPage | 是 | 集群的节点查询结果 |
| requestID | String | 是 | 响应的请求的 ID |
请求示例
Plain Text
1GET /v2/cluster/cce-47bqnhmj/instancegroup/cce-ig-796lmt7a/instances?pageNo=1&pageSize=10 HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: d52c646c-207d-4630-95ba-0539124fd42b
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "requestID": "d52c646c-207d-4630-95ba-0539124fd42b",
8 "page": {
9 "pageNo": 0,
10 "pageSize": 0,
11 "totalCount": 3,
12 "list": [
13 {
14 "spec": {
15 "cceInstanceID": "cce-z6qjgcq7-7dd7z1fc",
16 "instanceName": "cce-z6qjgcq7-7dd7z1fc",
17 "runtimeType": "docker",
18 "runtimeVersion": "18.9.2",
19 "clusterID": "cce-z6qjgcq7",
20 "clusterRole": "node",
21 "instanceGroupID": "cce-ig-dvej1d3y",
22 "instanceGroupName": "sdk-testcase",
23 "existedOption": {},
24 "machineType": "BCC",
25 "instanceType": "N3",
26 "bbcOption": {},
27 "vpcConfig": {
28 "vpcID": "vpc-pi9fghaxcpnf",
29 "vpcSubnetID": "sbn-ww1xf6a5fi88",
30 "vpcSubnetType": "BCC",
31 "availableZone": "zoneA"
32 },
33 "instanceResource": {
34 "cpu": 1,
35 "mem": 4,
36 "rootDiskType": "hp1",
37 "rootDiskSize": 40
38 },
39 "imageID": "m-4Umtt2i5",
40 "instanceOS": {
41 "imageType": "System",
42 "imageName": "centos-8u0-x86_64-20200601205040",
43 "osType": "linux",
44 "osName": "CentOS",
45 "osVersion": "8.0",
46 "osArch": "x86_64 (64bit)",
47 "osBuild": "2020060100"
48 },
49 "eipOption": {},
50 "instanceChargingType": "Postpaid",
51 "instancePreChargingOption": {},
52 "deleteOption": {
53 "deleteResource": true,
54 "deleteCDSSnapshot": true
55 },
56 "deployCustomConfig": {
57 "dockerConfig": {}
58 },
59 "labels": {
60 "cluster-id": "cce-z6qjgcq7",
61 "cluster-role": "node",
62 "instance-group-id": "cce-ig-dvej1d3y"
63 },
64 "cceInstancePriority": 5
65 },
66 "status": {
67 "machine": {
68 "instanceID": "i-HVq1GwKr",
69 "orderID": "71f6d4249aed4a08b2bc1470fefd6b2a",
70 "vpcIP": "192.168.16.33"
71 },
72 "instancePhase": "running",
73 "machineStatus": "ACTIVE"
74 },
75 "createdAt": "2020-09-27T06:35:04Z",
76 "updatedAt": "2020-09-27T06:36:53Z"
77 },
78 {
79 "spec": {
80 "cceInstanceID": "cce-z6qjgcq7-asf0p09i",
81 "instanceName": "cce-z6qjgcq7-asf0p09i",
82 "runtimeType": "docker",
83 "runtimeVersion": "18.9.2",
84 "clusterID": "cce-z6qjgcq7",
85 "clusterRole": "node",
86 "instanceGroupID": "cce-ig-dvej1d3y",
87 "instanceGroupName": "sdk-testcase",
88 "existedOption": {},
89 "machineType": "BCC",
90 "instanceType": "N3",
91 "bbcOption": {},
92 "vpcConfig": {
93 "vpcID": "vpc-pi9fghaxcpnf",
94 "vpcSubnetID": "sbn-ww1xf6a5fi88",
95 "vpcSubnetType": "BCC",
96 "availableZone": "zoneA"
97 },
98 "instanceResource": {
99 "cpu": 1,
100 "mem": 4,
101 "rootDiskType": "hp1",
102 "rootDiskSize": 40
103 },
104 "imageID": "m-4Umtt2i5",
105 "instanceOS": {
106 "imageType": "System",
107 "imageName": "centos-8u0-x86_64-20200601205040",
108 "osType": "linux",
109 "osName": "CentOS",
110 "osVersion": "8.0",
111 "osArch": "x86_64 (64bit)",
112 "osBuild": "2020060100"
113 },
114 "eipOption": {},
115 "instanceChargingType": "Postpaid",
116 "instancePreChargingOption": {},
117 "deleteOption": {
118 "deleteResource": true,
119 "deleteCDSSnapshot": true
120 },
121 "deployCustomConfig": {
122 "dockerConfig": {}
123 },
124 "labels": {
125 "cluster-id": "cce-z6qjgcq7",
126 "cluster-role": "node",
127 "instance-group-id": "cce-ig-dvej1d3y"
128 },
129 "cceInstancePriority": 5
130 },
131 "status": {
132 "machine": {
133 "instanceID": "i-RndUYlWF",
134 "orderID": "71f6d4249aed4a08b2bc1470fefd6b2a",
135 "vpcIP": "192.168.16.34"
136 },
137 "instancePhase": "running",
138 "machineStatus": "ACTIVE"
139 },
140 "createdAt": "2020-09-27T06:35:06Z",
141 "updatedAt": "2020-09-27T06:36:58Z"
142 },
143 {
144 "spec": {
145 "cceInstanceID": "cce-z6qjgcq7-ibtt74zc",
146 "instanceName": "cce-z6qjgcq7-ibtt74zc",
147 "runtimeType": "docker",
148 "runtimeVersion": "18.9.2",
149 "clusterID": "cce-z6qjgcq7",
150 "clusterRole": "node",
151 "instanceGroupID": "cce-ig-dvej1d3y",
152 "instanceGroupName": "sdk-testcase",
153 "existedOption": {},
154 "machineType": "BCC",
155 "instanceType": "N3",
156 "bbcOption": {},
157 "vpcConfig": {
158 "vpcID": "vpc-pi9fghaxcpnf",
159 "vpcSubnetID": "sbn-ww1xf6a5fi88",
160 "vpcSubnetType": "BCC",
161 "availableZone": "zoneA"
162 },
163 "instanceResource": {
164 "cpu": 1,
165 "mem": 4,
166 "rootDiskType": "hp1",
167 "rootDiskSize": 40
168 },
169 "imageID": "m-4Umtt2i5",
170 "instanceOS": {
171 "imageType": "System",
172 "imageName": "centos-8u0-x86_64-20200601205040",
173 "osType": "linux",
174 "osName": "CentOS",
175 "osVersion": "8.0",
176 "osArch": "x86_64 (64bit)",
177 "osBuild": "2020060100"
178 },
179 "eipOption": {},
180 "instanceChargingType": "Postpaid",
181 "instancePreChargingOption": {},
182 "deleteOption": {
183 "deleteResource": true,
184 "deleteCDSSnapshot": true
185 },
186 "deployCustomConfig": {
187 "dockerConfig": {}
188 },
189 "labels": {
190 "cluster-id": "cce-z6qjgcq7",
191 "cluster-role": "node",
192 "instance-group-id": "cce-ig-dvej1d3y"
193 },
194 "cceInstancePriority": 5
195 },
196 "status": {
197 "machine": {
198 "instanceID": "i-aRGKcLtv",
199 "orderID": "71f6d4249aed4a08b2bc1470fefd6b2a",
200 "vpcIP": "192.168.16.35"
201 },
202 "instancePhase": "running",
203 "machineStatus": "ACTIVE"
204 },
205 "createdAt": "2020-09-27T06:35:07Z",
206 "updatedAt": "2020-09-27T06:37:02Z"
207 }
208 ]
209 }
210}获取节点事件步骤
描述
获取创建或删除过程中节点所处的事件步骤,请求参数同时兼容cceInstanceID和instanceID
请求结构
Plain Text
1GET /v2/event/instance/{instanceID} HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceID | String | 是 | URL 参数 | 节点 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| status | String | 是 | 事件类型 |
| steps | List<Step> | 是 | 集群操作步骤 |
| requestID | String | 是 | 请求ID |
请求示例
Plain Text
1GET /v2/event/instance/i-ezs9bmjY HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 08eb305a-87fb-4360-8a27-42b9561edf4a
3Date: Fri, 12 Aug 2022 03:10:30 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "status": "created",
8 "steps": [
9 {
10 "stepName": "准备机器",
11 "stepStatus": "done",
12 "ready": true,
13 "startTime": "2022-08-04T02:45:28Z",
14 "finishedTime": "2022-08-04T02:45:56Z",
15 "costSeconds": 28,
16 "retryCount": 1,
17 "errInfo": {}
18 },
19 {
20 "stepName": "绑定安全组",
21 "stepStatus": "done",
22 "ready": true,
23 "startTime": "2022-08-04T02:45:56Z",
24 "finishedTime": "2022-08-04T02:45:57Z",
25 "costSeconds": 1,
26 "retryCount": 1,
27 "errInfo": {}
28 },
29 {
30 "stepName": "前置检查",
31 "stepStatus": "done",
32 "ready": true,
33 "startTime": "2022-08-04T02:45:57Z",
34 "finishedTime": "2022-08-04T02:48:38Z",
35 "costSeconds": 161,
36 "retryCount": 2,
37 "errInfo": {}
38 },
39 {
40 "stepName": "部署 K8S",
41 "stepStatus": "done",
42 "ready": true,
43 "startTime": "2022-08-04T02:48:38Z",
44 "finishedTime": "2022-08-04T02:49:20Z",
45 "costSeconds": 42,
46 "retryCount": 1,
47 "errInfo": {}
48 },
49 {
50 "stepName": "等待就绪",
51 "stepStatus": "done",
52 "ready": true,
53 "startTime": "2022-08-04T03:40:41Z",
54 "finishedTime": "2022-08-04T03:40:41Z",
55 "retryCount": 1,
56 "errInfo": {}
57 }
58 ],
59 "requestID": "08eb305a-87fb-4360-8a27-42b9561edf4a"
60}同步节点元信息
描述
同步并更新集群下所有节点的IAAS配置信息。例如：用户变更BCC付费方式，可通过接口进行数据同步。
请求结构
Plain Text
1POST /v2/sync/cluster/{clusterID}/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| clusterID | String | 是 | URL 参数 | 集群 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| clusterID | String | 是 | 请求的集群ID |
| requestID | String | 是 | 请求ID |
请求示例
Plain Text
1POST /v2/sync/cluster/cce-f7zeyx1u/instances HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{}返回示例
Plain Text
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 23a82d7e-954f-4539-b828-ce620eaa97b3
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5
6{
7 "requestID": "23a82d7e-954f-4539-b828-ce620eaa97b3",
8 "clusterID": "cce-f7zeyx1u"
9}