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

查询endpoint详情

功能介绍

查询endpoint详情。

调试

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

URI

GET https://localhost.com/v1/workspaces/{workspace_id}/endpoints/{endpoint_id}

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

String

  • 参数解释:工作空间ID。

  • 约束限制:不涉及。

  • 取值范围:获取方法,请参见获取工作空间ID

  • 默认取值:不涉及。

endpoint_id

String

端点ID。获取方法,请参见获取端点ID

表2 Query参数

参数

是否必选

参数类型

描述

version

String

  • 参数解释:查询Endpoint信息的版本。

  • 约束限制:不涉及。

  • 取值范围

    • CURRENT:当前版本;

    • PREVIOUS:上个版本。

  • 默认取值:不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

  • 参数解释:租户Token。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 408

表6 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

请求示例

响应示例

状态码

状态码

描述

200

查询endpoint详情的响应。

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

408

Request timeout error。

500

Internal error。

错误码

请参见错误码

相关文档