You need to enable JavaScript to run this app.
导航

GetPublicEndpoint

最近更新时间2022.07.21 21:17:37

首次发布时间2022.06.14 21:29:04

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

请求参数

参数名类型是否必填示例值描述
ActionStringGetPublicEndpoint公共参数,本接口值:GetPublicEndpoint。
VersionString2022-05-12公共参数,本接口值:2022-05-12。
RegistryStringregistrya镜像仓库实例的名称。在 镜像仓库控制台实例列表 页面,获取实例名称。

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

请求示例

POST /?Action=GetPublicEndpoint
&Version=2022-05-12
&<公共参数>

Body
{
    "Registry": "registrya"
}

返回参数

参数名类型示例值描述
RegistryStringregistrya镜像仓库实例的名称。
EnabledBooleantrue是否已开启公网入口,参数值说明:
  • false:未开启
  • true:已开启
StatusStringEnabled公网入口当前状态,参数值说明:
  • Enabling:开启中
  • Enabled:已开启
  • Disabling:关闭中
  • Updating:更新中
  • Failed:失败
  • Disabled:已关闭

返回示例

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

错误码

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

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