UpdateRepository--镜像仓库-火山引擎

文档中心

立即注册

导航

UpdateRepository

最近更新时间：2024.09.27 11:28:29首次发布时间：2022.06.14 21:29:04

更新指定命名空间下的 OCI 制品仓库信息。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时，除了以下请求参数外，还需传入公共请求参数。公共请求参数说明，请参见火山引擎公共参数文档。

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateRepository	接口名称。当前 API 的名称为 `UpdateRepository`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Registry	String	是	registrya	指定命名空间所属的镜像仓库实例名称。在镜像仓库控制台的实例列表页面，获取实例名称。
Namespace	String	是	library	指定命名空间名称。在镜像仓库控制台目标实例的命名空间页面，获取命名空间名称。
Name	String	是	repositorya	OCI 制品仓库名称。同一个命名空间下，名称必须唯一。支持小写英文、数字、分隔符（分隔符可输入一个`.`或`/`、一个或多个`-`、一个或两个`_`，且分隔符不能出现在首位或末位，不能连续出现），长度限制为 2～128 个字符。
Description	String	否	This is a description	OCI 制品仓库描述信息。长度不超过 300 个字符。
AccessLevel	String	否	Private	OCI 制品仓库的类型。 Public：拥有全读写权限的子用户可推送或拉取镜像，其他用户可匿名拉取镜像。 Private：拥有全读写权限的子用户可推送或拉取镜像，拥有只读权限的子用户可拉取镜像。默认值为 Private。
ClientToken	String	否	dd1fc09f-17ff-4cf5-929d-643e36******	用于保证请求幂等性的字符串。该字符串由调用方传入，需保证不同请求之间唯一。ClientToken 对大小写敏感，且最大值不超过 64 个 ASCII 字符。

请求示例

POST https://open.volcengineapi.com?Action=UpdateRepository&Version=2022-05-12
{
    "Registry": "registrya",
    "Namespace": "library",
    "Name": "repositorya",
    "AccessLevel": "Private",
}

返回参数

无

返回示例

{
    "ResponseMetadata" : {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "UpdateRepository",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {}
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.NothingToUpdate	The action has been denied due to nothing to update.	指定更新的内容与资源当前信息一致，没有需要更新的属性。
400	OperationDenied.RegistryStatus	The action has been denied due to wrong status %s.	当前实例状态下不允许执行指定操作，请等待状态转换后重试。