文档首页> 弹性伸缩 AS> API参考> API> 计划任务管理> 查询计划任务列表
更新时间：2023-11-08 GMT+08:00
查看PDF

查询计划任务列表

功能介绍

查询弹性伸缩计划任务。

URI

GET /autoscaling-api/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

scaling_group_id

是

String

伸缩组ID

limit

否

Integer

查询的记录条数

marker

否

String

查询的分页marker

请求参数

无

请求示例

查询计划任务列表。

GET https://{Endpoint}/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks

响应参数

表2 响应参数

参数

是否必选

参数类型

描述

page_info

否

Object

分页信息，请参见表3

scheduled_tasks

否

Array of objects

计划任务列表，请参见表4
表3 page_info字段数据结构说明

参数

是否必选

参数类型

描述

next_marker

否

String

下一页的marker
表4 scheduled_tasks字段数据结构说明

参数

是否必选

参数类型

描述

task_id

否

String

计划任务ID

scaling_group_id

否

String

伸缩组ID

name

否

String

计划任务名称

scheduled_policy

否

Object

计划任务策略，请参考表5

instance_number

否

Object

伸缩组实例数，请参考表6

create_time

否

String

创建时间

tenant_id

否

String

租户ID

domain_id

否

String

帐号ID

update_time

否

String

更新时间
表5 scheduled_policy字段数据结构说明

参数

是否必选

参数类型

描述

start_time

否

String

计划任务的生效开始时间。仅当recurrence_type不为空时生效，格式为yyyy-MM-dd'T'HH:mm'Z'，不填写时默认为任务创建成功的时间。

end_time

否

String

计划任务的生效结束时间。仅当recurrence_type不为空时生效且必选，格式为yyyy-MM-dd'T'HH:mm'Z'。

launch_time

是

String

计划任务的执行时间。采用UTC时间，当recurrence_type不填写或为空时,格式为yyyy-MM-dd'T'HH:mm'Z'，当recurrence_type不为空时，格式为HH:mm。

recurrence_type

否

String

不填写或为空时计划任务为定时执行，填写时计划任务为周期执行，且只能填写DAILY、WEEKLY、MONTHLY 中的一种，分别为按天、按周、按月周期执行。

recurrence_value

否

String

仅当recurrence_type为WEEKLY、MONTHLY时必选，表示周期执行的具体日期，多个日期用,分割，当recurrence_type为WEEKLY时，可填入1-7，当recurrence_type为MONTHLY时，可填入1-31。
表6 instance_number字段数据结构说明

参数

是否必选

参数类型

描述

max

否

Integer

伸缩组最大实例数

min

否

Integer

伸缩组最小实例数

desire

否

Integer

伸缩组期望实例数

响应示例

{
  "page_info": {
    "next_marker": "xxxx"
  },
  "scheduled_tasks": [
    {
      "task_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3",
      "name": "task_01",
      "scheduled_policy": {
        "start_time": "2016-01-0T17:31Z",
        "end_time": "2016-02-08T17:31Z",
        "launch_time": "17:00",
        "recurrence_type": "Daily"
      },
      "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a",
      "instance_number": {
        "max": 10
      }
    }
  ]
}

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求的页面访问禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证，这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突，请求无法被完成。

    500 Internal Server Error

    请求未完成，服务异常。

    501 Not Implemented

    请求未完成，服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成，服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成，系统暂时异常。

    504 Gateway Timeout

    网关超时。

错误码

请参考错误码。

父主题： 计划任务管理