获取设备云存服务详情

最近更新时间:2024-03-28 01:19:07

我的收藏

1. 接口描述

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

获取设备云存服务详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCloudStorage。
Version String 公共参数,本接口取值:2019-04-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。
ProductId String 产品ID
示例值:H541SOP191
DeviceName String 设备名称
示例值:event_36502632_1
UserId String 云存用户ID
示例值:default
ChannelId Integer 通道ID 非NVR设备不填 NVR设备必填 默认为无
示例值:1

3. 输出参数

参数名称 类型 描述
Status Integer 云存开启状态,1为开启,0为未开启或已过期
示例值:1
Type Integer 云存类型,1为全时云存,2为事件云存
示例值:2
ExpireTime Integer 云存套餐过期时间
示例值:1606963491
ShiftDuration Integer 云存回看时长
示例值:86400
UserId String 云存用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备云存服务详情

输入示例

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

{
    "ProductId": "H541SOP191",
    "DeviceName": "event_36502632_1",
    "UserId": "default"
}

输出示例

{
    "Response": {
        "RequestId": "f889deee-70ec-4391-9b91-bb0f3f09b5a4",
        "Status": 1,
        "Type": 1,
        "ExpireTime": 1614670782,
        "ShiftDuration": 86400,
        "UserId": "default"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
UnsupportedOperation 操作不支持。