查询单元化规则列表V2

最近更新时间:2024-03-12 02:00:06

我的收藏

1. 接口描述

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

查询单元化规则列表V2

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUnitRulesV2。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
GatewayInstanceId String 网关实体ID
示例值:gw-ins-123456
SearchWord String 根据规则名或备注内容模糊查询
示例值:desc
Status String 启用状态, disabled: 未发布, enabled: 发布
示例值:disabled
Offset Integer 翻页查询偏移量
Limit Integer 翻页查询每页记录数

3. 输出参数

参数名称 类型 描述
Result TsfPageUnitRuleV2 分页列表信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询单元化规则列表

查询单元化规则列表

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeUnitRulesV2
&GatewayInstanceId=gw-ins-afsfas
&Offset=0
&Limit=20
&SearchWord=xxx
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "Content": [
                {
                    "Id": "abc",
                    "GatewayInstanceId": "abc",
                    "Name": "abc",
                    "Description": "abc",
                    "Status": "abc",
                    "UnitRuleItemList": [
                        {
                            "Id": "abc",
                            "UnitRuleId": "abc",
                            "Relationship": "abc",
                            "DestNamespaceId": "abc",
                            "DestNamespaceName": "abc",
                            "Name": "abc",
                            "Priority": 0,
                            "Description": "abc",
                            "UnitRuleTagList": [
                                {
                                    "UnitRuleItemId": "abc",
                                    "Id": "abc",
                                    "TagType": "abc",
                                    "TagField": "abc",
                                    "TagOperator": "abc",
                                    "TagValue": "abc"
                                }
                            ]
                        }
                    ],
                    "CreatedTime": "abc",
                    "UpdatedTime": "abc"
                }
            ]
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.GatewayConsulError 配置中心访问异常。
InvalidParameterValue.GatewayParameterInvalid 无效请求参数:%s。
MissingParameter.GatewayParameterRequired 缺少请求参数:%s。