查询终端节点列表_VPC终端节点 VPCEP_API参考_API_终端节点功能

功能介绍

查询当前用户下的终端节点的列表。

URI

GET /v1/{project_id}/vpc-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&limit={limit}&offset={offset}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}

请求消息

• 参数说明

  表2 请求参数

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

• 请求样例

  GET https://{endpoint}/v1/{project_id}/vpc-endpoints

响应消息

• 参数说明

  表3 响应参数

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

  表4 endpoint要素说明

  属性	参数类型	描述
  id	String	终端节点的ID，唯一标识。
  service_type	String	终端节点连接的终端节点服务类型。 gataway：由运维人员配置。用户无需创建，可直接使用。 interface：包括运维人员配置的云服务和用户自己创建的私有服务。其中，运维人员配置的云服务无需创建，用户可直接使用。 您可以通过创建终端节点创建访问Gateway和Interface类型终端节点服务的终端节点。
  status	String	终端节点的连接状态。 pendingAcceptance：待接受 creating：创建中 accepted：已接受 rejected：已拒绝 failed：失败 deleting：删除中
  active_status	Array of strings	帐号状态。 frozen：冻结 active：解冻
  endpoint_service_name	String	终端节点服务的名称。
  marker_id	Integer	终端节点的报文标识。
  endpoint_service_id	String	终端节点服务的ID。
  enable_dns	Boolean	是否创建域名。 true：创建域名 false：不创建域名 说明： 当创建连接gateway类型终端节点服务的终端节点时，“enable_dns”设置为true或者false，均不创建域名。
  dns_names	Array of strings	访问所连接的终端节点服务的域名。 当“enable_dns”为true时，该参数可见。
  ip	String	访问所连接的终端节点服务的IP。 仅当同时满足如下条件时，返回该参数： 当查询连接interface类型终端节点服务的终端节点时。 终端节点服务启用“连接审批”功能，且已经“接受”连接审批。 “status”可以是“accepted”或者“rejected（仅支持“接受”连接审批后再“拒绝”的情况）”。
  vpc_id	String	终端节点所在的VPC的ID。
  subnet_id	String	vpc_id对应VPC下已创建的网络（network）的ID，UUID格式。
  created_at	String	终端节点的创建时间。 采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
  updated_at	String	终端节点的更新时间。 采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
  project_id	String	项目ID，获取方法请参见获取项目ID。
  tags	Array of objects	资源标签列表，详细内容请参见表5。
  error	Array of objects	错误信息。 当终端节点状态异常，即“status”的值为“failed”时，会返回该字段，详细内容请参见表6。
  whitelist	Array of strings	控制访问终端节点的白名单。 若未创建，则返回空列表。 创建连接Interface类型终端节点服务的终端节点时，显示此参数。
  enable_whitelist	Boolean	是否开启网络ACL隔离。 true：开启网络ACL隔离 false：不开启网络ACL隔离 若未指定，则返回false。 创建连接Interface类型终端节点服务的终端节点时，显示此参数。
  routetables	Array of strings	路由表ID列表。 若未指定，返回默认VPC下路由表ID。 创建连接Gateway类型终端节点服务的终端节点时，显示此参数。

  表5 ResourceTags要素说明

  名称	参数类型	说明
  key	String	键。最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。
  value	String	值。每个值最大长度43个unicode字符，可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。

  表6 Error要素说明

  属性	参数类型	描述
  error_code	String	错误编码。
  error_message	String	错误信息。

状态码

状态码请参见状态码。