物联网开发平台查询设备云存AI分析服务-消费版云存AI相关接口-API 中心-腾讯云

1. 接口描述

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

查询指定设备的云存 AI 服务开通状态与参数配置

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCloudStorageAIService。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou 。
ProductId	是	String	产品 ID 示例值：TQBDY6RPI9
DeviceName	是	String	设备名称示例值：cs_112114601_2
ServiceType	是	String	云存 AI 服务类型。可选值： - `RealtimeObjectDetect`：目标检测 - `Highlight`：视频浓缩示例值：Highlight

3. 输出参数

参数名称	类型	描述
Type	Integer	云存 AI 套餐类型。可能取值： - `1`：全时套餐 - `2`：事件套餐 - `3`：低功耗套餐示例值：1
Status	Integer	云存 AI 套餐生效状态。可能取值： - `0`：未开通或已过期 - `1`：生效中示例值：1
ExpireTime	Integer	云存 AI 套餐过期时间 UNIX 时间戳示例值：1719294987
UserId	String	用户 ID 示例值：user1
Enabled	Boolean	视频分析启用状态示例值：true
Config	String	视频分析配置参数示例值：{"param1":"value1"}
ROI	String	视频分析识别区域示例值：{}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询设备云存AI服务

输入示例

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

{
    "ProductId": "KH6Q8C4N0D",
    "DeviceName": "aaa_31400554_1",
    "ServiceType": "Highlight"
}

输出示例

{
    "Response": {
        "Enabled": true,
        "ROI": "{}",
        "Config": "{\"param1\":\"value1\"}",
        "Type": 1,
        "Status": 1,
        "ExpireTime": 1719294987,
        "UserId": "user1",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ProductIotVideoServiceNotEnabled	产品未开通 IoT Video 服务
InternalError	内部错误。
InvalidParameter	参数错误。
UnsupportedOperation	操作不支持。