GetInstanceEndpoint - 查询实例的访问入口

更新时间:
复制 MD 格式

查询实例的访问入口。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cr:GetInstanceEndpoint

get

*Instance

acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID

cri-xkx6vujuhay0****

EndpointType

string

是

端点类型,只支持 Internet

internet

ModuleName

string

否

访问模块,取值:

  • Registry:镜像仓库

  • Chart:Helm Chart

Registry

返回参数

名称

类型

描述

示例值

object

Status

string

运行状态,取值:

CREATING:创建中

RUNNING:运行中

DELETING:删除中

RUNNING

RequestId

string

请求 ID

8F3D5EC5-39D1-4C53-A198-48C54C658FA3

Code

string

返回值

success

IsSuccess

boolean

是否成功

true

AclEnable

boolean

是否启用 ACL

true

Enable

boolean

是否开启该访问入口

true

Domains

array<object>

域名列表

object

Type

string

域名类型,取值:

  • SYSTEM:系统域名

  • USER:用户域名

SYSTEM

Domain

string

访问企业版实例的域名

shanghai-instance1-registry.cn-shanghai.cr.aliyuncs.com

AclEntries

array<object>

ACL 列表

object

Comment

string

添加公网白名单的备注

1

Entry

string

添加公网白名单地址段

192.168.1.0/24

示例

正常返回示例

JSON格式

{
  "Status": "RUNNING",
  "RequestId": "8F3D5EC5-39D1-4C53-A198-48C54C658FA3",
  "Code": "success",
  "IsSuccess": true,
  "AclEnable": true,
  "Enable": true,
  "Domains": [
    {
      "Type": "SYSTEM",
      "Domain": "shanghai-instance1-registry.cn-shanghai.cr.aliyuncs.com"
    }
  ],
  "AclEntries": [
    {
      "Comment": "1",
      "Entry": "192.168.1.0/24"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

500 SystemError Unknown error.
403 NoPrivilege Access denied for this user.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。