调用GenerateTemplateByScratch接口为资源场景生成模板。

本文将提供一个示例,在杭州地域为资源纳管类型的资源场景ts-aa9c62feab844a6b****生成模板。

调试

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

请求参数

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

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

RegionId String cn-hangzhou

资源场景所属的地域ID。

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

TemplateScratchId String ts-aa9c62feab844a6b****

资源场景ID。

关于如何获取资源场景ID,请参见ListTemplateScratches

ProvisionRegionId String cn-hangzhou

新节点所属的地域ID。

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

返回数据

名称 类型 示例值 描述
RequestId String D22C1D13-D74E-558C-AF68-1B4C05FA6F1A

请求ID。

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 of ResourceToImport

资源纳管类型的资源场景中,待导入资源栈的资源。

说明 仅资源纳管类型的资源场景支持返回该参数。
ResourceType String ALIYUN::ECS::VPC

资源类型。

LogicalResourceId String ECSVPC_001

资源逻辑ID。

ResourceIdentifier Map

字符串到字符串的键值映射。取值是JSON格式的字符串,用来标识要导入的资源。

键是资源的标识符属性(例如:ALIYUN::ECS::VPC资源的VpcId),值是属性的取值(例如:vpc-bp1m6fww66xbntjyc****")。

示例

请求示例

http(s)://[Endpoint]/?Action=GenerateTemplateByScratch
&RegionId=cn-hangzhou
&TemplateScratchId=ts-aa9c62feab844a6b****
&公共请求参数

正常返回示例

XML格式

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

<GenerateTemplateByScratchResponse>
    <RequestId>D22C1D13-D74E-558C-AF68-1B4C05FA6F1A</RequestId>
    <ResourcesToImport>
        <ResourceIdentifier>
            <VpcId>vpc-bp1m6fww66xbntjyc****</VpcId>
        </ResourceIdentifier>
        <LogicalResourceId>ECSVPC_001</LogicalResourceId>
        <ResourceType>ALIYUN::ECS::VPC</ResourceType>
    </ResourcesToImport>
    <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}}}}</TemplateBody>
</GenerateTemplateByScratchResponse>

JSON格式

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

{
  "RequestId" : "D22C1D13-D74E-558C-AF68-1B4C05FA6F1A",
  "ResourcesToImport" : [ {
    "ResourceIdentifier" : {
      "VpcId" : "vpc-bp1m6fww66xbntjyc****"
    },
    "LogicalResourceId" : "ECSVPC_001",
    "ResourceType" : "ALIYUN::ECS::VPC"
  } ],
  "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}}}}"
}

错误码

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