すべてのプロダクト
Search

このプロダクト

    CloudOps Orchestration Service:ListTemplates

    ドキュメントセンター

    CloudOps Orchestration Service:ListTemplates

    最終更新日:Dec 21, 2025

    テンプレートを照会します。 複数のメソッドを使用してテンプレートをフィルターできます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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

    任意

    テンプレートの作成者。

    • Alibaba Cloud が提供するテンプレートを照会するには、このパラメーターを ACS に設定します。

    • ユーザーが作成したテンプレートを照会するには、このパラメーターをテンプレートの ID またはテンプレートを作成したユーザーの名前に設定します。

    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

    任意

    1ページあたりのエントリ数。 有効値：10～100。 デフォルト値：50。

    50
    NextToken

    string

    任意

    次のページの検索結果を取得するために使用されるトークン。

    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

    次のページの検索結果を取得するために使用されるトークン。

    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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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