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

文档中心

立即注册

导航

GetPublicEndpoint

最近更新时间：2024.11.28 11:20:01首次发布时间：2022.06.14 21:29:04

获取镜像仓库实例的公网入口信息。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	GetPublicEndpoint	接口名称。当前 API 的名称为 `GetPublicEndpoint`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Registry	String	是	registrya	镜像仓库实例的名称。在镜像仓库控制台的实例列表页面，获取实例名称。

请求示例

POST https://open.volcengineapi.com?Action=GetPublicEndpoint&Version=2022-05-12
{
    "Registry": "registrya"
}

返回参数

参数	类型	示例值	描述
Registry	String	registrya	镜像仓库实例的名称。
Enabled	Boolean	true	是否已开启公网入口，参数值说明： false：未开启 true：已开启
AclPolicies	Array of AclPolicy	["192.168.1.0/24"]	公网IP白名单列表
Status	String	Enabled	公网入口当前状态，参数值说明： Enabling：开启中 Enabled：已开启 Disabling：关闭中 Updating：更新中 Failed：失败 Disabled：已关闭

AclPolicy

参数	类型	示例值	描述
Entry	String	192.168.1.0/24	IP条目地址
Description	String	xxx	IP条目描述

返回示例

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

错误码

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

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