Last updated: 2020-09-04 09:46:46

1. API Description

Domain name for API request:

This API (DescribeScheduledActions) is used to query the details of one or more scheduled tasks.

  • You can query the details of scheduled tasks based on information such as scheduled task ID, scheduled task name, or auto scaling group ID. For more information on filters, see Filter.
  • If the parameter is empty, a certain number (specified by Limit and 20 by default) of scheduled tasks of the current user will be returned.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeScheduledActions.
Version Yes String Common parameter. The value used for this API: 2018-04-19.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ScheduledActionIds.N No Array of String Queries by one or more scheduled task IDs in the format of asst-am691zxo. The maximum number of instances per request is 100. This parameter does not support specifying both ScheduledActionIdsandFilters` at the same time.
Filters.N No Array of Filter Filter.
  • scheduled-action-id - String - Required: No - (Filter) Filter by scheduled task ID.
  • scheduled-action-name - String - Required: No - (Filter) Filter by scheduled task name.
  • auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.
  • Offset No Integer Offset. Default value: 0. For more information on Offset, see the relevant section in the API overview.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in the API overview.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible scheduled tasks.
    ScheduledActionSet Array of ScheduledAction List of scheduled task details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a scheduled action

    Input Example
    &<Common request parameters>

    Output Example

      "Response": {
        "RequestId": "cc207181-288d-4a39-a1d1-63a5e1ba1d2b",
        "TotalCount": 1,
        "ScheduledActionSet": [
            "ScheduledActionId": "asst-caa5ha40",
            "ScheduledActionName": "testv2-0",
            "AutoScalingGroupId": "asg-2nr9xh8h",
            "StartTime": "2018-09-28T00:00:00+08:00",
            "Recurrence": "0 0 * * *",
            "EndTime": "2018-09-28T23:59:59+08:00",
            "MaxSize": 10,
            "DesiredCapacity": 0,
            "MinSize": 0,
            "CreatedTime": "2018-09-24T07:41:54Z"

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.Filter Invalid filter.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback