有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeCrossBorderFlowMonitor)用于查询跨境带宽监控数据,该接口目前只提供给服务商联通使用。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCrossBorderFlowMonitor。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SourceRegion String 源地域。
示例值:ap-guangzhou
DestinationRegion String 目的地域。
示例值:na-siliconvalley
CcnId String 云联网ID。
示例值:ccn-gree226l
CcnUin String 云联网所属账号。
示例值:251223380
Period Integer 时间粒度。单位为:秒,如60为60s的时间粒度
示例值:60
StartTime String 开始时间。
示例值:2022-08-20 00:00:00
EndTime String 结束时间。
示例值:2022-08-20 00:10:00

3. 输出参数

参数名称 类型 描述
CrossBorderFlowMonitorData Array of CrossBorderFlowMonitorData 云联网跨境带宽监控数据
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询跨境带宽监控数据

查询跨境带宽监控数据

输入示例

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

{
    "CcnId": "ccn-gree226l",
    "CcnUin": "251223380",
    "SourceRegion": "ap-guangzhou",
    "DestinationRegion": "ap-shanghai",
    "Period": 60,
    "StartTime": "2022-08-20 00:00:00",
    "EndTime": "2022-08-20 00:10:00"
}

输出示例

{
    "Response": {
        "CrossBorderFlowMonitorData": [
            {
                "InBandwidth": [
                    1,
                    1
                ],
                "InPkg": [
                    1,
                    2
                ],
                "OutBandwidth": [
                    1,
                    3
                ],
                "OutPkg": [
                    1,
                    4
                ]
            }
        ],
        "RequestId": "ff8a76ff-8900-4169-b126-ff59fdb39b6c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.Coexist 参数不支持同时指定。
InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
InvalidParameter.FilterNotDict 指定过滤条件不是键值对。
InvalidParameter.FilterValuesNotList 指定过滤选项值不是列表。
InvalidParameterValue.Malformed 入参格式不合法。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。
UnsupportedOperation.CcnInstanceAccountNotApprovedByUnicom CCN实例所属账号未通过联通审批。
UnsupportedOperation.CurrentAccountIsNotUnicomAccount 当前账号非联通账号。
UnsupportedOperation.CurrentQueryRegionIsNotCrossBorder 当前查询地域非跨境。
UnsupportedOperation.UinNotFound 账号ID不存在。
UnsupportedOperation.UnableCrossBorder 不支持跨境。