カスタムテンプレート作成のための API 呼び出し - Resource Orchestration Service (ROS) - Alibaba Cloud -

カスタムテンプレートを作成します。

操作説明

このトピックでは、中国 (杭州) リージョン (cn-hangzhou) で MyTemplate という名前のテンプレートを作成する例を示します。 TemplateBody パラメーターは {"ROSTemplateFormatVersion": "2015-09-01"} に設定されています。

今すぐお試しください

この 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:CreateTemplate

create

*Template

acs:ros:{#regionId}:{#accountId}:template/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TemplateURL	string	任意	テンプレートボディを含むファイルの URL。 URL は、Web サーバー (HTTP または HTTPS) または Alibaba Cloud Object Storage Service (OSS) バケット (例: oss://ros/stack-policy/demo または oss://ros/stack-policy/demo?RegionId=cn-hangzhou) にあるテンプレートを指す必要があります。 URL の長さは、1～1,024 バイトにする必要があります。 OSS バケットのリージョンを指定しない場合、RegionId パラメーターの値を使用します。説明 `TemplateBody`、`TemplateURL`、`TemplateId` は、いずれか 1 つのパラメーターのみを指定できます。	oss://ros/template/demo
Description	string	任意	テンプレートの説明。説明の長さは最大 256 文字です。	It is a demo.
TemplateBody	string	任意	テンプレートボディの構造。テンプレートボディの長さは、1～524,288 バイトにする必要があります。テンプレートボディが大きい場合は、URL が長すぎることによるリクエストの失敗を防ぐため、リクエストボディにパラメーターを指定してください。説明 `TemplateBody`、`TemplateURL`、`TemplateId` は、いずれか 1 つのパラメーターのみを指定できます。	{"ROSTemplateFormatVersion":"2015-09-01"}
TemplateName	string	必須	テンプレートの名前。長さは 255 文字までです。先頭は、数字、英字、漢字のいずれかである必要があります。名前に使用できる文字は、数字、英字、漢字、ハイフン (-)、アンダースコア (_) です。	MyTemplate
ResourceGroupId	string	任意	リソースグループの ID。リソースグループの詳細については、「リソースグループとは」をご参照ください。	rg-acfmxazb4ph6aiy****
Tags	array<object>	任意	テンプレートのタグ。
	object	任意	テンプレートのタグ。
Key	string	必須	テンプレートのタグキー。説明 Tags はオプションのパラメーターです。 Tags を指定する場合、`Tags.N.Key` を指定する必要があります。	usage
Value	string	任意	テンプレートのタグ値。	test
ValidationOptions	array	任意	検証オプション。デフォルトでは、オプションは有効になっておらず、厳密な検証を実行します。
	string	任意	検証オプション。有効な値は次のとおりです： BasicValidation：テンプレートの構造に対して基本的な検証のみを実行します。	BasicValidation

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

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	8C5D90E1-66B6-496C-9371-3807F8DA80A8
TemplateId	string	テンプレート ID。	5ecd1e10-b0e9-4389-a565-e4c15efc****

例

成功レスポンス

JSONJSON

{
  "RequestId": "8C5D90E1-66B6-496C-9371-3807F8DA80A8",
  "TemplateId": "5ecd1e10-b0e9-4389-a565-e4c15efc****"
}

エラーコード

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

変更履歴

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