调用GetTemplateScratch接口获取资源场景详情。

本文将提供一个示例,查询杭州地域资源场景ts-7f7a704cf71c49a6****的详情,并显示源节点数据。

调试

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

请求参数

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

要执行的操作,取值:GetTemplateScratch。

RegionId String cn-hangzhou

资源场景所属的地域ID。

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

TemplateScratchId String ts-7f7a704cf71c49a6****

资源场景ID。

ShowDataOption String Source

数据显示选项,取值:

  • Source:仅显示源节点数据。
  • Provisions:仅显示新节点数据。
  • All:显示所有数据。

关于源节点和新节点的更多信息,请参见概览

说明 不设置该参数时,默认不显示节点数据。

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

返回数据

名称 类型 示例值 描述
RequestId String A8E0EF98-6FBD-5656-8298-FC8194F0F7B7

请求ID。

TemplateScratch Object

资源场景。

TemplateScratchId String ts-7f7a704cf71c49a6****

资源场景ID。

TemplateScratchType String ArchitectureReplication

资源场景类型,取值:

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

资源场景状态,取值:

  • GENERATE_IN_PROGRESS:生成中。
  • GENERATE_COMPLETE:生成完成。
  • GENERATE_FAILED:生成失败。
StatusReason String Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.

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

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

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

说明 仅当Status为GENERATE_FAILED时返回该参数。
TemplateScratchData Map

资源场景数据。

PreferenceParameters Array of PreferenceParameter

资源场景配置参数。

ParameterKey String DeletionPolicy

参数名称。

ParameterValue String Retain

参数值。

Description String 复制VPC资源。

资源场景说明。

SourceResources Array of SourceResource

源资源。

ResourceId String vpc-m5e7cv7e9mz69sszb****

资源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:短类型前缀+哈希后缀。
CreateTime String 2021-12-22T01:49:22

资源场景创建时间。

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

UpdateTime String 2021-12-22T01:49:23

资源场景更新时间。

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

Stacks Array of Stack

资源场景关联的资源栈列表。

StackId String 3708bf6a-3a67-44d4-9eb1-c56704b9****

资源栈ID。

RegionId String cn-hangzhou

资源栈所属的地域ID。

UsageType String ArchitectureReplication

资源栈用途,取值:

  • ResourceImport:资源纳管。
  • ArchitectureReplication:资源复制。
StackProvision Object

资源栈预置信息。

Creatable Boolean true

是否支持通过CreateStack创建资源栈以进行资源复制,取值:

  • true:支持。
  • false:不支持。
Importable Boolean false

是否支持通过CreateChangeSet创建更改集以进行资源纳管,取值:

  • true:支持。
  • false:不支持。

示例

请求示例

http(s)://[Endpoint]/?Action=GetTemplateScratch
&RegionId=cn-hangzhou
&TemplateScratchId=ts-7f7a704cf71c49a6****
&ShowDataOption=Source
&公共请求参数

正常返回示例

XML格式

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

<GetTemplateScratchResponse>
    <TemplateScratch>
        <Status>GENERATE_COMPLETE</Status>
        <Description>复制VPC资源。</Description>
        <CreateTime>2021-12-22T01:49:22</CreateTime>
        <TemplateScratchId>ts-7f7a704cf71c49a6****</TemplateScratchId>
        <LogicalIdStrategy>LongTypePrefixAndIndexSuffix</LogicalIdStrategy>
        <PreferenceParameters>
            <ParameterValue>vpc-bp1xuamwmphrpcfim****</ParameterValue>
            <ParameterKey>VpcId</ParameterKey>
        </PreferenceParameters>
        <PreferenceParameters>
            <ParameterValue>Retain</ParameterValue>
            <ParameterKey>DeletionPolicy</ParameterKey>
        </PreferenceParameters>
        <PreferenceParameters>
            <ParameterValue>cn-hangzhou</ParameterValue>
            <ParameterKey>RegionId</ParameterKey>
        </PreferenceParameters>
        <PreferenceParameters>
            <ParameterKey>ZoneId</ParameterKey>
        </PreferenceParameters>
        <PreferenceParameters>
            <ParameterKey>VSwitchId</ParameterKey>
        </PreferenceParameters>
        <PreferenceParameters>
            <ParameterKey>InstanceDataReplication</ParameterKey>
        </PreferenceParameters>
        <TemplateScratchData>
            <Source>
                <RegionId>cn-hangzhou</RegionId>
                <Nodes>
                    <ECSVPC_001>
                        <ResourceId>vpc-m5e7cv7e9mz69sszb****</ResourceId>
                        <NodeType>SourceNode</NodeType>
                        <ResourceType>ALIYUN::ECS::VPC</ResourceType>
                        <Properties>
                            <Description>
                                <Type>String</Type>
                            </Description>
                            <SecondaryCidrBlock>
                                <Type>String</Type>
                            </SecondaryCidrBlock>
                            <CidrBlock>
                                <Type>String</Type>
                                <Value>172.16.0.0/12</Value>
                            </CidrBlock>
                            <VpcName>
                                <Type>String</Type>
                                <Value>tf_test</Value>
                            </VpcName>
                            <Ipv6CidrBlock>
                                <Type>String</Type>
                            </Ipv6CidrBlock>
                            <Tags>
                                <Type>List</Type>
                            </Tags>
                            <EnableIpv6>
                                <Type>Boolean</Type>
                                <Value>false</Value>
                            </EnableIpv6>
                            <UserCidr>
                                <Type>String</Type>
                            </UserCidr>
                        </Properties>
                        <ResourceIdentifiers>VpcId</ResourceIdentifiers>
                    </ECSVPC_001>
                </Nodes>
            </Source>
        </TemplateScratchData>
        <UpdateTime>2021-12-22T01:49:23</UpdateTime>
        <Stacks>
            <RegionId>cn-hangzhou</RegionId>
            <UsageType>ArchitectureReplication</UsageType>
            <StackId>3708bf6a-3a67-44d4-9eb1-c56704b9****</StackId>
        </Stacks>
        <TemplateScratchType>ArchitectureReplication</TemplateScratchType>
        <StackProvision>
            <Creatable>true</Creatable>
            <Importable>false</Importable>
        </StackProvision>
        <SourceResources>
            <ResourceId>vpc-m5e7cv7e9mz69sszb****</ResourceId>
            <ResourceType>ALIYUN::ECS::VPC</ResourceType>
        </SourceResources>
    </TemplateScratch>
    <RequestId>A8E0EF98-6FBD-5656-8298-FC8194F0F7B7</RequestId>
</GetTemplateScratchResponse>

JSON格式

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

{
  "TemplateScratch" : {
    "Status" : "GENERATE_COMPLETE",
    "Description" : "复制VPC资源。",
    "CreateTime" : "2021-12-22T01:49:22",
    "TemplateScratchId" : "ts-7f7a704cf71c49a6****",
    "LogicalIdStrategy" : "LongTypePrefixAndIndexSuffix",
    "PreferenceParameters" : [ {
      "ParameterValue" : "vpc-bp1xuamwmphrpcfim****",
      "ParameterKey" : "VpcId"
    }, {
      "ParameterValue" : "Retain",
      "ParameterKey" : "DeletionPolicy"
    }, {
      "ParameterValue" : "cn-hangzhou",
      "ParameterKey" : "RegionId"
    }, {
      "ParameterKey" : "ZoneId"
    }, {
      "ParameterKey" : "VSwitchId"
    }, {
      "ParameterKey" : "InstanceDataReplication"
    } ],
    "TemplateScratchData" : {
      "Source" : {
        "RegionId" : "cn-hangzhou",
        "Nodes" : {
          "ECSVPC_001" : {
            "ResourceId" : "vpc-m5e7cv7e9mz69sszb****",
            "NodeType" : "SourceNode",
            "ResourceType" : "ALIYUN::ECS::VPC",
            "Properties" : {
              "Description" : {
                "Type" : "String"
              },
              "SecondaryCidrBlock" : {
                "Type" : "String"
              },
              "CidrBlock" : {
                "Type" : "String",
                "Value" : "172.16.0.0/12"
              },
              "VpcName" : {
                "Type" : "String",
                "Value" : "tf_test"
              },
              "Ipv6CidrBlock" : {
                "Type" : "String"
              },
              "Tags" : {
                "Type" : "List"
              },
              "EnableIpv6" : {
                "Type" : "Boolean",
                "Value" : false
              },
              "UserCidr" : {
                "Type" : "String"
              }
            },
            "ResourceIdentifiers" : [ "VpcId" ]
          }
        }
      }
    },
    "UpdateTime" : "2021-12-22T01:49:23",
    "Stacks" : [ {
      "RegionId" : "cn-hangzhou",
      "UsageType" : "ArchitectureReplication",
      "StackId" : "3708bf6a-3a67-44d4-9eb1-c56704b9****"
    } ],
    "TemplateScratchType" : "ArchitectureReplication",
    "StackProvision" : {
      "Creatable" : true,
      "Importable" : false
    },
    "SourceResources" : [ {
      "ResourceId" : "vpc-m5e7cv7e9mz69sszb****",
      "ResourceType" : "ALIYUN::ECS::VPC"
    } ]
  },
  "RequestId" : "A8E0EF98-6FBD-5656-8298-FC8194F0F7B7"
}

错误码

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