清除启动配置属性

最近更新时间:2024-08-08 01:10:11

我的收藏

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(ClearLaunchConfigurationAttributes)用于将启动配置内的特定属性完全清空。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ClearLaunchConfigurationAttributes。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
LaunchConfigurationId String 启动配置ID。
示例值:asc-aaaabbbb
ClearDataDisks Boolean 是否清空数据盘信息,非必填,默认为 false。
填 true 代表清空“数据盘”信息,清空后基于此新创建的云主机将不含有任何数据盘。
示例值:false
ClearHostNameSettings Boolean 是否清空云服务器主机名相关设置信息,非必填,默认为 false。
填 true 代表清空主机名设置信息,清空后基于此新创建的云主机将不设置主机名。
示例值:false
ClearInstanceNameSettings Boolean 是否清空云服务器实例名相关设置信息,非必填,默认为 false。
填 true 代表清空主机名设置信息,清空后基于此新创建的云主机将按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置。
示例值:false
ClearDisasterRecoverGroupIds Boolean 是否清空置放群组信息,非必填,默认为 false。
填 true 代表清空置放群组信息,清空后基于此新创建的云主机将不指定任何置放群组。
示例值:false
ClearInstanceTags Boolean 是否清空实例标签列表,非必填,默认为 false。
填 true 代表清空实例标签列表,清空后基于此新创建的云主机将不会绑定列表中的标签。
示例值:false

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 清空启动配置中的数据盘项

指定启动配置asc-kr4beurf,入参ClearDataDisks设置为true,接口调用后启动配置中的数据盘信息被清空,后续基于asc-kr4beurf创建的云主机将不再分配任何数据盘

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ClearLaunchConfigurationAttributes
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameter.ActionNotFound 无效的Action请求。
InvalidParameterValue.InvalidLaunchConfigurationId 启动配置ID无效。