文档

ListTemplateScratches - 查询资源场景列表

更新时间:

查询资源场景列表。

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ros:ListTemplateScratchesRead
  • TemplateScratch
    acs:ros:{#regionId}:{#accountId}:templatescratch/*

请求参数

名称类型必填描述示例值
RegionIdstring

资源场景所属的地域 ID。

您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
TemplateScratchIdstring

资源场景 ID。

ts-7f7a704cf71c49a6****
TemplateScratchTypestring

资源场景类型,取值:

  • ArchitectureReplication:资源复制。

  • ArchitectureDetection:资源探查。

  • ResourceImport:资源纳管。

  • ResourceMigration:资源迁移。

ArchitectureReplication
Statusstring

资源场景状态,取值:

  • GENERATE_IN_PROGRESS:生成中。

  • GENERATE_COMPLETE:生成完成。

  • GENERATE_FAILED:生成失败。

["GENERATE_COMPLETE"]
Tagsobject []

资源场景的标签。

Keystring

资源场景的标签键。

说明 Tags 为可选参数。如果需要指定 Tags,则 Tags.N.Key 必须指定。
usage
Valuestring

资源场景的标签值。

test
PageSizeinteger

分页查询时设置的每页行数。

最大值:50。

默认值:10。

10
PageNumberinteger

资源场景的页码。

起始值:1。

默认值:1。

1
ResourceGroupIdstring

资源组 ID。

rg-acfmxazb4ph6aiy****

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D1C09606-C58B-558F-9B4E-5BF263D17D09
TotalCountinteger

资源场景总个数。

2
PageNumberinteger

资源场景的页码。

1
PageSizeinteger

分页查询时设置的每页行数。

10
TemplateScratchesobject []

资源场景列表。

TemplateScratchIdstring

资源场景 ID。

ts-48ad85d66cca4620****
TemplateScratchTypestring

资源场景类型,取值:

  • ResourceImport:资源纳管。

  • ArchitectureReplication:资源复制。

ResourceImport
Statusstring

资源场景状态。

GENERATE_COMPLETE
StatusReasonstring

资源场景生成失败的原因。

说明 仅当 Status 为 GENERATE_FAILED 时返回该参数。
Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.
FailedCodestring

资源场景生成失败的状态码。

说明 仅当 Status 为 GENERATE_FAILED 时返回该参数。
InvalidZoneId
PreferenceParametersobject []

资源场景配置参数。

ParameterKeystring

参数名称。

DeletionPolicy
ParameterValuestring

参数值。

Retain
Descriptionstring

资源场景说明。

纳管VPC资源。
SourceResourcesobject []

源资源。

ResourceIdstring

资源 ID。

vpc-m5eauuq80anx59v28****
ResourceTypestring

资源类型。

ALIYUN::ECS::VPC
SourceTagobject

源标签。

ResourceTagsobject

源标签。

{"a": "b"}
ResourceTypeFilterarray

资源类型筛选器。

string

资源类型筛选器。

ALIYUN::ECS::VPC
SourceResourceGroupobject

源资源组。

ResourceGroupIdstring

源资源组 ID。

rg-acfmzawhxxc****
ResourceTypeFilterarray

资源类型筛选器。

string

资源类型筛选器。

ALIYUN::ECS::VPC
LogicalIdStrategystring

逻辑 ID 生成策略,取值:

  • LongTypePrefixAndIndexSuffix(默认值):长类型前缀+索引后缀。

  • LongTypePrefixAndHashSuffix:长类型前缀+哈希后缀。

  • ShortTypePrefixAndHashSuffix:短类型前缀+哈希后缀。

LongTypePrefixAndIndexSuffix
Tagsobject []

资源场景的标签。

Keystring

资源场景的标签键。

usage1
Valuestring

资源场景的标签值。

test1
CreateTimestring

资源场景创建时间。

按照 ISO8601 标准表示,需使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ss。

2021-12-07T08:06:44
UpdateTimestring

资源场景更新时间。

按照 ISO8601 标准表示,需使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ss。

2021-12-07T08:06:44
ResourceGroupIdstring

资源组 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-10OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)