文档

DescribeMaskingRules - 查询脱敏规则列表

更新时间:

查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeMaskingRulesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

说明 您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息,包括集群 ID。
pc-*****************
RuleNameListstring

脱敏规则名称。

testrule

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

2F83D131-1C18-4599-889D-729A9D******
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Successboolean

请求结果。取值:

  • true:请求成功。

  • false:请求失败。

true
Dataobject

结果集。

RuleListarray

脱敏规则详情。

string

脱敏规则详细配置。

说明 关于各参数的详细介绍,详情请参见 ModifyMaskingRulesRuleConfig的参数描述。
"{\"testrule\":{\"auto\":{\"databases\":[],\"tables\":[\"t1\"],\"columns\":[\"c1\"]},\"applies_to\":[],\"description\":\"This rule will be applied to the columns c1 in table t1\",\"enabled\":\"true\"}}"
RuleVersionstring

脱敏规则版本, 取值 v1、v2, 默认值 v1

v1
DBClusterIdstring

集群 ID。

pc-bp1s826a1up******

示例

正常返回示例

JSON格式

{
  "RequestId": "2F83D131-1C18-4599-889D-729A9D******",
  "Message": "Successful",
  "Success": true,
  "Data": {
    "RuleList": [
      "\"{\\\"testrule\\\":{\\\"auto\\\":{\\\"databases\\\":[],\\\"tables\\\":[\\\"t1\\\"],\\\"columns\\\":[\\\"c1\\\"]},\\\"applies_to\\\":[],\\\"description\\\":\\\"This rule will be applied to the columns c1 in table t1\\\",\\\"enabled\\\":\\\"true\\\"}}\""
    ],
    "RuleVersion": "v1"
  },
  "DBClusterId": "pc-bp1s826a1up******"
}

错误码

HTTP status code错误码错误信息描述
400Abs.InvalidAccount.NotFoundaccount is not found.找不到帐户
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
  • 本页导读 (0)
文档反馈