GetNetworkAccessEndpoint - 查询一个网络端点信息

查询指定的网络端点信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:GetNetworkAccessEndpointget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
NetworkAccessEndpointIdstring

专属网络端点 ID。

nae-examplexxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A
NetworkAccessEndpointobject

网络端点信息。

InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
NetworkAccessEndpointIdstring

专属网络端点 ID。

nae_examplexxx
NetworkAccessEndpointNamestring

专属网络端点名称。

xx业务VPC访问端点
VpcIdstring

专属网络端点连接的 VPC ID。

vpc-examplexxx
VpcRegionIdstring

专属网络端点连接的 VPC 所属地域。

cn-hangzhou
VSwitchIdsarray

专属网络端点连接的指定 vSwitch 列表。

VSwitchIdstring

虚拟交换机 ID。

vsw-2vc8z0f90z4k6xxxxx
SecurityGroupIdstring

专属网络端点使用的安全组 ID。

sg-examplexxx
Statusstring

网络端点的状态,取值可选范围:

  • pending:待初始化。
  • creating:创建中。
  • running:运行中。
  • deleting:删除中。
running
NetworkAccessEndpointTypestring

网络端点的类型,取值可选范围:

  • shared:共享网络端点。
  • private:专属网络端点。
private
EgressPublicIpAddressesarray

共享网络端点公网出口 IP 地址段,当且仅当 NetworkEndpointType 为共享网络端点(shared)时有返回值。

EgressPublicIpAddressstring

公网出口 IP 地址。

公网出口IP地址,具体以接口实际返回为准。 示例:203.0.XX.XX/27
EgressPrivateIpAddressesarray

专属网络端点公网出口 IP 地址段,当且仅当 NetworkEndpointType 为专属网络端点(private)时有返回值。

EgressPrivateIpAddressstring

私网出口 IP 地址。

192.168.1.1
CreateTimelong

网络端点创建时间,Unix 时间戳格式,单位为毫秒。

1649830226000
UpdateTimelong

专属网络端点最近更新时间,Unix 时间戳格式,单位为毫秒。

1649830226000

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "NetworkAccessEndpoint": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "NetworkAccessEndpointId": "nae_examplexxx",
    "NetworkAccessEndpointName": "xx业务VPC访问端点",
    "VpcId": "vpc-examplexxx",
    "VpcRegionId": "cn-hangzhou",
    "VSwitchIds": [
      "vsw-2vc8z0f90z4k6xxxxx\n"
    ],
    "SecurityGroupId": "sg-examplexxx",
    "Status": "running",
    "NetworkAccessEndpointType": "private",
    "EgressPublicIpAddresses": [
      "公网出口IP地址,具体以接口实际返回为准。 示例:203.0.XX.XX/27"
    ],
    "EgressPrivateIpAddresses": [
      "192.168.1.1"
    ],
    "CreateTime": 1649830226000,
    "UpdateTime": 1649830226000
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史