使用ModifySqlLogConfig接口开启或配置DAS企业版-数据库自治服务-阿里云

调用ModifySqlLogConfig接口，为数据库实例开启或配置DAS企业版。

接口说明

使用该接口需满足以下前提条件：

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
使用该接口默认开启当前支持的最新版本。DAS 企业版各个版本支持的数据库和地域请参见 DAS 产品系列及支持的功能。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:ModifySqlLogConfig

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	数据库实例 ID。	rr-2ze770smbq3tp****
Enable	boolean	否	是否开启 DAS 企业版： true：是。 false：否。说明开通企业版时必须配置，默认开启当前支持的最新版本。	true
RequestEnable	boolean	否	是否开启 SQL 洞察。 true：是。 false：否。说明仅支持开通企业版 V3 时，需要配置该参数。	true
Retention	integer	否	数据总存储时长，单位为天，取值为： 7 30 180 365 说明开通 DAS 企业版 V3 时，该参数取值必须大于等于 30。	30
HotRetention	integer	否	数据热存储时长，单位为天，取值为[1, 7]范围内的整数。说明仅支持开通企业版 V3 时，需要配置该参数。	1
Filters	array<object>	否	预留参数。
	object	否	预留参数。
Key	string	否	预留参数。	None
Value	string	否	预留参数。	None
EnableAudit	boolean	否	开启安全审计。	true

DAS 企业版当前存在 V0、V1、V2、V3 四个版本，默认开通当前支持的最新版本。

对于仅支持开启企业版 V0 的数据库实例，仅需传入参数 Enable 和 Retention。
对于支持开启企业版 V1 的数据库实例，仅需传入参数 Enable 和 Retention，系统自动开启 SQL 洞察功能（即 RequestEnable 默认配置为 true）。
对于支持开启企业版 V2 的数据库实例，仅需传入参数 Enable 和 Retention，系统自动开启 SQL 洞察功能（即 RequestEnable 默认配置为 true），且数据热存储时长（HotRetention）固定为 7 天，数据冷存储时长为Retention - 7天。

返回参数

名称	类型	描述	示例值
	object
Code	string	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	03C88D8E-1541-518E-8BFF-BEC6589B6334
Success	string	请求是否执行成功： true：执行成功 false：执行失败	false
Data	object	返回数据。
SqlLogVisibleTime	integer	DAS 企业版开启的时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
RequestStopTime	integer	DAS 企业版 V1 到期时间，格式为 Unix 时间戳，单位为毫秒。	1715335200000
CollectorVersion	string	采集器版本。 MYSQL_V0：MySQL V0 版。 MYSQL_V1：MySQL V1 版。 MYSQL_V2：MySQL V2 版。 MYSQL_V3：MySQL V3 版。 PG_V1：PostgreSQL V1 版。 rdspg_v1：RDS PostgreSQL V1 版。 polarpg_v1：PolarDB PostgreSQL 版 V1 版。	MYSQL_V3
SupportVersion	string	当前支持的最新 DAS 企业版版本。 SQL_LOG_V0：企业版 V0。 SQL_LOG_V1：企业版 V1。 SQL_LOG_V2：企业版 V2。 SQL_LOG_V3：企业版 V3。 SQL_LOG_NOT_ENABLE：未开启企业版。 SQL_LOG_NOT_SUPPORT：不支持企业版。	SQL_LOG_V3
ColdRetention	integer	数据冷存储时长，单位为天，由 `Retention - HotRetention` 计算获得。	23
SqlLogEnable	boolean	是否开启了 DAS 企业版。 true：是。 false：否。	true
Retention	integer	数据总存储时长，单位为天。	30
HotRetention	integer	数据热存储时长，单位为天。	7
RequestEnable	boolean	是否开启 SQL 洞察。 true：是。 false：否。	false
Version	string	当前开启的 DAS 企业版版本。 SQL_LOG_V0：企业版 V0。 SQL_LOG_V1：企业版 V1。 SQL_LOG_V2：企业版 V2。 SQL_LOG_V3：企业版 V3。 SQL_LOG_NOT_ENABLE：未开启企业版。 SQL_LOG_NOT_SUPPORT：不支持企业版。	SQL_LOG_V3
RequestStartTime	integer	SQL 洞察开启时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
HotEnable	boolean	是否开启数据热存储。 true：是。 false：否。	true
HotStartTime	integer	数据热存储开始时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
ColdEnable	boolean	是否开启数据冷存储。 true：是。 false：否。	true
ColdStartTime	integer	数据冷存储开始时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
SqlLogState	string	数据迁移状态。 FINISH：历史数据迁移完成。 RUNNING：历史数据迁移中。 FAILURE：历史数据迁移失败。	FINISH
LogFilter	string	预留参数。	None
SqlLogSource	string

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "03C88D8E-1541-518E-8BFF-BEC6589B6334",
  "Success": "false",
  "Data": {
    "SqlLogVisibleTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "CollectorVersion": "MYSQL_V3",
    "SupportVersion": "SQL_LOG_V3",
    "ColdRetention": 23,
    "SqlLogEnable": true,
    "Retention": 30,
    "HotRetention": 7,
    "RequestEnable": false,
    "Version": "SQL_LOG_V3",
    "RequestStartTime": 1683712800000,
    "HotEnable": true,
    "HotStartTime": 1683712800000,
    "ColdEnable": true,
    "ColdStartTime": 1683712800000,
    "SqlLogState": "FINISH",
    "LogFilter": "None",
    "SqlLogSource": ""
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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

变更历史

更多信息，参考变更详情。