创建RapidFS缓存实例
更新时间:2026-06-17
描述
创建 RapidFS 缓存实例。当您调用接口时,系统返回订单ID(orderId)和创建的实例 instanceId。
您可以通过查询单个 RapidFS 实例接口查询实例创建状态。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
使用该接口时,需要注意以下事项:
- 请确保在使用该接口前,已充分了解 RapidFS 数据湖加速产品的收费方式(当前只支持后付费)和价格。
- 用户可购买的产品规格不超过可用区下的可购买资源库存。因此建议在创建实例前通过 DescribeSpecs 接口获取用户可购买的规格和库存信息,并通过 CheckBeforeCreateInstance 进行预校验。
请求结构
Plain Text
1POST /v{version}/instance?action=CreateInstance&clientToken={clientToken} HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceName": "demo-instance",
7 "description": "demo-description",
8 "zone": "zoneB",
9 "vpcId": "vpc-znt4cwv6z817",
10 "subnetId": "sbn-p69syq5etyp5",
11 "managedMode": "FullyManaged",
12 "metaSpec": "M1",
13 "dataSpec": "Basic",
14 "type": "BCC",
15 "capacityTiB": 3,
16 "cceClusterId": "cce-gv45s2cp",
17 "aihcResourcePoolId": "aihc-hk25ilq7xcfd",
18 "k8sControllerId": "controller-id",
19 "k8sControllerToken": "controller-token",
20 "tokenRefreshIntervalMinutes": 0,
21 "tags": [
22 {
23 "tagKey": "tagKey",
24 "tagValue": "tagValue"
25 }
26 ]
27}
请求头域
除公共头域外,无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号。 |
| clientToken | String | 是 | Query参数 | 保证API调用的幂等性。 |
| instanceName | String | 是 | RequestBody参数 | 用户自定义的实例名称。 |
| description | String | 否 | RequestBody参数 | 描述信息,最大支持256字符。 |
| zone | String | 是 | RequestBody参数 | 指定RapidFS 实例的zone,例如zoneA。 |
| vpcId | String | 是 | RequestBody参数 | RapidFS 实例所在的 VPC 短ID,例如:vpc-6rug1kkkq8ca。 |
| subnetId | String | 是 | RequestBody参数 | 子网短ID,注意 vpcId 和 subnetId 需要与 zone 匹配,例如:sbn-mcn9i27r44e6。 |
| managedMode | String | 否 | RequestBody参数 | RapidFS 实例部署模式,枚举值: • FullyManaged:全托管部署模式,适合无闲置存储资源、超大规模或追求高稳定性的业务。该模式下,RapidFS 产品完全管理实例,无需用户运维; • MasterManaged:Master 托管部署模式,适合有闲置存储资源、成本敏感且具备一定运维能力的业务。 |
| metaSpec | String | 否 | RequestBody参数 | 元数据规格,当前仅在 MasterManaged 部署模式下生效,枚举值: • M1:适用于文件数在 10 亿,Cache节点上限 50 个,单个Cache节点可挂载数据盘上限 4 个的场景; • M2:适用于文件数在 50 亿,Cache节点上限 400 个,单个Cache节点可挂载数据盘上限 8 个的场景。 |
| dataSpec | String | 否 | RequestBody参数 | 数据规格,当前仅在 FullyManaged 部署模式下生效,枚举值: • Basic:数据性能基线为 100MB/s/TiB; • Capacity:数据性能基线为 200MB/s/TiB; |
| type | String | 否 | RequestBody参数 | MasterManaged 部署模式下,用户运维管理的缓存接入类型,仅 MasterManaged 部署模式时有效,枚举值如下: • BCC:云服务器 BCC,表示用户的缓存节点直接部署在云服务器 BCC 上; • IDC:自建数据中心,表示用户的缓存节点直接部署在用户 IDC 服务器上;; • CCE:Cloud Container Engine, 容器引擎 CCE,表示用户的缓存节点通过容器形式部署在 CCE 集群中; • K8S:自有 Kubernetes 容器服务,厂内 EKS/自建 K8s,表示用户的缓存节点通过容器形式部署在厂内 EKS/自建 K8s 集群中; • AIHC:AI Heterogeneous Compute,百舸 AIHC,表示用户的缓存节点通过容器形式部署在百舸集群中,当前仅支持百舸全托管资源池。 |
| capacityTiB | Int | 否 | RequestBody参数 | FullyManaged 部署模式下必填,表示购买的缓存容量,单位 TiB。不超过 DescribeSpecs 接口返回的可购买的最大容量。 |
| cceClusterId | String | 否 | RequestBody参数 | MasterManaged 部署模式下,用户运维管理的缓存接入类型 type 为 CCE 时必填,为容器引擎 CCE 集群 ID。 |
| aihcResourcePoolId | String | 否 | RequestBody参数 | MasterManaged 部署模式下,用户运维管理的缓存接入类型 type 为 AIHC 时必填,为 AIHC 全托管资源池 ID。 |
| k8sControllerId | String | 否 | RequestBody参数 | MasterManaged 部署模式下,用户运维管理的缓存接入类型 type 为 K8S 时必填,为 K8s 集群内 RapidFS 缓存控制器 ID;需要在 controller 安装之后,通过 K8s 命令行查询获取:kubectl get cm -n kube-system rapidfs-cache-service-config -o yaml |
| k8sControllerToken | String | 否 | RequestBody参数 | MasterManaged 部署模式下,用户运维管理的缓存接入类型 type == K8S 时必填,为 K8s 集群内 RapidFS 缓存控制器 Token;需要在 controller 安装之后,通过 K8s 命令行 get controller 查询获取:kubectl get cm -n kube-system rapidfs-cache-service-config -o yaml该字段需要基于请求 header x-bce-accesskey 对应的 secretkey 进行加密传输,详见密码加密传输规范定义。可参考 bce-python-sdk aes128_encrypt_16char_key()函数实现。 |
| tokenRefreshIntervalMinutes | Int | 否 | RequestBody参数 | 实例 Token 初始更新周期,单位分钟,取值范围 [0, 43200(min)];仅在 Master 托管类型且缓存接入类型为 K8S/CCE/AIHC 时有效。默认值 0 表示永不更新,Token 永久有效。 |
| tags | List<Tag> | 否 | RequestBody参数 | 创建标签,见数据类型Tag。 |
返回状态码
成功返回200,除了通用的错误码,需要指出的是下面两种常见报错:
| http_status | code | msg | 说明 |
|---|---|---|---|
| 400 | InvalidXxx | "Invalid ..." | 传入的参数无效,需要仔细核对该参数是否有效 |
| InsufficientXxx | "Insufficient ..." | 库存不足包含以下两种情况(可提工单咨询具体的用量需求): 1. 计算资源不足:指用户购买的容量超过当前可用库存,此时需联系资源账户管理员进行资源预约;若遇计算资源不足提示,建议优先通过管理员协调扩容或调整资源配额,同时可查询其他可用区的库存状态,系统会实时更新库存数据。 2. IP资源不足:指指定子网内可用IP数量低于系统最低要求。 |
|
| 403 | OperationDenied | "... not allowed to ..." | 拒绝执行该操作,通常是缺少相应的权限 |
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderId | String | 订单ID |
| instanceId | String | 实例ID |
请求示例
Plain Text
1POST /v2/instance?action=CreateInstance&clientToken={clientToken} HTTP/1.1
2Host: rapidfs.bj.baidubce.com
3Authorization: authorization string
4{
5 "instanceName": "demo-instance",
6 "zone": "zoneB",
7 "vpcId": "vpc-znt4cwv6z817",
8 "subnetId": "sbn-p69syq5etyp5",
9 "managedMode": "FullyManaged",
10 "dataSpec": "Basic",
11 "capacityTiB": 3,
12 "description": "demo-description",
13 "tags": [
14 {
15 "tagKey": "qa-create_normal-key",
16 "tagValue": "qa-create_normal-value"
17 }
18 ]
19}
返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
4{
5 "orderId": "412aa51b-eff5-4667-b240-5128edd93937",
6 "instanceId": "rapidfs-iE87C6n1Kjte"
7}
评价此篇文章
