You need to enable JavaScript to run this app.
文档中心
VPN连接

VPN连接

复制全文
下载 pdf
用户网关
DescribeCustomerGatewayAttributes-查询指定用户网关
复制全文
下载 pdf
DescribeCustomerGatewayAttributes-查询指定用户网关
调用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。​
​
Tags Object[] 示例值:-​
用户网关已添加的全部标签信息。​
Key String 示例值:key1​
标签键。​
​
Value String 示例值:value1​
标签值。​
​
​
IpVersion String 示例值:ipv4​
用户网关的IP地址类型。​
  • ipv4:IPv4地址类型。​
  • ipv6:IPv6地址类型。​
​
​
​
请求示例​
​
GET /?Action=DescribeCustomerGatewayAttributes&Version=2020-04-01&CustomerGatewayId=cgw-7qthudw0ll6jmc**** HTTP/1.1​
Host: vpn.cn-beijing.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeCustomerGatewayAttributes",​
"Version": "2020-04-01",​
"Service": "vpn",​
"Region": "cn-beijing"​
},​
"Result": {​
"AccountId": "20005****",​
"Asn": 65001,​
"ConnectionCount": 8,​
"CreationTime": "2021-04-09T08:36:47+08:00",​
"CustomerGatewayId": "cgw-3tehy13n2l4c6c0v****",​
"CustomerGatewayName": "CGW-q04n",​
"Description": "This is a sample description",​
"IpAddress": "8.XX.XX.8",​
"IpVersion": "ipv4",​
"ProjectName": "Project_1",​
"RequestId": "202203211611080102121461940900****",​
"Status": "Available",​
"Tags": [​
{​
"Key": "key1",​
"Value": "value1"​
}​
],​
"UpdateTime": "2021-04-09T10:30:04+08:00"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
404​
InvalidCustomerGateway.NotFound​
The specified customer gateway does not exist.​
指定的用户网关不存在。​
​
​
最近更新时间:2026.05.22 11:23:15
这个页面对您有帮助吗?
有用
有用
无用
无用