GetTemplateScratch - 获取资源场景详情 - 资源编排

获取资源场景详情。

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ros:GetTemplateScratch	get	*TemplateScratch `acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	资源场景所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
TemplateScratchId	string	是	资源场景 ID。	ts-7f7a704cf71c49a6****
ShowDataOption	string	否	数据显示选项，取值： Sources：仅显示源节点数据，且针对 TemplateScratchType 为 ArchitectureDetection。 Source：仅显示源节点数据，且针对 TemplateScratchType 不为 ArchitectureDetection。 Provisions：仅显示新节点数据，且针对 TemplateScratchType 不为 ArchitectureDetection。 All：显示所有数据。关于源节点和新节点的更多信息，请参见概览。说明不设置该参数时，默认不显示节点数据。	Source

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	A8E0EF98-6FBD-5656-8298-FC8194F0F7B7
TemplateScratch	object	资源场景。
TemplateScratchId	string	资源场景 ID。	ts-7f7a704cf71c49a6****
TemplateScratchType	string	资源场景类型，取值： ResourceImport：资源纳管。 ArchitectureReplication：资源复制。	ArchitectureReplication
Status	string	资源场景状态，取值： GENERATE_IN_PROGRESS：生成中。 GENERATE_COMPLETE：生成完成。 GENERATE_FAILED：生成失败。	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
TemplateScratchData	object	资源场景数据。	参见返回示例
PreferenceParameters	array<object>	资源场景配置参数。
PreferenceParameter	object
ParameterKey	string	参数名称。	DeletionPolicy
ParameterValue	string	参数值。	Retain
Description	string	资源场景说明。	复制VPC资源。
SourceResources	array<object>	源资源。
SourceResource	object	源资源。
ResourceId	string	资源 ID。	vpc-m5e7cv7e9mz69sszb****
ResourceType	string	资源类型。	ALIYUN::ECS::VPC
RelatedResourceTypeFilter	array	附属资源类型筛选器。
RelatedResourceTypeFilter	string	附属资源类型筛选器。	ALIYUN::ECS::VPC
SourceTag	object	源标签。
ResourceTags	object	源标签。	{"a": "b"}
ResourceTypeFilter	array	资源类型筛选器。
ResourceTypeFilter	string	资源类型筛选器。	ALIYUN::ECS::VPC
SourceResourceGroup	object	源资源组。
ResourceGroupId	string	源资源组 ID。	rg-acfmzawhxxc****
ResourceTypeFilter	array	资源类型筛选器。
ResourceTypeFilter	string	资源类型筛选器。	ALIYUN::ECS::VPC
LogicalIdStrategy	string	逻辑 ID 生成策略，取值： LongTypePrefixAndIndexSuffix（默认值）：长类型前缀+索引后缀。 LongTypePrefixAndHashSuffix：长类型前缀+哈希后缀。 ShortTypePrefixAndHashSuffix：短类型前缀+哈希后缀。	LongTypePrefixAndIndexSuffix
CreateTime	string	资源场景创建时间。按照 ISO8601 标准表示，需使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ss。	2021-12-22T01:49:22
UpdateTime	string	资源场景更新时间。按照 ISO8601 标准表示，需使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ss。	2021-12-22T01:49:23
Stacks	array<object>	资源场景关联的资源栈列表。
Stack	object
StackId	string	资源栈 ID。	3708bf6a-3a67-44d4-9eb1-c56704b9****
RegionId	string	资源栈所属的地域 ID。	cn-hangzhou
UsageType	string	资源栈用途，取值： ResourceImport：资源纳管。 ArchitectureReplication：资源复制。	ArchitectureReplication
StackProvision	object	资源栈预置信息。
Creatable	boolean	是否支持通过 CreateStack 创建资源栈以进行资源复制，取值： true：支持。 false：不支持。	true
Importable	boolean	是否支持通过 CreateChangeSet 创建更改集以进行资源纳管，取值： true：支持。 false：不支持。	false
ResourceGroupId	string	资源组 ID。	rg-acfmzmhzoaad5oq

示例

正常返回示例

JSON格式

{
  "RequestId": "A8E0EF98-6FBD-5656-8298-FC8194F0F7B7",
  "TemplateScratch": {
    "TemplateScratchId": "ts-7f7a704cf71c49a6****",
    "TemplateScratchType": "ArchitectureReplication",
    "Status": "GENERATE_COMPLETE",
    "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
    "FailedCode": "InvalidZoneId",
    "TemplateScratchData": {
      "test": "test",
      "test2": 1
    },
    "PreferenceParameters": [
      {
        "ParameterKey": "DeletionPolicy",
        "ParameterValue": "Retain"
      }
    ],
    "Description": "复制VPC资源。",
    "SourceResources": [
      {
        "ResourceId": "vpc-m5e7cv7e9mz69sszb****",
        "ResourceType": "ALIYUN::ECS::VPC",
        "RelatedResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      }
    ],
    "SourceTag": {
      "ResourceTags": {
        "a": "b"
      },
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "SourceResourceGroup": {
      "ResourceGroupId": "rg-acfmzawhxxc****",
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
    "CreateTime": "2021-12-22T01:49:22",
    "UpdateTime": "2021-12-22T01:49:23",
    "Stacks": [
      {
        "StackId": "3708bf6a-3a67-44d4-9eb1-c56704b9****",
        "RegionId": "cn-hangzhou",
        "UsageType": "ArchitectureReplication"
      }
    ],
    "StackProvision": {
      "Creatable": true,
      "Importable": false
    },
    "ResourceGroupId": "rg-acfmzmhzoaad5oq"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-04-24	OpenAPI 返回结构发生变更	查看变更详情
2023-10-10	OpenAPI 返回结构发生变更	查看变更详情