权限相关接口

更新时间：2022-03-31

创建权限组中的权限

描述

在特定的存储网关权限组中创建一个权限

请求结构

POST /v{version}/auth&authGroupId={authGroupId} HTTP/1.1 
Host: bsg.bj.baidubce.com 
Authorization: authorization string 
 {
  "authGroupId": authGroupId, 
  "nfsFileShareConfig": {
     "ipAddr": ipAddr,
     "rwFlag": rw_flag,
     "squash": squash,
     "sync":sync,
  },
  "smbFileShareConfig": {
     "userName": userName,
     "password": password,
  }
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authGroupId	String	是	Query参数	权限组id
protocolType	String	是	RequestBody参数	权限组类型: NFS/SMB, 必须继承权限组的类型
nfsFileShareConfig	nfsFileShareConfig	否	RequestBody参数	NFS协议相关权限信息
ipAddr	String	否	nfsFileShareConfig	NFS协议允许访问的IP地址，支持CIDR
rwFlag	String	否	nfsFileShareConfig	NFS协议账户的读写权限，支持ro:只读和 rw:读写
squash	String	否	nfsFileShareConfig	支持root_squash限制root用户权限，all_squash限制所有用户权限，no_root_squash不限制root用户权限（默认值）
sync	String	否	nfsFileShareConfig	支持sync同步写入内存和硬盘，async先写入内存再写入硬盘（默认值）
smbFileShareConfig	smbFileShareConfig	否	RequestBody参数	SMB协议相关权限信息
userName	String	否	smbFileShareConfig	SMB协议的账户名
password	String	否	smbFileShareConfig	SMB协议的密码

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
authId	String	存储网关权限id
authUuid	String	存储网关权限uuid

请求示例

POST http://bsg.bj.baidubce.com/v1/auth&authGroupId=ag-xddsnwi
 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
 
 {
     "nfsFileShareConfig": {
     	"ipAddr": "0.0.0.0",
     	"rwFlag": "rw",
     	"squash": "all_squash",
     	"sync": "sync"
  	}
 }

返回示例

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

查询权限组中权限列表

描述

查询权限组中权限列表

请求结构

GET /v{version}/auth/{authId}?authGroupId={authgroupId}
HTTP/1.1 
Host: bsg.bj.baidubce.com 
Authorization: authorization string
{ 
}

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authGroupId	String	是	Query参数	权限组id
authId	String	否	Query参数	过滤类参数，若指定, 则返回该权限详细信息；不指定则返回列表
manner	String	是	Query参数	指定分页策略, 固定为: manner=page
pageNo	int	是	Query参数	当前页数
pageSize	int	是	Query参数	单页数据项个数
order	String	否	Query参数	升序/降序
orderBy	String	否	Query参数	排序数据项
keyword	String	否	Query参数	搜索该字段
keywordType	String	否	Query参数	搜索字段类型, 当前支持字段: 待补充

返回状态码

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

返回头域

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

返回参数

参数名称	类型	是否必须	参数位置	描述
pageNo	int	是	ResponseBody参数	当前页数
pageSize	int	是	ResponseBody参数	单页数据项个数
totalCount	int	是	ResponseBody参数	总数据项个数
orders	OrderInfo	是	ResponseBody参数	排序信息
order	String	是	OrderInfo	升序/降序
orderBy	String	是	OrderInfo	排序数据项
result	List	是	ResponseBody参数	权限列表信息，由AuthInfo组成的集合, 详见附录
authId	String	是	AuthInfo	权限id
protocolType	String	是	AuthInfo	权限组类型: NFS/SMB, 必须继承权限组的类型
nfsFileShareConfig	nfsFileShareConfig	否	AuthInfo	NFS协议相关权限信息
ipAddr	String	否	nfsFileShareConfig	NFS协议允许访问的IP地址，支持CIDR
rwFlag	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协议的密码

请求示例

GET http://bsg.bj.baidubce.com/v1/auth&bsgId=bsg-sdijl&authGroupId=ag-sdklsdnkk
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
 Content-Type: application/json;charset=UTF-8
 x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
 Server: BWS
 
 {
    "order": "desc",
    "orderBy": "ctime",
    "orders": [
        {
            "order": "desc",
            "orderBy": "ctime"
        }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "result": [
        {
            "authId": "a-PYcjzRCw",
            "nfsFileShareConfig": {
                "ipAddr": "*",
                "mode": "rw",
                "squash": "no_root_squash",
                "sync": "sync"
            },
            "protocolType": "NFS",
            "smbFileShareConfig": null,
            "status": "CREATING"
        }
    ],
    "totalCount": 1
}

修改权限组中单个权限规则

描述

修改权限组中单个权限规则

请求结构

PUT /v{version}/auth/{authId}?{aciton}&authGroupId={authGroupId} HTTP/1.1 
Host: bsg.bj.baidubce.com 
Authorization: authorization string 
 {
  "nfsFileShareConfig": {
     "ipAddr": ipAddr,
     "rwFlag": rw_flag,
     "squash": squash,
     "sync":sync,
  },
  "smbFileShareConfig": {
     "userName": userName,
     "password": password,
  }
 }

请求头域

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

请求参数

参数名称	类型	是否必须	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
authId	String	是	URL参数	权限id
authGroupId	String	是	Query参数	权限组id
action	String	是	Query参数	固定为: modify
nfsFileShareConfig	nfsFileShareConfig	否	RequestBody参数	NFS协议相关权限信息
ipAddr	String	否	nfsFileShareConfig	NFS协议允许访问的IP地址，支持CIDR
rwFlag	String	否	nfsFileShareConfig	NFS协议账户的读写权限，支持ro:只读和 rw:读写
squash	String	否	nfsFileShareConfig	支持root_squash限制root用户权限，all_squash限制所有用户权限，no_root_squash不限制root用户权限（默认值）
sync	String	否	nfsFileShareConfig	支持sync同步写入内存和硬盘，async先写入内存再写入硬盘（默认值）
smbFileShareConfig	smbFileShareConfig	否	RequestBody参数	SMB协议相关权限信息
userName	String	否	smbFileShareConfig	SMB协议的账户名
password	String	否	smbFileShareConfig	SMB协议的密码

返回状态码

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

返回头域

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

返回参数 无

请求示例

PUT http://bsg.bj.baidubce.com/v1/auth/sdlkjslhvq?modify&authGroupId=ag-sldkjsls
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}/auth/{authId}?authGroupId={authGroupId} HTTP/1.1
Host: bsg.bj.baidubce.com
Authorization: authorization string
{
}

请求头域

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

请求参数

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

返回状态码

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

返回头域

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

返回参数 无

请求示例

DELETE http://bsg.bj.baidubce.com/v1/auth/sdlkjslsvghvq?bsgId=bsg-sdldsin&authGroupId=ag-sldkjsls
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

百度智能云

存储网关 BSG

存储网关 BSG

权限相关接口

创建权限组中的权限

查询权限组中权限列表

修改权限组中单个权限规则

删除权限组中权限