tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ClearLaunchConfigurationAttributes

Last updated: 2024-10-25 15:16:59

    1. API Description

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

    This API is used to clear specific attributes of the launch configuration.

    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: ClearLaunchConfigurationAttributes.
    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.
    LaunchConfigurationId Yes String Launch configuration ID
    ClearDataDisks No Boolean Whether to clear data disk information. This parameter is optional and the default value is false.
    Setting it to true will clear data disks, which means that CVM newly created on this launch configuration will have no data disk.
    ClearHostNameSettings No Boolean Whether to clear the CVM hostname settings. This parameter is optional and the default value is false.
    Setting it to true will clear the hostname settings, which means that CVM newly created on this launch configuration will have no hostname.
    ClearInstanceNameSettings No Boolean Whether to clear the CVM instance name settings. This parameter is optional and the default value is false.
    Setting it to true will clear the instance name settings, which means that CVM newly created on this launch configuration will be named in the “as-{{AutoScalingGroupName}} format.
    ClearDisasterRecoverGroupIds No Boolean Whether to clear placement group information. This parameter is optional. Default value: false.
    True means clearing placement group information. After that, no placement groups are specified for CVMs created based on the information.
    ClearInstanceTags No Boolean Whether to clear the instance tag list. This parameter is optional, and its default value is false.
    If true is filled in, it indicates that the instance tag list should be cleared. After the list is cleared, the CVMs created based on this will not be bound to the tags in the list.

    3. Output Parameters

    Parameter Name Type Description
    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 Clearing data disk information of the launch configuration

    The following example clears the data disks of the launch configuration asc-kr4beurf. And do not assign data disks to CVMs created by using asc-kr4beurf.

    Input Example

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

{
    "LaunchConfigurationId": "asc-kr4beurf",
    "ClearDataDisks": true
}

    Output Example

    {
    "Response": {
        "RequestId": "382c6cad-15ae-496a-a965-66b95674f5a7"
    }
}

    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
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameterValue.InvalidLaunchConfigurationId Invalid launch configuration ID.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy