ModifyScheduledTask API で定期タスクを設定する - 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:ModifyScheduledTask

*ScheduledTask

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーションの名前または ID。	121414148
taskId	string	必須	タスク ID。	56e9c2e7-5a4d-481a-9f1b-b07da6909450

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	any	任意	リクエストパラメーター。	{ "cron": "0 0 * * 1,2,3,4,5,6,7", "enabled": true, "filter": { "field": "cat_id", "days": 30, "unit": "s" } }

レスポンスフィールド

フィールド	型	説明	例
	object
result	object	スケジュールされたタスクに関する情報。	Array
requestId	string	リクエスト ID。	D77D0DAF-790D-F5F5-A9C0-133738165014

例

成功レスポンス

JSONJSON

{
  "result": {
    "test": "test",
    "test2": 1
  },
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014"
}

エラーコード

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

変更履歴

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