全部產品
Search
文件中心

Resource Orchestration Service:ListTemplates - 查詢範本列表

更新時間:Oct 27, 2025

查詢私人與共用的模板列表。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:ListTemplates

list

*Template

acs:ros:{#regionId}:{#accountId}:template/*

請求參數

名稱

類型

必填

描述

樣本值

PageNumber

integer

模板列表的頁碼。
起始值:1。
預設值:1。

1

PageSize

integer

分頁查詢時設定的每頁行數。
取值範圍:1~50。
預設值:10。

10

TemplateName

string

模板名稱。僅在 ShareType 為 Private 時生效。 長度不超過 255 個字元,必須以數字或英文字母開頭,可包含數字、英文字母、短劃線(-)和底線(_)。

MyTemplate

ShareType

string

模板的共用類型。

取值:

  • Private(預設值):模板為使用者自己所擁有。

  • Shared:模板由其他使用者所共用。

  • Official:官方共用模板。

Private

Tag

array<object>

標籤。最多支援指定 20 個標籤。

object

標籤。

Key

string

標籤鍵。僅在 ShareType 為 Private 時生效。

最多支援指定 20 個標籤鍵。

usage

Value

string

標籤值。僅在 ShareType 為 Private 時生效。

最多支援指定 20 個標籤值。

deploy

ResourceGroupId

string

資源群組 ID。
關於資源群組的更多資訊,請參見什麼是資源群組

rg-acfmxazb4ph6aiy****

IncludeTags

string

是否查詢標籤資訊。取值:

  • Enabled:查詢。

  • Disabled(預設值):不查詢。

Enabled

Filters

array<object>

過濾器。

object

過濾器。

Name

string

過濾器名稱,可選擇一個或者多個名稱進行查詢。取值範圍:

  • Categories:模板分類

  • DeployTypes:部署類型

  • ApplicationScenes:應用情境

  • BasicServices:基礎服務

  • ResourceTypes:資源類型

  • TemplateNames:模板名稱

Categories

Values

array

過濾器值列表。

string

過濾器值列表。N 的取值範圍:1~10。

ROS

關於公用請求參數的詳情,請參見公用參數

返回參數

名稱

類型

描述

樣本值

object

TotalCount

integer

模板總數。

1

PageSize

integer

分頁查詢時設定的每頁行數。

10

RequestId

string

請求 ID。

C3A8413B-1F16-4DED-AC3E-61A00718DE8A

PageNumber

integer

模板列表的頁碼。
起始值:1。

1

Templates

array<object>

模板列表。

array<object>

模板列表。

TemplateARN

string

模板的 ARN。

acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****

UpdateTime

string

模板最後更新時間。

2019-10-15T08:17:14.000000

Description

string

模板描述。

test-description

CreateTime

string

建立時間。

2019-10-15T08:17:14.000000

TemplateName

string

模板名稱。

demo

TemplateVersion

string

模板最新版本名。

v1

TemplateId

string

模板 ID。

4d4f5aa2-3260-4e47-863b-763fbb12****

OwnerId

string

模板所屬阿里雲帳號 ID。

151266687691****

ShareType

string

模板的共用類型。

取值:

  • Private:模板為使用者自己所擁有。

  • Shared:模板由其他使用者所共用。

Private

ResourceGroupId

string

資源群組 ID。

rg-acfmxazb4ph6aiy****

Tags

array<object>

模板的標籤。

object

模板的標籤。

Key

string

模板的標籤鍵。

usage

Value

string

模板的標籤值。

test

AdditionalInfo

object

公用模板的補充資訊。

{"DeploymentDuration":null,"Title":"Self-Built_Elasticsearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["其他"]},"Provider":"ROS","Categories":["Solution"]}

TemplateUrl

string

模板的連結。

https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
  "PageNumber": 1,
  "Templates": [
    {
      "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
      "UpdateTime": "2019-10-15T08:17:14.000000",
      "Description": "test-description",
      "CreateTime": "2019-10-15T08:17:14.000000",
      "TemplateName": "demo",
      "TemplateVersion": "v1",
      "TemplateId": "4d4f5aa2-3260-4e47-863b-763fbb12****",
      "OwnerId": "151266687691****",
      "ShareType": "Private",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Tags": [
        {
          "Key": "usage",
          "Value": "test"
        }
      ],
      "AdditionalInfo": {
        "DeploymentDuration": null,
        "Title": "Self-Built_Elasticsearch_Snapshot_Saved_To_OSS",
        "Labels": {
          "ResourceTypes": [
            "ALIYUN::ECS::Instance",
            "ALIYUN::ECS::SecurityGroup",
            "ALIYUN::ECS::VPC",
            "ALIYUN::ECS::VSwitch",
            "ALIYUN::OSS::Bucket",
            "ALIYUN::ROS::WaitCondition",
            "ALIYUN::ROS::WaitConditionHandle"
          ],
          "DeployTypes": [
            "ROS"
          ],
          "ApplicationScenes": [
            "其他"
          ]
        },
        "Provider": "ROS",
        "Categories": [
          "Solution"
        ]
      },
      "TemplateUrl": "https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml"
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情