You need to enable JavaScript to run this app.
导航
全球加速
  • 文档首页
    • /
  • 全球加速

ListBandwidthPackages

最近更新时间：2022.09.01 11:30:07

首次发布时间：2022.09.01 11:30:07

我的收藏

API说明

API 名称：ListBandwidthPackages。
API 域名：open.volcengineapi.com 。
API 描述：获取跨域带宽包列表。

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2022-03-01 。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例
PageNumberint否列表的页码，默认值为1
1
PageSizeint否分页查询时每页的行数，最大值为100，默认值为10。10

State

string

否

跨域带宽包的状态，支持取值：

  • creating：开通中。
  • failed：开通失败。
  • reclaiming：停用中。
  • recliamed：已停用。
  • overdue：欠费停用。
  • stopped：已停用。
  • bound：已绑定。
  • unbound：未绑定。

bound

BandwidthPackageIdstring否跨域带宽包ID，指定带宽包获取。cdb-bp1sgzldyj6b4q7cx****
AcceleratorIdstring否加速器 ID 。accinstance-U42kghD9q8vXkrEmj2fSDi

响应正文

参数类型参数说明示例
TotalCountint
列表条目数。
10
PageSizeint每页包含的条目数。10
PageNumberint当前页码。1
CrossDomainBandwidthPackagesarray of CrossDomainBandwidthPackage跨域带宽包详情。见 CrossDomainBandwidthPackage

CrossDomainBandwidthPackage

参数类型参数说明示例
Id
string跨域带宽包 ID 。cdb-vjaCiwcfTWhpppmiqBywXL
CreateTimelong跨域带宽包创建的时间，时间戳。1643155486
ExpiredTimelong跨域带宽包过期的时间，时间戳。1643155486
Namestring跨域带宽包的名称。test

State

string

跨域带宽包的状态，支持取值：

  • deploy：配置中。
  • recliamed：已停用。
  • overdue：已欠费。
  • frozen：已冻结。
  • bound：已绑定。
  • unbound：未绑定。

bound

ChargeTypestring付费类型，当前为后付费，仅返回POSTPAY。POSTPAY
Descstring跨域带宽包的描述。Test
CrossDomainBandwidthLinesarray of CrossDomainBandwidthLine互通区域及带宽信息。见 CrossDomainBandwidthLine

CrossDomainBandwidthLine

参数类型参数说明示例
Bandwidth
int
带宽值。
2
EndpointAstring互通区域A。China-mainland
EndpointBstring互通区域B。Overseas

示例

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=ListBandwidthPackages&<其他公共请求参数>
{
    "AcceleratorId": "",
    "PageNum": 1,
    "PageSize": 2,
    "State": ""
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2022080511244201017424420202C5335F",
        "Action": "ListBandwidthPackages",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 15,
        "PageSize": 2,
        "PageNumber": 1,
        "CrossDomainBandwidthPackages": [
            {
                "Id": "cdb-vjaCiwcfTWhpppmiqBywXL",
                "CreateTime": 1658305207,
                "ExpiredTime": 0,
                "Name": "CrossDomainLine-shenzhen-xianggang",
                "State": "reclaimed",
                "ChargeType": "POSTPAY",
                "Desc": "",
                "CrossDomainBandwidthLines": [
                    {
                        "Bandwidth": 10,
                        "EndpointA": "China-mainland",
                        "EndpointB": "Overseas"
                    }
                ],
                "AccountID": "2100055193",
                "EndpointA": "China-mainland",
                "EndpointB": "Overseas",
                "Bandwidth": 10
            },
            {
                "Id": "cdb-za27Eu6SvJLnfjFnj42Uq9",
                "CreateTime": 1658308752,
                "ExpiredTime": 0,
                "Name": "CrossDomainLine-shenzhen-xianggang",
                "State": "reclaimed",
                "ChargeType": "POSTPAY",
                "Desc": "",
                "CrossDomainBandwidthLines": [
                    {
                        "Bandwidth": 2,
                        "EndpointA": "China-mainland",
                        "EndpointB": "Overseas"
                    }
                ],
                "AccountID": "2100055193",
                "EndpointA": "China-mainland",
                "EndpointB": "Overseas",
                "Bandwidth": 2
            }
        ]
    }
}