すべてのプロダクト
Search

このプロダクト

    :ListTemplateScratches

    ドキュメントセンター

    :ListTemplateScratches

    最終更新日:Dec 15, 2025

    シナリオを照会します。

    操作説明

    この例では、中国 (杭州) リージョンで作成されたシナリオを照会します。応答では、リソース管理タイプのシナリオとリソースのレプリケーションタイプのシナリオが返されます。

    今すぐお試しください

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

    get

    *TemplateScratch

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

    DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    TemplateScratchId

    string

    任意

    シナリオの ID。

    ts-7f7a704cf71c49a6****
    TemplateScratchType

    string

    任意

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

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

    • ArchitectureDetection: リソースの検出

    • ResourceImport: リソース管理

    • ResourceMigration: リソースの移行

    ArchitectureReplication
    Status

    string

    任意

    シナリオのステータス。有効値：

    • GENERATE_IN_PROGRESS: シナリオは作成中です。

    • GENERATE_COMPLETE: シナリオは作成済みです。

    • GENERATE_FAILED: シナリオの作成に失敗しました。

    ["GENERATE_COMPLETE"]
    Tags

    array<object>

    任意

    シナリオのタグ。

    object

    任意

    Key

    string

    必須

    シナリオのタグキー。

    説明

    Tags はオプションです。Tags を指定する場合は、Key を指定する必要があります。

    usage
    Value

    string

    任意

    シナリオのタグ値。

    test
    PageSize

    integer

    任意

    各ページに返すエントリ数。

    最大値：50。

    デフォルト値：10。

    10
    PageNumber

    integer

    任意

    返すページ番号。

    ページは 1 から始まります。

    デフォルト値：1

    1
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-acfmxazb4ph6aiy****

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    D1C09606-C58B-558F-9B4E-5BF263D17D09
    TotalCount

    integer

    シナリオの総数。

    2
    PageNumber

    integer

    返されたページのページ番号。

    1
    PageSize

    integer

    ページあたりに返されるエントリ数。

    10
    TemplateScratches

    array<object>

    リソースシナリオ。

    array<object>

    TemplateScratchId

    string

    リソースシナリオの ID。

    ts-48ad85d66cca4620****
    TemplateScratchType

    string

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

    • ResourceImport: リソース管理

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

    ResourceImport
    Status

    string

    リソースシナリオの状態。

    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
    PreferenceParameters

    array<object>

    リソースシナリオの優先パラメーター。

    object

    ParameterKey

    string

    パラメーター名。

    DeletionPolicy
    ParameterValue

    string

    パラメーター値。

    Retain
    Description

    string

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

    The description of the scenario.
    SourceResources

    array<object>

    ソースリソース。

    object

    ResourceId

    string

    リソース ID。

    vpc-m5eauuq80anx59v28****
    ResourceType

    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
    Tags

    array<object>

    リソースシナリオのタグ。

    object

    Key

    string

    リソースシナリオのタグキー。

    usage1
    Value

    string

    リソースシナリオのタグ値。

    test1
    CreateTime

    string

    リソースシナリオが作成された時刻。

    時刻は、YYYY-MM-DDThh:mm:ss 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。

    2021-12-07T08:06:44
    UpdateTime

    string

    リソースシナリオが更新された時刻。

    時刻は、YYYY-MM-DDThh:mm:ss 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。

    2021-12-07T08:06:44
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfm4nxcvht4pmi

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D1C09606-C58B-558F-9B4E-5BF263D17D09",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10,
  "TemplateScratches": [
    {
      "TemplateScratchId": "ts-48ad85d66cca4620****",
      "TemplateScratchType": "ResourceImport",
      "Status": "GENERATE_COMPLETE",
      "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
      "FailedCode": "InvalidZoneId",
      "PreferenceParameters": [
        {
          "ParameterKey": "DeletionPolicy",
          "ParameterValue": "Retain"
        }
      ],
      "Description": "纳管VPC资源。",
      "SourceResources": [
        {
          "ResourceId": "vpc-m5eauuq80anx59v28****",
          "ResourceType": "ALIYUN::ECS::VPC"
        }
      ],
      "SourceTag": {
        "ResourceTags": {
          "a": "b"
        },
        "ResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      },
      "SourceResourceGroup": {
        "ResourceGroupId": "rg-acfmzawhxxc****",
        "ResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      },
      "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
      "Tags": [
        {
          "Key": "usage1",
          "Value": "test1"
        }
      ],
      "CreateTime": "2021-12-07T08:06:44",
      "UpdateTime": "2021-12-07T08:06:44",
      "ResourceGroupId": "rg-acfm4nxcvht4pmi"
    }
  ]
}

    エラーコード

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

    変更履歴

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