GetTemplateScratch - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries the details of a resource scenario.

Operation description

In this example, the details of the resource scenario whose ID is ts-7f7a704cf71c49a6**** is queried. In the response, the source node data is displayed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource scenario. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
TemplateScratchId	string	Yes	The ID of the resource scenario.	ts-7f7a704cf71c49a6****
ShowDataOption	string	No	The data display option. Valid values: Sources: displays only the data of source nodes. This setting takes effect only when TemplateScratchType is set to ArchitectureDetection. Source: displays only the data of the source node. This setting takes effect only when TemplateScratchType is not set to ArchitectureDetection. Provisions: displays only the data of new nodes. This setting takes effect only when TemplateScratchType is not set to ArchitectureDetection. All: displays all data. For more information about source nodes and new nodes, see Overview . Note If you do not specify this parameter, the node data is not displayed.	Source

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	A8E0EF98-6FBD-5656-8298-FC8194F0F7B7
TemplateScratch	object	The resource scenario.
TemplateScratchId	string	The ID of the resource scenario.	ts-7f7a704cf71c49a6****
TemplateScratchType	string	The type of the resource scenario. Valid values: ResourceImport: resource management ArchitectureReplication: resource replication	ArchitectureReplication
Status	string	The state of the resource scenario. Valid values: GENERATE_IN_PROGRESS: The resource scenario is being created. GENERATE_COMPLETE: The resource scenario is created. GENERATE_FAILED: The resource scenario fails to be created.	GENERATE_COMPLETE
StatusReason	string	The reason why the resource scenario fails to be created. Note This parameter is returned only if you set Status to GENERATE_FAILED.	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.
FailedCode	string	The status code of the resource scenario that fails to be created. Note This parameter is returned only if you set Status to GENERATE_FAILED.	InvalidZoneId
TemplateScratchData	object	The resource scenario data.
PreferenceParameters	array<object>	The preference parameters of the resource scenario.
	object
ParameterKey	string	The parameter name.	DeletionPolicy
ParameterValue	string	The parameter value.	Retain
Description	string	The description of the resource scenario.	The description of the resource scenario.
SourceResources	array<object>	The source resources.
	object	The source resource.
ResourceId	string	The resource ID.	vpc-m5e7cv7e9mz69sszb****
ResourceType	string	The resource type.	ALIYUN::ECS::VPC
RelatedResourceTypeFilter	array	The related resource type filters.
	string	The related resource type filter.	ALIYUN::ECS::VPC
SourceTag	object	The source tag.
ResourceTags	object	The source tags.	{"a": "b"}
ResourceTypeFilter	array	The resource type filters.
	string	The resource type filter.	ALIYUN::ECS::VPC
SourceResourceGroup	object	The source resource group.
ResourceGroupId	string	The ID of the source resource group.	rg-acfmzawhxxc****
ResourceTypeFilter	array	The resource type filters.
	string	The resource type filter.	ALIYUN::ECS::VPC
LogicalIdStrategy	string	The policy based on which the logical ID is generated. Valid values: LongTypePrefixAndIndexSuffix (default): long-type prefix + index-type suffix LongTypePrefixAndHashSuffix: long-type prefix + hash-type suffix ShortTypePrefixAndHashSuffix: short-type prefix + hash-type suffix	LongTypePrefixAndIndexSuffix
CreateTime	string	The time at which the resource scenario was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2021-12-22T01:49:22
UpdateTime	string	The time at which the resource scenario was updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2021-12-22T01:49:23
Stacks	array<object>	The stacks that are associated with the resource scenario.
	object
StackId	string	The stack ID.	3708bf6a-3a67-44d4-9eb1-c56704b9****
RegionId	string	The region ID of the stack.	cn-hangzhou
UsageType	string	The purpose of the stack. Valid values: ResourceImport: resource management ArchitectureReplication: resource replication	ArchitectureReplication
StackProvision	object	The preset information of the stack.
Creatable	boolean	Indicates whether the resource is replicated by calling the CreateStack operation. Valid values: true false	true
Importable	boolean	Indicates whether the resource is managed by calling the CreateChangeSet operation. Valid values: true false	false
ResourceGroupId	string	The ID of the resource group.	rg-acfmzmhzoaad5oq

Examples

Sample success responses

JSONformat

{
  "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": "The description of the resource scenario. ",
    "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"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-24	The response structure of the API has changed	View Change Details
2023-10-10	The response structure of the API has changed	View Change Details