该接口用于开启或关闭实例的SQL洞察(SQL审计)功能。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
- RDS MySQL SQL洞察和审计
- RDS PostgreSQL SQL审计(数据库审计)
- RDS SQL Server SQL审计(数据库审计)
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifySQLCollectorPolicy | WRITE |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
SQLCollectorStatus | string | 是 |
开启或关闭SQL洞察(SQL审计),取值:
|
Enable |
ResourceGroupId | string | 否 |
资源组ID。可调用DescribeDBInstanceAttribute获取。 |
rg-acfmx**** |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
RequestId | string |
请求ID。 |
1AD222E9-E606-4A42-BF6D-8A4442913CEF |
示例
正常返回示例
JSON
格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidSqlLog.Malformed | The specified parameter SqlLog is not valid. | 参数SqlLog无效。 |
400 | InvalidConfigName | The ConfigName is not valid. | ConfigName无效。 |
400 | InvalidConfigValue | The ConfigValue is not valid. | 操作失败,指定的参数配置无效。 |
400 | IncorrectPerfFrequencyType | Current DB instance does not support this perf frequency. | 当前DB实例不支持此性能频率。 |
400 | InvalidParameters.Format | Specified parameter is not valid | 操作失败,指定的参数格式不合法。 |
400 | ErrorMxsServiceInsNum.Error | The Maxscale serviceIns num must be 1. | Maxscale必须为1. |
400 | IncorrectSQLLogVersion | Current DB instance SQL log version does not support this operation. | 操作失败,当前数据库实例sql log版本状态不允许此操作。 |
400 | IncorrectSQLLogActiveStatus | Current DB instance SQL log active status does not support this operation. | 操作失败,运行状态下不支持该操作。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
403 | IncorrectDBType | The current DB type does not support this operation. | 操作失败,当前数据库类型不支持此操作,请使用其他类型的数据库进行操作。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
403 | IncorrectDBInstanceCharacterType | Current DB Instance character_type does not support this operation. | 当前DB实例字符类型不支持此操作。 |
403 | InvalidSqlRetention.Malformed | Specified sql retention is not valid. | 指定的sql保留无效。 |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/154157.html