查询公共终端节点服务列表

功能介绍

查询公共终端节点服务的列表，公共终端节点服务是所有用户可见且可连接的终端节点服务，由运维人员创建，用户可直接使用，但无权创建。

URI

GET /v1/{project_id}/vpc-endpoint-services/public?limit={limit}&offset={offset}&endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}&sort_key={sort_key}&sort_dir={sort_dir}

参数说明如表1所示。

表1 参数说明
参数	是否必选	描述
project_id	是	项目ID，获取方法请参见获取项目ID。

表2 查询参数
名称	是否必选	参数类型	描述
limit	否	Integer	查询返回公共的终端节点服务数量限制，即每页返回的个数。取值范围：0~1000，取值一般为10，20或者50，默认为10。
offset	否	Integer	偏移量。偏移量为一个大于0小于终端节点服务总个数的整数，表示从偏移量后面的终端节点服务开始查询。
endpoint_service_name	否	String	公共终端节点服务的名称，支持大小写以及模糊匹配。
id	否	String	公共终端节点服务的ID，唯一标识。
sort_key	否	String	查询结果中终端节点服务列表的排序字段，取值为： created_at：终端节点服务的创建时间 updated_at：终端节点服务的更新时间默认值为created_at。
sort_dir	否	String	查询结果中终端节点服务列表的排序方式，取值为： desc：降序排序 asc：升序排序默认值为desc。

请求消息

参数说明
 无。

请求样例

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/public

响应消息

参数说明

表3 响应参数
参数	参数类型	描述
endpoint_services	Array of objects	终端节点服务列表，详细内容请参见表4。
total_count	Integer	满足查询条件的公共终端节点服务总条数，不受分页（即limit、offset参数）影响。

表4 endpoint_service要素说明
属性	参数类型	描述
id	String	公共终端节点服务的ID，唯一标识。
owner	String	终端节点服务的所有者。
service_name	String	公共终端节点服务的名称。
service_type	String	终端节点服务类型。 gateway：由运维人员配置。用户无需创建，可直接使用。 interface：包括运维人员配置的云服务和用户自己创建的私有服务。其中，运维人员配置的云服务无需创建，用户可直接使用。您可以通过创建终端节点创建访问Gateway和Interface类型终端节点服务的终端节点。
created_at	String	终端节点服务的创建时间。采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
is_charge	Boolean	连接该终端节点服务的终端节点是否计费。 true：计费 false：不计费

响应样例

{
  "endpoint_services": [
    {
      "id": "b0e22f6f-26f4-461c-b140-d873464d4fa0",
      "owner": "example"
      "service_name": "test123",
      "service_type": "interface",
      "created_at": "2018-09-10T13:13:23Z",
      "is_charge": "true"
    },
	{
      "id": "26391a76-546b-42a9-b2fc-496ec68c0e4d",
      "owner": "example"
      "service_name":  "OBS",
      "service_type": "gateway",
      "created_at": "2019-03-28T09:30:27Z",
      "is_charge": "true"
    }
  ],
  "total_count": 2
}