ClearLaunchConfigurationAttributes

Last updated: 2021-07-23 10:47:20

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ClearLaunchConfigurationAttributes.
Version Yes String Common parameter. The value used for this API: 2018-04-19.
Region Yes String Common parameter. 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.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Clearing data disk information of the launch configuration

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
InvalidParameterValue.InvalidLaunchConfigurationId Invalid launch configuration ID.