You need to enable JavaScript to run this app.
导航

DescribeCustomerGatewayAttributes

最近更新时间2023.07.12 11:24:24

首次发布时间2022.04.28 07:17:15

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

请求参数

名称类型是否必选示例值描述
ActionStringDescribeCustomerGatewayAttributes要执行的操作,取值:DescribeCustomerGatewayAttributes。
VersionString2020-04-01API版本信息。
CustomerGatewayIdStringcgw-3tehy13n2l4c6c0v****用户网关的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息。

返回数据

名称类型
示例值
描述
RequestIdString202203211611080102121461940900****请求ID。
AccountIdString20005****用户网关所属账户的ID。
CustomerGatewayIdStringcgw-3tehy13n2l4c6c0v****用户网关的ID。
IpAddressString8.XX.XX.8用户网关的出口IP地址。
ConnectionCountInteger8用户网关关联的IPsec连接的数量。
CreationTimeString2021-04-09T08:36:47+08:00创建用户网关的时间。
UpdateTimeString2021-04-09T10:30:04+08:00更新用户网关的时间。
CustomerGatewayNameStringCGW-q04n用户网关的名称。
DescriptionStringThis is a sample description用户网关的描述信息。

Status

String

Available

用户网关的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending:配置中
  • Available:可用
ProjectNameStringProject_1用户网关所属的项目。

请求示例

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",
        "Status": "Available"
    }
}

错误码

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

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