文档首页/ 高性能弹性文件服务 SFS Turbo/ API参考/ API/ 文件系统管理/ 配置hpc缓存型后端信息 - SetHpcCacheBackend
更新时间:2026-10-08 GMT+08:00
分享

配置hpc缓存型后端信息 - SetHpcCacheBackend

功能介绍

配置hpc缓存型后端信息。

接口约束

该接口仅适用于HPC缓存型文件系统

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

share_id

是

String

参数解释:

文件系统ID,用于唯一标识SFS Turbo文件系统实例。

获取方法请参见查询文件系统列表接口。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于鉴权认证。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

是

String

参数解释:

请求消息体MIME类型,用于标识请求正文的数据格式。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

update_hpc_cache

是

ReqUpdateHpcCacheInfo object

参数解释:

后端挂载更新信息,包含配置动作和后端配置数据。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 ReqUpdateHpcCacheInfo

参数

是否必选

参数类型

描述

action

是

String

参数解释:

配置HPC缓存型的动作类型,用于指定要执行的操作。

约束限制:

不涉及。

取值范围:

initialize_overlay:初始化Overlay配置。

默认取值:

不涉及。

data

是

ReqUpdateHpcCacheData object

参数解释:

HPC缓存型后端配置信息,包含冷数据淘汰时间、后端校验时间及NAS后端配置等。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表5 ReqUpdateHpcCacheData

参数

是否必选

参数类型

描述

gc_time

是

Long

参数解释:

冷数据淘汰时间,单位:小时。指定时间内线上缓存的数据如果没有被访问则会自动从缓存中删除。0表示数据不会因为时间原因自动从缓存中删除。

约束限制:

不涉及。

取值范围:

0~100000000的整数。0表示数据不会因时间原因自动从缓存中删除。

默认取值:

不涉及。

ck_time

是

Long

参数解释:

后端校验时间,单位:秒。指定时间间隔进行线上缓存文件与后端存储文件比较,存在变化则自动更新。0表示文件进行实时校验。

约束限制:

不涉及。

取值范围:

0~100000000的整数。0表示文件进行实时校验。

默认取值:

不涉及。

nas

否

Array of ConfigNasTarget objects

参数解释:

配置NAS后端的信息列表,用于指定NAS后端的名称、协议类型和挂载地址等。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表6 ConfigNasTarget

参数

是否必选

参数类型

描述

name

是

String

参数解释:

NAS配置名称,用于唯一标识一个NAS后端。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

type

是

String

参数解释:

NAS配置协议类型,用于指定NAS后端的访问协议。

约束限制:

不涉及。

取值范围:

NFS:NFS协议。

默认取值:

不涉及。

url

是

String

参数解释:

NAS配置IP地址及挂载路径,用于指定NAS后端的访问地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

状态码:400

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表9 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

状态码:500

表10 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表11 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

请求示例

配置hpc缓存型后端信息,冷数据淘汰时间是100小时,后端校验时间是60秒。配置Nas后端信息,nas 配置 ip是“192.168.xx.xx:/”,nas 配置协议类型是“NFS”。

{
  "update_hpc_cache" : {
    "action" : "initialize_overlay",
    "data" : {
      "gc_time" : 100,
      "ck_time" : 60,
      "nas" : [ {
        "name" : "abc",
        "type" : "NFS",
        "url" : "192.168.xx.xx:/"
      } ]
    }
  }
}

响应示例

状态码:200

无

状态码:400

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter error"
}

状态码:500

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

状态码

状态码

描述

200

成功

400

错误响应

500

错误响应

错误码

请参见错误码。

相关文档