DescribeVpnGatewaysBilling--VPN连接-火山引擎

文档中心

立即注册

导航

DescribeVpnGatewaysBilling

最近更新时间：2024.04.18 17:23:56首次发布时间：2022.04.28 07:17:15

调用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	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网关。

返回数据

名称	类型	示例值	描述
RequestId	String	2022032416142901022524308102CF****	请求ID
PageSize	Integer	10	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	1	符合查询条件的VPN网关的数量。
VpnGateways	Array of struct	-	VPN网关详细计费信息列表。具体请参见下表“VpnGateway”。

VpnGateway

名称	类型	示例值	描述
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: 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	错误码	错误信息	描述
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数量上限。