查询对端网关列表

功能介绍

查询对端网关列表。

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/customer-gateways

请求消息

• 请求参数

  无。

• 请求样例

  GET https://{Endpoint}/v5/{project_id}/customer-gateways?limit={limit}&marker={marker}

响应消息

• 响应参数

  返回状态码为 200: 查询成功。

  表3 响应Body参数列表

  名称	类型	描述
  customer_gateways	Array of ResponseCustomerGateway objects	customer_gateway对象。
  total_count	Long	租户下对端网关总数。
  page_info	PageInfo object	分页信息。
  request_id	String	请求id。

  表4 ResponseCustomerGateway

  名称	类型	描述
  id	String	功能说明：对端网关的ID。 格式：36位UUID。
  name	String	功能说明：对端网关名称，不填时会自动生成。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。
  id_type	String	功能说明：对端网关标识类型。 取值范围： ip。 fqdn。
  id_value	String	对端网关标识值。
  bgp_asn	Long	对端网关的BGP自治域编号。仅当id_type为ip时返回。
  ca_certificate	CaCertificate object	对端网关CA证书信息。仅当对端网关绑定CA证书时返回。
  created_at	String	创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。
  updated_at	String	最后一次更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。
  tags	Array of VpnResourceTag objects	标签列表。

  表5 CaCertificate

  名称	类型	描述
  id	String	证书ID。
  serial_number	String	证书序列号。
  signature_algorithm	String	签名算法。
  issuer	String	证书颁发者。
  subject	String	证书使用者。
  expire_time	String	证书过期时间。
  is_updatable	boolean	是否能更新证书内容。

  表6 VpnResourceTag

  名称	类型	描述
  key	String	功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。
  value	String	功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。

  表7 PageInfo

  名称	类型	描述
  next_marker	String	下一页的marker，值为上一次查询响应中最后一个资源的创建时间。
  current_count	Integer	当前列表中资源数量。若小于查询请求传入的limit则表示最后一页。

• 响应样例

  {
      "customer_gateways": [{
          "id": "e67d6e27-demo-a8df-va86-be9a0f0168e9",
          "name": "cgw-a45b",
          "id_type": "ip",
          "id_value": "100.***.***.81",
          "bgp_asn": 65588,
          "ca_certificate": {
              "serial_number": "14257156674311863338",
              "signature_algorithm": "SM3WITHSM2",
              "issuer": "C=CN,O=a0002,CN=XXX",
              "subject": "C=CN,O=a0002,CN=XXX",
              "expire_time": "2024-05-22T07:34:22Z",
              "is_updatable": true
          },
          "created_at": "2022-11-28T07:36:24.923Z",
          "updated_at": "2022-11-28T07:36:24.923Z"
      }, {
          "id": "312067bb-demo-a8df-va86-09dc941bbffc",
          "name": "cgw-21a3",
          "id_type": "fqdn",
          "id_value": "123******456",
          "ca_certificate": null,
          "created_at": "2022-11-28T06:25:01.937Z",
          "updated_at": "2022-11-28T06:25:01.937Z"
      }],
      "total_count": 2,
      "page_info": {
          "next_marker": "2022-11-28T06:25:01.937Z",
          "current_count": 2
      },
      "request_id": "82a108d9-0929-42e9-adb7-e146c04c587c"
  }

状态码

请参见状态码。