全部產品
Search

搜尋本產品

    CloudOps Orchestration Service：ListTemplates

    文件中心

    CloudOps Orchestration Service：ListTemplates

    更新時間：Sep 02, 2026

    支援多種篩選方式。

    調試

    您可以在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}
    • oos:tag
    • oos:TLSVersion
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-hangzhou
    TemplateName

    string

    否

    範本名稱。列出包含所填範本名稱的所有範本。

    MyTemplate
    TemplateFormat

    string

    否

    範本格式。取值範圍：

    • JSON

    • YAML

    YAML
    ShareType

    string

    否

    分享類型。取值範圍：

    • Public

    • Private

    Private
    CreatedBy

    string

    否

    範本建立者。

    • 對於阿里雲官方提供的範本，為 ACS。

    • 對於使用者個人建立的範本，可填寫 UID 進行篩選，或填寫 使用者名稱 進行篩選。

    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

    否

    排序欄位。取值範圍：

    • TotalExecutionCount（預設值）：總執行次數

    • Popularity：受歡迎程度

    • TemplateName：範本名稱

    • CreatedDate：建立時間

    • UpdatedDate：更新時間

    Popularity
    SortOrder

    string

    否

    排序方向。取值範圍：

    • Ascending：升序

    • Descending（預設值）：降序

    Descending
    HasTrigger

    boolean

    否

    是否觸發。

    true
    TemplateType

    string

    否

    範本類型：

    • Automation：自動化

    • State：組態清單

    • Package：軟體套件

    枚舉值：

    • Automation :

      Automation

    • State :

      State

    • Package :

      Package

    Automation
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-acfmxsn4m4******
    IsFavorite

    boolean

    否

    是否已收藏。

    true
    IsExample

    boolean

    否

    是否為範例範本。

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    NextToken

    string

    對查詢結果進行翻頁時需要傳入的 Token 值，如有則獲取自當前頁的返回值。

    xxx
    RequestId

    string

    請求 ID。

    BEF54BA-17B6-449F-A219-49ACB157E3
    MaxResults

    integer

    分頁大小。

    50
    Templates

    array<object>

    範本中繼資料。

    array<object>

    Hash

    string

    範本內容的 SHA256。

    4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
    UpdatedDate

    string

    範本更新時間。

    2019-05-16T10:26:14Z
    UpdatedBy

    string

    範本更新者。

    root(13092000)
    TemplateType

    string

    範本類型。

    private
    Tags

    object

    標籤鍵及值，鍵值對數量限制為 1 至 20。

    {"k1":"v1","k2":"v2"}
    TemplateName

    string

    範本名稱。

    MyTemplate
    TemplateVersion

    string

    範本版本。以「v」+數字的形式表示，數字從 1 開始。

    v1
    TemplateFormat

    string

    範本格式。由系統欄位判斷，為 JSON 或 YAML。

    JSON
    Popularity

    integer

    公用範本受歡迎程度。範圍為 1-10，數字越高表示越受歡迎。若 ShareType 為 Private，該欄位值為 -1。

    說明

    該欄位在 ShareType 為 Public 時有意義。

    8
    TotalExecutionCount

    integer

    私有範本總執行次數。若 ShareType 為 Public，該欄位值為 -1。

    說明

    該欄位在 ShareType 為 Private 時有意義。

    5
    Description

    string

    範本說明。

    Describe instances of given status
    ResourceGroupId

    string

    資源群組 ID。

    rg-acfmxsn4m4******
    CreatedBy

    string

    範本建立者。

    root(1309200)
    CreatedDate

    string

    範本建立時間。

    2019-05-16T10:26:14Z
    Category

    string

    範本類型。

    TimerTrigger
    HasTrigger

    boolean

    是否成功觸發。

    true
    TemplateId

    string

    範本 ID。

    t-94753deed38
    ShareType

    string

    範本共用類型。目前使用者建立的範本的共用類型均為 Private。取值範圍：

    • Public

    • Private

    Public
    IsFavorite

    boolean

    是否已收藏。

    true
    Publisher

    string

    發佈者。

    aliyun
    Constraints

    string

    約束條件。

    { "InstanceTypeFamilies": ["ecs.g8y", "ecs.c8y"], "ImageTypes": ["system"], "OSPlatforms": ["CentOS", "Ubuntu"], "OSVersions": ["CentOS7.9 64bit"] }
    VersionName

    string

    版本名稱。

    3

    樣本

    正常返回樣本

    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"
    }
  ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。