文档

ModifySqlLogConfig - 开启或配置DAS企业版

更新时间:

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

接口说明

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

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

数据库实例 ID。

rr-2ze770smbq3tp****
Enableboolean

是否开启 DAS 企业版:

  • true:是。
  • false:否。
说明 开通企业版时必须配置,默认开启当前支持的最新版本。
true
RequestEnableboolean

是否开启 SQL 洞察。

  • true:是。
  • false:否。
说明 仅支持开通企业版 V3 时,需要配置该参数。
true
Retentioninteger

数据总存储时长,单位为天,取值为:

  • 7
  • 30
  • 180
  • 365
说明 开通 DAS 企业版 V3 时,该参数取值必须大于等于 30。
30
HotRetentioninteger

数据热存储时长,单位为天,取值为[1, 7]范围内的整数。

说明 仅支持开通企业版 V3 时,需要配置该参数。
1
Filtersobject []

预留参数。

Keystring

预留参数。

None
Valuestring

预留参数。

None

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

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

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

03C88D8E-1541-518E-8BFF-BEC6589B6334
Successstring

请求是否执行成功:

  • true:执行成功
  • false:执行失败
false
Dataobject

返回数据。

SqlLogVisibleTimelong

DAS 企业版开启的时间,格式为 Unix 时间戳,单位为毫秒。

1683712800000
RequestStopTimelong

DAS 企业版 V1 到期时间,格式为 Unix 时间戳,单位为毫秒。

1715335200000
CollectorVersionstring

采集器版本。

  • 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
SupportVersionstring

当前支持的最新 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
ColdRetentioninteger

数据冷存储时长,单位为天,由 Retention - HotRetention 计算获得。

23
SqlLogEnableboolean

是否开启了 DAS 企业版。

  • true:是。
  • false:否。
true
Retentioninteger

数据总存储时长,单位为天。

30
HotRetentioninteger

数据热存储时长,单位为天。

7
RequestEnableboolean

是否开启 SQL 洞察。

  • true:是。
  • false:否。
false
Versionstring

当前开启的 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
RequestStartTimelong

SQL 洞察开启时间,格式为 Unix 时间戳,单位为毫秒。

1683712800000
HotEnableboolean

是否开启数据热存储。

  • true:是。
  • false:否。
true
HotStartTimelong

数据热存储开始时间,格式为 Unix 时间戳,单位为毫秒。

1683712800000
ColdEnableboolean

是否开启数据冷存储。

  • true:是。
  • false:否。
true
ColdStartTimelong

数据冷存储开始时间,格式为 Unix 时间戳,单位为毫秒。

1683712800000
SqlLogStatestring

数据迁移状态。

  • FINISH: 历史数据迁移完成。
  • RUNNING: 历史数据迁移中。
  • FAILURE: 历史数据迁移失败。
FINISH
LogFilterstring

预留参数。

None

示例

正常返回示例

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"
  }
}

错误码

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

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