查詢資源場景列表。
接口說明
本文為您提供一個示例，查詢杭州地域的資源場景列表。返回結果顯示，杭州地域有 2 個資源場景，分別為資源納管和資源復制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ros:ListTemplateScratches | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 資源場景所屬的地域 ID。 您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| TemplateScratchId | string | 否 | 資源場景 ID。 | ts-7f7a704cf71c49a6**** |
| TemplateScratchType | string | 否 | 資源場景類型，取值：
| ArchitectureReplication |
| Status | string | 否 | 資源場景狀態，取值：
| ["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**** |
關于公共請求參數的詳情，請參見公共參數。
返回參數
示例
正常返回示例
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 返回結構發生變更 | 查看變更詳情 |