接口功能介绍
创建镜像版本保留规则
接口约束
仅限企业版实例使用
URI
POST /v1/createRetentionPolicy
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | String | 类型 | application/json | |
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceId | 是 | Long | 实例ID | 1638470585571688449 | |
namespaceName | 是 | String | 命名空间名称 | myns | |
cronExpression | 是 | String | 定时表达式 | * 0 * * * | |
rules | 是 | Object | 规则列表 | rules |
表 rules
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
scopePattern | 是 | String | 仓库的匹配模式 | repo | |
tagPattern | 是 | String | 版本的匹配模式 | v1 | |
params | 是 | Object | 保留策略 | params |
表 params
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
latestPulledN | 是 | Integer | 版本保留策略(latestPulledN:保留最近拉取N个;latestPushedK:保留最近推送N个;nDaysSinceLastPull:保留最近D天拉取;nDaysSinceLastPush:保留最近D天推送) | 8 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应码 | 0 | |
message | String | 返回信息 | ||
returnObj | Boolean | 创建是否成功 | true | |
error | String | 错误信息 |
枚举参数
无
请求示例
请求url
POST https://[endpoint].ctapi.ctyun.cn/v1/createRetentionPolicy
请求头header
{
"Content-Type": "application/json"
}
请求体body
{
"instanceId": 1669023179152674818,
"namespaceName": "myns",
"rules": [
{
"params":{
"latestPulledN":8
},
"scopePattern": "a3",
"tagPattern": "v2"
}
],
"cronExpression": "* 0 * * *"
}
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": true
}
状态码
请参考 状态码
错误码
请参考 错误码