更新时间:2024-08-12 GMT+08:00
分享

查询终端节点详情

功能介绍

查询终端节点的详细信息。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

vpc_endpoint_id

String

终端节点的ID。

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

终端节点的ID,唯一标识。

最小长度:1

最大长度:64

service_type

String

终端节点连接的终端节点服务类型。

  • gateway:由运维人员配置。用户无需创建,可直接使用。

  • interface:包括运维人员配置的云服务和用户自己创建的私有服务。 其中,运维人员配置的云服务无需创建,用户可直接使用。 您可以通过查询公共终端节点服务列表, 查看由运维人员配置的所有用户可见且可连接的终端节点服务, 并通过创建终端节点服务创建Interface类型的终端节点服务。

status

String

终端节点的连接状态。

  • pendingAcceptance:待接受

  • creating:创建中

  • accepted:已接受

  • rejected:已拒绝

  • failed:失败

  • deleting:删除中

active_status

Array of strings

账号状态。

  • frozen:冻结

  • active:解冻

enable_status

String

终端节点是否可用。

  • enable:启用

  • disable:不启用

specification_name

String

终端节点服务规格的名称。

endpoint_service_name

String

终端节点服务的名称。

marker_id

Integer

终端节点的报文标识。

endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

enable_dns

Boolean

是否创建域名。

  • true:创建域名

  • false:不创建域名 说明 当创建gateway类型终端节点服务的终端节点时, “enable_dns”设置为true或者false,均不创建域名。

dns_names

Array of strings

访问所连接的终端节点服务的域名。 当“enable_dns”为true时,该参数可见。

最小长度:0

最大长度:32

ip

String

访问所连接的终端节点服务的IP。 仅当同时满足如下条件时,返回该参数:

  • 当查询连接interface类型终端节点服务的终端节点时。

  • 终端节点服务启用“连接审批”功能,且已经“接受”连接审批。 “status”可以是“accepted”或者“rejected(仅支持“接受”连接审批后再“拒绝”的情况)”。

最小长度:1

最大长度:64

vpc_id

String

终端节点所在的VPC的ID。

最小长度:1

最大长度:64

subnet_id

String

vpc_id对应VPC下已创建的网络(network)的ID,UUID格式。

最小长度:1

最大长度:64

created_at

String

终端节点的创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

updated_at

String

终端节点的更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

project_id

String

项目ID,获取方法请参见获取项目ID。

最小长度:1

最大长度:64

tags

Array of TagList objects

标签列表,没有标签默认为空数组。

error

QueryError object

查询资源返回的异常信息

whitelist

Array of strings

控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。

最小长度:0

最大长度:32

enable_whitelist

Boolean

是否开启网络ACL隔离。

  • true:开启网络ACL隔离

  • false:不开启网络ACL隔离 若未指定,则返回false。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。

routetables

Array of strings

路由表ID列表。 若未指定,返回默认VPC下路由表ID。 创建gateway类型终端节点服务的终端节点时,显示此参数。

最小长度:0

最大长度:64

description

String

描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。

最小长度:0

最大长度:512

policy_statement

Array of PolicyStatement objects

Gateway类型终端节点策略信息,仅限OBS、SFS的终端节点服务的enable_policy值为true时支持该参数。

数组长度:0 - 10

policy_document

String

终端节点策略信息,仅当终端节点服务的enable_policy值为true时支持该参数,默认值为完全访问权限。(OBS、SFS的终端节点服务暂不支持该参数)

数组长度:0 - 20480

endpoint_pool_id

String

待废弃,实例相关联的集群ID

最小长度:1

最大长度:64

public_border_group

String

终端节点对应Pool的Public Border Group信息

ipv6_address

String

访问所连接的终端节点服务的IPv6的地址。

创建终端节点时,可以指定访问所连接的终端节点服务的IP,不指定的情况下,会使用系统生成的一个地址。

仅专业型终端节点支持此参数。

表4 TagList

参数

参数类型

描述

key

String

键。 最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”,且首尾字符不能为空格。

最小长度:1

最大长度:36

value

String

值。 每个值最大长度43个unicode字符,可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”,且首尾字符不能为空格。

最小长度:1

最大长度:43

表5 QueryError

参数

参数类型

描述

error_code

String

错误编码。

最小长度:0

最大长度:10

error_message

String

错误信息。

最小长度:0

最大长度:1024

表6 PolicyStatement

参数

参数类型

描述

Effect

String

Allow允许或Refuse拒绝,控制访问权限

Action

Array of strings

obs访问权限

Resource

Array of strings

obs对象

请求示例

查询终端节点详情

GET https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83

响应示例

状态码: 200

服务器已成功处理了请求

{
  "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "ip" : "192.168.0.187",
  "service_type" : "interface",
  "marker_id" : 16777337,
  "status" : "accepted",
  "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "enable_dns" : false,
  "endpoint_service_name" : "test123",
  "endpoint_service_id" : "test123",
  "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
  "whitelist" : [ "127.0.0.1" ],
  "enable_whitelist" : true,
  "created_at" : "2022-04-14T09:35:47Z",
  "updated_at" : "2022-04-14T09:36:47Z"
}

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码

相关文档