更新服务存储有效期

最近更新时间：2023.05.26 11:55:03

首次发布时间：2023.04.14 14:25:48

本接口支持更新指定服务的存储有效期。若资源有效期到期，veImageX 将自动删除指定服务内的资源，减少您的存储成本。

使用限制

您在更新服务的存储有效期后的 24 小时内，veImageX 将加载您的最新配置。并在配置加载完成后，于每天北京时间 2:00 开始执行配置删除资源，并保证在 24 小时内删除完毕。

示例：您在 2022 年 10 月 21日 24:00 设置有效期为 1 天，预计有效期到期时间为 2022 年 10 月 22 日 24:00。

veImageX 最晚将在 2022 年 10 月 22 日 24:00 加载完成有效期最新配置。
veImageX 将于 2022 年 10 月 23 日 02:00 开始删除服务内资源，并保证最晚可在 2022 年 10 月 24 日 02:00 完成资源删除操作。

使用说明

接口名称：UpdateImageStorageTTL
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=UpdateImageStorageTTL&Version=2018-08-01
请求频率限制：50 次/秒
超时时间：30 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 2018-08-01。

Body

参数类型是否必选描述

参数	类型	是否必选	描述
ServiceId	String	是	服务 ID 。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
TTL	Integer	是	更新后的有效期时间。单位为秒，取值范围为 [86400, 7776000]。若取值超过整天，则默认向上取整，例如当`TTL`取值为`86401`时，实际有效期被设置为 2 天。

ServiceId

String

是

服务 ID 。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

TTL

Integer

是

更新后的有效期时间。单位为秒，取值范围为 [86400, 7776000]。
若取值超过整天，则默认向上取整，例如当TTL取值为86401时，实际有效期被设置为 2 天。

返回参数

无

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageStorageTTL&Version=2018-08-01 
{
    "ServiceId": "d2****1h",
    "TTL": 86400
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageStorageTTL",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {}
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageStorageTTL",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：