查询端点详情 - ShowEndPointDetail

功能介绍

查询一个端点的详情

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v2/{project_id}/routemgr/endpoints/{endpoint_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID
endpoint_id	是	String	端点ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	消息体的类型（格式），默认取值为“application/json”。
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
ief-instance-id	否	String	企业版实例ID，专业版实例为空值。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
endpoint	EndpointObjResp object	端点详情

表4 EndpointObjResp
参数	参数类型	描述
created_at	String	创建时间
description	String	端点描述，最大长度255，不允许^~#$%&*<>()[]{}'"\
id	String	端点ID
ief_instance_id	String	企业版实例ID，如果为空则表示是专业版实例。
is_shared	Boolean	是否共享
name	String	端点名称，只允许中文字符、英文字符、数字、下划线、中划线，最大长度64 同一个账号中创建的端点名唯一
project_id	String	项目ID
properties	Map<String,Object>	端点的属性，端点需要对外展示的属性，示例： dis: servicebus: apigw: {"domain_id":"user's domain id"} {"service_port":8080} {"domain_id":"user's domain id"}
type	String	端点类型。枚举值： dis servicebus apigw
updated_at	String	更新时间

状态码：401

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述信息

状态码：404

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述信息

状态码：500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述信息

请求示例

无

响应示例

状态码：200

查询成功

{
  "endpoint" : {
    "name" : "SystemEventBus",
    "description" : "",
    "type" : "eventbus",
    "properties" : { },
    "ief_instance_id" : "default",
    "is_shared" : true,
    "id" : "6bf2fda9-810c-40ed-8623-ff9396fe357d",
    "project_id" : "op_svc_ief_container1",
    "created_at" : "2021-04-20T22:02:34.604985+08:00",
    "updated_at" : "2022-09-09T10:48:32.293802+08:00"
  }
}