DescribeTemplateAttribute - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

オーケストレーションテンプレートは、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:DescribeTemplateAttribute

get

*All Resource

*

なし

リクエスト構文

GET /templates/{TemplateId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
TemplateId	string	必須	テンプレートの ID。	874ec485-e7e6-4373-8a3b-47bde8a****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
template_type	string	任意	テンプレートのタイプ。値はカスタム値にすることができます。パラメーターが `kubernetes` に設定されている場合、テンプレートはコンソールの [テンプレート] ページに表示されます。パラメーターが `compose` に設定されている場合、テンプレートはコンソールの Container Service - Swarm ページに表示されます。 Container Service for Swarm は非推奨です。パラメーターの値が `kubernetes` でない場合、テンプレートはコンソールの [テンプレート] ページに表示されません。パラメーターを `kubernetes` に設定することを推奨します。デフォルト値：`kubernetes`。	kubernetes

レスポンスフィールド

フィールド	型	説明	例
	array	クエリされたテンプレートの詳細。
	object
id	string	テンプレートの ID。テンプレートを更新すると、新しいテンプレート ID が生成されます。	72d20cf8-a533-4ea9-a10d-e7630d3d****
acl	string	テンプレートのアクセス制御ポリシー。	private
name	string	テンプレートの名前。	web
template	string	YAML フォーマットのテンプレートコンテンツ。	apiVersion: V1\n***
template_type	string	テンプレートのタイプ。値はカスタム値にすることができます。パラメーターが `kubernetes` に設定されている場合、テンプレートはコンソールの [テンプレート] ページに表示されます。パラメーターが `compose` に設定されている場合、テンプレートはコンソールの Container Service - Swarm ページに表示されます。 Container Service for Swarm は非推奨です。パラメーターの値が `kubernetes` でない場合、テンプレートはコンソールの [テンプレート] ページに表示されません。パラメーターを `kubernetes` に設定することを推奨します。デフォルト値：`kubernetes`。	kubernetes
description	string	テンプレートの説明。	test template
tags	string	テンプレートのラベル。	sa
template_with_hist_id	string	テンプレートの一意の ID。テンプレートを更新しても、値は変更されません。	874ec485-e7e6-4373-8a3b-47bde8ae****
created	string	テンプレートが作成された時間。	2025-04-25T16:56:33+08:00
updated	string	テンプレートが更新された時間。	2025-04-25T16:56:33+08:00

例

成功レスポンス

JSONJSON

[
  {
    "id": "72d20cf8-a533-4ea9-a10d-e7630d3d****",
    "acl": "private",
    "name": "web",
    "template": "apiVersion: V1\\n***",
    "template_type": "kubernetes",
    "description": "test template",
    "tags": "sa",
    "template_with_hist_id": "874ec485-e7e6-4373-8a3b-47bde8ae****",
    "created": "2025-04-25T16:56:33+08:00",
    "updated": "2025-04-25T16:56:33+08:00"
  }
]

エラーコード

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

変更履歴

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