更新时间:2024-11-15 GMT+08:00

查询对端网关

功能介绍

根据对端网关ID,查询指定的对端网关。

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/customer-gateways/{customer_gateway_id}

表1 参数说明

名称

类型

是否必选

描述

project_id

String

项目ID,可以通过获取项目ID获取项目ID。

customer_gateway_id

String

对端网关ID。

请求消息

  • 请求参数

    无。

  • 请求样例
    GET https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}

响应消息

  • 响应参数

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

    表2 响应Body参数列表

    名称

    类型

    描述

    customer_gateway

    ResponseCustomerGateway object

    customer_gateway对象。

    request_id

    String

    请求id。

    表3 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

    标签列表。

    表4 CaCertificate

    名称

    类型

    描述

    id

    String

    证书ID。

    serial_number

    String

    证书序列号。

    signature_algorithm

    String

    签名算法。

    issuer

    String

    证书颁发者。

    subject

    String

    证书使用者。

    expire_time

    String

    证书过期时间。

    is_updatable

    boolean

    是否能更新证书内容。

    表5 VpnResourceTag

    名称

    类型

    描述

    key

    String

    • 功能说明:标签的键。
    • 取值范围:1-128个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。

    value

    String

    • 功能说明:标签的值。
    • 取值范围:0-255个字符,支持数字、英文字母、中文、西班牙语、葡语、空格,以及以下字符:_.:=+-@。
  • 响应样例
    {
        "customer_gateway": {
            "id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
            "name": "cgw-ba08",
            "id_type": "ip",
            "id_value": "10.***.***.21",
            "bgp_asn": 65000,
            "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": "2021-12-21T16:49:28.108+08:00",
            "updated_at": "2021-12-21T16:49:28.108+08:00"
        },
        "request_id": "8111d315-5024-45c9-8ee3-5ef676edb0d1"
    }

状态码

请参见状态码