CreateTemplate API リファレンス - OOS - Alibaba Cloud - CloudOps Orchestration Service

テンプレートを作成します。

今すぐお試しください

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

create

*Template

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

oos:tag
oos:TLSVersion

ram:PassRole

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
TemplateName	string	必須	テンプレート名。名前には英数字、ハイフン (-)、アンダースコア (_) を使用でき、長さは最大 200 文字です。名前の先頭を ALIYUN、ACS、ALIBABA、または ALICLOUD にすることはできません。	MyTemplate
Content	string	必須	テンプレートの内容。内容は JSON または YAML フォーマットである必要があり、サイズは 64 KB 以下にしてください。	{"FormatVersion": "OOS-2019-06-01", "Description": "指定されたステータスのインスタンスを照会します", "Parameters": {"Status": {"Type": "String", "Description": "(必須) ECS インスタンスのステータス。"}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}
Tags	object	任意	タグキーと値のペアのリスト。1～20 個のタグキーと値のペアを指定できます。	{"k1":"v1","k2":"v2"}
VersionName	string	任意	バージョン名。	v2
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmxsn4m4******

レスポンスフィールド

フィールド	型	説明	例
	object
TemplateType	string	テンプレートのタイプ。	Private
RequestId	string	リクエスト ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
Template	object	テンプレートのメタデータ。
Hash	string	テンプレート内容の SHA-256 ハッシュ。	4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDate	string	テンプレートが最後に更新された時間。	2019-05-16T10:26:14Z
UpdatedBy	string	テンプレートを最後に更新したユーザー。	root(130900000)
Tags	object	リソースのタグ。	{ "k1":"v1", "k2":"v2" }
TemplateName	string	テンプレート名。	MyTemplate
TemplateVersion	string	テンプレートのバージョン。バージョンは "v" の後に 1 から始まる数字が続くフォーマットです。	v1
TemplateFormat	string	テンプレートのフォーマット。システムが自動的にフォーマット (JSON または YAML) を決定します。	JSON
Description	string	テンプレートの説明。	指定されたステータスのインスタンスを照会します
ResourceGroupId	string	リソースグループの ID。	rg-acfmxsn4m4******
CreatedBy	string	テンプレートを作成したユーザー。	root(13090000)
CreatedDate	string	テンプレートが作成された時間。	2019-05-16T10:26:14Z
TemplateId	string	テンプレートの ID。	t-94753d38
HasTrigger	boolean	テンプレートが正常にトリガーされたかどうかを示します。	true
ShareType	string	テンプレートの共有タイプ。ユーザー作成テンプレートの共有タイプは Private です。	Private

例

成功レスポンス

JSONJSON

{
  "TemplateType": "Private",
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "Template": {
    "Hash": "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
    "UpdatedDate": "2019-05-16T10:26:14Z",
    "UpdatedBy": "root(130900000)",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "TemplateName": "MyTemplate",
    "TemplateVersion": "v1",
    "TemplateFormat": "JSON",
    "Description": "指定されたステータスのインスタンスを照会します",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(13090000)",
    "CreatedDate": "2019-05-16T10:26:14Z",
    "TemplateId": "t-94753d38",
    "HasTrigger": true,
    "ShareType": "Private"
  }
}

エラーコード

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

変更履歴

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