支持多種過濾方式。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
oos:ListTemplates | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 否 | 是否是示例模板 |
返回參數
示例
正常返回示例
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}"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-11 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-12-08 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |