文档

DescribeLaunchTemplates - 查询一个或多个可用的实例启动模板

更新时间:

调用DescribeLaunchTemplates查询一个或多个可用的实例启动模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeLaunchTemplatesRead
  • LaunchTemplate
    acs:ecs:{#regionId}:{#accountId}:launchtemplate/*
  • LaunchTemplate
    acs:ecs:{#regionId}:{#accountId}:launchtemplate/{#launchtemplateId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
TemplateTagobject []

启动模板的标签列表。

Keystring

启动模板的标签键。N 的取值范围:1~20。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过 1000 个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个,请使用 ListTagResources 接口进行查询。

TestKey
Valuestring

启动模板的标签值。N 的取值范围:1~20。

TestValue
PageNumberinteger

实例启动模板列表的页码。起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。

默认值:10。

10
TemplateResourceGroupIdstring

启动模板所在的企业资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。

说明 不支持默认资源组过滤。
rg-acfmxazb4p****
LaunchTemplateIdarray

一个或多个实例启动模板 ID,最多支持查询 100 个启动模板。您必须指定 LaunchTemplateId 或 LaunchTemplateName 以确定模板。

string

一个或多个实例启动模板 ID,最多支持查询 100 个启动模板。您必须指定 LaunchTemplateId 或 LaunchTemplateName 以确定模板。

lt-m5e3ofjr1zn1aw7q****
LaunchTemplateNamearray

一个或多个实例启动模板名称,最多支持查询 100 个启动模板。

string

一个或多个实例启动模板名称,最多支持查询 100 个启动模板。

wd-152630748****

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时设置的每页行数。

10
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE12CBA
PageNumberinteger

当前页码。

1
TotalCountinteger

实例启动模板总个数。

1
LaunchTemplateSetsobject []

实例启动模板的信息集合。

LaunchTemplateNamestring

模板名称。

wd-152630748****
DefaultVersionNumberlong

模板默认版本号。

1
ModifiedTimestring

修改时间。

2018-05-14T14:18:00Z
LaunchTemplateIdstring

模板 ID。

lt-m5e3ofjr1zn1aw7q****
CreateTimestring

实例启动模板创建时间。

2018-05-14T14:18:00Z
ResourceGroupIdstring

启动模板所在的企业资源组 ID。

rg-acfmxazb4p****
CreatedBystring

模板的创建者。

1234567890
LatestVersionNumberlong

模板最新版本号。

1
Tagsobject []

启动模板的标签对属性。

TagValuestring

启动模板的标签值。

TestValue
TagKeystring

启动模板的标签键。

TestKey

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE12CBA",
  "PageNumber": 1,
  "TotalCount": 1,
  "LaunchTemplateSets": {
    "LaunchTemplateSet": [
      {
        "LaunchTemplateName": "wd-152630748****",
        "DefaultVersionNumber": 1,
        "ModifiedTime": "2018-05-14T14:18:00Z",
        "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7q****",
        "CreateTime": "2018-05-14T14:18:00Z",
        "ResourceGroupId": "rg-acfmxazb4p****",
        "CreatedBy": "1234567890",
        "LatestVersionNumber": 1,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegion.NotExist%s指定的地域不存在,请确认参数是否正确。
400MissingParameter%s缺失参数,请检查参数是否完整。
400InvalidParameter%s无效的参数。
403InnerServiceFailed%s内部服务调用失败。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误,请重试。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.请求后端超时,请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
    删除错误码:503
  • 本页导读 (1)