获取镜像老化记录 - ListRetentionHistories
功能介绍
获取镜像老化记录
接口约束
无
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/histories
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| namespace | 是 | String | 参数解释: 组织名称。用于唯一标识一个组织,组织下的所有镜像仓库都属于该组织。 约束限制: 不涉及。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 默认取值: 不涉及。 |
| repository | 是 | String | 参数解释: 镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。 约束限制: 不涉及。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | String | 参数解释: 返回条数。用于分页查询时指定每页返回记录的数量。 约束限制: offset和limit参数需要配套使用。 取值范围: 1~100的整数。 默认取值: 10。 |
| offset | 否 | String | 参数解释: 起始索引。用于分页查询时指定返回记录的起始位置。 约束限制: offset和limit参数需要配套使用。 取值范围: 大于等于0的整数。 默认取值: 0。 |
| filter | 否 | String | 参数解释: 查询过滤条件。用于分页查询镜像老化规则历史记录,指定返回条数和起始索引。 约束限制: filter参数中limit和offset组件需配套使用,且filter整体可选,使用时其中limit和offset组件必填。 取值范围: 格式为limit::{limit}|offset::{offset},其中{limit}为返回条数,{offset}为起始索引。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),用于指定请求体的MIME类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token。用于调用API时的鉴权。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| Content-Range | String | 参数解释: 响应头的分页范围信息,用于告知客户端当前返回记录的起止位置和总记录数。 约束限制: 不涉及。 取值范围: 格式为offset(开始索引)-count(当前页记录条数)/total(总记录条数),由数字、小数点、中划线、斜杠组成,长度1~64个字符。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| retention_log | Array of RetentionLog objects | 参数解释: 镜像老化日志,数组元素为RetentionLog对象,每条日志记录一次镜像老化操作的执行结果,包含created_at(创建时间)、id(记录ID)、namespace(组织名)、repo(镜像仓库名)、retention_id(老化规则ID)、rule_type(规则类型)、tag(镜像版本)等字段,参见RetentionLog数据类型。 取值范围: 不涉及。 |
| total | Integer | 参数解释: 镜像老化日志记录的总条数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| created_at | String | 参数解释: 创建时间,UTC时间格式,如2025-11-19T07:50:06.718359Z。 取值范围: 不涉及。 |
| id | Integer | 参数解释: 镜像老化日志记录ID。 取值范围: 镜像老化日志记录ID。 |
| namespace | String | 参数解释: 组织名。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 |
| repo | String | 参数解释: 镜像仓库名。 取值范围: 以小写字母或数字开头,后面跟小写字母、数字、小数点、下划线或中划线(不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。 |
| retention_id | Integer | 参数解释: 老化规则ID。 取值范围: 老化规则ID。 |
| rule_type | String | 参数解释: 镜像老化规则类型,用于区分不同的老化策略。 取值范围: |
| tag | String | 参数解释: 镜像版本。 取值范围: 以字母或数字开头,后面跟字母、数字、小数点、下划线或中划线,长度1~128个字符。 |
请求示例
GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions/histories 响应示例
状态码:200
{
"retention_log" : [ {
"created_at" : "2020-04-17T08:01:09.658309Z",
"id" : 9088,
"namespace" : "hwstaff_l00283074",
"repo" : "experience_2048",
"retention_id" : 91,
"rule_type" : "{\"template\":\"tag_rule\",\"params\":{\"num\":\"7\"},\"tag_selectors\":[]}",
"tag" : "4"
} ],
"total" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 错误的请求 |
| 401 | 鉴权失败 |
| 404 | 组织或镜像仓库不存在 |
| 500 | 内部错误 |
错误码
请参见错误码。