ListTemplateScratches - 查询资源场景列表 - 资源编排

查询资源场景列表。

接口说明

本文为您提供一个示例，查询杭州地域的资源场景列表。返回结果显示，杭州地域有 2 个资源场景，分别为资源纳管和资源复制。

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	资源场景所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
TemplateScratchId	string	否	资源场景 ID。	ts-7f7a704cf71c49a6****
TemplateScratchType	string	否	资源场景类型，取值： ArchitectureReplication：资源复制。 ArchitectureDetection：资源探查。 ResourceImport：资源纳管。 ResourceMigration：资源迁移。	ArchitectureReplication
Status	string	否	资源场景状态，取值： GENERATE_IN_PROGRESS：生成中。 GENERATE_COMPLETE：生成完成。 GENERATE_FAILED：生成失败。	["GENERATE_COMPLETE"]
Tags	array<object>	否	资源场景的标签。
	object	否
Key	string	是	资源场景的标签键。说明 Tags 为可选参数。如果需要指定 Tags，则 Tags.N.Key 必须指定。	usage
Value	string	否	资源场景的标签值。	test
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10
PageNumber	integer	否	资源场景的页码。起始值：1。默认值：1。	1
ResourceGroupId	string	否	资源组 ID。	rg-acfmxazb4ph6aiy****

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D1C09606-C58B-558F-9B4E-5BF263D17D09
TotalCount	integer	资源场景总个数。	2
PageNumber	integer	资源场景的页码。	1
PageSize	integer	分页查询时设置的每页行数。	10
TemplateScratches	array<object>	资源场景列表。
	object
TemplateScratchId	string	资源场景 ID。	ts-48ad85d66cca4620****
TemplateScratchType	string	资源场景类型，取值： ResourceImport：资源纳管。 ArchitectureReplication：资源复制。	ResourceImport
Status	string	资源场景状态。	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
PreferenceParameters	array<object>	资源场景配置参数。
	object
ParameterKey	string	参数名称。	DeletionPolicy
ParameterValue	string	参数值。	Retain
Description	string	资源场景说明。	纳管VPC资源。
SourceResources	array<object>	源资源。
	object
ResourceId	string	资源 ID。	vpc-m5eauuq80anx59v28****
ResourceType	string	资源类型。	ALIYUN::ECS::VPC
SourceTag	object	源标签。
ResourceTags	object	源标签。	{"a": "b"}
ResourceTypeFilter	array	资源类型筛选器。
	string	资源类型筛选器。	ALIYUN::ECS::VPC
SourceResourceGroup	object	源资源组。
ResourceGroupId	string	源资源组 ID。	rg-acfmzawhxxc****
ResourceTypeFilter	array	资源类型筛选器。
	string	资源类型筛选器。	ALIYUN::ECS::VPC
LogicalIdStrategy	string	逻辑 ID 生成策略，取值： LongTypePrefixAndIndexSuffix（默认值）：长类型前缀+索引后缀。 LongTypePrefixAndHashSuffix：长类型前缀+哈希后缀。 ShortTypePrefixAndHashSuffix：短类型前缀+哈希后缀。	LongTypePrefixAndIndexSuffix
Tags	array<object>	资源场景的标签。
	object
Key	string	资源场景的标签键。	usage1
Value	string	资源场景的标签值。	test1
CreateTime	string	资源场景创建时间。按照 ISO8601 标准表示，需使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ss。	2021-12-07T08:06:44
UpdateTime	string	资源场景更新时间。按照 ISO8601 标准表示，需使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ss。	2021-12-07T08:06:44
ResourceGroupId	string	资源组 ID。	rg-acfm4nxcvht4pmi

示例

正常返回示例

JSON格式

{
  "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": "纳管VPC资源。",
      "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"
    }
  ]
}

错误码

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

变更历史

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