すべてのプロダクト
Search
ドキュメントセンター

:ListTemplates

最終更新日:Jun 04, 2026

プライベートテンプレートと共有テンプレートのリストをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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

任意

フィルター名です。1 つ以上の名前を選択してクエリできます。有効な値:

  • Categories:テンプレートカテゴリ

  • DeployTypes:デプロイメントタイプ

  • ApplicationScenes:アプリケーションシナリオ

  • BasicServices:基本サービス

  • ResourceTypes:リソースタイプ

  • TemplateNames:テンプレート名

Categories

Values

array

任意

フィルター値のリストです。

string

任意

フィルター値です。N の値の範囲は 1~10 です。

ROS

共通リクエストパラメータの詳細については、「共通パラメータ」をご参照ください。

レスポンスフィールド

フィールド

説明

object

TotalCount

integer

テンプレートの総数です。

1

PageSize

integer

1ページあたりに返されるエントリ数です。

10

RequestId

string

リクエスト ID です。

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

PageNumber

integer

テンプレートリストのページ番号です。
値は 1 から始まります。

1

Templates

array<object>

テンプレートのリストです。

array<object>

The list of templates.

TemplateARN

string

テンプレートの Alibaba Cloud リソースネーム (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

テンプレートが属する Alibaba Cloud アカウントの 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":["other"]},"Provider":"ROS","Categories":["Solution"]}

TemplateUrl

string

テンプレートの URL です。

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

成功レスポンス

JSONJSON

{
  "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": [
            "other"
          ]
        },
        "Provider": "ROS",
        "Categories": [
          "Solution"
        ]
      },
      "TemplateUrl": "https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml"
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。