开通设备云存AI分析服务

最近更新时间:2024-08-02 01:43:29

我的收藏

1. 接口描述

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

开通设备云存AI分析服务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCloudStorageAIService。
Version String 公共参数,本接口取值:2019-04-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。
ProductId String 产品 ID
示例值:H541SOP191
DeviceName String 设备名称
示例值:event_36502632_1
PackageId String 云存 AI 套餐 ID。可选值:

- 1m_low_od:低功耗目标检测月套餐
- 1y_low_od:低功耗目标检测年套餐
- 1m_ev_od:事件目标检测月套餐
- 1y_ev_od:事件目标检测年套餐
- 1m_ft_od:全时目标检测月套餐
- 1y_ft_od:全时目标检测年套餐
- 1m_low_hl:低功耗视频浓缩月套餐
- 1y_low_hl:低功耗视频浓缩年套餐
- 1m_ev_hl:事件视频浓缩月套餐
- 1y_ev_hl:事件视频浓缩年套餐
- 1m_ft_hl:全时视频浓缩月套餐
- 1y_ft_hl:全时视频浓缩年套餐
示例值:1m_ev_hl
ChannelId Integer 通道 ID
示例值:1
OrderId String 订单 ID
示例值:20240208123456

3. 输出参数

参数名称 类型 描述
OrderId String 订单 ID
示例值:20240208123456
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开通成功

输入示例

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

{
    "ProductId": "H541SOP191",
    "DeviceName": "event_36502632_1",
    "PackageId": "1m_ev_hl"
}

输出示例

{
    "Response": {
        "RequestId": "a9a9d232-01c0-494a-baa3-57c384463c3f",
        "OrderId": "3c189db8-4637-4f7d-aee5-9d6172c2c9ec"
    }
}

示例2 开通失败:指定的设备不存在

输入示例

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

{
    "ProductId": "H541SOP191",
    "DeviceName": "event_36502632_1",
    "PackageId": "1m_ev_hl"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter",
            "Message": "设备未创建或已删除,请检查后重新操作"
        },
        "RequestId": "053656d4-7694-47c4-9ed3-1d853454f8c7"
    }
}

示例3 开通失败:设备未开通云存套餐

设备当前无生效的云存套餐,尝试开通云存 AI 套餐时开通失败

输入示例

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

{
    "ProductId": "H541SOP191",
    "DeviceName": "event_36502632_1",
    "PackageId": "1m_ev_hl"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.CloudStoragePackageRequired",
            "Message": "需先开通云存套餐"
        },
        "RequestId": "4d85001c-1f75-486e-b96c-f75e37b2b9a9"
    }
}

示例4 开通失败:云存套餐与云存 AI 套餐时长不匹配

设备当前生效云存月套餐,尝试开通云存 AI 年套餐时开通失败

输入示例

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

{
    "ProductId": "H541SOP191",
    "DeviceName": "event_36502632_1",
    "PackageId": "1y_ft_od"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "UnsupportedOperation.CloudStoragePackageTimeMismatch",
            "Message": "云存套餐与云存 AI 套餐时长不匹配"
        },
        "RequestId": "703a2a1d-1d7b-4625-a151-a985b17f32a5"
    }
}

示例5 开通失败:云存套餐与云存 AI 套餐类型不匹配

设备当前生效全时云存套餐,尝试开通事件云存 AI 套餐时开通失败

输入示例

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

{
    "ProductId": "H541SOP191",
    "DeviceName": "event_36502632_1",
    "PackageId": "1m_ev_od"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "UnsupportedOperation.CloudStoragePackageTypeMismatch",
            "Message": "云存套餐与云存 AI 套餐类型不匹配"
        },
        "RequestId": "884a9ffd-426f-48bf-ab6a-79a5bb1631c1"
    }
}

示例6 开通失败:云存 AI 套餐有效时长超过云存套餐的有效时长

设备当前生效事件云存月套餐(过期时间为 2024年12月1日 00:00:00),且设备当前生效云存 AI 事件视频浓缩月套餐(过期时间同样为 2024年12月1日 00:00:00),尝试继续追加开通云存 AI 事件视频浓缩月套餐时开通失败

输入示例

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

{
    "ProductId": "H541SOP191",
    "DeviceName": "event_36502632_1",
    "PackageId": "1m_ev_hl"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.CloudStorageAIPackageExpireTimeExceeded",
            "Message": "云存 AI 套餐生效时长不能超过当前云存套餐生效时长"
        },
        "RequestId": "4d85001c-1f75-486e-b96c-f75e37b2b9a9"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CloudStorageAIPackageExpireTimeExceeded 云存 AI 套餐生效时长不能超过当前云存套餐生效时长
FailedOperation.CloudStorageAIServiceNotEnabled 产品未开通视频AI分析服务
FailedOperation.CloudStoragePackageRequired 需先开通云存套餐
FailedOperation.ProductIotVideoServiceNotEnabled 产品未开通 IoT Video 服务
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.CloudStorageAIPackageIdNotExist 指定的云存 AI 套餐不存在
UnsupportedOperation 操作不支持。
UnsupportedOperation.CloudStoragePackageTimeMismatch 云存套餐与云存 AI 套餐时长不匹配
UnsupportedOperation.CloudStoragePackageTypeMismatch 云存套餐与云存 AI 套餐类型不匹配