ListScheduledTasks 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:ListScheduledTask

*ScheduledTask

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーション名。	my_app_group_name

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
type	string	任意	定期タスクのタイプ。有効な値： wipe：データクリーニング fork：インデックスの再作成 check-status：アプリケーションのステータスチェック index：インデックスの再作成	wipe
pageNumber	integer	任意	ページ番号。デフォルト値：1。	1
pageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：10。	10

クエリパラメーター

フィールド	タイプ	必須	例	説明
id	文字列	いいえ	"2f12c585-5873-11ea-974a-7cd30ad3e268"	タスク ID。
enabled	ブール値	いいえ	true	定期タスクが有効になっているかどうかを指定します。
updated	整数	いいえ	1582706232	定期タスクが最後に更新されたときのタイムスタンプ。

レスポンスフィールド

フィールド	型	説明	例
	object
totalCount	integer	返されたエントリの総数。	1
requestId	string	リクエスト ID。	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	array<object>
	object	定期タスクに関する情報。詳細については、「ScheduledTask」をご参照ください。	[]

例

成功レスポンス

JSONJSON

{
  "totalCount": 1,
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    []
  ]
}

エラーコード

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

変更履歴

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