調用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 |
RequestEnable | boolean | 否 | 是否開啟 SQL 洞察。
說明
僅支持開通企業版 V3 時,需要配置該參數。
| true |
Retention | integer | 否 | 數據總存儲時長,單位為天,取值為:
說明
開通 DAS 企業版 V3 時,該參數取值必須大于等于 30。
| 30 |
HotRetention | integer | 否 | 數據熱存儲時長,單位為天,取值為[1, 7]范圍內的整數。 說明
僅支持開通企業版 V3 時,需要配置該參數。
| 1 |
Filters | array<object> | 否 | 預留參數。 | |
object | 否 | 預留參數。 | ||
Key | string | 否 | 預留參數。 | None |
Value | string | 否 | 預留參數。 | None |
DAS 企業版當前存在 V0、V1、V2、V3 四個版本,默認開通當前支持的最新版本。
- 對于僅支持開啟企業版 V0 的數據庫實例,僅需傳入參數 Enable 和 Retention。
- 對于支持開啟企業版 V1 的數據庫實例,僅需傳入參數 Enable 和 Retention,系統自動開啟 SQL 洞察功能(即 RequestEnable 默認配置為 true)。
- 對于支持開啟企業版 V2 的數據庫實例,僅需傳入參數 Enable 和 Retention,系統自動開啟 SQL 洞察功能(即 RequestEnable 默認配置為 true),且數據熱存儲時長(HotRetention)固定為 7 天,數據冷存儲時長為
Retention - 7
天。
返回參數
示例
正常返回示例
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 | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-05-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |