修改镜像仓库-UpdateImageRepo
功能介绍
修改镜像仓库
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:imageRepo:update
Write
workspace *
-
-
-
URI
PUT /v1.0/{project_id}/common/image-registry/image-repos/{id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 只能用小写字母 a-z 和数字 0-9组成,且长度为32个字符 默认取值: 不涉及 |
| id | 是 | Long | 参数解释: 镜像仓库id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| description | 否 | String | 参数解释: 描述信息 约束限制: 不涉及 取值范围: 不包含\ @ # $ / %^ & * < > 且长度为[0~256] 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 镜像名称 约束限制: 不涉及 取值范围: 只能用中文字符、大小写英文字母、数字、“_”、“-”组成,且长度为[1~64]个字符 默认取值: 不涉及 |
响应参数
状态码:200
修改成功
无
请求示例
修改镜像仓库名称、描述
PUT https://{endpoint}/v1.0/{project_id}/common/image-registry/image-repos/10357
{
"name" : "测试镜像1",
"description" : "一些描述1"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 修改成功 |
| 400 | 参数校验失败 |
| 401 | 身份认证失败 |
| 403 | 权限校验失败 |
| 404 | 找不到请求的镜像仓库 |
| 409 | 输入的名称已被其他镜像仓库使用 |
| 500 | 系统内部错误 |
错误码
请参见错误码。