有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

动作列表查询

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeActionList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
WorkspaceId Integer 工作空间id
示例值:1016
PageNumber Integer 分页查询,第几页,必传,大于0
示例值:1
PageSize Integer 每页条数,必传大于0
示例值:1
ApplicationToken String 应用token
示例值:baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0
ActionType String 动作类型,(app,device,toAlarm,toNotification)
示例值:device
IdSet.N Array of Integer 事件id详情
示例值:214

3. 输出参数

参数名称 类型 描述
Result DescribeActionListRes 动作列表查询结果
示例值:{"ActionDetailSet": [{"ActionDesc": "lena测试控制开灯","ActionType": "deviceControl","CreateTime": "2023-05-15 16:29:17","Id": 22,"LinkRuleSet": [],"MsgContent": "x-json:[{"model":"红灯(red)","value":"10","obj":{"name":"红灯","type":"int","modelName":"智能灯控模块","modelId":"2000126","define":{"type":"int","min":0,"max":255},"options":[]},"type":"int"},{"model":"绿灯(green)","value":"10","type":"int","obj":{"name":"绿灯","type":"int","modelName":"智能灯控模块","modelId":"2000126","define":{"type":"int","min":0,"max":255},"options":[]}}]","MsgType": "model","Name": "lena测试控制开灯","SinkConfig": "x-json:{"nearbySearch":{"deviceType":"w0905001","pid":2000126,"limit":0,"objectLevel":0,"scopeLevel":"","scopeRadius":"","deviceAssign":"deviceType"}}","WID": ""}],"PageNumber": 1,"PageSize": 1,"TotalPage": 158,"TotalRow": 158}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取动作列表

成功响应

输入示例

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

{
    "WorkspaceId": 1016,
    "PageNumber": 1,
    "PageSize": 1,
    "ApplicationToken": "baSTzPx0vZ6LPuv2EifNa5CqRBj9hoY0"
}

输出示例

{
    "Response": {
        "RequestId": "1c116023-0562-4488-933e-84df17c7f08c",
        "Result": {
            "ActionDetailSet": [
                {
                    "ActionDesc": "lena测试控制开灯",
                    "ActionType": "deviceControl",
                    "CreateTime": "2023-05-15 16:29:17",
                    "Id": 22,
                    "LinkRuleSet": [],
                    "MsgContent": "x-json:[{\"model\":\"红灯(red)\",\"value\":\"10\",\"obj\":{\"name\":\"红灯\",\"type\":\"int\",\"modelName\":\"智能灯控模块\",\"modelId\":\"2000126\",\"define\":{\"type\":\"int\",\"min\":0,\"max\":255},\"options\":[]},\"type\":\"int\"},{\"model\":\"绿灯(green)\",\"value\":\"10\",\"type\":\"int\",\"obj\":{\"name\":\"绿灯\",\"type\":\"int\",\"modelName\":\"智能灯控模块\",\"modelId\":\"2000126\",\"define\":{\"type\":\"int\",\"min\":0,\"max\":255},\"options\":[]}}]",
                    "MsgType": "model",
                    "Name": "lena测试控制开灯",
                    "SinkConfig": "x-json:{\"nearbySearch\":{\"deviceType\":\"w0905001\",\"pid\":2000126,\"limit\":0,\"objectLevel\":0,\"scopeLevel\":\"\",\"scopeRadius\":\"\",\"deviceAssign\":\"deviceType\"}}",
                    "WID": ""
                }
            ],
            "PageNumber": 1,
            "PageSize": 1,
            "TotalPage": 158,
            "TotalRow": 158
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidParameterValue.InvalidWorkspaceId 错误的工作空间Id
ResourceNotFound 资源不存在。