查询单元化规则列表

最近更新时间: 2026-09-17 00:04:00

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.cn。

查询单元化规则列表

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

接口更新时间：2025-09-12 16:15:23。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeUnitRules
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GatewayInstanceId	是	否	String	网关实体ID 示例值：
SearchWord	否	否	String	根据规则名或备注内容模糊查询示例值：
Status	否	否	String	启用状态, disabled: 未发布， enabled: 发布示例值：
Offset	否	否	Int64	翻页查询偏移量示例值：
Limit	否	否	Int64	翻页查询每页记录数示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageUnitRule	分页列表信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

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

输入示例

POST / HTTP/1.1
Host: tsf.api3.<no value>
Content-Type: application/json
X-TC-Action: DescribeUnitRules
<公共请求参数>

{
  "GatewayInstanceId": "gw-ins-szesmg28",
  "SearchWord": "gwInsName",
  "Status": "disabled",
  "Offset": 0,
  "Limit": 10
}

输出示例

{
    "Response": {
        "RequestId": "2cb64889-e6d8-45af-afdf-c12f874a6d08",
        "Result": [
            {
                "Content": [
                    {
                        "CreatedTime": "2024-12-23 11:14:17",
                        "Description": null,
                        "GatewayInstanceId": "gw-ins-szesmg28",
                        "Id": "unit-rl-cgd3l6jo",
                        "Name": "gwInsName",
                        "Status": "disabled",
                        "UnitRuleItemList": [
                            {
                                "CreatedTime": "2024-12-23 11:14:17",
                                "Description": "this is desc",
                                "DestNamespaceId": "namespace-vk5blxnv",
                                "DestNamespaceName": "global_default",
                                "Id": "unit-item-ghpuh9rn",
                                "ItemIndex": 1,
                                "Name": "Rule1",
                                "Priority": 0,
                                "Relationship": "AND",
                                "UnitRuleId": "unit-rl-cgd3l6jo",
                                "UnitRuleTagList": [
                                    {
                                        "Id": "unit-tag-vmhijoic",
                                        "TagField": "user",
                                        "TagOperator": "IN",
                                        "TagType": "U",
                                        "TagValue": "1",
                                        "UnitRuleItemId": "unit-item-ghpuh9rn"
                                    }
                                ],
                                "UpdatedTime": "2024-12-23 11:14:17"
                            }
                        ],
                        "UpdatedTime": "2024-12-23 11:14:17"
                    }
                ],
                "TotalCount": 1
            }
        ]
    }
}