调用ListTemplateScratches接口查询资源场景列表。

本文为您提供一个示例，查询杭州地域的资源场景列表。返回结果显示，杭州地域有2个资源场景，分别为资源纳管和资源复制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListTemplateScratches

要执行的操作，取值：ListTemplateScratches。
RegionId String 是 cn-hangzhou

资源场景所属的地域ID。

您可以调用DescribeRegions查看最新的阿里云地域列表。

TemplateScratchId String 否 ts-7f7a704cf71c49a6****

资源场景ID。
TemplateScratchType String 否 ArchitectureReplication

资源场景类型，取值：

  • ResourceImport：资源纳管。
  • ArchitectureReplication：资源复制。
Status String 否 GENERATE_COMPLETE

资源场景状态，取值：

  • GENERATE_IN_PROGRESS：生成中。
  • GENERATE_COMPLETE：生成完成。
  • GENERATE_FAILED：生成失败。
Tags.N.Key String 是 usage

资源场景的标签键。

说明 Tags为可选参数。如果需要指定Tags，则Tags.N.Key必须指定。
Tags.N.Value String 否 test

资源场景的标签值。
PageSize Integer 否 10

分页查询时设置的每页行数。

最大值：50。

默认值：10。
PageNumber Integer 否 1

资源场景的页码。

起始值：1。

默认值：1。

关于公共请求参数的详情，请参见公共参数。

返回数据

名称 类型 示例值 描述
RequestId String D1C09606-C58B-558F-9B4E-5BF263D17D09

请求ID。
TotalCount Integer 2

资源场景总个数。
PageNumber Integer 1

资源场景的页码。

PageSize Integer 10

分页查询时设置的每页行数。

TemplateScratches Array of TemplateScratch

资源场景列表。
TemplateScratchId String ts-48ad85d66cca4620****

资源场景ID。
TemplateScratchType String ResourceImport

资源场景类型，取值：

  • ResourceImport：资源纳管。
  • ArchitectureReplication：资源复制。
Status String GENERATE_COMPLETE

资源场景状态。
StatusReason String Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.

资源场景生成失败的原因。

说明 仅当Status为GENERATE_FAILED时返回该参数。
FailedCode String InvalidZoneId

资源场景生成失败的状态码。

说明 仅当Status为GENERATE_FAILED时返回该参数。
PreferenceParameters Array of PreferenceParameter

资源场景配置参数。
ParameterKey String DeletionPolicy

参数名称。
ParameterValue String Retain

参数值。
Description String 纳管VPC资源。

资源场景说明。
SourceResources Array of SourceResource

源资源。
ResourceId String vpc-m5eauuq80anx59v28****

资源ID。
ResourceType String ALIYUN::ECS::VPC

资源类型。
SourceTag Object

源标签。
ResourceTags Map

源标签。
ResourceTypeFilter Array of String ALIYUN::ECS::VPC

资源类型筛选器。
SourceResourceGroup Object

源资源组。
ResourceGroupId String rg-acfmzawhxxc****

源资源组ID。
ResourceTypeFilter Array of String ALIYUN::ECS::VPC

资源类型筛选器。
LogicalIdStrategy String LongTypePrefixAndIndexSuffix

逻辑ID生成策略，取值：

  • LongTypePrefixAndIndexSuffix（默认值）：长类型前缀+索引后缀。
  • LongTypePrefixAndHashSuffix：长类型前缀+哈希后缀。
  • ShortTypePrefixAndHashSuffix：短类型前缀+哈希后缀。
Tags Array of Tags

资源场景的标签。
Key String usage1

资源场景的标签键。
Value String test1

资源场景的标签值。
CreateTime String 2021-12-07T08:06:44

资源场景创建时间。

按照ISO8601标准表示，需使用UTC时间，格式：YYYY-MM-DDThh:mm:ss。
UpdateTime String 2021-12-07T08:06:44

资源场景更新时间。

按照ISO8601标准表示，需使用UTC时间，格式：YYYY-MM-DDThh:mm:ss。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTemplateScratches
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : {
      "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"
  }
}

错误码

访问错误中心查看更多错误码。