接口功能介绍
查询镜像版本不可变规则列表
接口约束
仅限企业版实例使用
URI
GET /v1/listImmutableTagRule
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | Long | 实例ID | 1638470585571688449 | |
namespaceName | 是 | String | 命名空间名称 | myns | |
pageNum | 否 | Integer | 页码 | 1 | |
pageSize | 否 | Integer | 每页大小 | 10 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | String | 类型 | application/json | |
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应码 | 0 | |
message | String | 返回信息 | ||
returnObj | Object | 返回结果 | returnObj | |
error | String | 错误信息 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Integer | 总条数 | 5 | |
size | Integer | 每页条数 | 10 | |
current | Integer | 当前页码 | 1 | |
pages | Integer | 总页数 | 1 | |
records | Object | 规则列表 | records |
表 records
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
id | Integer | 规则ID | 8 | |
disabled | Boolean | 是否禁用 | false | |
scopePattern | String | 仓库的匹配模式 | alpine | |
tagPattern | String | 版本的匹配模式 | 1.23.2-alpine |
枚举参数
无
请求示例
请求url
GET https://[endpoint].ctapi.ctyun.cn/v1/getRetentionPolicy?instanceId=1669023179152674818&namespaceName=myns
请求头header
{
"Content-Type":"application/json"
}
请求体body
无
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"current": 1,
"hitCount": false,
"optimizeCountSql": true,
"orders": [
],
"pages": 1,
"records": [
{
"disabled": false,
"id": 3,
"scopePattern": "
{
regre*,
nginx
}
",
"tagPattern": "
{
v0.0.1,
retain
}
"
}
],
"searchCount": true,
"size": 10,
"total": 1
}
}
状态码
请参考 状态码
错误码
请参考 错误码