支持多种过滤方式。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| oos:ListTemplates | get | *Template acs:oos:{#regionId}:{#accountId}:template/**Template acs:oos:{#regionId}:{#accountId}:template/{#templateName} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID | cn-hangzhou |
| TemplateName | string | 否 | 模板名称。列出含所填模板名称的所有模板。 | MyTemplate |
| TemplateFormat | string | 否 | 模板格式。取值范围：
| YAML |
| ShareType | string | 否 | 分享类型。取值范围：
| Private |
| CreatedBy | string | 否 | 模板创建者。
| ACS |
| CreatedDateBefore | string | 否 | 创建时间小于等于指定时间的模板。 格式为：YYYY-MM-DDThh:mm::ssZ | 2019-05-16T10:26:14Z |
| CreatedDateAfter | string | 否 | 创建时间大于等于指定时间的模板。 格式为：YYYY-MM-DDThh:mm:ssZ | 2019-05-16T10:26:14Z |
| Tags | object | 否 | 标签键及值，键值对数量限制为 1 至 20。 | {"k1":"k2","k2":"v2"} |
| Category | string | 否 | 模版类型如 TimerTrigger，EventTrigger，AlarmTrigger，Other。 | TimerTrigger |
| MaxResults | integer | 否 | 分页大小。取值范围：10-100。默认为 50。 | 50 |
| NextToken | string | 否 | 对查询结果进行翻页时需要传入的 Token 值，如有则获取自当前页的返回值。 | xxx |
| SortField | string | 否 | 排序字段。取值范围：
| Popularity |
| SortOrder | string | 否 | 排序方向。取值范围：
| Descending |
| HasTrigger | boolean | 否 | 是否触发 | true |
| TemplateType | string | 否 | 模版类型：
| Automation |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmxsn4m4****** |
| IsFavorite | boolean | 否 | 是否已收藏 | true |
| IsExample | boolean | 否 | 是否是示例模板 | true |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "xxx",
"RequestId": "BEF54BA-17B6-449F-A219-49ACB157E3",
"MaxResults": 50,
"Templates": [
{
"Hash": "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
"UpdatedDate": "2019-05-16T10:26:14Z",
"UpdatedBy": "root(13092000)",
"TemplateType": "private",
"Tags": {
"k1": "v1",
"k2": "v2"
},
"TemplateName": "MyTemplate",
"TemplateVersion": "v1",
"TemplateFormat": "JSON",
"Popularity": 8,
"TotalExecutionCount": 5,
"Description": "Describe instances of given status",
"ResourceGroupId": "rg-acfmxsn4m4******",
"CreatedBy": "root(1309200)",
"CreatedDate": "2019-05-16T10:26:14Z",
"Category": "TimerTrigger",
"HasTrigger": true,
"TemplateId": "t-94753deed38",
"ShareType": "Public",
"IsFavorite": true,
"Publisher": "aliyun",
"Constraints": "{\n \"InstanceTypeFamilies\": [\"ecs.g8y\", \"ecs.c8y\"],\n \"ImageTypes\": [\"system\"],\n \"OSPlatforms\": [\"CentOS\", \"Ubuntu\"],\n \"OSVersions\": [\"CentOS7.9 64bit\"]\n}",
"VersionName": "3"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-12 | OpenAPI 描述信息更新 | 查看变更详情 |
| 2024-11-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-07-11 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-12-08 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |