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

Serverless App Engine:SuspendJob

最終更新日:Apr 23, 2026

1 つ以上のジョブを一時停止します。

今すぐお試しください

この 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:SuspendJob

*All Resource

*

なし なし

リクエスト構文

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

AppId

string

必須

ジョブテンプレートの ID。

ee1a7a07-abcb-4652-a1d3-2d57f415****

Suspend

boolean

必須

ジョブテンプレートを開始するか、一時停止するかを指定します。

  • true: ジョブテンプレートを開始します。

  • false: ジョブテンプレートを一時停止します。

true

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエストの ID。

67DD9A98-9CCC-5BE8-8C9E-B45E72F4****

Message

string

返される追加情報。 有効な値:

  • success: 呼び出しが成功した場合、success が返されます。

  • エラーコード: 呼び出しが失敗した場合、エラーコードが返されます。

success

TraceId

string

リクエストの詳細のクエリに使用されるトレース ID。

0b87b7e716575071334387401e****

Data

string

実行が成功したかどうかを示します。

{success: true}

ErrorCode

string

返されるエラーコード。 有効な値:

  • リクエストが成功した場合、ErrorCode パラメーターは返されません。

  • 呼び出しが失敗した場合、ErrorCode パラメーターが返されます。 詳細については、このトピックの「エラーコード」をご参照ください。

Code

string

HTTP ステータスコード。 有効な値:

  • 2xx:呼び出しは成功しました。

  • 3xx:呼び出しはリダイレクトされました。

  • 4xx:呼び出しは失敗しました。

  • 5xx:サーバーエラーが発生しました。

200

Success

boolean

ジョブが実行されたかどうかを示します。 有効な値:

  • true:ジョブは実行されました。

  • false:ジョブの実行に失敗しました。

true

成功レスポンス

JSONJSON

{
  "RequestId": "67DD9A98-9CCC-5BE8-8C9E-B45E72F4****",
  "Message": "success",
  "TraceId": "0b87b7e716575071334387401e****",
  "Data": "{success: true}",
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

404 InvalidAppId.NotFound The specified AppId does not exist.

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

変更履歴

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