ListTemplateScratches - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries scenarios.

Operation description

In this example, the scenarios that are created in the China (Hangzhou) region are queried. In the response, a scenario of the Resource Management and a scenario of the Resource Replication type are returned.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ros:ListTemplateScratches	get	TemplateScratch acs:ros:{#regionId}:{#accountId}:templatescratch/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scenario. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
TemplateScratchId	string	No	The ID of the scenario.	ts-7f7a704cf71c49a6****
TemplateScratchType	string	No	The type of the resource scenario. Valid values: ArchitectureReplication: resource replication ArchitectureDetection: resource detection ResourceImport: resource management ResourceMigration: resource migration	ArchitectureReplication
Status	string	No	The status of the scenario. Valid values: GENERATE_IN_PROGRESS: The scenario is being created. GENERATE_COMPLETE: The scenario is created. GENERATE_FAILED: The scenario fails to be created.	["GENERATE_COMPLETE"]
Tags	array<object>	No	The tags of the scenario.
	object	No
Key	string	Yes	The tag key of the scenario. Note Tags is optional. If you want to specify Tags, you must specify Key.	usage
Value	string	No	The tag value of the scenario.	test
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1	1
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxazb4ph6aiy****

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	D1C09606-C58B-558F-9B4E-5BF263D17D09
TotalCount	integer	The total number of scenarios.	2
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TemplateScratches	array<object>	The resource scenarios.
	object
TemplateScratchId	string	The ID of the resource scenario.	ts-48ad85d66cca4620****
TemplateScratchType	string	The type of the resource scenario. Valid values: ResourceImport: resource management ArchitectureReplication: resource replication	ResourceImport
Status	string	The state of the resource scenario.	GENERATE_COMPLETE
StatusReason	string	The reason why the resource scenario failed to be generated. Note This parameter is returned only if the value of Status is 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 failed to be generated. Note This parameter is returned only if the value of Status is GENERATE_FAILED.	InvalidZoneId
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 scenario.
SourceResources	array<object>	The source resources.
	object
ResourceId	string	The resource ID.	vpc-m5eauuq80anx59v28****
ResourceType	string	The resource type.	ALIYUN::ECS::VPC
SourceTag	object	The source tag.
ResourceTags	object	The source tags.	{"a": "b"}
ResourceTypeFilter	array	The resource types for filtering resources.
	string	The resource type for filtering resources.	ALIYUN::ECS::VPC
SourceResourceGroup	object	The source resource group.
ResourceGroupId	string	The ID of the source resource group.	rg-acfmzawhxxc****
ResourceTypeFilter	array	The resource types for filtering resources.
	string	The resource type for filtering resources.	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
Tags	array<object>	The tags of the resource scenario.
	object
Key	string	The tag key of the resource scenario.	usage1
Value	string	The tag value of the resource scenario.	test1
CreateTime	string	The time when 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-07T08:06:44
UpdateTime	string	The time when 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-07T08:06:44
ResourceGroupId	string	The ID of the resource group.	rg-acfm4nxcvht4pmi

Examples

Sample success responses

JSONformat

{
  "RequestId": "D1C09606-C58B-558F-9B4E-5BF263D17D09",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10,
  "TemplateScratches": [
    {
      "TemplateScratchId": "ts-48ad85d66cca4620****",
      "TemplateScratchType": "ResourceImport",
      "Status": "GENERATE_COMPLETE",
      "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
      "FailedCode": "InvalidZoneId",
      "PreferenceParameters": [
        {
          "ParameterKey": "DeletionPolicy",
          "ParameterValue": "Retain"
        }
      ],
      "Description": "The description of the scenario.",
      "SourceResources": [
        {
          "ResourceId": "vpc-m5eauuq80anx59v28****",
          "ResourceType": "ALIYUN::ECS::VPC"
        }
      ],
      "SourceTag": {
        "ResourceTags": {
          "a": "b"
        },
        "ResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      },
      "SourceResourceGroup": {
        "ResourceGroupId": "rg-acfmzawhxxc****",
        "ResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      },
      "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
      "Tags": [
        {
          "Key": "usage1",
          "Value": "test1"
        }
      ],
      "CreateTime": "2021-12-07T08:06:44",
      "UpdateTime": "2021-12-07T08:06:44",
      "ResourceGroupId": "rg-acfm4nxcvht4pmi"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-10-10	The request parameters of the API has changed. The response structure of the API has changed	View Change Details