查询启动配置

最近更新时间: 2026-09-17 00:04:45

1. 接口描述

接口请求域名: as.api3.fincloud.tencent.cn。

本接口(DescribeLaunchConfigurations)用于查询启动配置的信息。

  • 可以根据启动配置ID、启动配置名称等信息来查询启动配置的详细信息。过滤信息详细请见过滤器Filter
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的启动配置。

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

接口更新时间:2019-10-31 17:06:10。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeLaunchConfigurations
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
LaunchConfigurationIds Array of String 按照一个或者多个启动配置ID查询。启动配置ID形如:asc-ouy1ax38。每次请求的上限为100。参数不支持同时指定LaunchConfigurationIdsFilters
示例值: ["asc-fa28v4in"]
Filters Array of Filter 过滤条件。
  •  launch-configuration-id - String - 是否必填:否 -(过滤条件)按照启动配置ID过滤。
  •  launch-configuration-name - String - 是否必填:否 -(过滤条件)按照启动配置名称过滤。
  • 每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定LaunchConfigurationIdsFilters
    示例值:查看
    Limit Uint64 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值: 20
    Offset Uint64 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值: 0

    3. 输出参数

    参数名称 类型 描述
    TotalCount Uint64 符合条件的启动配置数量。
    示例值: 1
    LaunchConfigurationSet Array of LaunchConfiguration 启动配置详细信息列表。
    示例值:查看
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InvalidLaunchConfigurationId 启动配置ID无效。
    InvalidPermission 账户不支持该操作。
    InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
    InvalidFilter 无效的过滤器。
    InvalidLaunchConfiguration 无效的启动配置。

    5. 示例

    示例1 使用Filters查看启动配置列表。

    输入示例

    https://as.api3.fincloud.tencent.cn/?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.api3.fincloud.tencent.cn/?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"
        }
    }