文档中心

函数服务

沙箱镜像

UpdateCustomImageRegistry

UpdateCustomImageRegistry

更新自定义镜像仓库。

请求说明

请求方式：POST

请求地址：http://open.volcengineapi.com/?Action=UpdateCustomImageRegistry&Version=2024-06-06

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateCustomImageRegistry	接口名称。当前 API 的名称为 UpdateCustomImageRegistry。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 2024-06-06。
RegistryId	String	是	regcfg-2fvj****	自定义镜像仓库的 ID。
Name	String	否	team-a-registry****	自定义镜像仓库的名称。
AuthConfig	Object of CustomImageRegistryAuthConfig	否	-	自定义镜像仓库的认证配置。
NetworkConfig	Object of CustomImageRegistryNetworkConfig	否	-	自定义镜像仓库的网络配置信息。

CustomImageRegistryAuthConfig

参数	类型	是否必选	示例值	描述
Token	String	否	eyJhbG****adQssw5c	认证使用的令牌，当认证类型（AuthType）为 BearerToken 时生效。仅允许在创建或更新操作时写入，查询接口不会返回该字段。
AuthType	String	是	BasicAuth	自定义镜像仓库的认证类型，用于指定访问该仓库时的认证方式，取值如下。 BasicAuth：用户名和密码认证。 BearerToken：令牌认证。 Anonymous：匿名访问，无需认证。
Password	String	否	********	认证使用的密码，当认证类型（AuthType）为 BasicAuth 时生效。仅允许在创建或更新操作时写入，查询接口不会返回该信息。
Username	String	否	robot****	认证使用的用户名，当认证类型（AuthType）为 BasicAuth 时生效。仅允许在创建或更新操作时写入，查询接口不会返回该信息。

CustomImageRegistryNetworkConfig

参数	类型	是否必选	示例值	描述
VpcId	String	否	vpc-****	自定义镜像仓库所在的私有网络 ID，网络访问类型（AccessType）为 PrivateVpc 时生效。
SubnetId	String	否	subnet-***	自定义镜像仓库所在的子网 ID，网络访问类型（AccessType）为 PrivateVpc 时生效。
ServerIps	Array of String	否	[ "172.16.*.*" ]	自定义镜像仓库在用户 VPC 内的可达 IP 列表，网络访问类型（AccessType）为 PrivateVpc 时生效。
AccessType	String	是	Public	镜像仓库的网络访问类型，取值如下。 Public：公网访问。 PrivateVpc：私网访问。
DnsServerIps	Array of String	否	[ "192.168.*.*"]	用于解析镜像仓域名的 DNS 服务器的 IP 列表。网络访问类型（AccessType）为 PrivateVpc 且域名需要用户侧 DNS 解析时生效。
UserSecurityGroupIds	Array of String	否	["sg-*****"]	用户账号下的安全组列表，网络访问类型（AccessType）为 PrivateVpc 时生效。

请求示例

返回参数

参数	类型	示例值	描述
Registry	Object of CustomImageRegistry		自定义镜像仓库配置。

CustomImageRegistry

参数	类型	示例值	描述
Name	String	team-a-registry****	自定义镜像仓库的名称。
Server	String	registry.****.com	自定义镜像仓库的访问地址。
Namespace	String	team-a****	自定义镜像仓库的默认命名空间。预热镜像时，如果镜像地址中未包含命名空间，则使用该默认命名空间定位镜像。
AuthStatus	Object of CustomImageRegistryAuthStatus	-	自定义镜像仓库的认证状态。
RegistryId	String	regcfg-2fvj****	自定义镜像仓库的 ID。
UpdateTime	String	2025-04-25 11:11:29.376 +0000 UTC	自定义镜像仓库的最近更新时间。
NetworkConfig	Object of CustomImageRegistryNetworkConfig	-	自定义镜像仓库的网络配置信息。
PrivateAccess	Object of CustomImageRegistryPrivateAccessInfo	-	自定义镜像仓库的私网访问状态。

CustomImageRegistryAuthStatus

参数	类型	示例值	描述
AuthType	String	BasicAuth	自定义镜像仓库的认证类型，用于指定访问该仓库时的认证方式，取值如下。 BasicAuth：用户名和密码认证。 BearerToken：令牌认证。 Anonymous：匿名访问，无需认证。
Configured	Boolean	true	是否已配置认证密钥。 true：已配置。 false：未配置。

CustomImageRegistryNetworkConfig

参数	类型	示例值	描述
VpcId	String	vpc-****	自定义镜像仓库所在的私有网络 ID，网络访问类型（AccessType）为 PrivateVpc 时生效。
SubnetId	String	subnet-***	自定义镜像仓库所在的子网 ID，网络访问类型（AccessType）为 PrivateVpc 时生效。
ServerIps	Array of String	[ "172.16.*.*" ]	自定义镜像仓库在用户 VPC 内的可达 IP 列表，网络访问类型（AccessType）为 PrivateVpc 时生效。
AccessType	String	Public	镜像仓库的网络访问类型，取值如下。 Public：公网访问。 PrivateVpc：私网访问。
DnsServerIps	Array of String	[ "192.168.*.*"]	用于解析镜像仓域名的 DNS 服务器的 IP 列表。网络访问类型（AccessType）为 PrivateVpc 且域名需要用户侧 DNS 解析时生效。
UserSecurityGroupIds	Array of String	["sg-*****"]	用户账号下的安全组列表，网络访问类型（AccessType）为 PrivateVpc 时生效。

CustomImageRegistryPrivateAccessInfo

参数	类型	示例值	描述
Status	String	ready	私网访问的状态，取值如下。 disabled：已禁用。 pending：待处理。 enabling：启用中。 ready：已就绪。 failed：访问失败。
Message	String	Private network access is ready	私网访问操作的结果信息或错误提示。
EndpointIp	String	192.168.*.*	自定义镜像仓库的访问入口 IP。
LastCheckTime	String	2025-04-25 11:11:29.376 +0000 UTC	最近一次探测自定义镜像仓库的时间。

返回示例

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2026.07.31 11:24:47

这个页面对您有帮助吗？

有用

有用

无用

无用