すべてのプロダクト
Search

このプロダクト

    :UpdateTemplate

    ドキュメントセンター

    :UpdateTemplate

    最終更新日:Jun 04, 2026

    テンプレートの更新

    操作説明

    テンプレートを更新する際は、次の点にご注意ください。

    • TemplateBody または TemplateURL を指定した場合、更新が成功するとテンプレートバージョンが 1 ずつ増加します。例えば、v1 から v2 になります。

    • TemplateBody と TemplateURL のいずれも指定しない場合、テンプレートバージョンは変更されません。

    • テンプレートには最大 100 個のバージョンを保持できます。バージョンの上限に達した場合、テンプレートの更新は失敗します。この場合、テンプレートを再作成する必要があります。

    今すぐお試しください

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

    update

    *template

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TemplateURL

    string

    任意

    テンプレート本文を含むファイルの場所。URL は、Web サーバー (HTTP または HTTPS) または Alibaba Cloud OSS バケット (例：oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou) 上のテンプレートを指している必要があります。テンプレートの最大サイズは 524,288 バイトです。

    説明

    OSS リージョンが指定されていない場合、リクエストの RegionId パラメーターと同じリージョンがデフォルトになります。

    TemplateBody、TemplateURL、TemplateId、または TemplateScratchId のいずれか 1 つのみを指定する必要があります。
    URL の最大長は 1,024 バイトです。

    oss://ros/template/demo
    TemplateName

    string

    任意

    テンプレートの名前。
    長さは 255 文字 (UTF-8 エンコーディング) 以下とし、数字、英字、または漢字で始まる必要があります。数字、英字、漢字、ハイフン (-)、およびアンダースコア (_) を含めることができます。

    MyTemplate
    Description

    string

    任意

    テンプレートの説明。最大長は 256 文字です。

    It is a demo.
    TemplateBody

    string

    任意

    テンプレート本文の構造。長さは 1 ～ 524,288 バイトである必要があります。内容が長い場合は、HTTP POST + Body Param を使用してリクエストボディでパラメータを渡すことを推奨します。これにより、URL が長すぎることによるリクエスト失敗を回避できます。

    説明

    TemplateBody、TemplateURL、TemplateId、または TemplateScratchId のいずれか 1 つのみを指定する必要があります。

    {"ROSTemplateFormatVersion":"2015-09-01"}
    TemplateId

    string

    必須

    テンプレート ID。共有テンプレートとプライベートテンプレートの両方に対応しています。

    5ecd1e10-b0e9-4389-a565-e4c15efc****
    ValidationOptions

    array

    任意

    検証オプション。

    デフォルトでは、オプションは有効になっておらず、厳密な検証が実行されます。

    string

    任意

    検証オプション。有効な値：

    • BasicValidation：テンプレート本文の基本的な構造検証のみを実行します。

    BasicValidation
    RotateStrategy

    string

    任意

    テンプレートバージョンのローテーション戦略。有効な値：

    • None (デフォルト)：ローテーションなし。バージョンの上限に達した場合、エラーが発生します。

    • DeleteOldestNonSharedVersionWhenLimitExceeded：共有されていないテンプレートバージョンをローテーションして削除します。

    説明

    • テンプレートのすべてのバージョンが共有されている場合、ローテーションおよび削除はできません。

    • 現在の最新バージョンはローテーションおよび削除されません。

    • ローテーション削除を使用するかどうかに関わらず、テンプレートバージョン番号は v65000 を超えることはできません。

    None
    IsDraft

    boolean

    任意

    ドラフトバージョンを更新するかどうか。有効な値：

    • false (デフォルト)：テンプレート本文が指定された場合、新しいバージョンが作成され、ドラフトバージョンがクリアされます。それ以外の場合、現在の最新バージョンが変更されます。

    • true：ドラフトバージョンを変更します。ドラフトバージョンは GetTemplate インターフェースを使用してのみ取得できます。ListTemplateVersions インターフェースは返しません。他のインターフェースの TemplateVersion パラメーターでドラフトを指定することはできません。

    false

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    8C5D90E1-66B6-496C-9371-3807F8DA80A8
    TemplateId

    string

    テンプレート ID。

    5ecd1e10-b0e9-4389-a565-e4c15efc****
    TemplateVersion

    string

    この操作で更新されたテンプレートバージョン。

    v2

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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