权限组相关接口

更新时间：2023-08-24

创建存储网关权限组

描述

创建存储网关权限组，返回权限组id

请求结构

POST /v{version}/authGroup HTTP/1.1
Host: bsg.bj.baidubce.com 
Authorization: authorization string 
 {
   "name": name,
   "protocolType": protocolType
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
targetId	String	否	RequestBody参数	当前权限组需绑定的共享目标id, 若不为空, 则直接将新创建的权限组绑定到共享目标
name	String	否	RequestBody参数	存储网关账户名称，如果未指定，则自动生成
protocolType	String	是	RequestBody参数	协议类型，NFS 和 SMB
authList	List	否	RequestBody参数	权限组中的具体权限列表, 如不为空, 则直接将权限添加到该权限组, AuthInfo结构详见附录
protocolType	String	是	AuthInfo	权限组类型: NFS/SMB, 必须继承权限组的类型
nfsFileShareConfig	nfsFileShareConfig	否	AuthInfo	NFS协议相关权限信息
ipAddr	String	否	nfsFileShareConfig	NFS协议允许访问的IP地址，支持CIDR
mode	String	否	nfsFileShareConfig	NFS协议账户的读写权限，支持ro:只读和 rw:读写
squash	String	否	nfsFileShareConfig	支持root_squash限制root用户权限，all_squash限制所有用户权限，no_root_squash不限制root用户权限（默认值）
sync	String	否	nfsFileShareConfig	支持sync同步写入内存和硬盘，async先写入内存再写入硬盘（默认值）
smbFileShareConfig	smbFileShareConfig	否	AuthInfo	SMB协议相关权限信息
userName	String	否	smbFileShareConfig	SMB协议的账户名
password	String	否	smbFileShareConfig	SMB协议的密码

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
authGroupId	String	存储网关权限组id
authGroupUuid	String	存储网关权限组uuid

请求示例

POST http://bsg.bj.baidubce.com/v1/authGroup
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",
    "protocolType": "NFS",
    "targetId": "t-CgneHp"
}

返回示例

HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
 Server: BWS
 
 {
    "authGroupId": "ag-L80IwB",
    "authGroupUuid": "ag-L80IwB"
 }

查询存储网关权限组列表

描述

返回权限组列表

请求结构

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

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authGroupId	String	否	URL参数	过滤类参数，若不为空, 则回指定groupId的详细信息, 否则返回列表
isBindTarget	int	否	Query参数	过滤类参数, -1:不过滤(默认值), 0:拉取未绑定到target的权限组, 1:拉取已绑定到target的权限组
manner	String	是	Query参数	指定分页策略, 固定为: manner=page
pageNo	int	是	Query参数	当前页数
pageSize	int	是	Query参数	单页数据项个数
order	String	否	Query参数	升序/降序
orderBy	String	否	Query参数	排序数据项
keyword	String	否	Query参数	搜索该字段
keywordType	String	否	Query参数	搜索字段类型, 当前支持字段:authGroupId, name

返回参数

参数名称	类型	是否必须	参数位置	描述
pageNo	int	是	ResponseBody参数	当前页数
pageSize	int	是	ResponseBody参数	单页数据项个数
totalCount	int	是	ResponseBody参数	总数据项个数
orders	OrderInfo	是	ResponseBody参数	排序信息
order	String	是	OrderInfo	升序/降序
orderBy	String	是	OrderInfo	排序数据项
result	List< AuthGroupInfo>	是	ResponseBody参数	存储网关权限组列表信息，AuthGroupInfo组成的集合, 详见附录
authGroupId	String	是	AuthGroupInfo	权限组id
name	String	是	AuthGroupInfo	权限组名称
protocolType	String	是	AuthGroupInfo	权限组协议类型 NFS/SMB
targetId	String	否	AuthGroupInfo	若为空: 表示当前未绑定到共享对象, 不为空: 权限组所绑定的共享对象id
targetName	String	否	AuthGroupInfo	权限组所绑定的共享对象名称, 若targetId为空, 则targetName也为空
authList	List< AuthInfo>	否	AuthGroupInfo	权限组中的权限列表
authId	String	是	AuthInfo	权限id
protocolType	String	是	AuthInfo	权限组类型: NFS/SMB, 必须继承权限组的类型
nfsFileShareConfig	nfsFileShareConfig	否	AuthInfo	NFS协议相关权限信息
ipAddr	String	否	nfsFileShareConfig	NFS协议允许访问的IP地址，支持CIDR
mode	String	否	nfsFileShareConfig	NFS协议账户的读写权限，支持ro:只读和 rw:读写
squash	String	否	nfsFileShareConfig	支持: root_squash限制root用户权限，all_squash限制所有用户权限，no_root_squash不限制root用户权限（默认值）
sync	String	否	nfsFileShareConfig	支持sync同步写入内存和硬盘，async先写入内存再写入硬盘（默认值）
smbFileShareConfig	smbFileShareConfig	否	AuthInfo	SMB协议相关权限信息
userName	String	否	smbFileShareConfig	SMB协议的账户名
password	String	否	smbFileShareConfig	SMB协议的密码

