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

Container Service for Kubernetes:DescribeTemplates

最終更新日:Apr 04, 2026

オーケストレーションテンプレートは、Kubernetes リソースのグループを定義し、記述するものです。アプリケーションの構成や実行方法を宣言的に記述します。DescribeTemplates API オペレーションを呼び出すと、オーケストレーションテンプレートとその詳細情報 (アクセス権限、YAML コンテンツ、ラベルなど) をクエリできます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:DescribeTemplates

get

*All Resource

*

なし なし

リクエスト構文

GET /templates HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

template_type

string

任意

テンプレートのタイプ。このパラメーターはカスタム値に設定できます。

  • パラメーターを kubernetes に設定すると、テンプレートはコンソールの [テンプレート] ページに表示されます。

  • パラメーターを compose に設定すると、テンプレートはコンソールの [テンプレート] ページに表示されません。

デフォルト値: kubernetes

kubernetes

page_num

integer

任意

ページ番号。

デフォルト値: 1。

1

page_size

integer

任意

1 ページあたりのエントリ数。

デフォルト値: 10。

10

レスポンスフィールド

フィールド

説明

object

レスポンスボディ。

templates

array<object>

返されたテンプレートのリスト。

object

acl

string

テンプレートのアクセス制御ポリシー。有効な値:

  • private: テンプレートは非公開です。

  • public: テンプレートは公開です。

  • shared: テンプレートは共有可能です。

デフォルト値: private

private

id

string

テンプレートの ID。

874ec485-e7e6-4373-8a3b-47bde8******

name

string

テンプレートの名前。

webserver

description

string

テンプレートの説明。

a web server

tags

string

テンプレートのラベル。デフォルトでは、値はテンプレートの名前です。

kubernetes

template

string

YAML フォーマットのテンプレートコンテンツ。

apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: nginx-deployment-basic\n labels:\n app: nginx\nspec:\n replicas: 2\n selector:\n matchLabels:\n app: nginx\n template:\n metadata:\n labels:\n app: nginx\n spec:\n containers:\n - name: nginx\n image: busybox:latest\n ports:\n - containerPort: 80

template_type

string

テンプレートのタイプ。このパラメーターはカスタム値に設定できます。

  • パラメーターを kubernetes に設定すると、テンプレートはコンソールの [テンプレート] ページに表示されます。

  • パラメーターを compose に設定すると、テンプレートはコンソールの Container Service for Swarm ページに表示されます。ただし、Container Service for Swarm は非推奨です。

kubernetes

created

string

テンプレートが作成された時間。

2025-04-25T16:56:33+08:00

updated

string

テンプレートが更新された時間。

2025-04-25T16:56:33+08:00

template_with_hist_id

string

親テンプレートの ID。`template_with_hist_id` の値は、各テンプレートバージョンで同じです。これにより、異なるテンプレートバージョンを管理できます。

ad81d115-7c8b-47e7-a222-9c28d7******

page_info

object

ページネーション情報。

page_number

integer

ページ番号。

20

page_size

integer

1 ページあたりのエントリ数。

3

total_count

integer

返されたエントリの総数。

50

成功レスポンス

JSONJSON

{
  "templates": [
    {
      "acl": "private",
      "id": "874ec485-e7e6-4373-8a3b-47bde8******",
      "name": "webserver",
      "description": "a web server",
      "tags": "kubernetes",
      "template": "apiVersion: apps/v1\\nkind: Deployment\\nmetadata:\\n  name: nginx-deployment-basic\\n  labels:\\n    app: nginx\\nspec:\\n  replicas: 2\\n  selector:\\n    matchLabels:\\n      app: nginx\\n  template:\\n    metadata:\\n      labels:\\n        app: nginx\\n    spec:\\n      containers:\\n      - name: nginx\\n        image: busybox:latest\\n        ports:\\n        - containerPort: 80",
      "template_type": "kubernetes",
      "created": "2025-04-25T16:56:33+08:00",
      "updated": "2025-04-25T16:56:33+08:00",
      "template_with_hist_id": "ad81d115-7c8b-47e7-a222-9c28d7******"
    }
  ],
  "page_info": {
    "page_number": 20,
    "page_size": 3,
    "total_count": 50
  }
}

エラーコード

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

変更履歴

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