有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

联动规则列表查询

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Result DescribeLinkRuleListRes 联动规则列表查询结果
示例值:{"LinkRuleSet": [{"ActionSet": [{"Id": 28,"Name": "瞿杨动作"}],"BeginDate": "2023-05-03","EndDate": "2023-05-22","EventSet": [{"Id": 33,"Name": "体验"}],"Id": 24,"Name": "体验","Status": 24,"ValidPeriod": ""}],"PageNumber": 1,"PageSize": 1,"TotalPage": 7,"TotalRow": 7}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 联动规则列表

成功响应

输入示例

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

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

输出示例

{
    "Response": {
        "RequestId": "aa1ac6c0-5721-4a84-bf87-dbd285bac6b7",
        "Result": {
            "LinkRuleSet": [
                {
                    "ActionSet": [
                        {
                            "Id": 59,
                            "Name": "体验123"
                        },
                        {
                            "Id": 28,
                            "Name": "瞿杨动作"
                        }
                    ],
                    "BeginDate": "2023-05-03",
                    "EndDate": "2023-05-22",
                    "EventSet": [
                        {
                            "Id": 34,
                            "Name": "联动新增事件"
                        },
                        {
                            "Id": 33,
                            "Name": "体验"
                        }
                    ],
                    "Id": 24,
                    "Name": "体验",
                    "Status": 24,
                    "ValidPeriod": ""
                }
            ],
            "PageNumber": 1,
            "PageSize": 1,
            "TotalPage": 7,
            "TotalRow": 7
        }
    }
}

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 资源不存在。