DescribeCustomerGatewayAttributes--VPN连接-火山引擎

文档中心

立即注册

导航

DescribeCustomerGatewayAttributes

最近更新时间：2024.09.06 08:00:06首次发布时间：2022.04.28 07:17:15

调用DescribeCustomerGatewayAttributes查询指定用户网关的信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCustomerGatewayAttributes	要执行的操作，取值：DescribeCustomerGatewayAttributes。
Version	String	是	2020-04-01	API版本信息。
CustomerGatewayId	String	是	cgw-3tehy13n2l4c6c0v****	用户网关的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息。

返回数据

名称	类型	示例值	描述
RequestId	String	202203211611080102121461940900****	请求ID。
AccountId	String	20005****	用户网关所属账户的ID。
CustomerGatewayId	String	cgw-3tehy13n2l4c6c0v****	用户网关的ID。
IpAddress	String	8.XX.XX.8	用户网关的出口IP地址。
ConnectionCount	Integer	8	用户网关关联的IPsec连接的数量。
CreationTime	String	2021-04-09T08:36:47+08:00	创建用户网关的时间。
UpdateTime	String	2021-04-09T10:30:04+08:00	更新用户网关的时间。
CustomerGatewayName	String	CGW-q04n	用户网关的名称。
Description	String	This is a sample description	用户网关的描述信息。
Status	String	Available	用户网关的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用
ProjectName	String	Project_1	用户网关所属的项目。
Asn	Integer	65001	用户网关的ASN。

请求示例

GET /?Action=DescribeCustomerGatewayAttributes&Version=2020-04-01&CustomerGatewayId=cgw-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203211611080102121461940900****",
        "Action": "DescribeCustomerGatewayAttributes",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202203211611080102121461940900****",
        "AccountId":"210000****",
        "CustomerGatewayId": "cgw-7qthudw0ll6jmc****",
        "CustomerGatewayName": "test",
        "Description": "test",
        "IpAddress":"1.XX.XX.1",
        "ConnectionCount":8,
        "CreationTime": "2022-03-16T17:05:42+08:00",
        "UpdateTime": "2022-03-17T11:50:30+08:00",
        "ProjectName":"Project_1",
        "Asn":65001,
        "Status": "Available"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
404	InvalidCustomerGateway.NotFound	The specified customer gateway does not exist.	指定的用户网关不存在。