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

文档中心

立即注册

导航

SetUser

最近更新时间：2024.10.09 11:36:05首次发布时间：2022.06.14 21:29:04

设置镜像仓库用户，即登录镜像仓库实例的用户。

接口说明

目前该接口仅支持设置用户登录密码。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	SetUser	接口名称。当前 API 的名称为 `SetUser`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Registry	String	是	registrya	需要设置登录用户的目标镜像仓库实例名称。在镜像仓库控制台的实例列表页面，获取实例名称。
Password	String	是	UGFzc3dvcmQxMj******	Base64 编码后的新镜像仓库登录密码。必须是合法的 Base64 字符串。通过 `echo` 命令编译时，需要使用 `echo -n` 去除尾部的换行符。原始密码（即 Base64 编码前）长度限制为 8～20 个字符，必须包含大小写英文字母，且数字和标点符号至少包含一种。支持的标点符号如下： `~!@#$%^&*()-_=+\\|[]:,<.>/;`

请求示例

POST https://open.volcengineapi.com?Action=SetUser&Version=2022-05-12
{
    "Registry": "registrya",
    "Password": "UGFzc3dvcmQx****"
}

返回参数

无

返回示例

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

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.RegistryStatus	The action has been denied due to wrong status %s.	当前实例状态下不允许执行指定操作，请等待状态转换后重试。