CFS-Open-API

更新时间：2020-07-24

如果您是初次调用百度智能云产品的API，可以观看API入门视频指南，快速掌握调用API的方法。

文件系统

CreateFileSystem创建文件系统

描述

创建一个cfs文件系统，返回分配的实例ID。
付费方式为后付费。

请求

请求结构

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

{
    "fsName": name,
    "type": type,
    "protocol": protocol
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
fsName	String	是	RequestBody参数	FileSystem的名称，方便记忆。长度1~65个字节，字母开头，可包含字母数字-_/.字符。
type	String	否	RequestBody参数	文件系统类型：1.cap（性能型），默认性能型
protocol	String	否	RequestBody参数	协议类型：1.nfs 2.smb，默认nfs协议

响应

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
fsId	String	FileSystem的ID。后续针对该实例的操作，均需要在请求中带上此ID

示例

请求：

POST /v1/cfs HTTP/1.1
HOST cfs.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
    "fsName":"cfs-for-test"
}

响应：

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
	"fsId":"cfs-jVDkWrBBoj"
}

UpdateFileSystem更新文件系统

描述

更新一个filesystem的配置信息。

请求

请求结构

PUT /v{version}/cfs/{fsId} HTTP/1.1
Host: cfs.bj.baidubce.com
Authorization: authorization string
{
    "fsName": name
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
fsId	String	是	URL参数	待更新的FileSystem的ID
fsName	String	否	RequestBody参数	FileSystem的名称，方便记忆。长度1~65个字节，字母开头，可包含字母数字-_/.字符。

响应

返回状态码

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

返回头域

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

返回参数

无

示例

请求：

PUT /v1/cfs/cfs-jVDkWrBBoj HTTP/1.1
HOST cfs.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
    "fsName":"cfs-for-test"
}

响应：

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

DescribeFileSystem查询文件系统

描述

查询用户账户下的所有FileSystem信息。
支持按fsId、userId，匹配规则支持部分包含。
返回结果是多重查询条件的交集
结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

请求

请求结构

GET /v{version}/cfs?fsId={fsId}&userId={userId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: cfs.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
userId	String	否	Query参数	要查询文件系统所属的用户ID
fsId	String	否	Query参数	要查询的FileSystem ID
marker	String	否	Query参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	int	否	Query参数	每页包含的最大数量，最大数量不超过1000。缺省值为1000

响应

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
FileSystemList	List<FileSystemModel>	包含查询结果的列表
marker	string	标记查询的起始位置，若结果列表为空，此项不存在
isTruncated	boolean	true表示后面还有数据，false表示已经是最后一页
nextMarker	String	获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现
maxKeys	int	每页结果包含的数量

示例

请求：

GET /v1/cfs?fsId=cfs-jVDkWrBBoj&maxKeys=2 HTTP/1.1
Host: cfs.bj.baidubce.com
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "FileSystemList": [
        {
            "fsId": "cfs-jVDkWrBBoj",
            "status": available,
            "name": "test-cfs",
			"type": "cap",
			"protocol": "nfs",
            "vpcId":"vpc-a3ashy00skpu",
            "MountTargetList": [
				{
            		"domain": "cfs-jVDkWrBBoj-jowjsoosdkwe.bce.qa.sandbox.baidu.com",
            		"subnetId": "sbn-qwkkxpvenm0z",
					"mountId": "70445147635732514f306c5a466a38394450385a37513d3e",
                    "ovip": "128.0.0.1"
        		}
			]
        },
    ],
	"marker": "cfs-jVDkWrBBoj",
    "isTruncated": false,
    "maxKeys": 1
}

DropFileSystem释放文件系统实例

描述

释放指定的FileSystem，被释放的FileSystem超过回收时间后会被永远删除，无法找回

请求

请求结构

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

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
fsId	String	是	URL参数	待释放的FileSystem的ID

响应

返回状态码

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

返回头域

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

返回参数

无

示例

请求：

DELETE /v1/cfs/cfs-jVDkWrBBoj HTTP/1.1
HOST cfs.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应：

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

挂载点

