存储网关 - console-api

更新时间：2023-08-24

创建存储网关

描述

创建一个存储网关，返回分配的服务地址以及实例ID。
付费方式为后付费。

请求结构

POST /v{version}/bsg HTTP/1.1
Host: bsg.bj.baidubce.com
Authorization: authorization string
 
 {
     "bsgClass": "STANDARD",
     "location": "CLOUD",
     "type": "FILE"
 }

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
paymentMethod	Set< PaymentModel>	否	RequestBody参数	订单级付费优惠信息详见订单文档:paymentMethod
items	List< AbstractCreateOrderItem>	是	RequestBody参数	订单items信息详见订单文档:AbstractCreateOrderItem
paymentMethod	Set< PaymentModel>	否	AbstractCreateOrderItem	items级付费优惠信息详见订单文档:paymentMethod
config	BsgInfo	是	AbstractCreateOrderItem	需创建的项目(存储网关)信息
name	String	否	BsgInfo	存储网关的名称，如果未指定，则自动生成
bsgClass	String	是	BsgInfo	指定网关规格, 可选择标准版本:STANDARD 和高性能版本:PERFORMANCE, 目前只支持STANDARD
location	String	是	BsgInfo	指定网关部署位置, 可选择百度云:CLOUD 和本地:LOCAL, 目前只支持CLOUD
type	String	是	BsgInfo	指定该存储网关类型, 可选择文件网关:FILE 和块网关:ISCSI, 目前只支持FILE
eip	String	否	BsgInfo	指定该存储网关需要绑定的eip，默认为空, 表示不绑定eip, "new"表示新创建
descr	string	否	BsgInfo	指定该存储网关描述信息
vpcId	string	是	BsgInfo	将网关创建在指定的VPC内 (短id)
subnet	SubnetModel	是	BsgInfo	子网信息
zoneName	String	是	SubnetModel	指定zone
subnetId	String	否	SubnetModel	指定subnetId(短id), 若为空则根据vpc拉取默认subnet
region	String	是	BsgInfo	指定购买区域, 例如北京/保定/苏州等
billing	Billing	是	BsgInfo	指定账单信息
isAutoRenewal	bool	是	Billing	是否开启自动续费
paymentTiming	String	是	Billing	付费类型信息预付费:prepay, 后付费:postpay, 目前只支持预付费
reservation	Reservation	是	Billing	预付费周期信息
reservationLength	int	是	Reservation	预付费数,例如1/3/6等
reservationTimeUnit	String	是	Reservation	预付费周期单位, 目前只支持"MONTH"
autoRenewReservation	Reservation	是	Billing	自动续费周期信息(与预付费付费周期类似)
reservationLength	int	是	Reservation	预付费数,例如1/3/6等
reservationTimeUnit	String	是	Reservation	预付费周期单位, 目前只支持"MONTH"

返回状态码

成功返回200，失败返回见错误码

返回头域

除公共头域外，无其他特殊头域

返回参数

参数名称	类型	是否必须	参数位置	描述
bsgId	String	是	ResponseBody参数	存储网关id
bsgUuid	String	是	ResponseBody参数	存储网关uuid
orderId	String	是	ResponseBody参数	账单id

请求示例

