すべてのプロダクト
Search

このプロダクト

    OpenSearch:CreateScheduledTask

    ドキュメントセンター

    OpenSearch:CreateScheduledTask

    最終更新日:Nov 24, 2025

    OpenSearch アプリケーションのスケジュールされたタスクを作成します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    opensearch:CreateScheduledTask

    *ScheduledTask

    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

    		 なし なし

    リクエスト構文

    POST /v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    appGroupIdentity

    string

    必須

    アプリケーションの名前。

    my_app_group_name

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    body

    ScheduledTask

    任意

    リクエストボディ。

    リクエストボディ

    パラメータータイプ必須例説明
    typeStringはい"wipe"スケジュールされたタスクのタイプ。
    - wipe: データスクラビング
    - fork: データのインポートとインデックスの再作成
    - reindex: インデックスの再作成
    - clear: データクリアリング










    cronStringはい"10 20 * * 1,2,3,4,5"スケジュールされたタスクの構成。
    詳細については、「ScheduledTask の cron フィールド

    enabledBooleanはいtrueスケジュールされたタスクを有効にするかどうかを指定します。
    appStrategyStringいいえdelete-idle新しいバージョンを作成するためのポリシー。
    - delete-idle: 2 つのバージョンが存在する場合、新しいバージョンが作成される前に非アクティブなバージョンが削除されます。
    - need-slot: 1 つのバージョンのみが存在する場合、新しいバージョンが作成されます。




    filterObjectいいえデータをクリアするために使用される条件。
    filter.daysIntegerはい7データが有効期限切れになるまでの日数。
    有効な値: [7, 180]。

    filter.unitStringはい"s"有効期限の単位。
    - s: 秒
    - ms: ミリ秒




    filter.fieldStringいいえ"cate_id"データの有効期限を決定するために使用されるフィールド。
    runNowBooleanいいえfalseタスクをすぐに実行するかどうかを指定します。デフォルト値: false。
    permanentBooleanいいえtrueタスクが永続的かどうかを指定します。デフォルト値: true。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    result

    object

    スケジュールされたタスクに関する情報。詳細については、「ScheduledTask」をご参照ください。

    {}
    requestId

    string

    リクエストの ID。

    ABCDEFGH

    例

    成功レスポンス

    JSONJSON

    {
  "result": {},
  "requestId": "ABCDEFGH"
}

    エラーコード

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

    変更履歴

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