接口功能介绍
分页查询DDL审计规则列表。
接口约束
请先订购DRDS实例。
URI
GET /v2/ddl-audit/list-rule
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
pageNow | 否 | Integer | 当前页,若为空或小于1,默认是1 | 1 | |
pageSize | 否 | Integer | 页大小,若为空或小于1,默认是10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
enabled | 是 | String | 是否开启,true表示开启,false表示关闭 | true | |
handler | 是 | String | 审计方式, RejectHandler(拒绝) ; WarnHandler (告警) | RejectHandler | |
id | 是 | String | 规则id | ||
type | 是 | Integer | 审计类型 | ||
desc | 是 | String | 审计规则名 | ||
properties | 否 | String | 属性 | ||
handlerName | 是 | String | 审计方式名,拒绝或告警 | 拒绝 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": [
{
"enabled": "false",
"properties": "dataTypeLimit:\"int,bigint\"",
"handler": "WarnHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000404",
"type": "AutoIncrementColumnDataTypeDdlAuditor",
"desc": "自增列不为int,bigint",
"handlerName": "警告"
},
{
"enabled": "false",
"properties": "",
"handler": "WarnHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000405",
"type": "AutoIncrementColumnNameDdlAuditor",
"desc": "自增列的名字不为ID",
"handlerName": "警告"
},
{
"enabled": "false",
"properties": "",
"handler": "WarnHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000406",
"type": "AutoIncrementColumnUnsignedDdlAuditor",
"desc": "自增列是不为无符号型",
"handlerName": "警告"
},
{
"enabled": "false",
"properties": "",
"handler": "RejectHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000407",
"type": "ColumnCharsetDdlAuditor",
"desc": "列设置字符集",
"handlerName": "拒绝"
},
{
"enabled": "false",
"properties": "",
"handler": "WarnHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000408",
"type": "ColumnCommentDdlAuditor",
"desc": "列没有注释",
"handlerName": "警告"
},
{
"enabled": "false",
"properties": "excludedDataType:\"enum,bit\"",
"handler": "WarnHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000409",
"type": "ColumnDataTypeDdlAuditor",
"desc": "列使用enum,bit数据类型",
"handlerName": "警告"
},
{
"enabled": "false",
"properties": "",
"handler": "WarnHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000410",
"type": "ColumnDefaultValueDdlAuditor",
"desc": "建表、修改列、新增列时无默认值",
"handlerName": "警告"
},
{
"enabled": "false",
"properties": "",
"handler": "RejectHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000411",
"type": "ColumnNotNullDdlAuditor",
"desc": "创建或者新增列时列为NULL",
"handlerName": "拒绝"
},
{
"enabled": "false",
"properties": "",
"handler": "WarnHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000412",
"type": "ColumnTimestampDefaultValueDdlAuditor",
"desc": "没有为timestamp类型列指定默认值",
"handlerName": "警告"
},
{
"enabled": "false",
"properties": "",
"handler": "RejectHandler",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/interceptor/ddl/interceptor_0000000413",
"type": "ForeignKeyDdlAuditor",
"desc": "使用外键",
"handlerName": "拒绝"
}
]
}
状态码
请参考 状态码说明。