查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:DescribeMaskingRules | get | *DBCluster acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 说明
您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。
| pc-***************** |
| RuleNameList | string | 否 | 脱敏规则名称。 | testrule |
| InterfaceVersion | string | 否 | 获取脱敏加密规则。取值范围如下： v1：获取脱敏规则。 v2：获取加密规则。 | v1 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Abs.InvalidAccount.NotFound | account is not found. | 找不到帐户 |
| 404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的 DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-02 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 |