ListJobs API 概要: パラメータ、フィルター、ページネーション - SAE - Alibaba Cloud - Serverless App Engine

ジョブテンプレートのリストを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:ListJobs

list

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/job/listJobs HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CurrentPage	integer	任意	ページ番号。値は 1 から始まります。	1
PageSize	integer	任意	ページあたりのエントリ数。有効値：0～200。	20
AppName	string	任意	ジョブテンプレートの名前。	demo-app
NamespaceId	string	任意	名前空間 ID。	cn-beijing:demo
Tags	string	任意	タグのリスト。これは JSON 文字列です。値は次の部分で構成されます： key：タグキー。 value：タグ値。	[{"key":"key","value":"value"}]
OrderBy	string	任意	ジョブテンプレートのソート方法。有効値： running：実行中のインスタンス数でソートします。 instances：宛先インスタンス数でソートします。	running
Reverse	boolean	任意	OrderBy パラメーターで指定されたフィールドに基づいて、結果を昇順または降順のどちらでソートするかを指定します。有効値： true：昇順。 false：降順。	true
FieldType	string	任意	ジョブテンプレートをフィルターするディメンション。有効値： appName：ジョブテンプレートの名前。 appIds：ジョブテンプレートの ID。	appName
FieldValue	string	任意	ターゲットジョブテンプレートの名前または ID。この値は FieldType で指定されたディメンションに対応します。	demo-app
Workload	string	任意	ワークロード。値を `job` に設定します。	job

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
Message	string	呼び出しに関する追加情報。	success
RequestId	string	リクエスト ID。	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	ジョブテンプレートのリスト。
CurrentPage	integer	現在のページ番号。	1
TotalSize	integer	ジョブテンプレートの合計数。	2
PageSize	integer	ページあたりのエントリ数。	20
Applications	array<object>	ジョブテンプレートのリスト。
	array<object>	ジョブテンプレートの詳細。
AppName	string	ジョブテンプレートの名前。	demo-app
NamespaceId	string	名前空間 ID。	cn-beijing:demo
AppId	string	ジョブテンプレートの ID。	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	ジョブテンプレートのタグ。
	object	ジョブテンプレートタグの詳細。
Key	string	タグキー。	key
Value	string	タグ値。	value
RegionId	string	リージョン ID。	cn-beijing
AppDescription	string	ジョブテンプレートの説明。	description
TriggerConfig	string	ジョブのトリガー設定。設定はジョブの種類によって異なります。スケジュールされたタスク：type フィールドを time に、config フィールドを Cron 式に、timezone フィールドを特定のタイムゾーンに設定します。例：`{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}` 1 回限りのジョブ：type フィールドを http に設定し、config フィールドで HTTP トリガールールを設定します。詳細については、「リクエストパラメーター SourceHttpEventParameters」をご参照ください。例：`{"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}`	{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}
Suspend	boolean	ジョブテンプレートが一時停止されているかどうかを示します。	false
Active	integer	実行中のインスタンス数。	0
Succeeded	integer	成功したインスタンス数。	3
Failed	integer	失敗したインスタンス数。	0
LastStartTime	integer	最後のジョブが開始された時刻。	1657522800
CompletionTime	integer	最後のジョブが完了した時刻。	1657522839
LastChangeorderState	string	最後のリリースオーダーが正常に実行されたかどうかを示します。有効値： 0：リリースオーダーの実行に失敗しました。 1：リリースオーダーは正常に実行されました。	1
LastJobState	string	最後のジョブの状態。有効値： 0：未実行。 1：成功。 2：失敗。 3：実行中。	0
Cpu	integer	各インスタンスに必要な CPU (ミリコア単位)。値を 0 にすることはできません。次の固定仕様のみがサポートされています： 500 1000 2000 4000 8000 16000 32000	500
Mem	integer	各インスタンスに必要なメモリ (MB 単位)。値を 0 にすることはできません。このパラメーターは CPU パラメーターに対応します。次の固定仕様のみがサポートされています： 1024：CPU 500 および 1,000 ミリコアに対応します。 2048：CPU 500、1,000、および 2,000 ミリコアに対応します。 4096：CPU 1,000、2,000、および 4,000 ミリコアに対応します。 8192：CPU 2,000、4,000、および 8,000 ミリコアに対応します。 12288：CPU 12,000 ミリコアに対応します。 16384：CPU 4,000、8,000、および 16,000 ミリコアに対応します。 24576：CPU 12,000 ミリコアに対応します。 32768：CPU 16,000 ミリコアに対応します。 65536：CPU 8,000、16,000、および 32,000 ミリコアに対応します。 131072：CPU 32,000 ミリコアに対応します。	1024
Message	string	呼び出しに関する追加情報。	success
ImageUrl	string	イメージ URL。
ErrorCode	string	エラーコード。リクエストが成功した場合、このパラメーターは返されません。リクエストが失敗した場合、このパラメーターが返されます。詳細については、このトピックのエラーコードセクションをご参照ください。
Code	string	インターフェイスのステータスまたは POP エラーコード。有効値： 2xx：リクエストは成功しました。 3xx：リダイレクション。 4xx：リクエストエラーが発生しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	ジョブテンプレートのリストが取得されたかどうかを示します。有効値： true：リストは取得されました。 false：リストの取得に失敗しました。	true
CurrentPage	integer	現在のページ番号。	1
TotalSize	integer	ジョブテンプレートの合計数。	2
PageSize	integer	ページあたりのエントリ数。	20

例

成功レスポンス

JSONJSON

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "TriggerConfig": "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
        "Suspend": false,
        "Active": 0,
        "Succeeded": 3,
        "Failed": 0,
        "LastStartTime": 1657522800,
        "CompletionTime": 1657522839,
        "LastChangeorderState": "1",
        "LastJobState": "0",
        "Cpu": 500,
        "Mem": 1024,
        "Message": "success",
        "ImageUrl": ""
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidAppId.NotFound	The specified AppId does not exist.

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

変更履歴

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