实例相关接口

更新时间：2024-08-09

创建实例

接口描述

• 本接口用于创建一个或多个同配物理机实例。

• 创建物理机前应查询所选套餐的RAID情况，并根据需要选取raidId。

请求（Request）

请求语法

Plain Text

1    POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
2    Host: bbc.bj.baidubce.com
3    Authorization: authorization string
4    {
5        "name": name,
6        "hostname": hostname,
7        "flavorId":flavorId,
8        "imageId": imageId,
9        "raidId":raidId,
10        "rootDiskSizeInGb":rootDiskSizeInGb,
11        "purchaseCount": purchaseCount,
12        "zoneName":zoneName,
13        "subnetId":subnetId,
14        "securityGroupId": securityGroupId,
15        "autoRenewTimeUnit": autoRenewTimeUnit,
16        "autoRenewTime": autoRenewTime,
17        "billing":{
18            "paymentTiming": paymentTiming,
19            "reservation": {
20                "reservationLength": reservationLength
21            }
22        }
23    }

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号。
clientToken	String	是	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串。
flavorId	String	是	Request Body参数	物理机套餐Id。
imageId	String	是	Request Body参数	镜像Id。
raidId	String	是	Request Body参数	raid配置Id，可通过查询RAID接口获得。
rootDiskSizeInGb	int	是	Request Body参数	待创建物理机的系统盘大小。
relationTag	boolean	否	Request Body参数	待创建实例指定的标签是否需要和已有标签键进行关联，默认为false。注意值为true时要保证该标签键已存在。
tags	List<TagModel>	是	Request Body参数	待绑定的标签，具体数据格式参见TagModel
purchaseCount	int	是	Request Body参数	批量创建（购买）的虚拟机实例个数，必须为大于0的整数，可选参数，缺省为1。
zoneName	String	是	Request Body参数	可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是“国家-region-可用区序列"，小写，例如北京可用区A为"cn-bj-a"。专属实例使用专属服务器所在zone，无需指定该字段。
subnetId	String	是	Request Body参数	指定subnet信息，不能为空。
securityGroupId	String	否	Request Body参数	指定securityGroupId信息。
autoRenewTimeUnit	String	否	Request Body参数	按月付费或者按年付费月是"month",年是"year"
autoRenewTime	int	否	Request Body参数	自动续费的时间按月是1-9 按年是 1-3。
billing	Billing	是	Request Body参数	订单、计费相关参数。
name	String	否	Request Body参数	物理机名字（可选）。默认都不指定name。
hostname	String	否	Request Body参数	虚拟机主机名（可选）。默认都不指定hostname。hostname仅支持小写字母、数字以及- . 特殊字符，必须以字母开头，不可连续使用特殊符号，不支持特殊符号开头或结尾，长度2-64。
adminPass	String	否	Request Body参数	机器密码，密码需要加密传输。请参考密码加密传输规范

响应（Response）

响应头域

无特殊Header参数响应

响应参数

名称	类型	描述
instanceIds	List	物理机实例ID的集合，其中ID符合BCE规范，必须是一个定长字符串，且只允许包含大小写字母、数字、连字号（-）和下划线（_）

示例

请求示例

Plain Text

1    POST /v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2    Host: bbc.bj.baidubce.com
3    ContentType: application/json    
4    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6    {
7        "name": "test2",
8    	"flavorId":"BBC-I1-01",
9    	"imageId": "m-JTcDChqz",
10    	"raidId":"raid-hna71m59",
11    	"rootDiskSizeInGb":"40",
12    	"purchaseCount": 2,
13    	"zoneName":"cn-bj-a",
14    	"subnetId":"8ea4c63e-9a93-47ac-b1c8-27f7f4b28154",
15        "autoRenewTimeUnit": "month",
16        "autoRenewTime": 1,
17    	"billing":{
18            "paymentTiming":"Prepaid",
19            "reservation": {
20                "reservationLength": 1
21            }
22        }
23    }

