文档首页/ VPC终端节点 VPCEP/ API参考 (阿布扎比区域）/ API/ 终端节点功能/ 查询终端节点服务概要
更新时间：2022-01-25 GMT+08:00
查看PDF
分享

查询终端节点服务概要

功能介绍

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

URI

GET /v1/{project_id}/vpc-endpoint-services/describe?endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}

参数说明如表1所示。
表1 参数说明

参数

是否必选

描述

project_id

是

项目ID，获取方法请参见获取项目ID。

请求消息

  • 参数说明
    表2 请求参数

    名称

    是否必选

    参数类型

    描述

    endpoint_service_name

    否

    说明：

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

    String

    终端节点服务的名称。

    id

    否

    说明：

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

    String

    终端节点服务的ID，唯一标识。
  • 请求样例 
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id={4189d3c2-8882-4871-a3c2-d380272eed83}

响应消息

  • 参数说明
    表3 响应参数

    参数

    参数类型

    描述

    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：不计费
  • 响应样例 
    {
  "id": "9d4c1028-1336-4556-9881-b5d807c1b8a8",
  "service_name": "test123",
  "service_type": "interface",
  "created_at": "2018-09-17T07:28:31Z",
  "is_charge": "true"
}

状态码

状态码请参见状态码。

父主题： 终端节点功能