API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 私有网络 > 云联网相关接口 > 查询云联网相关地域带宽信息

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

最近更新时间：2024-03-12 02:03:08

我的收藏

本页目录：

1. 接口描述

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

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

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

推荐使用 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），默认按 ExpireTime 排序。
    Offset 否 Integer 偏移量。
    Limit 否 Integer 返回数量。
    OrderBy 否 String 排序方式，'ASC':升序,'DESC':降序。默认按'ASC'排序。

    3. 输出参数

    参数名称 类型 描述
    CcnBandwidthSet Array of CcnBandwidthInfo 云联网（CCN）各地域出带宽详情。
    注意：此字段可能返回 null，表示取不到有效值。
    TotalCount Integer 符合条件的对象数。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：1
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

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

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

    输入示例

    POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetCcnRegionBandwidthLimits
<公共请求参数>

{
    "CcnId": "ccn-1pdchck1"
}

    输出示例

    {
    "Response": {
        "CcnBandwidthSet": [
            {
                "CcnRegionBandwidthLimit": {
                    "Region": "ap-guangzhou",
                    "IsBm": false,
                    "BandwidthLimit": 10
                },
                "CcnId": "ccn-1pdchck1",
                "TagSet": [
                    {
                        "Key": "test",
                        "Value": "123"
                    }
                ],
                "RegionFlowControlId": "fcr-krx0mfoi",
                "CreatedTime": "2020-05-20 16:29:44",
                "ExpiredTime": "2020-05-20 16:29:44",
                "MarketId": "abc",
                "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（自动续费）。

    输入示例

    POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetCcnRegionBandwidthLimits
<公共请求参数>

{
    "CcnId": "ccn-2gxeenq2"
}

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter 参数错误。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    UnsupportedOperation 操作不支持。
    中国站