文档

GenerateTemplateByScratch - 为资源场景生成模板

更新时间:

为资源场景生成模板。

接口说明

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

说明 资源探查类型的资源场景不支持生成模板。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ros:GenerateTemplateByScratchlist
  • TemplateScratch
    acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

请求参数

名称类型必填描述示例值
RegionIdstring

资源场景所属的地域 ID。

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

cn-hangzhou
TemplateScratchIdstring

资源场景 ID。

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

ts-aa9c62feab844a6b****
ProvisionRegionIdstring

新节点所属的地域 ID。

cn-hangzhou
TemplateTypestring

生成模板类型,支持生成 ROS 和 Terraform 类型的模板,默认为 ROS。

ROS

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D22C1D13-D74E-558C-AF68-1B4C05FA6F1A
TemplateBodystring

资源场景中生成的模板内容。

{\"ROSTemplateFormatVersion\": \"2015-09-01\", \"Resources\": {\"ECSVPC_001\": {\"DeletionPolicy\": \"Retain\", \"Type\": \"ALIYUN::ECS::VPC\", \"Properties\": {\"CidrBlock\": \"172.16.0.0/12\", \"VpcName\": \"MyTestVpc\", \"EnableIpv6\": false}}}}
ResourcesToImportarray<object>

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

说明 仅资源纳管类型的资源场景支持返回该参数。
object
ResourceTypestring

资源类型。

ALIYUN::ECS::VPC
LogicalResourceIdstring

资源逻辑 ID。

ECSVPC_001
ResourceIdentifierobject

字符串到字符串的键值映射。取值是 JSON 格式的字符串,用来标识要导入的资源。
键是资源的标识符属性(例如:ALIYUN::ECS::VPC 资源的 VpcId),值是属性的取值(例如:vpc-bp1m6fww66xbntjyc****")。

{"VpcId": "vpc-bp1m6fww66xbntjyc****" }

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-25OpenAPI 入参发生变更查看变更详情