You need to enable JavaScript to run this app.
导航
DescribeVpnGatewaysBilling
最近更新时间:2024.04.18 17:23:56首次发布时间:2022.04.28 07:17:15

调用DescribeVpnGatewaysBilling查询指定VPN网关的计费信息。

调试

请求参数

名称类型是否必选
示例值
描述
ActionStringDescribeVpnGatewaysBilling要执行的操作,取值:DescribeVpnGatewaysBilling。
VersionString2020-04-01API版本信息。
PageSizeInteger20分页查询时每页的行数。取值范围:1~100,默认值为20。

PageNumber

Integer

1

分页查询的页码。

  • 如需传入此参数,请传入非负整数。
  • 不传或传入0,则均默认为1。

VpnGatewayIds.N

List of String

VpnGatewayIds.1=vgw-273zkshb2qayo7fap8t2****&VpnGatewayIds.2=vgw-wb7ujxgeb3****

VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

  • 参数 - N:表示VPN网关ID的序号。
  • 多个ID之间用&分隔。

ProjectName

String

project01

VPN网关所属项目。

  • 传入该字段,表示查询指定项目下的VPN网关。
  • 不传入该字段,表示查询所有项目下的VPN网关。

返回数据

名称类型
示例值
描述
RequestIdString2022032416142901022524308102CF****请求ID
PageSizeInteger10当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger1符合查询条件的VPN网关的数量。
VpnGatewaysArray of struct-VPN网关详细计费信息列表。具体请参见下表“VpnGateway”。

VpnGateway

名称类型示例值描述
VpnGatewayIdStringvgw-2zeerraiwb7uj****VPN网关的ID。

BillingStatus

Integer

1

计费状态。

  • 1:运行中
  • 3:退订回收
  • 4: 到期关停

BillingType

Integer

1

VPN网关的计费类型。

  • 1:包年包月
  • 2:按量计费(按固定配置)
ExpiredTimeString2021-03-11 23:59:59VPN网关的到期时间。
ReclaimTimeString2021-03-18 23:59:59VPN网关的回收时间。

RemainRenewTimes

Integer

1

剩余自动续费次数。

  • 1~100:剩余自动续费的次数。
  • -1:续费不限次数。

RenewType

Integer

1

自动续费类型。

  • 1: 手动续费。
  • 2: 自动续费。
  • 3: 到期不续费。

说明:若传入3,平台将不会在VPN网关到期前给您发送到期通知。

OverdueTimeString2023-08-07T23:23:23+08:00资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
OverdueReclaimTimeString2019-04-29T01:37:38+08:00资源欠费关停后系统强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。

请求示例

GET /?Action=DescribeVpnGatewaysBilling&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "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":""
            }           
        ]
    }
}

错误码

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

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.VpnGatewayIdYou've reached the limit on the number of VPN gateway IDs that you can describe.已达到可查询的VPN网关ID数量上限。