DescribeTransitRouterBandwidthPackagesBilling--中转路由器-火山引擎

文档中心

立即注册

导航

DescribeTransitRouterBandwidthPackagesBilling

最近更新时间：2024.09.12 10:54:20首次发布时间：2024.07.09 08:42:37

调用 DescribeTransitRouterBandwidthPackagesBilling 接口，查询带宽包计费方式列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouterBandwidthPackagesBilling	要执行的操作，取值为 DescribeTransitRouterBandwidthPackagesBilling。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TransitRouterBandwidthPackageIds.N	String	否	TransitRouterBandwidthPackageIds.1=tr-bp-4c2zaavbvh5fx**&TransitRouterBandwidthPackageIds.2=tr-bp-qw2u6ur8lhe2t**	中转路由器带宽包的ID。您可以调用DescribeTransitRouterBandwidthPackages接口，查询中转路由器带宽包ID。 N：表示中转路由器带宽包的序号，取值范围为1～100。多个中转路由器带宽包ID之间使用&分隔。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。

返回参数

名称	类型	示例值	描述
PageSize	integer	20	当前分页的行数。
PageNumber	integer	1	当前页码。
TotalCount	Integer	2	符合条件的中转路由器带宽包总数。
TransitRouterBandwidthPackages	Array of Struct	--	符合条件的中转路由器带宽包的详细信息。具体请参见下表“ TransitRouterBandwidthPackages ”。

TransitRouterBandwidthPackages

名称	类型	示例值	描述
TransitRouterBandwidthPackageId	String	tr-bp-4c2zaavbvh5x****	中转路由器带宽包的ID。
BillingType	Integer	1	中转路由器带宽包的计费方式。 1：包年包月。
BillingStatus	Integer	1	中转路由器带宽包的计费状态。 0：创建中 1：运行中 3：已退订 4：到期关停 5：到期回收 8：退订关停
RenewType	String	Auto	中转路由器带宽包的续费类型。 Manual：手动续费 Auto：自动续费 NoRenew：不续费。说明当参数`BillingType`为1时，返回该参数。
RemainRenewTimes	Integer	1	自动续费的次数。取值包括-1和1～100，默认值为-1，表示自动续费无限次。说明当参数`RenewType`为2时，返回该参数。
ExpiredTime	String	2021-05-07 23:59:59	中转路由器带宽包的到期时间。说明当参数`BillingType`为1时，返回该参数。
ReclaimTime	String	2021-05-07 23:23:23	中转路由器带宽包到期后的回收时间。说明当参数`BillingType`为1时，返回该参数。

请求示例

GET /?Action=DescribeTransitRouterBandwidthPackagesBilling&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024062715311618200419005956CC0F",
    "Action": "DescribeTransitRouterBandwidthPackagesBilling",
    "Version": "2020-04-01",
    "Service": "transitrouter",
    "Region": "cn-guangzhou"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "TransitRouterBandwidthPackages": [
      {
        "TransitRouterBandwidthPackageId": "tr-bp-4c2zaavbvh5x****",
        "BillingType": 1,
        "BillingStatus": "1",
        "RenewType": "Auto",
        "RemainRenewTimes": 1,
        "ExpiredTime": "2021-05-07 23:23:23",
        "ReclaimTime": "2021-05-07 23:23:23"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	已达到单次可查询的实例数量上限。