接口说明

查询专属服务器列表

查询当前用户创建的所有专属服务器 DCC 列表。

请求结构

GET /v{version}/dedicatedHost HTTP/1.1
Host: dcc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 DCC API版本号,目前是v1。
marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串。
maxKeys int Query参数 每页包含的最大数量,最大数量通常不超过1000。缺省值为1000。
zoneName String Query参数 可用区名称

返回头域

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

返回参数

参数名称 类型 描述
marker String 标记查询的起始位置。
isTruncated boolean true表示后面还有数据,false表示已经是最后一页。
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现。
maxKeys int 每页包含的最大数量。
dedicatedHosts List<DedicatedHostModel> 返回的 DCC 服务器列表。

请求示例

GET /v1/dedicatedHost HTTP/1.1
Host: dcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2016-08-01T10:40:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

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

{
    "nextMarker": "d-xktdeMSf",
    "marker": "d-YufwpQAe",
    "maxKeys": 1,
    "isTruncated": true,
    "dedicatedHosts": [
        {
            "id": "d-YufwpQAe",            
            "name": "bj-S02-1te1fa",
            "status": "Stopped",
            "desc": "console",
            "flavorName": "S01",
            "resourceUsage": {
                "cpuCount": 22,
                "freeCpuCount": 20,
                "memoryCapacityInGB": 78,
                "freeMemoryCapacityInGB": 70,
                "ephemeralDisks": [
                    {
                        "storageType": "sata",
                        "sizeInGB": 6144,
                        "freeSizeInGB": 1024
                    },
                    {
                        "storageType": "ssd",
                        "sizeInGB": 1024,
                        "freeSizeInGB": 1024
                    }
                ]
            }
            "paymentTiming":"Postpaid",
            "createTime": "2015-07-09T10:27:15Z",
            "expireTime": null,
            "zoneName": "cn-bj-a"
        }
    ]
}

查询专属服务器详情

查询单个专属服务器详细信息。

请求结构

GET /v{version}/dedicatedHost/{hostId} HTTP/1.1
Host: dcc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 DCC API版本号,目前是v1。
hostId String URL参数 待查询的某个专属服务器ID。

返回头域

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

返回参数

参数名称 类型 描述
dedicatedHost DedicatedHostModel 返回的DCC 服务器详情。

请求示例

GET /v1/dedicatedHost/d-kqaRyeCT HTTP/1.1
Host: dcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2016-08-01T10:40:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

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

{
    "dedicatedHost": {
        "id": "d-YufwpQAe",            
        "name": "bj-S02-1te1fa",
        "status": "Stopped",
        "desc": "console",
        "flavorName": "S01",
        "resourceUsage": {
            "cpuCount": 22,
            "freeCpuCount": 20,
            "memoryCapacityInGB": 78,
            "freeMemoryCapacityInGB": 70,
            "ephemeralDisks": [
                {
                      "storageType": "sata",
                      "sizeInGB": 6144,
                      "freeSizeInGB": 0
                },
                {
                      "storageType": "ssd",
                      "sizeInGB": 1024,
                      "freeSizeInGB": 1024
                }
            ]
        }
        "paymentTiming":"Postpaid",
        "createTime": "2015-07-09T10:27:15Z",
        "expireTime": null,
        "zoneName": "cn-bj-a"
    }
}

专属服务器续费

描述

针对于指定专属服务器的续费操作,延长过期时长

  • 异步接口

请求结构

PUT /v{version}/dedicatedHost/{hostId}?{action}&clientToken={clientToken} HTTP/1.1
Host: dcc.bj.baidubce.com
Authorization: authorization string

{
    "billing":{
        "reservation":{
            "reservationLength": reservationLength,
            "reservationTimeUnit": reservationTimeUnit
        }
    }
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
hostId String URL参数 专属服务器ID
action String Query参数 本接口中该参数取值purchaseReserved
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见链接
billing Billing RequestBody参数 订单信息

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 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 不可操作

请求示例

PUT /v1/dedicatedHost/d-qw2Pf3wB?purchaseReserved&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: dcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "billing":{
        "reservation":{
            "reservationLength":1,
            "reservationTimeUnit":"Month"
        }
    }
}

