调用DescribeMaskingRules接口查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeMaskingRules |
系统规定参数。取值:DescribeMaskingRules。 |
DBClusterId | String | 是 | pc-***************** |
集群ID。 说明 您可以通过DescribeDBClusters接口查看账号下所有集群的详细信息,包括集群ID。
|
RuleNameList | String | 否 | testrule |
脱敏规则名称。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2F83D131-1C18-4599-889D-729A9D****** |
请求ID。 |
Message | String | Successful |
请求返回消息。 说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
|
Success | Boolean | true |
请求结果。取值:
|
Data | Object |
结果集。 |
|
RuleList | Array of String | "{\"testrule\":{\"auto\":{\"databases\":[],\"tables\":[\"t1\"],\"columns\":[\"c1\"]},\"applies_to\":[],\"description\":\"This rule will be applied to the columns c1 in table t1\",\"enabled\":\"true\"}}" |
脱敏规则详细配置。 说明 关于各参数的详细介绍,详情请参见ModifyMaskingRules中
RuleConfig 的参数描述。
|
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeMaskingRules
&DBClusterId=pc-*****************
&RuleNameList=testrule
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeMaskingRulesResponse>
<Message>Successful</Message>
<RequestId>2F83D131-1C18-4599-889D-729A9D******</RequestId>
<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"}}</RuleList>
</Data>
<Success>true</Success>
</DescribeMaskingRulesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "Successful",
"RequestId" : "2F83D131-1C18-4599-889D-729A9D******",
"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\"}}" ]
},
"Success" : true
}
错误码
访问错误中心查看更多错误码。