オーケストレーションテンプレートは、Kubernetes リソースのグループを定義し、記述するものです。アプリケーションの構成や実行方法を宣言的に記述します。DescribeTemplates API オペレーションを呼び出すと、オーケストレーションテンプレートとその詳細情報 (アクセス権限、YAML コンテンツ、ラベルなど) をクエリできます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:DescribeTemplates |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /templates HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| template_type |
string |
任意 |
テンプレートのタイプ。このパラメーターはカスタム値に設定できます。
デフォルト値: |
kubernetes |
| page_num |
integer |
任意 |
ページ番号。 デフォルト値: 1。 |
1 |
| page_size |
integer |
任意 |
1 ページあたりのエントリ数。 デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディ。 |
||
| templates |
array<object> |
返されたテンプレートのリスト。 |
|
|
object |
|||
| acl |
string |
テンプレートのアクセス制御ポリシー。有効な値:
デフォルト値: |
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 |
| 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
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。