CreateMountTarget创建挂载点

描述

创建一个文件系统的挂载点，返回domain。
付费方式为后付费。

请求

请求结构

POST /v{version}/cfs/{fsId} HTTP/1.1
Host: cfs.bj.baidubce.com
Authorization: authorization string
{
    "subnetId": subnetId
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
fsId	String	是	URL参数	待创建MountTarget的FileSystem的ID
subnetId	String	是	RequestBody参数	MountTarget所属子网，subnet属于fs所在vpc，为短id
vpcId	String	是	RequestBody参数	fs实例vip所属VPC的短Id

响应

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
domain	String	分配的服务dns，通过此dns执行文件系统挂载，即可访问服务
mountId	String	mount点的ID

示例

请求：

POST /v1/cfs/cfs-jVDkWrBBoj HTTP/1.1
HOST cfs.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "subnetId":"sbn-qwkkxpvenm0z"
}

响应：

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
	"mountId" : "53585364776c6d577a2f424444796a2b6641584251773d3d"
	"domain":"cfs-jVDkWrBBoj-sdfoijnvsdf.bce.qa.sandbox.baidu.com"
}

DeleteMountTarget删除挂载点

描述

释放指定的FileSystem的MountTarget

请求

请求结构

DELETE /v{version}/cfs/{fsId}/{mountId} HTTP/1.1
Host: cfs.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数	参数名称	类型	是否必需	参数位置
version	String	是	URL参数	API版本号，当前取值1
fsId	String	是	URL参数	待释放的target的FileSystem的ID
mountId	String	是	URL参数	待释放的target的ID

响应

返回状态码

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

返回头域

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

返回参数

无

示例

请求：

DELETE /v1/cfs/cfs-jVDkWrBBoj/53585364776c6d577a2f424444796a2b6641584251773d3d HTTP/1.1
HOST cfs.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应：

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

DescribeMountTarget描述挂载点

描述

查询指定文件系统下的所有MountTarget信息。
返回结果是多重查询条件的交集
结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

请求

请求结构

GET /v{version}/cfs/{fId}?&mountId={mountId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: cfs.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
fsId	String	是	URL参数	要查询的FileSystem ID
mountId	String	否	Query参数	要查询的MountTarget的ID
marker	String	否	Query参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	int	否	Query参数	每页包含的最大数量，最大数量不超过1000。缺省值为1000

响应

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
MountTargetList	List<MountTargetModel>	包含查询结果的列表
marker	string	标记查询的起始位置，若结果列表为空，此项不存在
isTruncated	boolean	true表示后面还有数据，false表示已经是最后一页
nextMarker	String	获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现
maxKeys	int	每页包含的最大数量

示例

请求：

GET /v1/cfs/cfs-jVDkWrBBoj?maxKeys=100 HTTP/1.1
Host: cfs.bj.baidubce.com
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应：

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "MountTargetList": [
        {
            "domain": "cfs-jVDkWrBBoj-xsjkusdgffes.bce.qa.sandbox.baidu.com",
            "subnetId": "sbn-qwkkxpvenm0z"
			"mountId": "53585364776c6d577a2f424444796a2b6641584251773d3d",
            "ovip": "128.0.0.1"
            
        },
        {
            "domain": "cfs-jVDkWrBBoj-kweicskdgsev.bce.qa.sandbox.baidu.com",
            "subnetId": "sbn-keisnlekndsw"
			"mountId": "36684e635250353569345454684e76364c36457057513d3d",
            "ovip": "128.1.0.1"
        }
    ],
    "marker": "kweicskdgsev",
    "nextMarker": "kweicskdgsev",
    "isTruncated": false,
    "maxKeys": 2
}

服务域名

Model对象定义

文件存储 CFS

文件存储 CFS

CFS-Open-API

文件系统

CreateFileSystem创建文件系统

UpdateFileSystem更新文件系统

DescribeFileSystem查询文件系统

DropFileSystem释放文件系统实例

挂载点

CreateMountTarget创建挂载点

DeleteMountTarget删除挂载点

DescribeMountTarget描述挂载点