功能介绍
查询 终端节点 的详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 最小长度:1 最大长度:64 |
vpc_endpoint_id |
是 |
String |
终端节点的ID。 最小长度:1 最大长度:64 |
请求参数
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
终端节点的ID,唯一标识。 |
service_type |
String |
终端节点连接的终端节点服务类型。 ● gataway:由运维人员配置。用户无需创建,可直接使用。 ● interface:包括运维人员配置的 云服务 和用户自己创建的私有服务。 其中,运维人员配置的云服务无需创建,用户可直接使用。 您可以通过查询公共终端节点服务列表, 查看由运维人员配置的所有用户可见且可连接的终端节点服务, 并通过创建终端节点服务创建Interface类型的终端节点服务。 |
status |
String |
终端节点的连接状态。 ● pendingAcceptance:待接受 ● creating:创建中 ● accepted:已接受 ● failed:失败 |
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。 |
enable_dns |
Boolean |
是否创建 域名 。 ● true:创建域名 ● false:不创建域名 说明 当创建连接gateway类型终端节点服务的终端节点时, “enable_dns”设置为true或者false,均不创建域名。 |
dns_names |
Array of strings |
访问所连接的终端节点服务的域名。 当“enable_dns”为true时,该参数可见。 |
ip |
String |
访问所连接的终端节点服务的IP。 仅当同时满足如下条件时,返回该参数: ● 当查询连接interface类型终端节点服务的终端节点时。 ● 终端节点服务启用“连接审批”功能,且已经“接受”连接审批。 “status”可以是“accepted”或者“rejected(仅支持“接受”连接审批后再“拒绝”的情况)”。 |
vpc_id |
String |
终端节点所在的VPC的ID。 |
subnet_id |
String |
vpc_id对应VPC下已创建的网络(network)的ID,UUID格式。 |
created_at |
String |
终端节点的创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ |
updated_at |
String |
终端节点的更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ |
project_id |
String |
项目ID,获取方法请参见获取项目ID。 |
tags |
标签列表,没有标签默认为空数组。 |
|
error |
查询资源返回的异常信息 |
|
whitelist |
Array of strings |
控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。 |
enable_whitelist |
Boolean |
是否开启网络ACL隔离。 ● true:开启网络ACL隔离 ● false:不开启网络ACL隔离 若未指定,则返回false。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。 |
routetables |
Array of strings |
路由表ID列表。 若未指定,返回默认VPC下路由表ID。 创建连接Gateway类型终端节点服务的终端节点时,显示此参数。 |
description |
String |
描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 |
policy_statement |
Array of strings |
只涉及开启双端固定的网关型终端节点,响应体展示此字段 |
endpoint_pool_id |
String |
待废弃,实例相关联的集群ID |
public_border_group |
String |
终端节点对应Pool的Public Border Group信息 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
键。 最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”,且首尾字符不能为空格。 最小长度:1 最大长度:36 |
value |
String |
值。 每个值最大长度43个unicode字符,可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”,且首尾字符不能为空格。 最小长度:1 最大长度:43 |
状态码: 400
状态码: 401
状态码: 403
状态码: 404
状态码: 405
状态码: 406
状态码: 407
状态码: 408
状态码: 409
状态码: 500
状态码: 501
状态码: 502
状态码: 503
状态码: 504
请求示例
查询终端节点详情
GET https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83
响应示例
状态码: 200
服务器已成功处理了请求
{ "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "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 |
服务器已成功处理了请求 |
400 |
服务器未能处理请求 |
401 |
被请求的页面需要用户名和密码 |
403 |
对被请求页面的访问被禁止 |
404 |
服务器无法找到被请求的页面 |
405 |
请求中指定的方法不被允许 |
406 |
服务器生成的响应无法被客户端所接受 |
407 |
用户必须首先使用代理服务器进行验证,这样请求才会被处理 |
408 |
请求超出了服务器的等待时间 |
409 |
由于冲突,请求无法被完成 |
500 |
请求未完成。服务异常 |
501 |
请求未完成。服务器不支持所请求的功能 |
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
503 |
请求未完成。系统暂时异常 |
504 |
网关超时 |
错误码
请参见错误码。