全部產品
Search
文件中心

:DescribeSqlLogConfig - 查詢DAS企業版配置資訊

更新時間:Dec 19, 2025

調用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

integer

資料冷儲存開始時間,格式為 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

integer

資料熱儲存開始時間,格式為 Unix 時間戳記,單位為毫秒。

1683712800000

LogFilter

string

預留參數。

None

RequestEnable

boolean

是否開啟 SQL 洞察。

  • true:是。

  • false:否。

true

RequestStartTime

integer

SQL 洞察開啟時間,格式為 Unix 時間戳記,單位為毫秒。

1683712800000

RequestStopTime

integer

DAS 企業版 V1 到期時間,格式為 Unix 時間戳記,單位為毫秒。

1715335200000

Retention

integer

資料總儲存時間長度,HotRetentionColdRetention 之和,單位為天。

30

SqlLogEnable

boolean

是否開啟了 DAS 企業版。

  • true:是。

  • false:否。

true

SqlLogSource

string

預留參數。

None

SqlLogState

string

資料移轉狀態。

  • FINISH: 歷史資料移轉完成。

  • RUNNING: 歷史資料移轉中。

  • FAILURE: 歷史資料移轉失敗。

FINISH

SqlLogVisibleTime

integer

DAS 企業版開啟的時間,格式為 Unix 時間戳記,單位為毫秒。

1683712800000

SupportMigration

boolean

預留參數。

None

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": "None",
    "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.

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

變更歷史

更多資訊,參考變更詳情