Tenant Cloud Compute Auto Scaling Lifecycle Hook APIs DescribeLifecycleHooks

DescribeLifecycleHooks

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

1. Interface Description

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

This API (DescribeLifecycleHooks) is used to query the information about lifecycle hooks.

  • You can query the details of lifecycle hooks based on information such as the scaling group ID, lifecycle hook ID, or lifecycle hook name. 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 lifecycle hooks that belong to the current user will be returned.

Default interface request rate limit: 20 times per second.

Interface update time: 2019-10-31 18:30:12.

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: DescribeLifecycleHooks
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
LifecycleHookIds No No Array of String ID of one or more lifecycle hooks to query, such as ash-8azjzxcl. You can specify a maximum of 100 scaling activity IDs in each request. LifecycleHookIds and Filters cannot be specified at the same time.
Example: ["ash-8azjzxcl"]
Filters No No Array of Filter Filter conditions.
  •  lifecycle-hook-id - String - Required: No - (Filter condition) Filter by lifecycle hook ID.
  •  lifecycle-hook-name - String - Required: No - (Filter condition) Filter by lifecycle hook name.
  •  auto-scaling-group-id - String - Required: No - (Filter condition) Filter by scaling group ID.
    • Filter conditions.
  •  lifecycle-hook-id - String - Required: No - (Filter condition) Filter by lifecycle hook ID.
  •  lifecycle-hook-name - String - Required: No - (Filter condition) Filter by lifecycle hook name.
  •  auto-scaling-group-id - String - Required: No - (Filter condition) Filter by scaling group ID.
    • The maximum number of Filters per request is 10. The upper limit for Filter.Values is 5. LifecycleHookIds and Filters cannot be specified at the same time.
    Example:View
    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: 1
    Offset No No Uint64 Offset. Default value: 0. For more information on Offset, see the relevant section in API Introduction.
    Example: 0

    3. Output Parameters

    Parameter name Type Description
    LifecycleHookSet Array of LifecycleHook Array of lifecycle hooks.
    Example:View
    TotalCount Int64 Total number.
    Example: 4
    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.
    InvalidParameter Parameter error.
    MissingParameter Parameter missing.
    InvalidFilter Invalid filter.
    InternalError Internal error.