响应示例

HTTP/1.1 200 OK x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50 Date: Wed, 03 Dec 2014 06:42:19 GMT Content-Type: application/json;charset=UTF-8 Server: BWS { "instanceIds": [ "i-l1KApd9e", "i-gFbUIZ13" ] }

查询实例列表

描述

查询所有BBC实例的列表及详情信息。

请求结构

Plain Text

1GET /v{version}/instance?marker={marker}&maxKeys={maxKeys}&internalIp={internalIp}&vpcId={vpcId}&priavteIp={privateIp} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
marker	String	否	Query参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串。
maxKeys	int	否	Query参数	每页包含的最大数量，最大数量通常不超过1000，缺省值为1000。
internalIp	String	否	Query参数	内网ip
vpcId	String	否	Query参数	vpcId
privateIp	String	否	Query参数	privateIp必须和vpcId一起组合查询，可以传入多个值，用逗号拼接
ipv6Addresses	String	否	Query参数	ipv6Addresses必须和vpcId一起组合查询，可以传入多个值，用逗号拼接

返回头域

除公共头域，无其它特殊头域。

返回参数

名称	类型	描述
marker	String	标记查询的起始位置。
isTruncated	boolean	true表示后面还有数据，false表示已经是最后一页。
nextMarker	String	获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现。
maxKeys	int	每页包含的最大数量。
instances	List<InstanceModel>	实例信息，由 InstanceModel 组成的集合。

错误码

无特殊返回错误码

请求示例

Plain Text

1GET /v1/instance?vpcId=vpc-r9wevxtu0wtr&privateIp=192.168.1.7 HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Fri, 09 Sep 2016 03:31:51 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8    "marker": "",
9    "isTruncated": false,
10    "maxKeys": 1000,
11    "instances": [
12        {
13            "id": "i-oqVG2iJZ",
14            "name": "OnlineSbbcSmoke-9531",
15            "hostname": "sandbox-sbbc-c",
16            "status": "Running",
17            "torId": "",
18            "desc": "",
19            "paymentTiming": "Prepaid",
20            "createTime": "2023-01-02T14:56:34Z",
21            "expireTime": "2023-02-02T14:56:34Z",
22            "internalIp": "192.168.1.7",
23            "ipv6":"",
24            "rdmaIp": "",
25            "rdmaType": "无",
26            "guid": "",
27            "publicIp": "",
28            "networkCapacityInMbps": 0,
29            "flavorId": "BBC-G4-05S",
30            "imageId": "m-mIdQWM1e",
31            "zone": "cn-bj-a",
32            "repairStatus": "normal",
33            "gpuCard": "",
34            "autoRenew": true,
35            "tags": [],
36            "region": "bj"
37        }
38   ]

查询位于回收站内的实例列表

描述

查询所有位于回收站内BBC实例的列表信息。

请求结构

Plain Text

1POST /v{version}/recycle/instance HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
marker	String	否	Request Body参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串。
maxKeys	int	否	Request Body参数	每页包含的最大数量，最大数量通常不超过1000，缺省值为1000。
instanceId	String	否	Request Body参数	实例id
name	String	否	Request Body参数	实例名称
paymentTiming	String	否	Request Body参数	付费方式，付费方式，包括Postpaid(后付费)，Prepaid(预付费)两种。
recycleBegin	String	是	Request Body参数	进入回收站的时间，筛选的开始时间 ,格式：yyyy-MM-dd'T'hh:mm:ss'Z'
recycleEnd	String	是	Request Body参数	进入回收站的时间，筛选的结束时间格式：yyyy-MM-dd'T'hh:mm:ss'Z'

返回头域

除公共头域，无其它特殊头域。

返回参数

名称	类型	描述
marker	String	标记查询的起始位置。
isTruncated	boolean	true表示后面还有数据，false表示已经是最后一页。
nextMarker	String	获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现。
maxKeys	int	每页包含的最大数量。
instances	List<RecycledInstanceModel>	实例信息，由 RecycledInstanceModel 组成的集合。

错误码

无特殊返回错误码

请求示例

Plain Text

1POST /v1/recycle/instance HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5{
6    "marker":"i-Hq0AKL60",
7    "maxKeys":10,
8    "recycleBegin":"2020-11-23T17:18:24Z",
9    "recycleEnd": "2020-12-10T17:18:24Z"
10}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Fri, 09 Sep 2016 03:31:51 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8  "marker": "",
9  "maxKeys": 1000,
10  "isTruncated": false,
11  "instances": [
12    {
13      "serviceType": "BBC",
14      "name": "instance-x9k0925w",
15      "serialNumber": "9db8f2ae-b87e-4b41-990a-86bd3ce8bdcf",
16      "paymentTiming": "postpay",
17      "configItems": [
18        "CPU：32核",
19        "内存：128G",
20        "类型：BBC-I3-01S"
21      ],
22      "serviceName": "弹性裸金属服务器",
23      "deleteTime": "2020-12-11T07:35:24Z",
24      "id": "i-Hq0AKL60",
25      "recycleTime": "2020-12-04T07:36:14Z"
26    }
27  ]
28}

查询单个实例详情

查询指定的某个实例详细信息。

请求结构

Plain Text

1GET /v{version}/instance/{instanceId} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	待查询的实例ID

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
instance	InstanceModel	返回的实例详情

请求示例

Plain Text

1GET /v1/instance/i-YufwpQAe HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8            "id": "i-IyWRtII7",
9            "name": "instance-j93wzbn1",
10            "status": "Running",
11            "desc": "console",
12            "paymentTiming":"Postpaid",
13			"createTime": "2015-08-06T13:23:13Z",
14            "expireTime": null,
15            "internalIp": "192.168.6.15",
16            "publicIp":"10.107.3.45",
17		    "networkCapacityInMbps": 1,
18			"flavorId":"BBC-C1-01",
19            "imageId": "m-3zfBY1Ku",
20               "tags": [
21                {
22                    "tagKey": "jian",
23                    "tagValue": "1"
24                }
25            ],				
26			"zone":"zoneA",
27            "deploysetId":"",
28            "hasAlive":1,
29			"region": "bj"
30
31}

启动实例

开机启动一个指定的实例。

接口调用成功后实例进入 Starting 状态。
实例状态必须为 Stopped，调用此接口才可以成功返回，否则提示409错误。

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	待启动的实例ID
action	String	是	Query参数	对实例执行的动作，本接口中该参数取值start

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Instance.StartInstanceOperationForbidden	Instance not stopped when starting.	409	只有 Stopped 状态的实例才可以进行开启

请求示例

Plain Text

1PUT /v1/instance/i-YufwpQAe?start HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

停止实例

停止一个指定的实例。

系统后台会在实例实际 Stop 成功后进入“已停止”状态。
只有状态为 Running 的实例才可以进行此操作，否则提示 409 错误。
实例支持强制停止，强制停止等同于断电处理，可能丢失实例操作系统中未写入磁盘的数据。

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4{
5    "forceStop":forceStop
6}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	待启动的实例ID
action	String	是	Query参数	对实例执行的动作，本接口中该参数取值stop
forceStop	Boolean	否	Request Body参数	指定实例是否强制关机，可选值：true,false,缺省为false

返回头域

除公共头域，无其它特殊头域

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Instance.StopInstanceOperationForbidden	Instance not running when shutting down.	409	只有 Running 状态的实例才可以进行关机

请求示例

Plain Text

1PUT /v1/instance/i-YufwpQAe?stop HTTP/1.1   
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "forceStop":false
8}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

重启实例

描述

重启一个指定的实例

只有状态为 Running 的实例才可以进行此操作，否则提示 409 错误。
接口调用成功后实例进入 Starting 状态。
支持强制重启，强制重启等同于传统服务器的断电重启，可能丢失实例操作系统中未写入磁盘的数据。

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4{
5    "forceStop":forceStop
6}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	待启动的实例ID
action	String	是	Query参数	对实例执行的动作，本接口中该参数取值reboot
forceStop	boolean	否	Request Body参数	是否强制停止实例，可选值true,false,缺省为false

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Instance.RebootInstanceOperationForbidden	Instance not running when rebooting.	409	只有 Running 状态的实例才可以进行重启

请求示例

Plain Text

1PUT /v1/instance/i-YufwpQAe?reboot HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Date: Wed, 01 Mar 2006 12:00:00 GMT
5Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
6
7{
8    "forceStop": true
9}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

修改实例名称

描述

修改指定虚机的名称；

只有 Running 和 Stopped 状态的实例才可以调用该接口，否则提示 409 错误。

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "name": name
7}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	指定的实例ID
action	String	是	Query参数	对实例执行的动作，当前取值rename
name	String	是	Request Body参数	实例名称，满足规则大小写字母、数字以及-_ /.特殊字符，必须以字母开头，长度1-65

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
BadRequest	Bad request parameters or illegal request.	400	请求参数无效
Instance.NameInvalid	Instance name is invalid.	400	name无效
NoSuchObject	The specified object is not found or resource do not exist.	404	资源不存在
OperationDenied	Operation not available.	409	不可操作

请求示例

Plain Text

1PUT /v1/instance/i-YufwpQAe?rename HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "name": "example"
8}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

修改实例描述

描述

修改指定虚机的描述；

只有 Running 和 Stopped 状态的实例才可以调用该接口，否则提示 409 错误。

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "desc": desc
7}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	指定的实例ID
action	String	是	Query参数	对实例执行的动作，当前取值updateDesc
desc	String	是	Request Body参数	实例描述

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
BadRequest	Bad request parameters or illegal request.	400	请求参数无效
NoSuchObject	The specified object is not found or resource do not exist.	404	资源不存在
OperationDenied	Operation not available.	409	不可操作

请求示例

Plain Text

1PUT /v1/instance/i-YufwpQAe?updateDesc HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "desc": "example"
8}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

重装实例

描述

使用镜像重建指定虚拟机

实例重装后，基于原系统盘的自定义镜像会保留。

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "imageId": imageId,
7    "adminPass":adminPass,
8    "isPreserveData":isPreserveData,
9    "raidId":raidId,
10    "sysRootSize":sysRootSize
11}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	指定的实例ID
action	String	是	Query参数	对实例执行的动作，当前取值rebuild
imageId	String	是	Request Body参数	待指定的镜像ID
adminPass	String	是	Request Body参数	机器密码，密码需要加密传输
isPreserveData	bool	否	Request Body参数	是否保留数据，默认为true。当值为true时，raidId和sysRootSize字段不生效
raidId	String	否	Request Body参数	raid配置Id，可通过查询RAID接口获得。此参数在isPreserveData为false时为必填，在isPreserveData为true时不生效
sysRootSize	int	否	Request Body参数	系统盘根分区大小，默认为20G，取值范围为20-100。此参数在isPreserveData为true时不生效

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

请求示例

Plain Text

1PUT /v1/instance/i-YufwpQAe?rebuild HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "imageId": "m-mRjO3cjs",
8    "adminPass":"8e056bf0eac2333baec721fc9e7eaf92",
9    "isPreserveData":false,
10    "raidId":"raid-fjzh8321",
11    "sysRootSize":20
12}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

释放实例

描述

释放单个物理机实例，释放后实例所使用的物理资源都被收回，相关数据全部丢失且不可恢复。

只有付费类型为Postpaid或者付费类型为Prepaid且已过期的实例才可以释放。
实例释放后，基于原系统盘的自定义镜像会保留。

