实例管理 OpenAPI

更新时间：2024-08-29

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

地域	Endpoint
北京	pfs.bj.baidubce.com
保定	pfs.bd.baidubce.com
苏州	pfs.su.baidubce.com
广州	pfs.gz.baidubce.com
阳泉	pfs.yq.baidubce.com

CreatePfs 创建并行文件系统

描述

创建一个pfs实例，返回分配的pfs id

请求

请求结构

POST /v1/pfs/instance
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string
{
    "name": xxx,
    "instanceType": instanceType,
    "capacity": int(capacity),
    "subnetId": subnetId,
    "description": desc,
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
name	string	是	request body	实例名称 • 长度为1~128个英文或中文字符。 • 必须以大小字母或中文开头。 • 可以包含数字、中文、半角冒号（:）、下划线（_）或者短划线（-）
instanceType	string	是	request body	可选类型包括：base、basic、baseX、plus、plus2、plusl2X
capacity	int	是	request body	购买文件系统存储容量大小，详情见容量限制表（单位GB）
subnetId	string	是	request body	子网短ID
description	string	否	request body	实例描述
tags	List<Tag>	否	request body	实例标签

购买不同类型实例的容量限制（单位GB）：

console侧展示类型	OpenApi对应标签	可购买最小容量	可购买最大容量	购买步长
标准型	basic	7168（7T）	207872（203T）	7168（7T）
增强型	plus	7168（7T）	107520（105T）	3584（3.5T）
极速型	base	51200（50T）	1048576（1P）	1024（1T）
极速型（专区）	baseX	51200（50T）	1048576（1P）	1024（1T）
极速型L2	plusl2	51200（50T）	5242880（5P）	1024（1T）
极速型L2（专区）	plusl2X	51200（50T）	5242880（5P）	1024（1T）

响应

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

返回头域

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

返回参数

参数名称	类型	是否必需	参数位置	描述
instanceId	string	是	response body	实例Id
orderId	string	是	response body	订单id

示例

请求：

POST /v1/pfs/instance
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string
{
    "name": test,
    "instanceType": basic,
    "capacity": 7168,
    "subnetId": sbn-6xba3c6eizh1,
    "description": 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
{
    "orderId": "order-xxx",
    "instanceId": "pfs-xxx",
}

DeletePfs 删除并行文件系统

描述

删除指定的PFS实例，被删除的PFS会被永远删除，无法找回

请求

请求结构

DELETE /v1/pfs/instance?instanceId=pfs-xxx
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	string	是	URL Parameter	被删除的实例Id

响应

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

返回头域

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

返回参数

无

示例

请求：

DELETE /v1/pfs/instance?instanceId=pfs-xxx
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

响应：

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

ListPfs 实例列表

描述

获取PFS实例列表

请求

请求结构

GET /v1/pfs/instance?maxKeys=1&manner=marker
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
maxKeys	int	否	URL Parameter	返回实例列表长度最大为1000，默认为20个，取值范围为【1，1000】，超过范围的规整为1或1000
manner	string	是	URL Parameter	请求的分段类型，必须指定marker
marker	string	否	URL Parameter	按照instanceId（格式一般为""pfs-xxxxxx""）的字典序排列，从marker之后的第一个开始返回（不包括marker）
filterTag	string	否	URL Parameter	用于过滤的标签

响应

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

返回头域

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

返回参数

参数名字	参数类型	是否必须	参数位置	描述
isTruncated	bool	是	response body	True表示数据未全部返回 False表示数据全部返回
marker	string	否	response body	按照instanceId（格式一般为""pfs-xxxxxx""）的字典序排列，从marker之后的第一个开始返回（不包括marker）
maxKeys	int	是	response body	请求返回的result个数
nextMarker	string	否	response body	下次请求需要传递的marker值
result	List	否	response body	PFS实例详细信息

示例

请求：

GET /v1/pfs/instance?maxKeys=1&manner=marker
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

响应：

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
{
    "isTruncated": true,
    "marker": "",
    "maxKeys": 1,
    "nextMarker": "pfs-0xxxxy",
    "result": [
        {
            "capacity": 7168,
            "createTime": "2023-06-09T05:04:30Z",
            "description": "PFS l2 test",
            "endpoint": "172.16.32.8",
            "instanceId": "pfs-xxxx",
            "instanceStatus": "RUNNING",
            "instanceType": "basic",
            "name": "",
            "paymentTiming": "postpay",
            "subnetModel": {
                "cidr": "172.16.32.0/20",
                "physicalZone": "AZONE-gzbh",
                "subnetId": "sbn-6xba3cdasf1",
                "zoneName": "zoneC"
            },
            "usage": 0,
            "vpcId": "vpc-jx648pkxw3tc"
        }
    ]
}

DescPfs 实例详情

描述

获取指定的PFS实例的详情信息

请求

请求结构

GET /v1/pfs/instance?instanceId=pfs-xxx
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	string	是	URL Parameter	实例短id

响应

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

返回头域

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

返回参数

参数名字	参数类型	参数位置	是否必须	备注
capacity	int	response body	是	PFS实例最大容量（单位GB）
createTime	string	response body	是	PFS实例创建时间
description	string	response body	否	PFS实例描述信息
endpoint	string	response body	是	PFS连接地址，仅basic、plus、base、baseX类型实例有该参数
instanceId	string	response body	是	实例ID
instanceStatus	string	response body	是	实例状态 CREATING RUNNING EXPIRED STARTING STOPPING DELETED
instanceType	string	response body	是	实例类型
name	string	response body	否	实例名称
paymentTiming	string	response body	是	付款方式
subnetModel	SubnetDetail	response body	是	PFS所在网络信息
usage	int	response body	是	PFS实例使用量（单位GB）
vpcId	string	response body	是	PFS所在VPCID
tags	List	response body	是	PFS绑定的标签

示例

请求：

GET /v1/pfs/instance?instanceId=pfs-xxx
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

响应：

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
{
    "capacity": 7168,
    "createTime": "2023-06-09T05:04:30Z",
    "description": "PFS l2 test",
    "endpoint": "172.16.32.8",
    "instanceId": "pfs-xxxx",
    "instanceStatus": "RUNNING",
    "instanceType": "basic",
    "name": "",
    "paymentTiming": "postpay",
    "subnetModel": {
        "cidr": "172.16.32.0/20",
        "physicalZone": "AZONE-gzbh",
        "subnetId": "sbn-6xba3cdasf1",
        "zoneName": "zoneC"
    },
    "usage": 0,
    "vpcId": "vpc-jx648pkxw3tc"
}

UpdatePFSTag 更新实例标签

描述

更新PFS实例标签
可传PFS实例个数限制为10，标签个数限制为100

请求

请求结构

POST /v1/pfs/tag
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	List	是	Request Body	实例ID列表
tags	List	否	Request Body	标签列表

响应

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

示例

请求：

POST /v1/pfs/instance?maxKeys=1&manner=marker
x-bce-date: 2023-06-09T10:08:22Z
host: pfs.gz.baidubce.com
content-type: application/json
Authorization: authorization string

{
        "instanceId": [
            "pfs-HwYFYM",
        ],
        "tags": [
            {"tagKey": "testKey", "tagValue": "testValue"}
        ],
}

响应：

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

Model

Tag

参数名称	类型	描述
tagKey	String	标签的键，可包含大小写字母、数字、中文以及-_ /.特殊字符，长度1-65
tagValue	String	标签的值，可包含大小写字母、数字、中文以及-_ /.特殊字符，长度0-65

InstanceModel

参数名字	参数类型	参数位置	是否必须	备注
capacity	int	response body	是	PFS实例最大容量（单位GB）
createTime	string	response body	是	PFS实例创建时间
description	string	response body	否	PFS实例描述信息
endpoint	string	response body	是	PFS连接地址，仅basic、plus、base、baseX类型实例有该参数
instanceId	string	response body	是	实例ID
instanceStatus	string	response body	是	实例状态 CREATING RUNNING EXPIRED STARTING STOPPING DELETED
instanceType	string	response body	是	实例类型
name	string	response body	否	实例名称
paymentTiming	string	response body	是	付款方式
subnetModel	SubnetDetail	response body	是	PFS所在网络信息
usage	int	response body	是	PFS实例使用量（单位GB）
vpcId	string	response body	是	PFS所在VPCID

SubnetDetail

参数名字	参数类型	是否必须	参数位置	备注
cidr	string	是	response body	子网掩码
physicalZone	string	是	response body	PFS实例所在物理Zone
subnetId	string	是	response body	子网ID
zoneName	string	是	response body	PFS实例所在逻辑Zone

错误码

请求发生错误时通过Response Body返回详细错误信息，遵循如下格式：

参数名	类型	说明
code	String	错误码
message	String	错误描述
requestId	String	本次请求的requestId

示例：

{
    "requestId" : "ae2225f7-1c2e-427a-a1ad-5413b762957d",
    "code" : "InvalidParameters",
    "message" : "Bad request parameters or illegal request."
}

PFS业务错误码

错误码	错误描述	HTTP状态码	语义
InvalidParameters	Bad request parameters or illegal request.	400	输入参数无效，导致无法被解析
InvalidInstanceId	The instance id is empty	400	实例Id为空
InvalidInstanceType	The instance type is empty	400	实例类型为空
InvalidInstanceType	The instance type is invalid	400	实例类型不符合要求
InvalidSubnetId	The subnet id is empty	400	子网Id为空
InvalidSubnetId	The subnet id is invalid	400	子网Id错误
InvalidCapacity	The capacity is empty	400	实例容量为空
	The instance capacity more than max limit		购买实例的容量超过上限
	The instance capacity less than min limit		购买实例的容量低于下限
	The instance capacity not meeting step size		购买实例的容量不符合步长限制
InvalidDescription	The description exceeds the length limit	400	实例描述超出长度限制
InvalidZoneInfo	The zone info is invalid	400	可用区信息错误
InvalidVpcId	The vpcId is invalid	400	vpcId错误
ResourceExpired	The resource is expired	403	资源已到期
NoSuchResource	The resource not be exist	404	资源不存在
NoSuchInstance	The instance not be exist	404	实例不存在
InvalidName	The instance name is empty	400	实例名称为空
InvalidName	The instance name is invalid	400	实例名称不符合要求
OperationDenied	The instance status cannot be deleted	403	实例当前状态不允许被删除
OperationDenied	Please release the mount point before releasing the instance	403	释放实例前，需要先释放挂载点

典型实践

常见问题

百度智能云

并行文件存储 PFS

并行文件存储 PFS

实例管理 OpenAPI

CreatePfs 创建并行文件系统

DeletePfs 删除并行文件系统

ListPfs 实例列表

DescPfs 实例详情

UpdatePFSTag 更新实例标签

Model

错误码