tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Virtual Machine
    Documentation
    Download PDF

    DescribeLaunchTemplates

    Last updated: 2024-11-27 10:20:10
    Download PDF

      1. API Description

      Domain name for API request: cvm.intl.tencentcloudapi.com.

      This API is used to query one or more instance launch templates.

      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: DescribeLaunchTemplates.
      Version Yes String Common Params. The value used for this API: 2017-03-12.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product.
      LaunchTemplateIds.N No Array of String Instance launch template ID. ID of one or more instance launch templates. If not specified, all templates of the user will be displayed.
      Filters.N No Array of Filter

      Filter by [LaunchTemplateName].

      Type: String

      Optional


      The maximum number of Filters in each request is 10. The upper limit for Filter.Values is 5. This parameter cannot specify LaunchTemplateIds and Filters at the same time.
      Offset No Integer The offset. Default value: 0. For more information on Offset, see the relevant sections in API Introduction.
      Limit No Integer The number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant sections in API Introduction.

      3. Output Parameters

      Parameter Name Type Description
      TotalCount Integer Number of eligible instance templates.
      Note: This field may return null, indicating that no valid values can be obtained.
      LaunchTemplateSet Array of LaunchTemplateInfo List of instance details
      Note: This field may return null, indicating that no valid values can be obtained.
      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 Querying an instance launch template

      Input Example

      POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLaunchTemplates
<Common request parameters>

{
    "LaunchTemplateIds": [
        "lt-q9t8j8eg"
    ]
}

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "LaunchTemplateSet": [
            {
                "LatestVersionNumber": 12,
                "LaunchTemplateId": "lt-q9t8j8eg",
                "LaunchTemplateName": "Not named foo\"'\"'''\"\"",
                "DefaultVersionNumber": 5,
                "LaunchTemplateVersionCount": 8,
                "CreatedBy": "251009920",
                "CreationTime": "2020-12-16T08:05:02Z"
            }
        ],
        "RequestId": "b2d70642-c69a-4115-ae4e-f6ddade68fea"
    }
}

      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
      InvalidFilter Invalid filter.
      InvalidFilterValue.LimitExceeded Filter
      InvalidParameter A parameter error occurred.
      InvalidParameterValue.InvalidLaunchTemplateName Incorrect format of instance launch template name.
      InvalidParameterValue.LaunchTemplateIdMalformed Incorrect format of instance launch template ID. Please provide a valid instance launch template ID, similar to lt-xxxxxxxx, where x represents a lowercase character or digit.
      InvalidParameterValue.LaunchTemplateIdNotExisted The instance launch template ID does not exist.
      InvalidParameterValue.LaunchTemplateIdVerNotExisted The combination of the template and the version ID does not exist.
      InvalidParameterValue.LaunchTemplateNotFound The instance launch template is not found.
      InvalidParameterValue.LaunchTemplateVersion Invalid instance launch template version number.
      UnknownParameter Unknown parameter error.
      UnsupportedOperation Unsupported operation.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy