UpdateImageCacheRetentionDays--容器服务-火山引擎

文档中心

立即注册

导航

容器服务

UpdateImageCacheRetentionDays

最近更新时间：2024.09.29 18:50:57首次发布时间：2024.09.12 15:30:47

批量更新镜像缓存的到期时间。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=UpdateImageCacheRetentionDays&Version=2022-05-12

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateImageCacheRetentionDays	接口名称。当前 API 的名称为 `UpdateImageCacheRetentionDays`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Retentiondays	Integer	是	15	将筛选出的镜像缓存保留时间，批量更新到指定天数。取值范围：1~365（正整数）。单位：天。
Filter	Object of Filter	是	-	待更新镜像缓存的筛选条件。

Filter

参数	类型	是否必选	示例值	描述
Images	Array of String	否	["cr-cn-beijing.volces.com/vke****/nginx:latest"]	镜像缓存对应的容器镜像列表。
ImageCacheIds	Array of String	否	["imc-3uqroqkx0i3j********"]	镜像缓存 ID 列表。单次最多填写 100 个 ID。
ImageCacheNames	Array of String	否	["image-cache-test"]	镜像缓存名称列表。单次最多填写 100 个名称。

请求示例

POST https://open.volcengineapi.com/?Action=UpdateImageCacheRetentionDays&Version=2022-05-12
Content-Type: application/json
{
    "Retentiondays": 15,
    "Filter": {
        "ImageCacheIds": [
            "imc-3uqroqkx0i3j********"
        ],
        "Images": [
            "cr-cn-beijing.volces.com/vke****/nginx: latest"
        ],
        "ImageCacheNames": [
            "image-cache-test"
        ]
    }
}

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

参数	类型	示例值	描述
TotalAmount	Integer	50	批量更新（含更新成功和失败）的镜像缓存总数。
UpdatedImageCacheIds	Array of String	["imc-3uqroqkx0i3j********"]	更新成功镜像缓存到期时间的镜像缓存 ID 列表。
FailedItems	Array of FailedItems		更新镜像缓存到期时间失败的镜像缓存列表及失败原因。

FailedItems

参数	类型	示例值	描述
ImageCacheId	String	imc-3uqroqkx********	更新镜像缓存到期时间失败的镜像缓存 ID 列表。
FailedReason	String	ImageCache status {Phase} is not allowed for updating retentiondays.	更新镜像缓存到期时间失败的原因。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420********",
        "Action": "UpdateImageCacheRetentionDays",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalAmount": 50,
        "UpdatedImageCacheIds": [
            "imc-3uqroqkx0i3j********"
        ],
        "FailedItems": [
            {
                "ImageCacheId": "imc-3uqroqkx********",
                "FailedReason": "ImageCache status {Phase} is not allowed for updating retentiondays."
            }
        ]
    }
}

错误码

本接口无专有错误码，公共错误码请参见公共错误码。