tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRefreshActivities

Last updated: 2024-10-25 15:17:05

1. API Description

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

This API (DescribeRefreshActivities) is used to query the instance refresh activity records of a scaling group.

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: DescribeRefreshActivities.
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.
RefreshActivityIds.N No Array of String List of refresh activity IDs. IDs are formatted like: 'asr-5l2ejpfo'. The upper limit per request is 100. Parameters do not support specifying both RefreshActivityIds and Filters simultaneously.
Filters.N No Array of Filter Filtering conditions.
  • auto-scaling-group-id - String - Required or not: No - (Filtering conditions) Filters by scaling group ID.
  • refresh-activity-status-code - String - Required or not: No - (Filtering conditions) Filters by refresh activity status. (INIT: Initializing. | RUNNING: In progress. | SUCCESSFUL: Activity successful. | FAILED_PAUSE: Failed paused. | AUTO_PAUSE: Automatic pause. | MANUAL_PAUSE: Manual pause. | CANCELLED: Activity canceled. | FAILED: Activity failed.)
  • refresh-activity-type - String - Required or not: No - (Filtering conditions) Filters by refresh activity type. (NORMAL: Normal refresh activity. | ROLLBACK: Rollback refresh activity.)
  • refresh-activity-id - String - Required or not: No - (Filtering conditions) Filters by refresh activity ID.
  • The maximum limit for Filters per request is 10, and the upper limit for Filter.Values is 5. Parameters do not support specifying both RefreshActivityIds and Filters simultaneously.
    		•
    Limit No Integer Number of returned pieces. Default value: 20. Maximum value: 100. For further information on Limit, please refer to relevant sections in API [Overview] (https://www.tencentcloud.com/document/api/213/15688?from_cn_redirect=1).
    Offset No Integer Offset, 0 by default. For further information on Offset, please refer to relevant sections in API [Overview] (https://www.tencentcloud.com/document/api/213/15688?from_cn_redirect=1).

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of refresh activities that meet the conditions.
    RefreshActivitySet Array of RefreshActivity A collection of information about refresh activities that meet the conditions.
    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 Viewing List of Refresh Activities Using Filters

    This example shows you how to query the details of refresh activity asr-cs0fxpcu using Filters.

    Input Example

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRefreshActivities
<Common request parameters>
{
    "Filters": [
        {
            "Name": "refresh-activity-id",
            "Values": [
                "asr-cs0fxpcu"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "RefreshActivitySet": [
            {
                "Status": "SUCCESSFUL",
                "RefreshBatchSet": [
                    {
                        "RefreshBatchNum": 3,
                        "EndTime": "2023-09-07T16:32:56Z",
                        "RefreshBatchRelatedInstanceSet": [
                            {
                                "InstanceId": "ins-w188n53l",
                                "InstanceStatusMessage": "success",
                                "LastActivityId": "asa-pb2y1bna",
                                "InstanceStatus": "SUCCESSFUL"
                            }
                        ],
                        "StartTime": "2023-09-07T16:31:44Z",
                        "RefreshBatchStatus": "SUCCESSFUL"
                    },
                    {
                        "RefreshBatchNum": 2,
                        "EndTime": "2023-09-07T16:31:44Z",
                        "RefreshBatchRelatedInstanceSet": [
                            {
                                "InstanceId": "ins-w1824wre",
                                "InstanceStatusMessage": "success",
                                "LastActivityId": "asa-e8dqz8r6",
                                "InstanceStatus": "SUCCESSFUL"
                            },
                            {
                                "InstanceId": "ins-w188n53m",
                                "InstanceStatusMessage": "success",
                                "LastActivityId": "asa-e8dqz8r6",
                                "InstanceStatus": "SUCCESSFUL"
                            }
                        ],
                        "StartTime": "2023-09-07T16:29:56Z",
                        "RefreshBatchStatus": "SUCCESSFUL"
                    },
                    {
                        "RefreshBatchNum": 1,
                        "EndTime": "2023-09-07T16:29:55Z",
                        "RefreshBatchRelatedInstanceSet": [
                            {
                                "InstanceId": "ins-w188n53k",
                                "InstanceStatusMessage": "success",
                                "LastActivityId": "asa-e0o3uxsu",
                                "InstanceStatus": "SUCCESSFUL"
                            },
                            {
                                "InstanceId": "ins-w188n53n",
                                "InstanceStatusMessage": "success",
                                "LastActivityId": "asa-e0o3uxsu",
                                "InstanceStatus": "SUCCESSFUL"
                            }
                        ],
                        "StartTime": "2023-09-07T16:27:49Z",
                        "RefreshBatchStatus": "SUCCESSFUL"
                    }
                ],
                "RefreshMode": "ROLLING_UPDATE_RESET",
                "AutoScalingGroupId": "asg-kgujlegg",
                "ActivityType": "NORMAL",
                "RefreshSettings": {
                    "CheckInstanceTargetHealth": true,
                    "RollingUpdateSettings": {
                        "BatchNumber": 3,
                        "BatchPause": "AUTOMATIC"
                    }
                },
                "OriginRefreshActivityId": "",
                "CurrentRefreshBatchNum": 3,
                "RefreshActivityId": "asr-cs0fxpcu",
                "StartTime": "2023-09-07T16:27:49Z",
                "CreatedTime": "2023-09-07T16:27:49Z",
                "EndTime": "2023-09-07T16:32:56Z"
            }
        ],
        "RequestId": "48869660-f1df-4085-a62c-1f9636cbe030"
    }
}

    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.LimitExceeded The value exceeds the limit.
    LimitExceeded.FilterValuesTooLong Too many values for the specified filter
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy