查询终端节点服务详情 - ListServiceDetails
功能介绍
查询终端节点服务的详细信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
vpcep:endpointServices:get
Read
endpointServices *
g:ResourceTag/<tag-key>
- vpcep:epservices:get
-
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
vpc_endpoint_service_id |
是 |
String |
终端节点服务的ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
否 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
终端节点服务的ID,唯一标识。 |
|
port_id |
String |
标识终端节点服务后端资源的ID, 格式为通用唯一识别码(Universally Unique Identifier,下文简称UUID)。取值为:
|
|
service_name |
String |
终端节点服务的名称。 |
|
server_type |
String |
资源类型。
|
|
vpc_id |
String |
终端节点服务对应后端资源所在的VPC的ID。 |
|
approval_enabled |
Boolean |
是否需要审批。
需要终端节点服务所属用户审核后方可使用。 |
|
status |
String |
终端节点服务的状态。
|
|
service_type |
String |
终端节点服务类型。 终端节点服务类型包括“网关(gateway)型”和“接口(interface)型”:
其中,运维人员配置的云服务无需创建,用户可直接使用。 您可以通过创建终端节点创建访问Gateway和Interface类型终端节点服务的终端节。 |
|
supported_editions |
Array of strings |
终端节点服务支持的类型,取值范围为profession-专业型,basic-基础型 |
|
created_at |
String |
终端节点服务的创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ |
|
updated_at |
String |
终端节点服务的更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ |
|
project_id |
String |
项目ID,获取方法请参见获取项目ID。 |
|
cidr_type |
String |
网段类型。 public:公网网段 internal:内网网段 默认值为internal。 |
|
ip |
String |
接口型VLAN场景服务端IPv4地址或域名 |
|
ports |
Array of PortList objects |
服务开放的端口映射列表,详细内容请参见表4-17 同一个终端节点服务下,不允许重复的端口映射。若多个终端节点服务共用一个port_id,则 终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复。 |
|
tcp_proxy |
String |
用于控制将哪些信息(如客户端的源IP、源端口、marker_id等)携带到服务端。 支持携带的客户端信息包括如下两种类型:
说明:仅当后端资源为OBS时,支持TCP TOA类型信息携带方式。 仅当服务端支持解析上述字段时,该参数设置才有效。 该参数的取值包括: 默认值为“close”。 |
|
tags |
Array of TagList objects |
资源标签列表 |
|
error |
Array of Error objects |
提交任务异常时返回的异常信息 |
|
enable_policy |
Boolean |
是否允许自定义终端节点策略。
默认为false |
|
description |
String |
描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
client_port |
Integer |
终端节点访问的端口。 终端节点提供给用户,作为访问终端节点服务的端口,范围1-65535。 |
|
server_port |
Integer |
终端节点服务的端口。 终端节点服务绑定了后端资源,作为提供服务的端口,范围1-65535。 |
|
protocol |
String |
端口映射协议,支持TCP。 |
请求示例
查询终端节点服务详情
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
查询ID为“4189d3c2-8882-4871-a3c2-d380272eed88”的终端节点服务详情。 GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88
响应示例
状态码:200
服务器已成功处理了请求
{
"id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
"status" : "available",
"approval_enabled" : false,
"service_name" : "test123",
"server_type" : "VM",
"service_type" : "interface",
"ports" : [ {
"client_port" : "8080",
"server_port" : "80",
"protocol" : "TCP"
}, {
"client_port" : "8081",
"server_port" : "80",
"protocol" : "TCP"
} ],
"project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
"supported_editions" : [ "basic", "profession" ],
"created_at" : "2022-04-14T09:35:47Z",
"updated_at" : "2022-04-14T09:36:47Z"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
服务器已成功处理了请求 |
错误码
请参见错误码。