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.	沒有許可權執行該操作

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。