DescribeSqlLogConfig - 查询DAS企业版配置信息 - 数据库自治服务 DAS

调用DescribeSqlLogConfig接口，查询数据库实例的DAS企业版配置信息。

接口说明

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

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
hdm:DescribeSqlLogConfig	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	数据库实例 ID。	rm-2ze8g2am97624****

返回参数

名称	类型	描述	示例值
	object
Code	string	返回的状态码。	200
Data	object	返回数据。
ColdEnable	boolean	是否开启数据冷存储。 true：是。 false：否。	true
ColdRetention	integer	数据冷存储时长，单位为天。	23
ColdStartTime	long	数据冷存储开始时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
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
HotEnable	boolean	是否开启数据热存储。 true：是。 false：否。	true
HotRetention	integer	数据热存储时长，单位为天。	7
HotStartTime	long	数据热存储开始时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
LogFilter	string	预留参数。	None
RequestEnable	boolean	是否开启 SQL 洞察。 true：是。 false：否。	true
RequestStartTime	long	SQL 洞察开启时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
RequestStopTime	long	DAS 企业版 V1 到期时间，格式为 Unix 时间戳，单位为毫秒。	1715335200000
Retention	integer	数据总存储时长，HotRetention 与 ColdRetention 之和，单位为天。	30
SqlLogEnable	boolean	是否开启了 DAS 企业版。 true：是。 false：否。	true
SqlLogState	string	数据迁移状态。 FINISH：历史数据迁移完成。 RUNNING：历史数据迁移中。 FAILURE：历史数据迁移失败。	FINISH
SqlLogVisibleTime	long	DAS 企业版开启的时间，格式为 Unix 时间戳，单位为毫秒。	1683712800000
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
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
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	0A74B755-98B7-59DB-8724-1321B394****
Success	string	请求是否执行成功： true：执行成功 false：执行失败	true

对于SQL_LOG_V0（企业版 V0）和SQL_LOG_V1（企业版 V1），其数据存储在 CStore 中，视为热存储。开通该版本的数据库实例，查询返回结果中SqlLogEnable = HotEnable = true, Retention = HotRetention， ColdEnable = false， ColdRetention = 0。

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": {
    "ColdEnable": true,
    "ColdRetention": 23,
    "ColdStartTime": 1683712800000,
    "CollectorVersion": "MYSQL_V3",
    "HotEnable": true,
    "HotRetention": 7,
    "HotStartTime": 1683712800000,
    "LogFilter": "None",
    "RequestEnable": true,
    "RequestStartTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "Retention": 30,
    "SqlLogEnable": true,
    "SqlLogSource": "",
    "SqlLogState": "FINISH",
    "SqlLogVisibleTime": 1683712800000,
    "SupportMigration": true,
    "SupportVersion": "SQL_LOG_V3",
    "Version": "SQL_LOG_V3"
  },
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": "true"
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-07-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情