全部產品
Search
文件中心

Data Management:GetDataCronClearConfig - 查詢歷史資料清理工單的定時配置

更新時間:Mar 21, 2026

查詢歷史資料清理工單的定時配置。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetDataCronClearConfig

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

OrderId

integer

工單 ID,可通過調用介面 ListOrders 擷取該參數的值。

51****

Tid

integer

租戶 ID。

說明

取自系統右上方頭像處懸停展示的租戶 ID 資訊,詳情請參見查看租戶資訊

3***

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

283C461F-11D8-48AA-B695-DF092DA32AF3

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功。

  • false:請求失敗。

true

ErrorMessage

string

調用失敗時,返回的錯誤資訊。

UnknownError

ErrorCode

string

錯誤碼。

UnknownError

DataCronClearConfig

object

資料配置。

CronFormat

string

Crontab 運算式,以便定期執行任務。更多資訊,請參見 Crontab 運算式

0 0 23 ? * 7,1

Duration

string

執行時間長度(單位:小時)。取值為 0 時,說明不指定執行時間長度。

1

CronStatus

string

定時任務狀態,為表示未調度,其他取值及說明如下:

  • PAUSE:調度暫停。

  • WAITING:待調度。

  • SUCCESS:調度完成。

SUCCESS

CronCallTimes

string

調度次數。

2

CronLastCallStartTime

string

最近一次調度時間。

2022-11-18 00:00:00

CronNextCallTime

string

下一次調度時間。

說明

僅當調度狀態為 SUCCESS 時才會顯示。

2022-11-19 00:00:00

OptimizeTableAfterEveryClearTimes

integer

是否啟用自動 Optimize table,取值:

  • 0:不啟用。

  • 大於 0:啟用,表示每隔多少次清理以後下次調用進行 Optimize table。

0

CurrentClearTaskCount

integer

已進行自動 Optimize table 的次數,僅當 OptimizeTableAfterEveryClearTimes 大於 0 時有效。

0

樣本

正常返回樣本

JSON格式

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DataCronClearConfig": {
    "CronFormat": "0 0 23 ? * 7,1",
    "Duration": "1",
    "CronStatus": "SUCCESS",
    "CronCallTimes": "2",
    "CronLastCallStartTime": "2022-11-18 00:00:00",
    "CronNextCallTime": "2022-11-19 00:00:00",
    "OptimizeTableAfterEveryClearTimes": 0,
    "CurrentClearTaskCount": 0
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情