tencent cloud

APIs

DocumentaçãoAPIsAuto ScalingLaunch Configuration APIsClearLaunchConfigurationAttributes

ClearLaunchConfigurationAttributes

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-03 21:01:32

1. API Description

Domain name for API request: as.intl.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. Obtain it in the following ways:

  • Log in to the console and query the launch configuration ID.
  • Call the API DescribeLaunchConfigurations and obtain the launch configuration ID from the LaunchConfigurationId in the returned information.
    		•
    ClearDataDisks No Boolean

    Whether to clear data disk information. This parameter is optional and defaults to false.
    Enter true to clear "data disk" information. After clearing, newly created CVMs will not contain any data disk.
    ClearHostNameSettings No Boolean

    Whether to clear the MachineName-related settings of the CVM. Optional. It is false by default.
    Set to true to clear the host name settings. After clearing, newly created CVMs will not have a host name configured.
    ClearInstanceNameSettings No Boolean

    Whether to clear the CVM instance name related settings. This parameter is optional and is false by default.
    If set to true, the host name setting information is cleared. After clearing, newly created CVMs will be configured based on "as-{{ scaling group AutoScalingGroupName }}".
    ClearDisasterRecoverGroupIds No Boolean

    Whether to clear the placement group information. This parameter is optional and defaults to false.
    Set it to true to clear the placement group information. After clearing, newly created hosts will not be assigned to any placement group.
    ClearInstanceTags No Boolean

    Whether to clear the instance tag list. This parameter is optional and is false by default.
    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.
    ClearMetadata No Boolean

    Whether to clear MetaData. This parameter is optional and defaults to false. Enter true to clear MetaData. After clearing, newly created CVMs will not associate custom Metadata.
    ClearNetworkInterfaces No Boolean

    Whether to clear the NetworkInterfaces in the launch configuration. If the value is TRUE, clear it; if not passed or FALSE, this field will not be processed.

    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.intl.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.
    Anterior: UpgradeLaunchConfigurationPróximo: ModifyScheduledAction

    Ajuda e Suporte

    Esta página foi útil?

    comentários

    Search
      Enter keywords to search documentation