本接口支持更新指定服务的存储策略。
仅当开启文件版本控制后,您才能指定历史版本文件的策略天数 NonCurrentDay 和策略命中后具体执行操作 NonCurrentAction。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateStorageRules |
接口名称。当前 API 的名称为 UpdateStorageRules。 |
| Version | String | 是 | 2023-05-01 |
接口版本。当前 API 的版本为 2023-05-01。 |
| ServiceId | String | 是 | 7s**0l |
服务 ID。 |
| - 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。 | ||||
| - 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| StorageRules | Array of StorageRules | 否 | - |
更新后的存储降冷策略 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Prefix | String | 否 | prefix |
文件前缀。例如设置为 prefix 后,规则将只对名称以 prefix 开头的存储资源生效。输入规则如下: |
| - 不能以正斜线(/)或者反斜线(\)开头; | ||||
| - 不支持使用正则表达式匹配前缀; | ||||
| - 长度为 1~1024 个字符。 | ||||
| Event | String | 是 | upload |
策略类型,固定取值 Upload,表示按上传时间。 |
| Day | Integer | 是 | 30 |
最新版本文件的策略天数,取值范围为 [1,365],单位为天。按照 Event 事件 Day 天后执行 Action 事件,即当匹配文件的上传时间符合指定天数后,自动按照处理策略对资源进行处理。 |
| Action | String | 是 | IA |
最新版本文件在策略命中后需要执行的操作,取值如下所示: |
- DELETE:删除文件 |
||||
- IA:文件转低频存储 |
||||
- ARCHIVE:文件转归档存储 |
||||
- COLD_ARCHIVE:文件转冷归档存储 |
||||
| NonCurrentDay | Integer | 否 | 30 |
历史版本文件的策略天数,取值范围为 [1,365],单位为天。按照 Event 事件 NonCurrentDay 天后执行 NonCurrentAction 事件,即当匹配历史版本文件的上传时间符合指定天数后,自动按照处理策略对历史版本资源进行处理。 |
| NonCurrentAction | String | 否 | IA |
历史版本文件在策略命中后需要执行的操作,取值如下所示: |
- DELETE:删除文件 |
||||
- IA:文件转低频存储 |
||||
- ARCHIVE:文件转归档存储 |
||||
- COLD_ARCHIVE:文件转冷归档存储 |
||||
| Enable | Boolean | 是 | true |
是否启用策略,取值如下所示: |
- true:是 |
||||
- false:否 |
本接口暂无特定的返回参数。更多信息请见公共返回参数。
POST https://imagex.volcengineapi.com/?Action=UpdateStorageRules&Version=2023-05-01&ServiceId=7s**0l
{
"StorageRules": [
{
"Prefix": "prefix",
"Event": "upload",
"Day": 30,
"Action": "IA",
"Enable": true
}
]
}
{
"ResponseMetadata": {
"RequestId": "202306041104200100100232280022D31",
"Action": "UpdateStorageRules",
"Version": "2023-05-01",
"Service": "ImageX",
"Region": "cn-north-1"
},
"Result": {}
}
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。