すべてのプロダクト
Search

このプロダクト

    SchedulerX:GetJobInfo

    ドキュメントセンター

    SchedulerX:GetJobInfo

    最終更新日:Mar 23, 2026

    ジョブ ID を指定して、対象ジョブの詳細情報を照会します。取得した情報は、ほとんどの場合、ジョブの更新に使用されます。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    edas:ReadSchedulerxJobQuery

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    JobId

    integer

    必須

    ジョブ ID。SchedulerX コンソールの [タスク管理] ページで確認できます。

    92583
    GroupId

    string

    必須

    アプリケーション ID。SchedulerX コンソールの [アプリケーション管理] ページで確認できます。

    testSchedulerx.defaultGroup
    Namespace

    string

    必須

    名前空間 ID。SchedulerX コンソールの [名前空間] ページで確認できます。

    adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
    NamespaceSource

    string

    任意

    名前空間のソース。特殊なサードパーティ向けにのみ必須となるパラメーターです。

    schedulerx
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    JobName

    string

    任意

    ジョブ名。

    simpleJob

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    integer

    HTTP ステータスコード。

    200
    Message

    string

    エラー発生時に返されるエラーメッセージ。

    jobid: 92583 not match groupId: testSchedulerx.defaultGroup
    RequestId

    string

    リクエスト ID。

    4F68ABED-AC31-4412-9297-D9A8F0401108
    Success

    boolean

    ジョブの詳細情報が正常に取得できたかどうかを示します。有効な値：

    • true

    • false

    true
    Data

    object

    ジョブの詳細情報。

    JobConfigInfo

    object

    ジョブの構成情報。

    JobId

    integer

    ジョブ ID。

    538039
    Status

    integer

    ジョブが有効化されているかどうかを示します。有効な値：

    • 1: ジョブが有効化されており、トリガー可能です。

    • 0: ジョブが無効化されており、トリガーできません。

    1
    Parameters

    string

    ジョブ実行時に取得可能なユーザー定義パラメーター。

    test
    Description

    string

    ジョブの説明文。

    test
    ExecuteMode

    string

    ジョブの実行モード。有効な値：

    • スタンドアロン実行: standalone

    • ブロードキャスト実行: broadcast

    • ビジュアル MapReduce: parallel

    • MapReduce: batch

    • シャーディング実行: sharding

    standalone
    MaxConcurrency

    string

    同時実行インスタンス数の上限。デフォルト値：1。このデフォルト値は、直前にトリガーされたインスタンスが実行中の場合、次の実行時刻に達しても、次のインスタンスはトリガーされないことを意味します。

    1
    Name

    string

    ジョブ名。

    helloworld
    MaxAttempt

    integer

    ジョブ失敗後の最大再試行回数。ビジネス要件に基づいて設定します。デフォルト値：0。

    0
    Content

    string

    スクリプトジョブのスクリプト内容。

    echo "clear" > /home/admin/edas-container/logs/catalina.out

    JarUrl

    string

    Object Storage Service (OSS) へのファイルアップロードに使用する完全なパス。

    JAR パッケージを使用する場合は、この OSS パスへ JAR パッケージをアップロードできます。

    https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar
    ClassName

    string

    ジョブインタフェースクラスの完全なパス。ジョブタイプが Java の場合にのみ返されます。

    com.alibaba.test.helloword
    JobType

    string

    ジョブタイプ。

    java
    AttemptInterval

    integer

    ジョブ失敗後にシステムが再試行する間隔。デフォルト値：30。単位：秒。

    30
    MapTaskXAttrs

    object

    ジョブの詳細設定。

    TaskMaxAttempt

    integer

    タスク失敗後の再試行回数。

    0
    TaskAttemptInterval

    integer

    タスク失敗後にシステムが再試行する間隔。

    0
    ConsumerSize

    integer

    1 つのワーカーが一度に起動するスレッド数。デフォルト値：5。

    5
    QueueSize

    integer

    キューに入れられるタスクの最大数。デフォルト値：10000。

    10000
    DispatcherSize

    integer

    タスク配信スレッド数。デフォルト値：5。

    5
    PageSize

    integer

    並列ジョブが一度に取得するタスク数。デフォルト値：100。

    100
    TimeConfig

    object

    時間関連の構成情報。

    Calendar

    string

    TimeType が 1（cron）に設定されている場合に指定するカスタムカレンダー日付。

    工作日
    TimeType

    integer

    時間タイプ。有効な値：

    • 1: cron

    • 3: fix_rate

    • 4: second_delay

    • 5: one_time

    • 100: api

    1
    DataOffset

    integer

    TimeType が 1（cron）に設定されている場合に指定する時間オフセット。単位：秒。

    0
    TimeExpression

    string

    TimeType の値に応じて指定する時間式：

    • TimeType が 100（api）の場合、時間式は不要です。

    • TimeType が 3（fix_rate）の場合、このパラメーター値は特定の固定頻度を表します。たとえば値が 30 の場合、システムは 30 秒ごとにジョブをトリガーします。

    • TimeType が 1（cron）の場合、このパラメーター値はジョブの実行時刻を指定するために使用される標準 CRON 式です。

    • TimeType が 4（second_delay）の場合、このパラメーター値はジョブがトリガーされるまでの固定遅延を表します。有効範囲：1～60。単位：秒。

    0 0/10 * * * ?
    JobMonitorInfo

    object

    ジョブのモニタリング情報。

    ContactInfo

    array<object>

    アラート連絡先情報。

    object

    UserPhone

    string

    アラート連絡先の携帯電話番号。

    1381111****
    UserName

    string

    アラート連絡先の氏名。

    userA
    UserMail

    string

    アラート連絡先のメールアドレス。

    user@demo.com
    Ding

    string

    DingTalk チャットボットの Webhook  URL。

    https://oapi.dingtalk.com/robot/send?access_token=XXXXXX
    MonitorConfig

    object

    アラート機能およびアラートのしきい値の構成情報。

    Timeout

    integer

    タイムアウトしきい値。デフォルト値：7200。単位：秒。

    12300
    SendChannel

    string

    アラート送信に使用する方法。現在は Short Message Service (SMS) のみ対応しています。

    sms
    TimeoutKillEnable

    boolean

    タイムアウト終了スイッチが有効化されているかどうかを示します。デフォルトでは無効です。

    true
    TimeoutEnable

    boolean

    タイムアウトアラートスイッチが有効化されているかどうかを示します。有効な値：

    • true

    • false

    true
    FailEnable

    boolean

    失敗アラートスイッチが有効化されているかどうかを示します。有効な値：

    • true

    • false

    true
    MissWorkerEnable

    boolean

    利用可能なマシンがない場合のアラートスイッチが有効化されているかどうかを示します。

    true
    XAttrs

    string

    拡張フィールド。

    {"pageSize":5,"queueSize":10,"consumerSize":5,"dispatcherSize":5,"taskMaxAttempt":0,"taskAttemptInterval":0,"globalConsumerSize":1000,"taskDispatchMode":"push"}

    例

    成功レスポンス

    JSONJSON

    {
  "Code": 200,
  "Message": "jobid: 92583 not match groupId: testSchedulerx.defaultGroup",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "Data": {
    "JobConfigInfo": {
      "JobId": 538039,
      "Status": 1,
      "Parameters": "test",
      "Description": "test",
      "ExecuteMode": "standalone",
      "MaxConcurrency": "1",
      "Name": "helloworld",
      "MaxAttempt": 0,
      "Content": "echo \"clear\" > /home/admin/edas-container/logs/catalina.out ",
      "JarUrl": "https://test.oss-cn-hangzhou.aliyuncs.com/schedulerX/test.jar",
      "ClassName": "com.alibaba.test.helloword",
      "JobType": "java",
      "AttemptInterval": 30,
      "MapTaskXAttrs": {
        "TaskMaxAttempt": 0,
        "TaskAttemptInterval": 0,
        "ConsumerSize": 5,
        "QueueSize": 10000,
        "DispatcherSize": 5,
        "PageSize": 100
      },
      "TimeConfig": {
        "Calendar": "工作日",
        "TimeType": 1,
        "DataOffset": 0,
        "TimeExpression": "0 0/10 * * * ?"
      },
      "JobMonitorInfo": {
        "ContactInfo": [
          {
            "UserPhone": "1381111****",
            "UserName": "userA",
            "UserMail": "user@demo.com",
            "Ding": "https://oapi.dingtalk.com/robot/send?access_token=XXXXXX"
          }
        ],
        "MonitorConfig": {
          "Timeout": 12300,
          "SendChannel": "sms",
          "TimeoutKillEnable": true,
          "TimeoutEnable": true,
          "FailEnable": true,
          "MissWorkerEnable": true
        }
      },
      "XAttrs": "{\"pageSize\":5,\"queueSize\":10,\"consumerSize\":5,\"dispatcherSize\":5,\"taskMaxAttempt\":0,\"taskAttemptInterval\":0,\"globalConsumerSize\":1000,\"taskDispatchMode\":\"push\"}"
    }
  }
}

    エラーコード

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

    変更履歴

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