返回状态码

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

返回头域

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

请求示例

GET http://bsg.bj.baidubce.com/v1/authGroup
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": [
        {
            "authGroupId": "ag-ye9Zbr87",
            "authList": [
                {
                    "authId": "a-PYcjzRCw",
                    "nfsFileShareConfig": {
                        "ipAddr": "*",
                        "mode": "rw",
                        "squash": "no_root_squash",
                        "sync": "sync"
                    },
                    "protocolType": "NFS",
                    "smbFileShareConfig": null,
                    "status": "CONFIGURING"
                }
            ],
            "name": "auth-group-xjMZhZMWlr",
            "protocolType": "NFS",
            "targetId": "t-m5ZHfB5r",
            "targetName": "t-msdsdkjdr"
        }
    ],
    "totalCount": 1
}

修改权限组

描述

修改权限组

请求结构

PUT /v{version}/authGroup/{authGroup}?{aciton} HTTP/1.1 
Host: bsg.bj.baidubce.com 
Authorization: authorization string 
 {
     name="newame"
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authGroupId	String	是	URL参数	权限组id
action	String	是	Query参数	固定为: modify
targetId	String	否	RequestBody参数	默认为空, 不为空:将当前权限组绑定/换绑到该target, -1:解绑定
name	String	否	RequestBody参数	权限组名称
authList	List< AuthInfo>	否	AuthGroupInfo	待修改的权限规则列表
authId	String	是	AuthInfo	权限id
nfsFileShareConfig	nfsFileShareConfig	否	AuthInfo	NFS协议相关权限信息
ipAddr	String	否	nfsFileShareConfig	NFS协议允许访问的IP地址，支持CIDR
mode	String	否	nfsFileShareConfig	NFS协议账户的读写权限，支持ro:只读和 rw:读写
squash	String	否	nfsFileShareConfig	支持: root_squash限制root用户权限，all_squash限制所有用户权限，no_root_squash不限制root用户权限（默认值）
sync	String	否	nfsFileShareConfig	支持: sync 同步写入内存和硬盘，async 先写入内存再写入硬盘（默认值）
smbFileShareConfig	smbFileShareConfig	否	AuthInfo	SMB协议相关权限信息
userName	String	否	smbFileShareConfig	SMB协议的账户名
password	String	否	smbFileShareConfig	SMB协议的密码

返回状态码

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

返回头域

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

返回参数 无

请求示例

PUT http://bsg.bj.baidubce.com/v1/authGroup/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}/authGroup/{authGroupId} HTTP/1.1
Host: bsg.bj.baidubce.com
Authorization: authorization string
{ 
}

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authGroupId	String	是	URL参数	待删除的权限组id

返回状态码

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

返回头域

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

返回参数 无

请求示例

DELETE http://bsg.bj.baidubce.com/v1/authGroup/ag-nrndvr?bsgId=bsg-sdklnfskdj
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

关联权限组到共享目标

描述

将指定的权限组关联到指定的共享目标。

请求结构

PUT /v{version}/authGroup/{authGroupId}?{action}&targetId={targetId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
 {
   "bsgId": bsgId,
   "targetId": targetId
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authGroupId	String	是	URL参数	权限组ID
action	String	是	Query参数	固定为:bindAuthGroup
targetId	String	是	Query参数	绑定/换绑到的共享目标id

返回状态码

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

返回头域

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

返回参数

无

请求示例

PUT http://bsg.bj.baidubce.com/v1/authGroup/ag-vrpomsyh?bindAuthGroup&targetId=t-sadkji
Host: bsg.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
 
 {
 	"targetId": "t-imosdlyl"
 }

返回示例

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

解除权限组和共享目标的关联

请求结构

PUT /v{version}/authGroup/{authGroupId}?{action}&targetId={targetId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
 {
   "targetId": targetId
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authGroupId	String	是	URL参数	权限组ID
action	String	是	Query参数	固定为:unbindAuthGroup
targetId	String	是	Query参数	解绑的共享目标id

返回状态码

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

返回头域

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

返回参数

无

请求示例

PUT http://bsg.bj.baidubce.com/v1/authGroup/ag-vrpomsyh?unbindAuthGroup&targetId=t-sadkji
Host: bsg.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
 
 {
 	"targetId": "t-utlimolyl"
 }

返回示例

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

百度智能云

存储网关 BSG

存储网关 BSG

权限组相关接口

创建存储网关权限组

查询存储网关权限组列表

修改权限组

删除存储网关权限组

关联权限组到共享目标

解除权限组和共享目标的关联