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

VPN连接

复制全文
下载 pdf
VPN网关
DescribeVpnGatewaysBilling-查询VPN网关计费信息
复制全文
下载 pdf
DescribeVpnGatewaysBilling-查询VPN网关计费信息
调用DescribeVpnGatewaysBilling查询指定VPN网关的计费信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeVpnGatewaysBilling​
要执行的操作,取值:DescribeVpnGatewaysBilling。​
​
Version String 必选 示例值:2020-04-01​
API版本信息。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数。取值范围:1~100,默认值为20。​
​
PageNumber Integer 可选 示例值:1​
分页查询的页码。​
  • 如需传入此参数,请传入非负整数。​
  • 不传或传入0,则均默认为1。​
​
VpnGatewayIds.N String 可选 示例值:vgw-273zkshb2qayo7fap8t2****​
VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。​
  • 参数 - N:表示VPN网关ID的序号。​
  • 多个ID之间用&分隔。​
​
ProjectName String 可选 示例值:project01​
VPN网关所属项目。​
  • 传入该字段,表示查询指定项目下的VPN网关。​
  • 不传入该字段,表示查询所有项目下的VPN网关。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 可选 示例值:2022032416142901022524308102CF****​
请求ID​
​
PageSize Integer 可选 示例值:10​
当前分页的行数。​
​
PageNumber Integer 可选 示例值:1​
当前页码。​
​
TotalCount Integer 可选 示例值:1​
符合查询条件的VPN网关的数量。​
​
VpnGateways Object[] 可选 示例值:-​
VPN网关详细计费信息列表。​
VpnGatewayId String 可选 示例值:vgw-2zeerraiwb7uj****​
VPN网关的ID。​
​
BillingStatus Integer 可选 示例值:1​
计费状态。​
  • 1:运行中​
  • 3:退订回收​
  • 4: 到期关停​
​
BillingType Integer 可选 示例值:1​
VPN网关的计费类型。​
  • 1:包年包月​
  • 2:按量计费(按固定配置)​
​
ExpiredTime String 可选 示例值:2021-03-11 23:59:59​
VPN网关的到期时间。​
​
ReclaimTime String 可选 示例值:2021-03-18 23:59:59​
VPN网关的回收时间。​
​
RemainRenewTimes Integer 可选 示例值:1​
剩余自动续费次数。​
  • 1~100:剩余自动续费的次数。​
  • -1:续费不限次数。​
​
RenewType Integer 可选 示例值:1​
自动续费类型。​
  • 1: 手动续费。​
  • 2: 自动续费。​
  • 3: 到期不续费。​
说明:若传入3,平台将不会在VPN网关到期前给您发送到期通知。​
​
OverdueTime String 可选 示例值:2023-08-07T23:23:23+08:00​
资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。​
​
OverdueReclaimTime String 可选 示例值:2019-04-29T01:37:38+08:00​
资源欠费关停后系统强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。​
​
​
​
请求示例​
​
GET /?Action=DescribeVpnGatewaysBilling&Version=2020-04-01 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":"2022032416142901022524308102CF****",​
"Action":"DescribeVpnGatewaysBilling",​
"Version":"2020-04-01",​
"Service":"vpn",​
"Region":"cn-beijing"​
},​
"Result":{​
"RequestId":"2022032416142901022524308102CF****",​
"PageNumber":1,​
"PageSize":20,​
"TotalCount":1,​
"VpnGateways":[​
{​
"VpnGatewayId":"vgw-2fe7zjsz13ksg5oxruwed****",​
"BillingType":1,​
"BillingStatus":1,​
"RenewType":1,​
"RemainRenewTimes":-1,​
"ExpiredTime":"2022-05-21 23:59:59",​
"ReclaimTime":"2022-06-05 23:59:59",​
"OverdueTime":"",​
"OverdueReclaimTime":""​
} ​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
LimitExceeded.VpnGatewayId​
You've reached the limit on the number of VPN gateway IDs that you can describe.​
已达到可查询的VPN网关ID数量上限。​
​
最近更新时间:2026.02.02 11:15:04
这个页面对您有帮助吗?
有用
有用
无用
无用