更新后端存储自动同步策略 - UpdateObsTargetPolicy
功能介绍
更新后端存储自动同步策略。
接口约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id}/policy
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。 获取方法请参见查询文件系统列表接口。 约束限制: 文件系统状态必须为可用状态,不能处于创建中、扩容中、删除中等任务执行中的中间状态,否则接口将拒绝该请求。调用前可通过查询文件系统详情接口确认文件系统状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
| target_id | 是 | String | 参数解释: 绑定关系ID,用于唯一标识后端存储与文件系统之间的绑定关系。 约束限制: 绑定关系必须已存在且属于该文件系统。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| policy | 是 | ObsDataRepositoryPolicy object | 参数解释: 后端存储自动同步策略配置对象,用于配置文件系统与OBS桶之间的数据自动同步规则。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| auto_export_policy | 否 | AutoExportPolicy object | 参数解释: 后端存储自动导出策略。当文件系统中的数据发生更新时,将自动同步到OBS桶。SFS Turbo以异步方式执行同步。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| target_id | String | 参数解释: 绑定关系ID,用于唯一标识后端存储与文件系统之间的绑定关系。 取值范围: 不涉及。 |
| policy | ObsDataRepositoryPolicy object | 参数解释: 后端存储自动同步策略配置对象,包含文件系统与OBS桶之间的数据自动同步规则。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| auto_export_policy | AutoExportPolicy object | 参数解释: 后端存储自动导出策略。当文件系统中的数据发生更新时,将自动同步到OBS桶。SFS Turbo以异步方式执行同步。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| events | Array of strings | 参数解释: 后端存储自动同步到OBS桶的数据更新类型。 取值范围: |
| prefix | String | 参数解释: 后端存储内对象匹配前缀,用于过滤需要同步的OBS对象。 取值范围: 不涉及。 |
| suffix | String | 参数解释: 后端存储内对象匹配后缀,用于过滤需要同步的OBS对象。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde",后端target_id为"11abef67-7ac4-0f46-644d-1d5cfc2424a4",更新后端存储自动同步策略
PUT HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/targets/11abef67-7ac4-0f46-644d-1d5cfc2424a4/policy
{
"policy" : {
"auto_export_policy" : {
"events" : [ "NEW", "CHANGED", "DELETED" ]
}
}
} 响应示例
状态码:200
{
"target_id" : "xxxxxx-xxx-xxxx-xxxxxxx",
"policy" : {
"auto_export_policy" : {
"events" : [ "NEW", "CHANGED", "DELETED" ]
}
}
} 状态码:404
{
"errCode" : "SFS.TURBO.0126",
"errMsg" : "target not found, not bound yet"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 404 | 错误响应 |
| 500 | 错误响应 |
错误码
请参见错误码。