返回示例

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

专属服务器创建

  • 本接口用于创建一个或多个同配置的专属服务器。

请求结构

POST /v{version}/dedicatedHost?clientToken={clientToken} HTTP/1.1
Host: dcc.bj.baidubce.com
Authorization: authorization string

{
    "vCpu": vCpu,  //cpu虚拟化核数
    "name": "name",  //专属服务器名称
    "flavorName": "flavorName",  //套餐类型:"C01"
    "purchaseCount": purchaseCount,  //购买数目,最小1
    "billing":{
        "paymentTiming": paymentTiming,  //付款时间,预付费(Prepaid)和后支付(Postid)
        "reservation": {
            "reservationLength": reservationLength  //购买时长,最小1
        }
    },
    "zoneName": zoneName   //zone信息,默认为空
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见链接
vCpu int RequestBody参数 待创建专属服务器虚拟CPU核数,数量不能超过物理CPU核数的两倍
flavorName String RequestBody参数 套餐类型,可选计算型(calculation)C01/C02,可选大数据机型(storage)S01/S02
purchaseCount int RequestBody参数 批量创建(购买)的虚专属服务器个数,必须为大于0的整数,可选参数,缺省为1
name String RequestBody参数 专属服务器名字(可选)。默认都不指定name。如果指定name:批量时name作为名字的前缀。后端将加上后缀,后缀生成方式:name{ -序号}。如果没有指定name,则自动生成,方式:{instance-八位随机串-序号}。注:随机串从0~9a~z生成;序号按照count的数量级,依次递增,如果count为100,则序号从000~100递增,如果为10,则从00~10递增
billing Billing RequestBody参数 订单、计费相关参数
zoneName String RequestBody参数 指定zone信息,默认为空,由系统自动选择

返回头域

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

返回参数

参数名称 类型 描述
dedicatedHostIds List\ 专属服务器ID的集合,其中ID符合BCE规范,必须是一个定长字符串,且只允许包含大小写字母、数字、连字号(-)和下划线(_)。

错误码

错误码 错误描述 HTTP状态码 中文解释
dedicatedHost.dedicatedHostBeBanned The dedicatedHost is banned, contact technical support for assistance. 403 DCC服务已被封禁
dedicatedHost.GlobalhostQuotaLimitExceeded Quota exceeds limit for regional prepaid dedicatedHost pool, contact technical support for further assistance. 413 预付费类型的专属服务器数目超出当前区域预售额度限制
dedicatedHost.dedicatedHostQuotaLimitExceeded Quota exceeds limit. 413 专属服务器个数超过限制

请求示例

POST /v1/dedicatedHost?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: dcc.bj.baidubce.com
ContentType: application/json    
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "cCpu": 22,  //cpu虚拟化核数
    "flavorName": "C01",  //套餐配置:"C01"
    "purchaseCount": 1,  //购买数目,最小1
    "billing":{
        "paymentTiming": "prepaid",  //付款时间,预付费(Prepaid)和后支付(Postid)
        "reservation": {
            "reservationLength": 1 //购买时长,最小1
        }
    }
}

返回示例

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

{
    "dedicatedHostIds": [
        "d-qw2Pf3wB"
    ]
}

专属服务器绑定标签

描述

为专属服务器绑定标签, 其所有子实例也会绑定相同标签。

请求结构

PUT /v{version}/dedicatedHost/{dccId}/tag?bind
Host: dcc.bj.baidubce.com
Authorization: authorization string
Request Body
{
    "changeTags": [
        {
            "tagKey": "aaa",
            "tagValue": "111"
        },
        {
            "tagKey": "bbb",
            "tagValue": "222"
        }
    ]
}