POST http://bsg.bj.baidubce.com/v1/bsg?clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: bsg.bj.baidubce.com
Authorization: bce-auth-v1/0a71d43401344af786ff328451073529/2022-02-08T07:17:51Z/1800/content-length;x-bce-date;content-md5;host;x-bce-request-id;x-bce-content-sha256;content-type/37f551cf056a694cbdcf2cae27f4c2d304d2563e3f2e340b330c0ac141dc9246
{
    "items": [
        {
            "config": {
                "billing": {
                    "paymentTiming": "prepay",
                    "reservation": {
                        "reservationLength": 1,
                        "reservationTimeUnit": "MONTH"
                    },
                    "autoRenewReservation": {
                        "reservationLength": 1,
                        "reservationTimeUnit": "MONTH"
                    }
                },
                "bsgClass": "STANDARD",
                "description": "",
                "location": "CLOUD",
                "name": "",
                "orderId": "412aa51b-eff5-4667-b240-5128edd93937",
                "subnet": {
                    "subnetId": "sbn-ap29xamu7d7c",
                    "zoneName": "zoneA"
                },
                "type": "FILE",
                "vpcId": "vpc-g7pn8fgeajh0"
            }
        }
    ]
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
 {
    "bsgId": "bsg-Khgzlg",
    "bsgUuid": "1a222bd7-9fe8-4b2c-86fe-88ec4868dbb2"
}

查询存储网关列表

描述

返回存储网关列表

请求结构

GET /v{version}/bsg/{bsgId}?manner=page&pageNo=1&pageSize=10&order=desc&orderBy=ctime HTTP/1.1
Host: bsg.bj.baidubce.com 
Authorization: authorization string
{ 
}

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
bsgId	String	否	URL参数	如指定具体bsgId, 则返回该存储网关详细信息, 不指定该参则返回所有存储网关列表
bsgClass	String	否	Query参数	筛选字段, 指定网关规格, 可选择标准版本:STANDARD 和高性能版本:PERFORMANCE, 目前只支持STANDARD
location	String	否	Query参数	筛选字段, 指定网关部署位置, 可选择百度云:CLOUD 和本地:LOCAL, 目前只支持CLOUD
type	String	否	Query参数	筛选字段, 指定该存储网关类型, 可选择文件网关:FILE 和块网关:ISCSI, 目前只支持FILE
manner	String	是	Query参数	指定分页策略, 固定为: manner=page
pageNo	int	是	Query参数	当前页数
pageSize	int	是	Query参数	单页数据项个数
order	String	否	Query参数	升序/降序
orderBy	String	否	Query参数	排序数据项
keyword	String	否	Query参数	搜索该字段
keywordType	String	否	Query参数	搜索字段类型, 当前支持字段:bsgId, name

返回头域

除公共头域外，无其他特殊头域

返回参数

参数名称	类型	是否必须	参数位置	描述
pageNo	int	是	ResponseBody参数	当前页数
pageSize	int	是	ResponseBody参数	单页数据项个数
totalCount	int	是	ResponseBody参数	总数据项个数
orders	OrderInfo	是	ResponseBody参数	排序信息
order	String	是	OrderInfo	升序/降序
orderBy	String	是	OrderInfo	排序数据项
result	List< BsgInfo>	是	ResponseBody参数	返回的存储网关信息列表
name	String	是	BsgInfo	存储网关的名称
bsgClass	String	是	BsgInfo	网关规格
location	String	是	BsgInfo	网关部署位置
type	String	是	BsgInfo	存储网关类型
eip	String	否	BsgInfo	存储网关需要绑定的eip, 若为空, 表示没有绑定eip
descr	string	否	BsgInfo	存储网关描述信息
vpcId	string	是	BsgInfo	存储网关vpc
domain	String	是	BsgInfo	存储网关挂载点
ctime	String	是	BsgInfo	存储网关创建时间
expireTime	String	是	BsgInfo	存储网关过期时间
status	String	是	BsgInfo	存储网关挂当前状态

请求示例

GET http://bsg.bj.baidubce.com/v1/bsg?manner=page&pageNo=1&pageSize=10&order=desc&orderBy=ctime
Host: bsg.bj.baidubce.com
Authorization: bce-auth-v1/0a71d43401344af786ff328451073529/2022-02-08T07:17:51Z/1800/content-length;x-bce-date;content-md5;host;x-bce-request-id;x-bce-content-sha256;content-type/37f551cf056a694cbdcf2cae27f4c2d304d2563e3f2e340b330c0ac141dc9246

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
  
{
    "order": "desc",
    "orderBy": "ctime",
    "orders": [
        {
            "order": "desc",
            "orderBy": "ctime"
        }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "result": [
        {
            "bsgClass": "STANDARD",
            "bsgId": "bsg-bUP9MYF2",
            "ctime": "2022-03-02T15:15:35Z",
            "descr": "",
            "domain": "192.168.0.6",
            "eip": "",
            "errcode": "NONE",
            "location": "CLOUD",
            "mtime": "2022-03-02T15:50:18Z",
            "name": "bsg-1LVt3FueBG",
            "status": "RUNNING",
            "subnet": {
                "cidr": null,
                "physicalZone": null,
                "subnetId": "7aafd389-ee91-4750-8b72-99eefc346de3",
                "zoneName": "zoneA"
            },
            "type": "FILE",
            "uuid": "c1d2acbf-c9ef-4f8b-a2b3-450ee659316d",
            "vpcId": "35856bf8-66ca-4031-b1ed-f37525ce2dac"
        }
    ],
    "totalCount": 1
}

修改存储网关

描述

修改存储网关

请求结构

PUT /v{version}/bsg/{bsgId}?{action} HTTP/1.1
Host: bsg.bj.baidubce.com
Authorization: authorization string
 
 {
     name: "bsg-newname"
 }

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
bsgId	String	是	URL参数	待修改的存储网关id
action	String	是	Query参数	固定为: modify
name	String	否	RequestBody参数	存储网关的名称
descr	string	否	RequestBody参数	存储网关描述信息

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域

返回参数

无

请求示例

PUT http://bsg.bj.baidubce.com/v1/bsg/bsg-pcm5PJ?modify
Host: bsg.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS

释放存储网关

描述

释放指定的存储网关，被释放的存储网关无法找回。

请求结构

DELETE /v{version}/bsg/{bsgId} HTTP/1.1
Host: bsg.bj.baidubce.com
Authorization: authorization string
{ 
}

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
bsgId	String	是	URL参数	待释放的存储网关id

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域

返回参数

无

请求示例

DELETE http://bsg.bj.baidubce.com/v1/bsg/bsg-pcm5PJ
Host: bsg.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
 
{ 
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS

绑定EIP到存储网关

描述

挂载指定的EIP到指定存储网关。

请求结构

PUT /v{version}/bsg/{bsgId}?{action}&eip={eip} HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string
 {
   "eip": eip
 }

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
bsgId	String	是	URL参数	存储网关的id
action	String	是	Query参数	固定为:bindEip
eip	String	是	Query参数	待绑定的eip, "new"表示新创建

请求示例

PUT /v{version}/bsg/sg-ksrvejrksvcy?bindEip&eip=127.0.0.1 HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

解除EIP绑定

描述

解除指定存储网关的IP绑定。

请求结构

PUT /v{version}/bsg/{bsgId}?{action}&eip={eip} HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
bsgId	String	是	URL参数	存储网关的id
action	String	是	Query参数	固定为:unbindEip
eip	String	是	Query参数	待解绑的eip

返回状态码

成功返回200，失败返回见错误码。

请求示例

PUT /v{version}/bsg/bsg-Khgzlg?unbindEip&eip=127.0.0.1 HTTP/1.1
 Host: bce.bj.baidubce.com
 Authorization: authorization string

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

获取存储网关规格信息

描述

获取网关规格.

请求结构

GET /v{version}/bsg?{action} HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
action	String	是	Query参数	固定为:getBsgClass

返回状态码

成功返回200，失败返回见错误码。

请求示例

GET /v{version}/bsg?getBsgClass HTTP/1.1
Host: bsg.bj.baidubce.com
Authorization: authorization string

返回参数

参数名称	类型	参数位置	描述
bsgClassList	List< BsgClassInfo>	ResponseBody参数	存储网关规格信息
bsgClass	String	BsgClassInfo	存储网关规格, 标准版本:STANDARD 和高性能版本:PERFORMANCE
bccCpuCore	long	BsgClassInfo	bcc cpu核数
bccMemSize	long	BsgClassInfo	bcc内存大小(GB)
bccDiskSize	long	BsgClassInfo	bcc磁盘大小(GB)
bccNum	int	BsgClassInfo	bcc个数(默认为1)
eipBandwidth	int	BsgClassInfo	eip带宽(Mbps), 标准版本默认为:20

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

{
    "bsgClassList": [
        {
            "bccDiskSize": 100,
            "bccCpuCore": 4,
            "bccMemSize": 12,
            "bccNum": 1,
            "bsgClass": "STANDARD"
        }
    ]
}

获取zone信息

描述

获取zone信息

请求结构

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1

返回状态码

成功返回200，失败返回见错误码。

请求示例

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

返回参数

参数名称	类型	参数位置	描述
zoneList	ZoneInfo	ResponseBody参数	可用区信息
zoneNames	List< String>	ZoneInfo	可用区名称列表

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

{
    "zoneList": {
        "zoneNames": [
            "zoneA",
            "zoneB"
        ]
    }
}

获取订单价格

描述

获取zone信息

请求结构

GET /v{version}/order/price?type=new HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
bsgType	String	是	RequestBody参数	存储网关类型
bsgClass	String	是	RequestBody参数	存储网关规格
region	String	是	RequestBody参数	存储网关地域

返回状态码

成功返回200，失败返回见错误码。

请求示例

GET /v{version}/order/price HTTP/1.1
 Host: bce.bj.baidubce.com
 Authorization: authorization string
 {
     bsgType:"FILE",
     bsgClass: "STANDARD" 
 }

返回参数

参数名称	类型	参数位置	描述
priceInfo	PriceInfo	ResponseBody参数	价格信息
price	long	PriceInfo	价格
perPrice	long	PriceInfo	单位价格

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

获取订单详情

描述

获取zone信息

请求结构

GET /v{version}/order/{orderId} HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
orderId	String	是	URL参数	订单id

返回状态码

成功返回200，失败返回见错误码。

请求示例

GET /v{version}/order/orderId HTTP/1.1
 Host: bce.bj.baidubce.com
 Authorization: authorization string

返回参数

参数名称	类型	参数位置	描述
order	Order	ResponseBody参数	订单信息, 详见billing

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

订单续费

描述

订单续费

请求结构

POST /v{version}/bsg/renew HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
reservationLength	int	是	RequestBody参数	续费时长,例如1/3/6等
reservationTimeUnit	String	是	RequestBody参数	续费周期单位, 目前只支持"MONTH"
paymentMethod	Set< PaymentModel>	否	RequestBody参数	付费优惠信息[详见订单文档]
bsgId	String	是	RequestBody参数	待续费的存储网关id

返回状态码

成功返回200，失败返回见错误码。

请求示例

POST /v{version}/bsg/renew HTTP/1.1
 Host: bce.bj.baidubce.com
 Authorization: authorization string

返回参数

参数名称	类型	参数位置	描述
orderId	long	ResponseBody参数	已创建订单id

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

获取白名单用户信息

描述

获取zone信息

请求结构

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
userId	String	否	RequestBody参数	用户id

返回状态码

成功返回200，失败返回见错误码。

请求示例

GET /v1/whiteList HTTP/1.1
Host: bce.bj.baidubce.com
Authorization: authorization string
{
    userId: "1bbb8693967a4f14b60b7cbd5c4c954d"
}

返回参数

参数名称	类型	参数位置	描述
whiteList	List< String>	ResponseBody参数	白名单列表
effect	int	ResponseBody参数	白名单生效方式 1:白名单生效中 2:不使用白名单,全量开放

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

{       
    "effect": 1,
    "whiteList": [
        "1bbb8693967a4f14b60b7cbd5c4c954d"
    ]
}

百度智能云

存储网关 BSG

存储网关 BSG

存储网关 - console-api

创建存储网关

查询存储网关列表

修改存储网关

释放存储网关

绑定EIP到存储网关

解除EIP绑定

获取存储网关规格信息

获取zone信息

获取订单价格

获取订单详情

订单续费

获取白名单用户信息