DescribeLaunchTemplatesInfo
最近更新时间: 2024-12-21 13:01:31
1. 接口描述
接口请求域名: cvm.api3.gsesgpucloud.com。
本接口(DescribeLaunchTemplatesInfo)用于查询一个或者多个实例启动模板详细信息。
默认接口请求频率限制:20次/秒。
接口更新时间:2023-03-16 18:41:54。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeLaunchTemplatesInfo |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
LaunchTemplateIds | 否 | 否 | Array of String | 启动模板ID,一个或者多个启动模板ID。若未指定,则显示用户所有模板。 示例值: ["lt-k8wrok8e"] |
Filters | 否 | 否 | Filter | 按照【LaunchTemplateName】进行过滤。 示例值:查看 |
Offset | 否 | 否 | Int64 | 偏移量,默认为0。 示例值: 0 |
Limit | 否 | 否 | Int64 | 返回数量,默认为20,最大值为100。 示例值: 20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Int64 | 符合条件的实例模板数量。 注意:此字段可能返回 null,表示取不到有效值。 示例值: 50 |
LaunchTemplateSet | LaunchTemplatesInfo | 实例详细信息列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidFilter | 无效的过滤器。 |
InvalidParameterValue.LaunchTemplateIdMalformed | 实例启动模板ID格式错误。 |
InvalidParameterValue.LaunchTemplateIdNotExisted | 实例启动模板ID不存在。 |
InvalidParameterValue.LaunchTemplateIdVerNotExisted | 实例启动模板和版本ID组合不存在。 |
InvalidParameterValue.LaunchTemplateNotFound | 实例启动模板未找到。 |
InvalidParameterValue.LaunchTemplateVersion | 无效的实例启动模板版本号。 |
InvalidParameterValue.InvalidLaunchTemplateName | 实例启动模板名称格式错误 |
InvalidParameter | 无效参数。参数不合要求或者参数不被支持等。 |