すべてのプロダクト
Search
ドキュメントセンター

Data Management:GetDataCronClearConfig

最終更新日:Mar 21, 2026

履歴データのクリーンアップ用チケットのスケジューリング構成を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:GetDataCronClearConfig

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

OrderId

integer

必須

チケットの ID です。チケット ID を照会するには、ListOrders 操作を呼び出します。

51****

Tid

integer

任意

テナントの ID です。

説明

テナント ID を確認するには、Data Management (DMS) コンソールにログインし、右上隅のプロフィール画像にポインターを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。

3***

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

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

成功レスポンス

JSONJSON

{
  "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
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。