帮你快速理解、总结文档立即下载

启用套餐用量上报

最近更新时间:2026-10-23 02:22:15
我的收藏

1. 接口描述

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

启用套餐用量上报

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:StartPackageUsageReport。
Version 是 String 公共参数,本接口取值:2019-04-23。
Region 是 String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。
ProductId 是 String

产品 ID


示例值:PTROMP3AOB
DeviceName 是 String

设备名


示例值:dev_001
ResourceId 是 String

预付费 resourceId(ncs- 前缀,必填)


示例值:ncs-video-7d-m-xxx
ChannelId 否 Integer

通道 ID(无通道填 0)


示例值:1
Operator 否 String

操作者


示例值:100012345***
Remark 否 String

备注(可选)


示例值:备注信息

3. 输出参数

参数名称 类型 描述
Status Integer

启停后状态(0 停用 / 1 启用)


示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 启用套餐用量上报请求

启用套餐用量上报请求

输入示例

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

{
    "ProductId": "PTROMP3AOB",
    "DeviceName": "dev_001",
    "ChannelId": "1",
    "ResourceId": "ncs-video-7d-m-xxx",
    "Operator": "100012345***",
    "Remark": ""
}

输出示例

{
    "Response": {
        "Status": 1,
        "RequestId": "cf56eccb-3662-4eb3-9f60-ce618e749144"
    }
}

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 参数错误。
UnsupportedOperation 操作不支持。