DescribeLaunchConfigurations

Last updated: 2019-07-16 18:55:08

1. API Description

API request domain name: as.tencentcloudapi.com.

This API (DescribeLaunchConfigurations) describes one or more launch configurations.

  • You can query the launch configuration details based on information such as launch configuration ID and name. For more information about filters, see Filter.
  • If the parameter is empty, a number (same as the Limit. The default is 20) of launch configurations will be returned.

Default API request frequency limit: 10 times/second.

Note: Because financial availability zones and non-financial availability zones are isolated. When specifying a financial availability zone (e.g., ap-shanghai-fsi) in the Region (a common parameter), you should also choose the financial availability zone preferably in the same region as that one specified in Region for the domain, such as as.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following list of request parameters lists only the API request parameters and some common parameters. For the complete list of common parameters, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: DescribeLaunchConfigurations
Version Yes String Common parameter; the version of this API: 2018-04-19
Region Yes String Common parameters; for details, see the Region List.
LaunchConfigurationIds.N No Array of String Query by one or more launch configuration IDs. Launch configuration ID example: asc-ouy1ax38. The upper limit per request is 100. The parameter does not support specifying both LaunchConfigurationIds and Filters at the same time.
Filters.N No Array of Filter Filter.
  • launch-configuration-id - String - Required: No - (Filter) Filter by launch configuration ID.
  • launch-configuration-name - String - Required: No - (Filter) Filter by launch configuration name.

  • The maximum number of Filters per request is 10. The upper limit for Filter.Values is 5. The parameter does not support specifying both LaunchConfigurationIds and Filters at the same time.
    Limit No Integer Number of returned results, 20 by default, up to 100. For more information about Limit, see the relevant section in the API overview.
    Offset No Integer Offset, 0 by default. For more information about Offset, see the relevant section in the API overview.

    3. Output Parameters

    Parameter name Type Description
    TotalCount Integer Number of eligible launch configurations.
    LaunchConfigurationSet Array of LaunchConfiguration List of launch configuration details.
    RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues

    4. Sample

    Using Filters to View the Launch Configuration List

    Input Sample Code

    https://as.tencentcloudapi.com/?Action=DescribeLaunchConfigurations
    &Filters.0.Name=launch-configuration-id
    &Filters.0.Values.0=asc-l7rduvv0
    &<Common request parameter>

    Output Sample Code

    {
        "Response": {
            "TotalCount": 1,
            "LaunchConfigurationSet": [
                {
                    "ProjectId": 0,
                    "LaunchConfigurationId": "asc-l7rduvv0",
                    "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"
                }
            ],
            "RequestId": "15f9582f-72ff-4b5f-91b6-ff905782391b"
        }
    }

    Querying Launch Configuration List by Launch Configuration ID

    Input Sample Code

    https://as.tencentcloudapi.com/?Action=DescribeLaunchConfigurations
    &LaunchConfigurationIds.0=asc-l7rduvv0
    &LaunchConfigurationIds.1=asc-2ejax3t8
    &<Common request parameter>

    Output Sample Code

    {
        "Response": {
            "TotalCount": 2,
            "LaunchConfigurationSet": [
                {
                    "ProjectId": 0,
                    "LaunchConfigurationId": "asc-2ejax3t8",
                    "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"
                },
                {
                    "ProjectId": 0,
                    "LaunchConfigurationId": "asc-l7rduvv0",
                    "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"
                }
            ],
            "RequestId": "f7dd68bc-d5e3-4a43-92a5-bde6d8fe9bd4"
        }
    }

    5. Developer Resources

    API Explorer

    This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

    SDK

    TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

    TCCLI

    6. Error Codes

    The following error codes are API business logic-related. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidFilter Invalid filter.
    InvalidLaunchConfiguration Invalid launch configuration.
    InvalidLaunchConfigurationId The launch configuration ID is invalid.
    InvalidParameterConflict Parameters that cannot co-exist were specified.
    InvalidPermission The account does not support this operation.