文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点功能> 查询终端节点服务概要
更新时间：2022-04-27 GMT+08:00
查看PDF
分享

查询终端节点服务概要

功能介绍

查询终端节点服务的概要信息，此接口是供创建终端节点的用户来查询需要连接的终端节点服务信息。

此接口既可以方便其他用户查询到您的终端节点服务概要信息又可以避免您的终端节点服务的细节信息暴露给其他用户。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/vpc-endpoint-services/describe

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

最小长度：1

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

endpoint_service_name

否

String

终端节点服务的名称。

该字段和id字段必须二选一，否则会出现错误。

最小长度：1

最大长度：128

id

否

String

终端节点服务的ID，唯一标识。

该字段必须和endpoint_service_name字段二选一，否则会出现错误。

最小长度：1

最大长度：64

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：2048

Content-Type

是

String

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

最小长度：1

最大长度：64

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

终端节点服务的ID，唯一标识。

service_name

String

终端节点服务的名称。

service_type

String

终端节点服务类型。仅支持将用户私有服务创建为interface类型的终端节点服务。

  • gataway：由运维人员配置。用户无需创建，可直接使用。
  • interface：包括运维人员配置的云服务和用户自己创建的私有服务。

其中，运维人 员配置的云服务无需创建，用户可直接使用。 您可以通过创建终端节点访问Gateway和 Interface类型终端节点服务。

created_at

String

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

is_charge

Boolean

连接该终端节点服务的终端节点是否计费。

  • true：计费
  • false：不计费

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表6 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表8 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表10 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表12 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 405

表13 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表14 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 406

表15 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表16 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 407

表17 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表18 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 408

表19 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表20 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 409

表21 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表22 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 500

表23 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表24 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 501

表25 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表26 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 502

表27 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表28 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 503

表29 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表30 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码： 504

表31 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息
表32 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

请求示例

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id={4189d3c2-8882-4871-a3c2-d380272eed83}

响应示例

状态码： 200

服务器已成功处理了请求

{
  "id" : "9d4c1028-1336-4556-9881-b5d807c1b8a8",
  "service_name" : "test123",
  "service_type" : "interface",
  "created_at" : "2018-09-17T07:28:31Z",
  "is_charge" : "true"
}

状态码

状态码

描述

200

服务器已成功处理了请求

400

服务器未能处理请求

401

被请求的页面需要用户名和密码

403

对被请求页面的访问被禁止

404

服务器无法找到被请求的页面

405

请求中指定的方法不被允许

406

服务器生成的响应无法被客户端所接受

407

用户必须首先使用代理服务器进行验证，这样请求才会被处理

408

请求超出了服务器的等待时间

409

由于冲突，请求无法被完成

500

请求未完成。服务异常

501

请求未完成。服务器不支持所请求的功能

502

请求未完成。服务器从上游服务器收到一个无效的响应

503

请求未完成。系统暂时异常

504

网关超时

错误码

请参见错误码。

父主题： 终端节点功能
分享：

    相关文档

    相关产品

close