すべてのプロダクト
Search

このプロダクト

    Serverless App Engine:DescribeJobStatus

    ドキュメントセンター

    Serverless App Engine:DescribeJobStatus

    最終更新日:Apr 22, 2026

    ジョブのステータスを照会します。

    今すぐお試しください

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

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AppId

    string

    必須

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

    e1a7a07-abcb-4652-a1d3-2d57f415****
    JobId

    string

    任意

    ジョブの ID。

    event-b798157b-40a2-4388-b578-71fb897103**-**

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータ。

    RequestId

    string

    リクエスト ID。

    53F15A18-8079-5992-810C-0211A5AE****
    Message

    string

    返されたメッセージ。次のルールに注意してください：

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

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

    success
    TraceId

    string

    リクエストの詳細を照会するために使用されるトレース ID。

    0b1639af16575057857241351e****
    Data

    object

    返されたデータ。

    JobId

    string

    ジョブの ID。

    event-b798157b-40a2-4388-b578-71fb897103**-**
    Active

    integer

    実行中のインスタンス数。

    0
    Succeeded

    integer

    正常に実行されたインスタンス数。

    3
    Failed

    integer

    実行に失敗したインスタンス数。

    0
    StartTime

    integer

    ジョブが作成された時刻。

    1657522800
    CompletionTime

    integer

    ジョブが実行された時刻。

    1657522839
    Message

    string

    返されたメッセージ。次のルールに注意してください：

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

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

    success
    State

    string

    ジョブのステータス。有効な値：

    • 0：ジョブは実行されていません。

    • 1：ジョブは実行されました。

    • 2：ジョブの実行に失敗しました。

    • 3：ジョブは実行中です。

    1
    ErrorCode

    string

    返されたエラーコード。次のルールに注意してください：

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

    • リクエストが失敗した場合、ErrorCode が返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。

    Code

    string

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

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

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

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

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

    200
    Success

    boolean

    呼び出しが成功したかどうかを示します。有効な値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "53F15A18-8079-5992-810C-0211A5AE****",
  "Message": "success",
  "TraceId": "0b1639af16575057857241351e****",
  "Data": {
    "JobId": "event-b798157b-40a2-4388-b578-71fb897103**-**",
    "Active": 0,
    "Succeeded": 3,
    "Failed": 0,
    "StartTime": 1657522800,
    "CompletionTime": 1657522839,
    "Message": "success",
    "State": "1"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidAppId.NotFound The specified AppId does not exist.

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

    変更履歴

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