Tenant Cloud Compute Auto Scaling Scheduled Task APIs DescribeScheduledActions

DescribeScheduledActions

Last Updated At: 2026-08-02 00:05:30

1. Interface Description

Interface request domain name: as.api3.convergecloud.com.

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

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

Default interface request rate limit: 20 times per second.

Interface update time: 2019-11-01 11:11:22.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeScheduledActions
Version Yes No String Public parameter, The value of this interface: 2018-04-19
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
ScheduledActionIds No No Array of String ID of one or more scheduled tasks, such as asst-am691zxo. You can specify a maximum of 100 instance IDs in each request. ScheduledActionIds and Filters cannot be specified at the same time.
Example: ["asst-caa5ha40"]
Filters No No Array of Filter Filter conditions.
  •  scheduled-action-id - String - Required: No - (Filter condition) Filter by scheduled task ID.
  •  scheduled-action-name - String - Required: No - (Filter condition) Filter by scheduled task name.
  •  auto-scaling-group-id - String - Required: No - (Filter condition) Filter by scaling group ID.

    • Example:View
    Offset No No Uint64 Offset. Default value: 0. For more information on Offset, see the relevant section in API introduction.
    Example: 0
    Limit No No Uint64 Number of returned items. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in API Introduction.
    Example: 20

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of scheduled tasks that meet the specified conditions.
    Example: 1
    ScheduledActionSet Array of ScheduledAction Details of scheduled tasks.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

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