请求结构

Plain Text

1DELETE /v{version}/instance/{instanceId} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	待释放的物理机实例ID

返回头域

除公共头域外，无其它特殊头域。

返回参数

无特殊返回参数

请求示例

Plain Text

1DELETE /v2/instance/i-3ghjsb67 HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-04-10T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Mon, 10 Apr 2017 04:17:29 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

批量释放实例

描述

批量释放物理机实例，释放后实例所使用的物理资源都被收回，相关数据全部丢失且不可恢复。用户也可以选择实例进入回收站，位于回收站的物理机会解绑所关联的eip等资源，且处于关机状态。物理机进入回收站起7天后会释放相关的物理机，用户可在进入回收站7天内恢复计费继续使用物理机实例。

只有付费类型为Postpaid或者付费类型为Prepaid且已过期的实例才可以释放。
实例释放后，基于原系统盘的自定义镜像会保留。
位于回收站的预付费物理机实例，可以使用预付费续费接口恢复计费。

请求结构

Plain Text

1POST /v{version}/instance/batchDelete HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceIds	List	是	Request Body参数	待释放的物理机实例ID列表
bbcRecycleFlag	boolean	否	Request Body参数	是否将实例进入回收站，可选值true,false,缺省为false

返回头域

除公共头域外，无其它特殊头域。

返回参数

无特殊返回参数

请求示例

Plain Text

1POST /v1/instance/batchDelete HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-04-10T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "bbcRecycleFlag":true,
8    "instanceIds":["i-0ZpkzJ6u","i-0ZpkzJ62"]
9}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 27bc23fc-2a05-4ef5-a11a-2639bc155221
3Date: Mon, 10 Apr 2017 04:17:29 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

修改实例密码

修改指定虚机的管理员密码

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	URL参数	指定的实例ID
action	String	是	Query参数	对实例执行的动作，当前取值changePass
adminPass	String	是	Request Body参数	待指定的实例管理员密码，8-16位字符，英文，数字和符号必须同时存在，符号仅限!@#$%^*()，密码需要加密传输

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Instance.PasswordOperationForbidden	Instance not stopped when changing password.	409	只有 Stopped 状态的实例才可以修改密码

请求示例

Plain Text

1PUT /v1/instance/i-YufwpQAe?changePass HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "adminPass": "c5b31add-ffe0-44b0-86eb-063109a1b6fe"
8}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

查询实例VPC/Subnet信息

描述

通过BBC实例id查询VPC/Subnet信息

请求结构

Plain Text

1POST /v{version}/vpcSubnet HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
bbcIds	List<String>	是	Request Body参数	需要查询VPC/Subnet信息的BBC实例Id列表

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
networkInfo	List<BbcNetworkModel>	返回BBC的VPC和Subnet信息

请求示例

Plain Text

1POST /v1/vpcSubnet HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7   "bbcIds":["i-CRALHVQx"]
8}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8"networkInfo": [{
9	"subnet": {
10		"vpcId": "vpc-cwtrgdc3cre4",
11		"name": "系统预定义子网",
12		"subnetType": "1",
13		"subnetId": "sbn-tgk8c11e7imb",
14		"cidr": "192.168.0.0/20",
15		"zoneName": "cn-bj-a"
16	},
17	"bbcId": "i-CRALHVQx",
18	"vpc": {
19		"cidr": "192.168.0.0/16",
20		"vpcId": "vpc-cwtrgdc3cre4",
21		"name": "默认私有网络",
22		"isDefault": "true",
23		"description": "default"
24	}
25}]
26}

实例绑定安全组

请求结构

Plain Text

1POST /v{version}/instance/securitygroup?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
action	String	是	Query参数	对实例执行的动作，当前取值bind
instanceIds	List	是	Request Body参数	待绑定安全组的实例ID集合
securityGroups	List	是	Request Body参数	安全组ID集合

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

请求示例

Plain Text

1POST /v1/instance/securitygroup?bind HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "instanceIds": ["i-c5b31add", "i-063109a1"],
8    "securityGroups": ["sg-a5b11avd","sg-bvb1sdnd"]
9}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

实例解绑安全组

请求结构

Plain Text

1POST /v{version}/instance/securitygroup?{action} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
action	String	是	Query参数	对实例执行的动作，当前取值unbind
instanceId	String	是	Request Body参数	待解绑安全组的实例ID
securityGroupId	String	是	Request Body参数	安全组ID

返回头域

除公共头域，无其它特殊头域。

返回参数

无特殊返回参数

请求示例

Plain Text

1POST /v1/instance/securitygroup?unbind HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7    "instanceId": "i-c5b31add",
8    "securityGroupId": "sg-a5b11avd"
9}

返回示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

bbc开通自动续费（包含关联产品）

描述

仅限预付费产品生效

请求结构

Plain Text

1 POST /v{version}/instance/batchCreateAutoRenewRules HTTP/1.1
2 Host: bbc.bj.baidubce.com
3 Authorization: authorization string
4

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	requestBody	虚拟机实例id
renewTimeUnit	String	是	requestBody	续费单位，month，year
renewTime	int	是	requestBody	续费时长，单位：month，支持1, 2, 3, 4, 5, 6, 7, 8, 9；单位：year，支持1, 2, 3

返回头域

除公共头域外，无其它特殊头域。

返回参数

无特殊返回参数

错误码

无特殊返回错误码

请求示例

Plain Text

1 POST /v1/instance/batchCreateAutoRenewRules HTTP/1.1
2 Host: bbc.bj.baidubce.com
3 ContentType: application/json
4 Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2015 08 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5 
6 {
7     "instanceId": "i-UWMoa9i8",
8     "renewTimeUnit" : "month"
9     "renewTime" : 1
10 }

返回示例

Plain Text

1 HTTP/1.1 200 OK
2 x bce request id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Wed, 03 Dec 2014 06:42:19 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS

bbc关闭自动续费（包含关联产品）

描述仅限预付费产品生效

请求结构

Plain Text

1 POST /v{version}/instance/batchDeleteAutoRenewRules HTTP/1.1
2 Host: bbc.bj.baidubce.com
3 Authorization: authorization string
4

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceId	String	是	requestBody	虚拟机实例id

返回头域

除公共头域外，无其它特殊头域。

返回参数

无特殊返回参数

错误码

无特殊返回错误码

请求示例

Plain Text

1 POST /v1/instance/batchDeleteAutoRenewRules HTTP/1.1
2 Host: bbc.bj.baidubce.com
3 ContentType: application/json
4 Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2015 08 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5 
6 {
7     "instanceId": "i-UWMoa9i8"
8 }

返回示例

Plain Text

1 HTTP/1.1 200 OK
2 x bce request id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Wed, 03 Dec 2014 06:42:19 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS

bbc回收站实例恢复计费（后付费）

描述仅限后付费产品生效,预付费实例使用预付费续费接口

请求结构

Plain Text

1 POST /v{version}/instance/recovery HTTP/1.1
2 Host: bbc.bj.baidubce.com
3 Authorization: authorization string
4

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
instanceIds	List	是	requestBody	虚拟机实例id数组

返回头域

除公共头域外，无其它特殊头域。

返回参数

无特殊返回参数

错误码

无特殊返回错误码

请求示例

Plain Text

1 POST /v1/instance/recovery HTTP/1.1
2 Host: bbc.bj.baidubce.com
3 ContentType: application/json
4 Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2015 08 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5 
6 {
7    "instanceIds":["i-0ZpkzJ6u","i-0ZpkzJ62"]
8 }

返回示例

Plain Text

1 HTTP/1.1 200 OK
2 x bce request id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Wed, 03 Dec 2014 06:42:19 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS

简介

标签相关接口