すべてのプロダクト
Search

このプロダクト

    Auto Scaling:DescribeScheduledTasks

    ドキュメントセンター

    Auto Scaling:DescribeScheduledTasks

    最終更新日:Nov 02, 2026

    定期タスクの詳細をクエリします。定期タスクは、指定された時間に指定されたスケーリングルールを実行して、コンピュートリソースの自動スケールアウトおよびスケールインを実現するプリセットノードです。定期タスクの作成後、DescribeScheduledTasks API オペレーションを呼び出して、トリガー時間、定期タスクの総数、定期タスクを実行するスケーリンググループの ID などの詳細をクエリできます。

    操作説明

    操作の説明

    定期タスク 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ess:DescribeScheduledTasks

    get

    *ScalingGroup

    acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    定期タスクが属するスケーリンググループのリージョン ID。

    cn-qingdao
    PageNumber

    integer

    任意

    定期タスクリストのページ番号。ページは 1 から始まります。

    デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページングクエリにおける 1 ページあたりのエントリ数のページング設定項目。最大値: 50。

    デフォルト値: 10。

    50
    ScalingGroupId

    string

    任意

    定期タスクを実行するスケーリンググループの ID。

    asg-bp1bo5tca4m56nap****
    ScheduledAction

    array

    任意

    定期タスクがトリガーされたときに実行されるスケーリングルール。このパラメーターは、定期タスクにスケーリングルールが指定されている場合にのみ有効です。

    ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****

    string

    任意

    定期タスクがトリガーされたときに実行されるスケーリングルール。このパラメーターは、定期タスクにスケーリングルールが指定されている場合にのみ有効です。N の有効な値: 0 ~ 20。

    値をスケーリングルールの一意な識別子 (ScalingRuleAri) に設定します。

    ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****
    ScheduledTaskId

    array

    任意

    照会する定期タスクの ID。

    edRtShc57WGXdt8TlPbr****

    string

    任意

    照会する定期タスクの ID。N の有効な値: 1 ~ 20。

    edRtShc57WGXdt8TlPbr****
    ScheduledTaskName

    array

    任意

    照会する定期タスクの名前。

    scheduled****

    string

    任意

    照会する定期タスクの名前。N の有効な値: 1 ~ 20。

    scheduled****
    TaskName

    string

    任意

    タスクの名前。キーワードによるあいまい検索がサポートされています。

    scheduled****
    RecurrenceType

    string

    任意

    定期タスクの繰り返し頻度のタイプ。有効な値:

    • Daily: 定期タスクは、指定された日数に 1 回実行されます。

    • Weekly: 定期タスクは、毎週の指定された曜日に実行されます。

    • Monthly: 定期タスクは、毎月の指定された日に実行されます。

    • Cron: 定期タスクは、指定された cron 式に基づいて実行されます。

    Weekly
    RecurrenceValue

    string

    任意

    定期タスクの繰り返し頻度の値。

    このパラメーターは、RecurrenceType が Weekly に設定されている場合にのみサポートされます。複数の値を指定し、コンマ (,) で区切ることができます。たとえば、日曜日、月曜日、火曜日、水曜日、木曜日、金曜日、土曜日の値はそれぞれ 0、1、2、3、4、5、6 です。

    1,2,3
    TaskEnabled

    boolean

    任意

    定期タスクが開始されているかどうかを指定します。有効な値:

    • true: タスクが開始されています。

    • false: タスクが停止されています。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageNumber

    integer

    現在のページ番号。

    1
    PageSize

    integer

    1 ページあたりに返されるエントリ数。

    50
    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    ScheduledTasks

    object

    ScheduledTask

    array<object>

    定期タスクの詳細。

    array<object>

    定期タスクの詳細。

    Description

    string

    定期タスクの説明。

    Test scheduled task.
    DesiredCapacity

    integer

    スケーリンググループ内の予想されるインスタンス数。このパラメーターは、定期タスクのスケーリングメソッドが [スケーリンググループ内のインスタンス数の設定] にセットされている場合に指定されます。

    10
    LaunchExpirationTime

    integer

    定期タスクのトリガーに失敗した後にリトライが実行される期間。単位: 秒。有効な値: 0 ~ 21600。

    600
    LaunchTime

    string

    定期タスクがトリガーされる時間。時間は協定世界時 (UTC) で表示され、YYYY-MM-DDThh:mmZ フォーマットの ISO 8601 標準に従います。

    2014-08-18T10:52Z
    MaxValue

    integer

    スケーリンググループ内のインスタンスの最大値。このパラメーターは、定期タスクのスケーリングメソッドが [スケーリンググループ内のインスタンス数の設定] にセットされている場合に指定されます。

    10
    MinValue

    integer

    スケーリンググループ内のインスタンスの最小値。このパラメーターは、定期タスクのスケーリングメソッドが [スケーリンググループ内のインスタンス数の設定] にセットされている場合に指定されます。

    0
    RecurrenceEndTime

    string

    繰り返し定期タスクの終了時間。時間は協定世界時 (UTC) で表示され、YYYY-MM-DDThh:mmZ フォーマットの ISO 8601 標準に従います。

    2014-08-20T16:55Z
    RecurrenceType

    string

    定期タスクの繰り返し頻度のタイプ。

    Daily
    RecurrenceValue

    string

    定期タスクの繰り返し頻度の値。

    1
    ScalingGroupId

    string

    定期タスクを実行するスケーリンググループの ID。

    asg-bp1bo5tca4m56nap****
    ScheduledAction

    string

    定期タスクがトリガーされたときに実行されるスケーリングルール。このパラメーターは、定期タスクにスケーリングルールが指定されている場合にのみ返されます。

    ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****
    ScheduledTaskId

    string

    定期タスクの ID。

    edRtShc57WGXdt8TlPbr****
    ScheduledTaskName

    string

    定期タスクの名前。

    scheduled****
    TaskEnabled

    boolean

    定期タスクが開始されているかどうかを指定します。有効な値:

    • true: タスクが開始されています。

    • false: タスクが停止されています。

    デフォルト値: true。

    true
    WarmPoolCapacityOptions

    object

    スケーリンググループのウォームプール容量設定。

    DesiredGroupPreparedCapacity

    integer

    準備済みインスタンスの予想数。

    5
    MinCapacity

    integer

    ウォームプール内のインスタンスの最小値。

    0
    TotalCount

    integer

    定期タスクの総数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ScheduledTasks": {
    "ScheduledTask": [
      {
        "Description": "Test scheduled task.",
        "DesiredCapacity": 10,
        "LaunchExpirationTime": 600,
        "LaunchTime": "2014-08-18T10:52Z",
        "MaxValue": 10,
        "MinValue": 0,
        "RecurrenceEndTime": "2014-08-20T16:55Z",
        "RecurrenceType": "Daily",
        "RecurrenceValue": "1",
        "ScalingGroupId": "asg-bp1bo5tca4m56nap****",
        "ScheduledAction": "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****",
        "ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
        "ScheduledTaskName": "scheduled****",
        "TaskEnabled": true,
        "WarmPoolCapacityOptions": {
          "DesiredGroupPreparedCapacity": 5,
          "MinCapacity": 0
        }
      }
    ]
  },
  "TotalCount": 1
}

    エラーコード

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

    変更履歴

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