Retrieve Resource Scenario Details via GetTemplateScratch API - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Retrieves the details of a resource scenario.

Operation description

This topic provides an example of how to query the details of the resource scenario ts-7f7a704cf71c49a6**** in the China (Hangzhou) region and display source node data.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:GetTemplateScratch

get

*TemplateScratch

acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource scenario. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
TemplateScratchId	string	No	The ID of the resource scenario.	ts-7f7a704cf71c49a6****
ShowDataOption	string	No	The data display option. Valid values: Sources: displays only source node data. This value is applicable when TemplateScratchType is set to ArchitectureDetection. Source: displays only source node data. This value is applicable when TemplateScratchType is not set to ArchitectureDetection. Provisions: displays only new node data. This value is applicable 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, node data is not displayed by default.	Source

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	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 status of the resource scenario. Valid values: GENERATE_IN_PROGRESS: being generated. GENERATE_COMPLETE: generated. GENERATE_FAILED: failed to be generated.	GENERATE_COMPLETE
StatusReason	string	The reason why the resource scenario failed to be generated. Note This parameter is returned only when Status is set to GENERATE_FAILED.	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.
FailedCode	string	The status code that indicates why the resource scenario failed to be generated. Note This parameter is returned only when Status is set to GENERATE_FAILED.	InvalidZoneId
TemplateScratchData	object	The resource scenario data.	See the response example.
PreferenceParameters	array<object>	The configuration 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.	Copy VPC resources.
SourceResources	array<object>	The source resources.
	object	The source resources.
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 logical ID generation strategy. Valid values: LongTypePrefixAndIndexSuffix (default): long type prefix with index suffix. LongTypePrefixAndHashSuffix: long type prefix with hash suffix. ShortTypePrefixAndHashSuffix: short type prefix with hash suffix.	LongTypePrefixAndIndexSuffix
CreateTime	string	The time when the resource scenario was created. The time is displayed in UTC+0 and follows the ISO 8601 standard without the trailing Z. Format: YYYY-MM-DDThh:mm:ss.	2021-12-22T01:49:22
UpdateTime	string	The time when the resource scenario was last updated. The time is displayed in UTC+0 and follows the ISO 8601 standard without the trailing Z. Format: YYYY-MM-DDThh:mm:ss.	2021-12-22T01:49:23
Stacks	array<object>	The list of stacks 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 stack provisioning information.
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 resource group ID.	rg-acfmzmhzoaad5oq

Examples

Success response

JSON format

{
  "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": "Copy VPC resources.",
    "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.