API文档

文档中心 > 私有网络 > API文档 > 云联网相关接口 > 查询云联网相关地域带宽信息

查询云联网相关地域带宽信息

最近更新时间:2020-07-13 08:55:13

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(GetCcnRegionBandwidthLimits)用于查询云联网相关地域带宽信息,其中预付费模式的云联网仅支持地域间限速,后付费模式的云联网支持地域间限速和地域出口限速。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetCcnRegionBandwidthLimits。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
CcnId String CCN实例ID。形如:ccn-f49l6u0z。
Filters.N Array of Filter 过滤条件。
  • sregion - String - (过滤条件)源地域,形如:ap-guangzhou。
  • dregion - String - (过滤条件)目的地域,形如:ap-shanghai-bm
  • SortedBy String 排序条件,目前支持带宽(BandwidthLimit)和过期时间(ExpireTime)
    Offset Integer 偏移量
    Limit Integer 返回数量
    OrderBy String 排序方式,'ASC':升序,'DESC':降序。

    3. 输出参数

    参数名称 类型 描述
    CcnBandwidthSet Array of CcnBandwidthInfo 云联网(CCN)各地域出带宽带宽详情。
    注意:此字段可能返回 null,表示取不到有效值。
    TotalCount Integer 符合条件的对象数。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询CCN地域出带宽详情

    该示例查询CCN地域出带宽详情,其中CCN的付费模式是后付费,后付费计费模式的云联网,用户不需要关注ExpireTime,RenewFlag参数。

    输入示例

    https://vpc.tencentcloudapi.com/?Action=GetCcnRegionBandwidthLimits
    &<公共请求参数>
    &CcnId=ccn-1pdchck1

    输出示例

    {
      "Response": {
        "CcnBandwidthSet": [
          {
            "CcnRegionBandwidthLimit": {
              "Region": "ap-guangzhou",
              "IsBm": false,
              "BandwidthLimit": 10
            },
            "CcnId": "ccn-1pdchck1",
            "RegionFlowControlId": "fcr-krx0mfoi",
            "CreateTime": "2020-05-20 16:29:44",
            "ExpireTime": "2020-05-20 16:29:44",
            "RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
          }
        ],
        "TotalCount": 1,
        "RequestId": "639c4bff-ff57-4734-bd72-f543df3b0771"
      }
    }

    示例2 查询CCN地域间带宽详情

    该示例是查询CCN地域间带宽详情,云联网为预付费,其中返回两个地域间限速实力,限速实例fcr-crrnp6w4续费模式RenewFlag为NOTIFY_AND_MANUAL_RENEW(非自动续费),限速实例fcr-lnfsgh4y续费模式RenewFlag为NOTIFY_AND_AUTO_RENEW(自动续费)。

    输入示例

    https://vpc.tencentcloudapi.com/?Action=GetCcnRegionBandwidthLimits
    &<公共请求参数>
    &CcnId=ccn-2gxeenq2

    输出示例

    {
      "Response": {
        "CcnBandwidthSet": [
          {
            "CcnRegionBandwidthLimit": {
              "Region": "ap-guangzhou",
              "IsBm": false,
              "BandwidthLimit": 1,
              "DstRegion": "ap-shanghai",
              "DstIsBm": false
            },
            "CcnId": "ccn-2gxeenq2",
            "RegionFlowControlId": "fcr-crrnp6w4",
            "CreateTime": "2020-06-10 14:48:13",
            "ExpireTime": "2020-07-10 15:47:05",
            "RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
          },
          {
            "CcnRegionBandwidthLimit": {
              "Region": "ap-nanjing",
              "IsBm": false,
              "BandwidthLimit": 1,
              "DstRegion": "ap-chengdu",
              "DstIsBm": false
            },
            "CcnId": "ccn-2gxeenq2",
            "RegionFlowControlId": "fcr-lnfsgh4y",
            "CreateTime": "2020-06-10 15:55:29",
            "ExpireTime": "2020-07-10 15:55:29",
            "RenewFlag": "NOTIFY_AND_AUTO_RENEW"
          }
        ],
        "TotalCount": 2,
        "RequestId": "39db643d-64ba-456b-91c6-279115682ad2"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameter 入参不合法。
    UnsupportedOperation 操作不支持。
    目录