1. 接口描述
接口请求域名: as.tencentcloudapi.com 。
本接口(DescribeLaunchConfigurations)用于查询启动配置的信息。
- 可以根据启动配置ID、启动配置名称等信息来查询启动配置的详细信息。过滤信息详细请见过滤器
Filter
。 - 如果参数为空,返回当前用户一定数量(
Limit
所指定的数量,默认为20)的启动配置。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLaunchConfigurations。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LaunchConfigurationIds.N | 否 | Array of String | 按照一个或者多个启动配置ID查询。启动配置ID形如:asc-ouy1ax38 。每次请求的上限为100。参数不支持同时指定LaunchConfigurationIds 和Filters |
Filters.N | 否 | Array of Filter | 过滤条件。 每次请求的 Filters 的上限为10,Filter.Values 的上限为5。参数不支持同时指定LaunchConfigurationIds 和Filters 。 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的启动配置数量。 |
LaunchConfigurationSet | Array of LaunchConfiguration | 启动配置详细信息列表。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用Filters查看启动配置列表。
输入示例
https://as.tencentcloudapi.com/?Action=DescribeLaunchConfigurations
&Filters.0.Name=launch-configuration-id
&Filters.0.Values.0=asc-l7rduvv0
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"LaunchConfigurationSet": [
{
"ProjectId": 0,
"LaunchConfigurationId": "asc-l7rduvv0",
"VersionNumber": 1,
"LaunchConfigurationName": "lc2",
"AutoScalingGroupAbstractSet": [],
"InstanceType": "S2.SMALL2",
"InstanceTypes": [
"S2.SMALL2"
],
"InstanceChargeType": "POSTPAID_BY_HOUR",
"InstanceMarketOptions": null,
"SystemDisk": {
"DiskType": "LOCAL_BASIC",
"DiskSize": 50
},
"DataDisks": [
{
"DiskType": "LOCAL_BASIC",
"DiskSize": 50
}
],
"LoginSettings": {
"KeyIds": []
},
"InternetAccessible": {
"InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 1,
"PublicIpAssigned": true
},
"SecurityGroupIds": [],
"EnhancedService": {
"SecurityService": {
"Enabled": true
},
"MonitorService": {
"Enabled": true
}
},
"UserData": null,
"CreatedTime": "2018-05-03T03:23:10Z",
"UpdatedTime": "2018-05-03T03:23:10Z"
}
],
"RequestId": "15f9582f-72ff-4b5f-91b6-ff905782391b"
}
}
示例2 根据启动配置ID查询启动配置列表
输入示例
https://as.tencentcloudapi.com/?Action=DescribeLaunchConfigurations
&LaunchConfigurationIds.0=asc-l7rduvv0
&LaunchConfigurationIds.1=asc-2ejax3t8
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 2,
"LaunchConfigurationSet": [
{
"ProjectId": 0,
"LaunchConfigurationId": "asc-2ejax3t8",
"VersionNumber": 1,
"LaunchConfigurationName": "lc1",
"AutoScalingGroupAbstractSet": [],
"InstanceType": "D1.2XLARGE32",
"InstanceTypes": [
"D1.2XLARGE32"
],
"InstanceChargeType": "POSTPAID_BY_HOUR",
"InstanceMarketOptions": null,
"SystemDisk": {
"DiskType": "LOCAL_BASIC",
"DiskSize": 50
},
"DataDisks": [],
"LoginSettings": {
"KeyIds": []
},
"InternetAccessible": {
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 0,
"PublicIpAssigned": false
},
"SecurityGroupIds": [],
"EnhancedService": {
"SecurityService": {
"Enabled": true
},
"MonitorService": {
"Enabled": true
}
},
"UserData": null,
"CreatedTime": "2018-05-03T06:37:48Z",
"UpdatedTime": "2018-05-03T06:37:48Z"
},
{
"ProjectId": 0,
"LaunchConfigurationId": "asc-l7rduvv0",
"VersionNumber": 1,
"LaunchConfigurationName": "lc2",
"AutoScalingGroupAbstractSet": [],
"InstanceType": "S2.SMALL2",
"InstanceTypes": [
"S2.SMALL2"
],
"InstanceChargeType": "POSTPAID_BY_HOUR",
"InstanceMarketOptions": null,
"SystemDisk": {
"DiskType": "LOCAL_BASIC",
"DiskSize": 50
},
"DataDisks": [
{
"DiskType": "LOCAL_BASIC",
"DiskSize": 50
}
],
"LoginSettings": {
"KeyIds": []
},
"InternetAccessible": {
"InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 1,
"PublicIpAssigned": true
},
"SecurityGroupIds": [],
"EnhancedService": {
"SecurityService": {
"Enabled": true
},
"MonitorService": {
"Enabled": true
}
},
"UserData": null,
"CreatedTime": "2018-05-03T03:23:10Z",
"UpdatedTime": "2018-05-03T03:23:10Z"
}
],
"RequestId": "f7dd68bc-d5e3-4a43-92a5-bde6d8fe9bd4"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidLaunchConfiguration | 无效的启动配置。 |
InvalidLaunchConfigurationId | 启动配置ID无效。 |
InvalidParameterConflict | 指定的两个参数冲突,不能同时存在。 |
InvalidParameterValue.InvalidFilter | 过滤条件无效。 |
InvalidParameterValue.InvalidLaunchConfigurationId | 启动配置ID无效。 |
InvalidPermission | 账户不支持该操作。 |