请求头域

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

请求参数

参数名称|类型|是否必需|参数位置|描述
---|---|---|---|----
version|String|是|URL参数|API版本号
dccId|String|是|URL参数|指定专属服务器id
changeTags|Array|是|Request Body参数|标签数组,每个标签由tagKey和tagValue组成。

返回头域

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

请求示例

PUT /v1/dedicatedHost/d-fkIthUMd/tag?bind=%22%22&clientToken=4ec448dc595635ead81b3ac467a3dee4 HTTP/1.1
    Host: dcc.bj.baidubce.com
    ContentType: application/json
    Authorization: bce-auth-v1/4e69d28643af46dea51fef90e221eb17/2019-02-12T08:48:37Z/1800/host;x-bce-date/c64a8863b70d0f5c105b41200bfacdbae78dded2509777056c1a4677b635d63d
    {
        "changeTags" : [
            {
                "tagKey" : "aaa",
                "tagValue" : "111"
            },
            {
                "tagKey" : "bbb",
                "tagValue" : "222"
            }
        ]
    }

返回示例

HTTP/1.1 200 OK
    x-bce-request-id: 4a05201c-f585-48c9-8656-186e7cfccab4

专属服务器解绑标签

描述

为专属服务器解绑标签, 其下的所有子实例也会解绑指定标签。

请求结构

PUT /v{version}/dedicatedHost/{dccId}/tag?unbind
    Host: dcc.bj.baidubce.com
    Authorization: authorization string
    Request Body
    {
        "changeTags": [
            {
                "tagKey": "aaa",
                "tagValue": "111"
            },
            {
                "tagKey": "bbb",
                "tagValue": "222"
            }
        ]
    }

请求头域

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

请求参数

参数名称|类型|是否必需|参数位置|描述
---|---|---|---|----
version|String|是|URL参数|API版本号
dccId|String|是|URL参数|指定专属服务器id
changeTags|Array|是|Request Body参数|需要解绑的标签数组,每个标签由tagKey和tagValue组成。

返回头域

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

请求示例

PUT /v1/dedicatedHost/d-fkIthUMd/tag?unbind=%22%22&clientToken=4ec448dc595635ead81b3ac467a3dee4 HTTP/1.1
    Host: dcc.bj.baidubce.com
    ContentType: application/json
    Authorization: bce-auth-v1/4e69d28643af46dea51fef90e221eb17/2019-02-12T09:12:17Z/1800/host;x-bce-date/5358d18753d02db087695bef221b32d669e7137efda02ce9be3d657d9342aa94
    {
        "changeTags" : [
            {
                "tagKey" : "aaa",
                "tagValue" : "111"
            },
            {
                "tagKey" : "bbb",
                "tagValue" : "222"
            }
        ]
    }

返回示例

HTTP/1.1 200 OK
    x-bce-request-id: cad7e206-8a09-4c23-93f3-2f46cc611194

创建专属实例

描述

本接口用于在专属服务器上创建专属实例。在创建专属实例时,以下操作可能与您的业务相关:

  • 专属实例不参与计费。

  • 本接口用于创建一个或多个专属实例。

  • 支持批量创建,且如果创建过程中有一个专属实例创建失败,所有实例将全部回滚,均创建失败,如果创建时包含CDS,CDS也会回滚。

  • 专属实例支持创建、添加本地磁盘。

  • 本地磁盘不支持挂载、卸载、删除。

  • DCC允许用户自定义专属实例的cpu和内存等参数,所创建的专属实例资源将会使用DCC的资源。

  • 专属实例只能通过ephemeralDisks创建临时盘并指定磁盘类型。

  • 专属实例支持用户自定义安全组和子网,两者需要同时指定在同一个VPC下。如果未指定安全组和子网,在创建专属实例时会自动加入系统默认的安全组和子网内。

请求结构

POST /v{version}/dedicatedHost/instance?clientToken={clientToken} HTTP/1.1
    Host: dcc.bj.baidubce.com
    Authorization: authorization string
    {
        "instanceType": instanceType,
        "cpuCount": cpuCoreCount,
        "memoryCapacityInGB": memoryCapacityInGB,
        "ephemeralDisks": [
            {
                "storageType": storageType,
                "sizeInGB": size
            },
            {
                "storageType": storageType,
                "sizeInGB": size
            }
        ],
        "createCdsList": [
            {
                "storageType": storageType,
                "cdsSizeInGB": cdsSizeInGB
            }
        ],
        "name": "name",
        "imageId": "imageId",
        "localDiskSizeInGB": localDiskSizeInGB,
        "networkCapacityInMbps": networkCapacityInMbps,
        "dedicatedHostId": dedicatedHostId,
        "purchaseCount": purchaseCount,
        "billing":{
            "paymentTiming": paymentTiming,
            "reservation": {
                "reservationLength": reservationLength
            }
        },
        "zoneName": zoneName,
        "subnetId": subnetId,
        "securityGroupId": securityGroupId
    }

请求头域

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

请求参数

参数名称 | 类型 | 是否必需 | 参数位置 | 描述
--- | --- | --- | --- | ----
version | String | 是 | URL参数 | API版本号
clientToken | String | 是 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串,详见[链接](#ClientToken幂等性支持)。
imageId | String | 是 | RequestBody参数 | 待创建虚拟机实例的镜像ID,可通过调用查询镜像列表接口选择获取所需镜像ID。
billing | [Billing](<https://cloud.baidu.com/doc/BCC/API.html#Reservation>) | 是 | RequestBody参数 | 订单、计费相关参数
instanceType | String | 否 | RequestBody参数 | 待创建虚拟机实例的类型,具体可选类型参见下述[InstanceType](#InstanceType),为空时使用默认虚机类型。
cpuCount | int | 是 | RequestBody参数 | 待创建虚拟机实例的CPU核数,可选配置请参考[区域机型以及可选配置](#区域机型以及可选配置)。
memoryCapacityInGB | int | 是 |  RequestBody参数 | 待创建虚拟机实例的内存容量,单位GB,可选配置请参考[区域机型以及可选配置](#区域机型以及可选配置)。
rootDiskSizeInGb | int | 否 |  RequestBody参数 | 待创建虚拟机实例的系统盘大小,单位GB,默认是40GB,范围为[40, 100]GB,超过40GB按照云磁盘价格收费。注意指定的系统盘大小需要满足所使用镜像最小磁盘空间限制。
rootDiskStorageType | String | 否 |  RequestBody参数 | 待创建虚拟机实例系统盘介质,默认使用SSD型云磁盘,可指定系统盘磁盘类型可参见[StorageType](#StorageType)。
localDiskSizeInGB | int | 否 | RequestBody参数 | [已废弃]待创建虚拟机实例的临时数据盘大小(不含系统盘,系统盘为免费赠送),单位为GB,大小为0~500G,请采用ephemeralDisks字段。
ephemeralDisks | List<[EphemeralDisk](#EphemeralDisk)>| 否 | RequestBody参数 | DCC实例可以创建多块本地盘,需要指定磁盘类型以及大小。其他类型BCC最多只能使用一块本地盘,使用默认磁盘类型,需要指定磁盘大小。FPGA实例以及GPU实例默认使用一块本地磁盘,根据配置指定本地盘大小,具体请参考[GPU型BCC可选规格配置](#GPU型BCC可选规格配置) 以及[FPGA型BCC可选规格配置](#FPGA型BCC可选规格配置) 。
createCdsList | List<[CreateCdsModel](#CreateCdsModel)> | 否 | RequestBody参数 | 待创建的CDS磁盘列表,具体数据格式参见下述[CreateCdsModel](#CreateCdsModel)
networkCapacityInMbps | int | 否 | RequestBody参数 |