查询脱敏规则

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

1. 接口描述

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

查询用户的权限列表, 也支持用户组/角色, 从授权的原始记录角度查阅权限

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

接口更新时间：2025-07-13 02:06:24。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeMaskRulesSTD
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
InstanceId	是	否	String	引擎ID, 等价与 ClusterId 示例值： tbds-9kr93vco
ServiceType	是	否	String	授权引擎种类: UNITY 示例值： UNITY
Users	否	否	Array of String	用户示例值： ['grace2']
Groups	否	否	Array of String	用户组示例值： []
Roles	否	否	Array of String	角色（保留字段，当前版本不支持）示例值： []
ResourceType	否	否	String	资源类型示例值： 1
Resource	否	否	AuthResource	通过具体的资源筛选示例值：查看
OrderFields	否	否	Array of Api3Order	排序（保留字段，当前版本不支持）示例值：查看
Limit	否	否	Int64	返回数量，默认为20，最大值为100。示例值： 10
Offset	否	否	Int64	分页参数，默认0示例值：0 示例值： 0

3. 输出参数

参数名称	类型	描述
Data	Array of AuthDataMaskPolicy	按照每个请求的资源路径做拆分，返回每个路径的授权结果，顺序与提交的Resources保持一致示例值：查看
TotalCount	Int64	符合条件的总数示例值： 1
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

5. 示例

示例1 查询脱敏规则

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeMaskRulesSTD
<公共请求参数>

{
  "InstanceId": "tbds-9kr93vco",
  "ServiceType": "UNITY",
  "Groups": [],
  "Users": [
    "grace2"
  ],
  "Roles": [],
  "Limit": 10,
  "Offset": 0
}

输出示例

{
    "Response": {
      "RequestId": "72c64d87-84dc-405b-977c-d26e7a8bcf06",
      "Data": [
        {
          "Resource": {
            "Metalake": null,
            "Catalog": "c9kr93vco_hive", 
            "Schema": "default",
            "Database": null,
            "Table": "table1",
            "ColumnFamily": null,
            "Column": "id",
            "Topic": null,
            "Path": null,
            "NameService": null
          },
          "DataMaskPolicyItems": [
            {
              "Groups": [],
              "Users": ["grace2"],
              "Roles": [],
              "DataMaskInfo": {
                "DataMaskType": "MASK",
                "ValueExpr": ""
              }
            }
          ],
          "PolicyPriority": 0
        }
      ],
      "TotalCount": 1
    }
  }