接口说明
查询实例启动模板列表。
URL
GET https://ecloud.10086.cn/api/openapi-instance/v4/launch-template/list
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
launchTemplateIds
|
<string> array(multi)
|
否
|
启动模板ID数组。您必须指定 launchTemplateIds 或 launchTemplateNames 以确定模板。您可以通过查询启动模板列表获取信息。 |
|
launchTemplateNames
|
<string> array(multi)
|
否
|
启动模板名称数组。您必须指定 launchTemplateIds 或 launchTemplateNames 以确定模板。您可以通过查询启动模板列表获取信息。 |
|
page
|
integer(int32)
|
否
|
实例启动模板列表的页码。默认值：1。 |
|
pageSize
|
integer(int32)
|
否
|
实例启动模板列表每页行数。最大值为100，默认值：10。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-instance/v4/launch-template/list返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«InstanceTemplateSet»
|
请求成功时返回的数据。 |
|
content
|
<InstanceTemplateSet> array
|
分页查询返回的具体结构体。 |
|
launchTemplateId
|
string
|
启动模板ID。 |
|
launchTemplateName
|
string
|
模板名称。 |
|
createdTime
|
string(date-time)
|
模板创建时间 |
|
modifiedTime
|
string(date-time)
|
模板修改时间 |
|
customerId
|
string
|
客户ID。 |
|
userId
|
string
|
用户ID。 |
|
launchTemplateDescription
|
string
|
模板描述。 |
|
total
|
integer
|
满足查询条件的总个数。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
返回码：200
OK
{
"requestId":"reqId-00e8a5a2623e9c34acc6a-f03bf475-1",
"state":"OK",
"body":{
"total":1,
"content":[
{
"launchTemplateId":"cbe9d4a9d3f0419d8ede12967dbe7fdf",
"launchTemplateName":"test",
"userId":"CIDC-U-***",
"customerId":"CIDC-A-***",
"createdTime":"2025-03-13 10:28:18",
"modifiedTime":"2025-03-13 10:29:49",
"launchTemplateDescription":"这是一个启动模板"
}
]
}
}