tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeScheduledActions

Last updated: 2024-10-25 15:15:51

    1. API Description

    Domain name for API request: as.tencentcloudapi.com.

    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.

    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 Params. The value used for this API: DescribeScheduledActions.
    Version Yes String Common Params. The value used for this API: 2018-04-19.
    Region Yes String Common Params. 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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying scheduled actions

    Input Example

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScheduledActions
<Common request parameters>

{
    "ScheduledActionIds": [
        "asst-caa5ha40"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "cc207181-288d-4a39-a1d1-63a5e1ba1d2b",
        "TotalCount": 1,
        "ScheduledActionSet": [
            {
                "ScheduledActionId": "asst-jf898dps",
                "ScheduledActionName": "test",
                "AutoScalingGroupId": "asg-keqt9eg1",
                "StartTime": "2022-02-22T16:00:00+08:00",
                "Recurrence": "0 0 * * *",
                "EndTime": "2024-02-22T16:00:00+08:00",
                "MaxSize": 15,
                "DesiredCapacity": 1,
                "MinSize": 1,
                "CreatedTime": "2022-02-21T02:19:52Z",
                "ScheduledType": "CRONTAB"
            }
        ]
    }
}

    5. Developer Resources

    SDK

    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 An internal error occurred.
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.Filter Invalid filter.
    InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
    InvalidParameterValue.InvalidFilter Invalid filter condition.
    InvalidParameterValue.InvalidScheduledActionId Invalid scheduled action ID.
    ResourceNotFound.ScheduledActionNotFound The specified scheduled task does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy