すべてのプロダクト
Search

このプロダクト

    :GetTemplateScratch

    ドキュメントセンター

    :GetTemplateScratch

    最終更新日:Jun 17, 2026

    リソースシナリオの詳細を取得します。

    操作説明

    この Topic では、中国（杭州）リージョンのリソースシナリオ ts-7f7a704cf71c49a6**** の詳細をクエリし、ソースノードデータを表示する例を示します。

    今すぐお試しください

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

    get

    *TemplateScratch

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

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

    cn-hangzhou
    TemplateScratchId

    string

    任意

    リソースシナリオの ID。

    ts-7f7a704cf71c49a6****
    ShowDataOption

    string

    任意

    データ表示オプション。有効な値:

    • Sources: ソースノードデータのみを表示します。この値は、TemplateScratchType が ArchitectureDetection に設定されている場合に適用されます。

    • Source: ソースノードデータのみを表示します。この値は、TemplateScratchType が ArchitectureDetection に設定されていない場合に適用されます。

    • Provisions: 新規ノードデータのみを表示します。この値は、TemplateScratchType が ArchitectureDetection に設定されていない場合に適用されます。

    • All: すべてのデータを表示します。

    ソースノードと新規ノードの詳細については、概要 を参照してください。

    説明

    このパラメーターを指定しない場合、デフォルトではノードデータは表示されません。

    Source

    共通リクエストパラメーターの詳細については、共通パラメーター を参照してください。フォーマットの詳細については、各パラメーターの説明を参照してください。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    A8E0EF98-6FBD-5656-8298-FC8194F0F7B7
    TemplateScratch

    object

    リソースシナリオ。

    TemplateScratchId

    string

    リソースシナリオの ID。

    ts-7f7a704cf71c49a6****
    TemplateScratchType

    string

    リソースシナリオのタイプ。有効な値:

    • ResourceImport: リソース管理。

    • ArchitectureReplication: リソースレプリケーション。

    ArchitectureReplication
    Status

    string

    リソースシナリオのステータス。有効な値:

    • GENERATE_IN_PROGRESS: 生成中。

    • GENERATE_COMPLETE: 生成完了。

    • GENERATE_FAILED: 生成に失敗した。

    GENERATE_COMPLETE
    StatusReason

    string

    リソースシナリオの生成に失敗した理由。

    説明

    このパラメーターは、Status が GENERATE_FAILED に設定されている場合にのみ返されます。

    Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.
    FailedCode

    string

    リソースシナリオの生成に失敗した理由を示す状態コード。

    説明

    このパラメーターは、Status が GENERATE_FAILED に設定されている場合にのみ返されます。

    InvalidZoneId
    TemplateScratchData

    object

    リソースシナリオデータ。

    See the response example.
    PreferenceParameters

    array<object>

    リソースシナリオの構成パラメーター。

    object

    ParameterKey

    string

    パラメーター名です。

    DeletionPolicy
    ParameterValue

    string

    パラメーター値です。

    Retain
    Description

    string

    リソースシナリオの説明。

    Copy VPC resources.
    SourceResources

    array<object>

    ソースリソース。

    object

    ソースリソース。

    ResourceId

    string

    リソース ID です。

    vpc-m5e7cv7e9mz69sszb****
    ResourceType

    string

    リソースタイプです。

    ALIYUN::ECS::VPC
    RelatedResourceTypeFilter

    array

    関連するリソースタイプのフィルターです。

    string

    関連するリソースタイプのフィルターです。

    ALIYUN::ECS::VPC
    SourceTag

    object

    ソースタグ。

    ResourceTags

    object

    ソースタグです。

    {"a": "b"}
    ResourceTypeFilter

    array

    リソースタイプのフィルターです。

    string

    リソースタイプのフィルターです。

    ALIYUN::ECS::VPC
    SourceResourceGroup

    object

    ソースリソースグループ。

    ResourceGroupId

    string

    ソースリソースグループの ID です。

    rg-acfmzawhxxc****
    ResourceTypeFilter

    array

    リソースタイプのフィルターです。

    string

    リソースタイプのフィルターです。

    ALIYUN::ECS::VPC
    LogicalIdStrategy

    string

    論理 ID 生成戦略。有効な値:

    • LongTypePrefixAndIndexSuffix（デフォルト）: 長いタイププレフィックスとインデックスサフィックス。

    • LongTypePrefixAndHashSuffix: 長いタイププレフィックスとハッシュサフィックス。

    • ShortTypePrefixAndHashSuffix: 短いタイププレフィックスとハッシュサフィックス。

    LongTypePrefixAndIndexSuffix
    CreateTime

    string

    リソースシナリオが作成された時間。時間は協定世界時 (UTC) で表示され、末尾の Z を含まない ISO 8601 標準に従います。フォーマット: YYYY-MM-DDThh:mm:ss。

    2021-12-22T01:49:22
    UpdateTime

    string

    リソースシナリオが最後に更新された時間。時間は協定世界時 (UTC) で表示され、末尾の Z を含まない ISO 8601 標準に従います。フォーマット: YYYY-MM-DDThh:mm:ss。

    2021-12-22T01:49:23
    Stacks

    array<object>

    リソースシナリオに関連付けられたスタックのリスト。

    object

    StackId

    string

    スタック ID です。

    3708bf6a-3a67-44d4-9eb1-c56704b9****
    RegionId

    string

    スタックのリージョン ID です。

    cn-hangzhou
    UsageType

    string

    スタックの目的です。有効な値は以下の通りです。

    • ResourceImport：リソース管理

    • ArchitectureReplication：リソースレプリケーション

    ArchitectureReplication
    StackProvision

    object

    スタックプロビジョニング情報。フォーマットの詳細については、関連ドキュメントを参照してください。

    Creatable

    boolean

    CreateStack API を呼び出してリソースをレプリケートするかどうかを示します。有効な値は以下の通りです。

    • true

    • false

    true
    Importable

    boolean

    CreateChangeSet API を呼び出してリソースを管理するかどうかを示します。有効な値は以下の通りです。

    • true

    • false

    false
    ResourceGroupId

    string

    リソースグループ ID。

    rg-acfmzmhzoaad5oq

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "A8E0EF98-6FBD-5656-8298-FC8194F0F7B7",
  "TemplateScratch": {
    "TemplateScratchId": "ts-7f7a704cf71c49a6****",
    "TemplateScratchType": "ArchitectureReplication",
    "Status": "GENERATE_COMPLETE",
    "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
    "FailedCode": "InvalidZoneId",
    "TemplateScratchData": {
      "test": "test",
      "test2": 1
    },
    "PreferenceParameters": [
      {
        "ParameterKey": "DeletionPolicy",
        "ParameterValue": "Retain"
      }
    ],
    "Description": "Copy VPC resources.",
    "SourceResources": [
      {
        "ResourceId": "vpc-m5e7cv7e9mz69sszb****",
        "ResourceType": "ALIYUN::ECS::VPC",
        "RelatedResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      }
    ],
    "SourceTag": {
      "ResourceTags": {
        "a": "b"
      },
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "SourceResourceGroup": {
      "ResourceGroupId": "rg-acfmzawhxxc****",
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
    "CreateTime": "2021-12-22T01:49:22",
    "UpdateTime": "2021-12-22T01:49:23",
    "Stacks": [
      {
        "StackId": "3708bf6a-3a67-44d4-9eb1-c56704b9****",
        "RegionId": "cn-hangzhou",
        "UsageType": "ArchitectureReplication"
      }
    ],
    "StackProvision": {
      "Creatable": true,
      "Importable": false
    },
    "ResourceGroupId": "rg-acfmzmhzoaad5oq"
  }
}

    エラーコード

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

    変更履歴

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