共享目标相关接口

更新时间：2023-08-24

创建共享目标

描述

在指定存储网关上创建共享目标

请求结构

POST /v{version}/target HTTP/1.1
Host: bsg.bj.baidubce.com
Authorization: authorization string
 {
     "bsgId": bsgId,
     "protocolType": protocolType,
     "name": targetName,
     "bucket": bucket,
     "authGroupId": authGroupId
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
bsgId	String	是	RequestBody参数	存储网关id
protocolType	String	是	RequestBody参数	共享目标类型，NFS 和 SMB
name	String	否	RequestBody参数	共享目标的name, 不填则系统自动生成
bucket	String	是	RequestBody参数	共享目标使用的bosBucket
bucketSubpath	String	否	RequestBody参数	共享目标使用的bosBucket子目录 for挂载子目录
syncMetaPath	List < String>	否	RequestBody参数	同步bos bucket中元数据路径, 必须以/结尾bucket的子路径, 最多5个
authGroupId	String	否	RequestBody参数	权限组id, 若指定, 则创建时进行绑定
descr	String	否	RequestBody参数	共享目标描述信息

返回状态码

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

返回头域

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

返回参数

参数名称	类型	是否必须	参数位置	描述
targetId	String	是	ResponseBody参数	共享目标id
targetUuid	String	是	ResponseBody参数	共享目标uuid

请求示例

POST http://bsg.bj.baidubce.com/v1/target
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
 
 {
 	"bsgId": "bsg-Khgzlg",
     "bucketName":"test-c-su",
     "protocolType":"NFS"
 }

返回示例

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

{
    "targetId": "t-kq68w8",
    "targetUuid": "t-kq68w8sds",
}

查询存储共享目标列表

描述

返回共享目标列表

请求结构

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

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
targetId	String	否	URL参数	如指定targetId, 则返回该共享目标详细信息, 不指定则返回所有共享目标列表
status	String	否	Query参数	按照status过滤
protocolType	String	否	Query参数	按照protocolType过滤
isBindAuthGroup	int	否	Query参数	按照是否已绑定权限组过滤 1:拉取已绑定 0:拉取未绑定 -1:不过滤
manner	String	是	Query参数	指定分页策略, 固定为: manner=page
pageNo	int	是	Query参数	当前页数
pageSize	int	是	Query参数	单页数据项个数
order	String	否	Query参数	升序/降序
orderBy	String	否	Query参数	排序数据项
keyword	String	否	Query参数	搜索该字段
keywordType	String	否	Query参数	搜索字段类型, 当前支持:targetId, name

返回头域

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

返回参数

参数名称	类型	是否必须	参数位置	描述
pageNo	int	是	ResponseBody参数	当前页数
pageSize	int	是	ResponseBody参数	单页数据项个数
totalCount	int	是	ResponseBody参数	总数据项个数
orders	OrderInfo	是	ResponseBody参数	排序信息
order	String	是	OrderInfo	升序/降序
orderBy	String	是	OrderInfo	排序数据项
result	List< TargetInfo>	是	ResponseBody参数	返回的共享目标信息列表
targetId	String	是	TargetModel	共享目标id
bsgId	String	是	TargetModel	绑定的存储网关id
bsgName	String	是	TargetModel	绑定的存储网关名称
protocolType	String	是	TargetModel	共享目标类型，NFS 和 SMB
name	String	是	TargetModel	共享目标的name
bucket	String	是	TargetModel	共享目标使用的bosBucket
bucketSubpath	String	否	RequestBody参数	共享目标使用的bosBucket子目录 for挂载子目录
authGroupId	String	否	TargetModel	当前绑定的权限组id
authGroupName	String	否	TargetModel	当前绑定的权限组name
descr	String	否	TargetModel	共享目标描述信息
status	String	是	TargetModel	该共享目标当前状态
bsgLocation	String	是	TargetModel	对应存储网关location, "CLOUD": 云上部署, "LOCAL": 本地部署型

请求示例

GET http://bsg.bj.baidubce.com/v1/target
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": [
        {
            "bsgId": "bsg-bUP9MYF2",
            "bucket": "test-a-sandbox",
            "name": "t-skelkndjl",
            "protocolType": "NFS",
            "status": "RUNNING",
            "targetId": "t-m5ZHfB5r"
    }
],
"totalCount": 1

}

修改共享目标

描述

修改共享目标

请求结构

PUT /v{version}/target/{targetId}?{action} HTTP/1.1 
Host: bsg.bj.baidubce.com 
Authorization: authorization string 
 {
     name="t-new-name"
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
targetId	String	是	URL参数	共享目标id
action	String	是	Query参数	固定为: modify
name	String	否	RequestBody参数	共享目标名称
descr	String	否	RequestBody参数	共享目标描述信息

返回状态码

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

返回头域

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

返回参数 无

请求示例

PUT http://bsg.bj.baidubce.com/v1/target/t-sdlkjslhvq?modify
Host: bsg.bj.baidubce.com
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
ontent-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5

删除共享目标

描述

删除指定的共享目标

请求结构

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

返回状态码

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

请求示例

DELETE http://bsg.bj.baidubce.com/v1/target/t-utlxhrimolyl
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

百度智能云

存储网关 BSG

存储网关 BSG

共享目标相关接口

创建共享目标

查询存储共享目标列表

修改共享目标

删除共享目标