すべてのプロダクト
Search

このプロダクト

    :GenerateTemplateByScratch

    ドキュメントセンター

    :GenerateTemplateByScratch

    最終更新日:Jun 03, 2026

    リソースシナリオのテンプレートを生成します。

    操作説明

    この例では、中国 (杭州) リージョンにあるリソース管理シナリオのテンプレートを生成します。リソースシナリオの ID は ts-aa9c62feab844a6b**** です。

    説明

    リソース検出シナリオのテンプレートは生成できません。

    今すぐお試しください

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

    list

    *TemplateScratch

    acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リソースシナリオのリージョン ID です。

    DescribeRegions API を呼び出して、最新のリージョンリストを取得できます。

    cn-hangzhou
    TemplateScratchId

    string

    必須

    リソースシナリオの ID です。

    リソースシナリオの ID を取得する方法の詳細については、「ListTemplateScratches」をご参照ください。

    ts-aa9c62feab844a6b****
    ProvisionRegionId

    string

    任意

    新しいノードのリージョン ID です。

    cn-hangzhou
    TemplateType

    string

    任意

    Resource Orchestration Service (ROS) が生成するテンプレートのタイプ。ROS は、ROS タイプと Terraform タイプのテンプレートを生成できます。デフォルト値：ROS。

    ROS

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    D22C1D13-D74E-558C-AF68-1B4C05FA6F1A
    TemplateBody

    string

    リソースシナリオのテンプレート本文です。

    {\"ROSTemplateFormatVersion\": \"2015-09-01\", \"Resources\": {\"ECSVPC_001\": {\"DeletionPolicy\": \"Retain\", \"Type\": \"ALIYUN::ECS::VPC\", \"Properties\": {\"CidrBlock\": \"172.16.0.0/12\", \"VpcName\": \"MyTestVpc\", \"EnableIpv6\": false}}}}
    ResourcesToImport

    array<object>

    リソース管理シナリオでスタックにインポートするリソースです。

    説明

    このパラメーターは、リソース管理シナリオに対してのみ返されます。

    array<object>

    ResourceType

    string

    リソースタイプです。

    ALIYUN::ECS::VPC
    LogicalResourceId

    string

    リソースの論理 ID です。

    ECSVPC_001
    ResourceIdentifier

    object

    キーと値のマッピングです。これは、スタックにインポートするリソースを識別する JSON オブジェクトです。
    キーはリソースの識別子で、値はキーに割り当てられたデータです。たとえば、VpcId は Virtual Private Cloud (VPC) の ID を示すキーで、vpc-bp1m6fww66xbntjyc****" は VpcId に割り当てられた値です。

    {"VpcId": "vpc-bp1m6fww66xbntjyc****" }

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D22C1D13-D74E-558C-AF68-1B4C05FA6F1A",
  "TemplateBody": "{\\\"ROSTemplateFormatVersion\\\": \\\"2015-09-01\\\", \\\"Resources\\\": {\\\"ECSVPC_001\\\": {\\\"DeletionPolicy\\\": \\\"Retain\\\", \\\"Type\\\": \\\"ALIYUN::ECS::VPC\\\", \\\"Properties\\\": {\\\"CidrBlock\\\": \\\"172.16.0.0/12\\\", \\\"VpcName\\\": \\\"MyTestVpc\\\", \\\"EnableIpv6\\\": false}}}}",
  "ResourcesToImport": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceId": "ECSVPC_001",
      "ResourceIdentifier": {
        "VpcId": "vpc-bp1m6fww66xbntjyc****"
      }
    }
  ]
}

    エラーコード

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

    変更履歴

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