文档

ModifySQLCollectorPolicy - 开启或关闭实例的SQL审计功能

更新时间:

该接口用于开启或关闭实例的SQL洞察(SQL审计)功能。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
说明 如果实例所在地域支持开启 DAS 企业版,使用该接口开启 SQL 审计功能时,默认开启该地域支持的最新的 DAS 企业版。DAS 企业版各个版本支持的数据库引擎和地域请参见 DAS 企业版支持的数据引擎和地域

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
SQLCollectorStatusstring

开启或关闭 SQL 洞察(SQL 审计),取值:

  • Enable
  • Disabled
Enable
ResourceGroupIdstring

资源组 ID。可调用 DescribeDBInstanceAttribute 获取。

rg-acfmx****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

错误码

HTTP status code错误码错误信息描述
400InvalidSqlLog.MalformedThe specified parameter SqlLog is not valid.参数SqlLog无效。
400InvalidConfigNameThe ConfigName is not valid.ConfigName无效。
400InvalidConfigValueThe ConfigValue is not valid.操作失败,指定的参数配置无效。
400IncorrectPerfFrequencyTypeCurrent DB instance does not support this perf frequency.当前DB实例不支持此性能频率。
400InvalidParameters.FormatSpecified parameter is not valid操作失败,指定的参数格式不合法。
400ErrorMxsServiceInsNum.ErrorThe Maxscale serviceIns num must be 1.Maxscale必须为1.
400IncorrectSQLLogVersionCurrent DB instance SQL log version does not support this operation.操作失败,当前数据库实例sql log版本状态不允许此操作。
400IncorrectSQLLogActiveStatusCurrent DB instance SQL log active status does not support this operation.操作失败,运行状态下不支持该操作。
400OperationDenied.QuotaInsufficientThe DAS Enterprise Edition (V1) quota is insufficient.DAS企业版(V1)配额不足
400OperationDenied.OperateFrequentlyThe modification operation is too frequent.该修改操作过于频繁
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectDBTypeThe current DB type does not support this operation.操作失败,当前数据库类型不支持此操作,请使用其他类型的数据库进行操作。
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.当前DB实例字符类型不支持此操作。
403InvalidSqlRetention.MalformedSpecified sql retention is not valid.指定的sql保留无效。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。

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

变更历史

变更时间变更内容概要操作
2024-02-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2022-10-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    新增错误码:400
    新增错误码:404
  • 本页导读 (1)
文档反馈