查詢模板參數的取值。
接口說明
使用說明
本文將提供一個示例，查詢杭州地域模板{ "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } } }中參數ZoneInfo的取值。
關于本接口支持查詢的參數和模板內容，請參見參數約束查詢。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ros:GetTemplateParameterConstraints | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TemplateBody | string | 否 | 模板主體的結構。長度為 1~524,288 個字節。如果長度較長，則建議通過 HTTP POST+Body Param 的方式，將參數放在請求體中進行傳遞，避免因 URL 過長而導致請求失敗。 說明
您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 和 TemplateScratchId 其中一個參數。
| { "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } } } |
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| TemplateURL | string | 否 | 包含模板主體的文件的位置。URL 必須指向位于 Web 服務器（HTTP 或 HTTPS）或阿里云 OSS 存儲空間（例如：oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou）中的模板，模板的最大長度為 524,288 個字節。如未指定 OSS 地域，默認與接口參數 RegionId 相同。 說明
您必須且僅能指定 TemplateBody、TemplateURL 和 TemplateId 其中一個參數。
| oss://ros-template/demo |
| TemplateId | string | 否 | 模板 ID。支持共享模板和私有模板。 說明
您必須且僅能指定 TemplateBody、TemplateURL 和 TemplateId 其中一個參數。
| 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
| TemplateVersion | string | 否 | 模板版本。如果不指定，默認取最新版本。 說明
TemplateVersion 僅在指定 TemplateId 時生效。
| v1 |
| Parameters | array<object> | 否 | 模板中已定義的參數。 | |
| object | 否 | |||
| ParameterKey | string | 是 | 模板中已定義的參數的名稱。 說明
Parameters 為可選參數。若指定了 Parameters，則 ParameterKey 為必選參數。
| ZoneInfo |
| ParameterValue | string | 是 | 模板中已定義的參數的取值。 說明
Parameters 為可選參數。若指定了 Parameters，則 ParameterValue 為必選參數。
| cn-hangzhou-h |
| ParametersKeyFilter | array | 否 | 需要查詢的參數列表。 | |
| string | 否 | 需要查詢的參數。 | ZoneInfo | |
| ClientToken | string | 否 | 保證請求的冪等性。 該值由客戶端生成，并且必須是全局唯一的。長度不超過 64 個字符，可包含英文字母、數字、短劃線（-）和下劃線（_）。 更多信息，請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-42665544**** |
| ParametersOrder | array | 否 | 參數依賴關系。 | |
| string | 否 | 參數依賴關系的順序。 說明
默認按照模板中 Metadata參數的依賴關系。
| ["ZoneId", "InstanceType"] | |
| StackId | string | 否 | 資源棧 ID。 當填寫此參數時，表示查詢變配場景的參數約束。 | c754d2a4-28f1-46df-b557-9586173a**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "9816785B-BCF8-514D-8B76-C1EC2BC954FC",
"ParameterConstraints": [
{
"ParameterKey": "ZoneInfo",
"Type": "String",
"AllowedValues": [
"cn-hangzhou-h"
],
"Behavior": "NoLimit",
"BehaviorReason": "No resource property refer to the parameter",
"AssociationParameterNames": [
"InstanceType"
],
"IllegalValueByParameterConstraints": [
"cn-hangzhou-h"
],
"IllegalValueByRules": [
"cn-hangzhou-h"
],
"NotSupportResources": [
{
"ResourceType": "ALIYUN::ECS::InstanceGroup",
"PropertyName": "InstanceName"
}
],
"QueryErrors": [
{
"ErrorMessage": "ALIYUN::ECS::InstanceGroup",
"ResourceName": "MyECS",
"ResourceType": "InstanceType is needed while query DataDisk"
}
],
"OriginalConstraints": [
{
"ResourceName": "MyECS",
"AllowedValues": [
"cn-hangzhou-a"
],
"ResourceType": "ALIYUN::ECS::InstanceGroup\n",
"PropertyName": "ZoneId",
"Behavior": "QueryError",
"BehaviorReason": "No resource property refer to the parameter"
}
],
"QueryTimeoutDetails": [
{
"ResourceType": "ALIYUN::RDS::DBInstance",
"ResourceName": "rds",
"ErrorMessage": "query property SlaveZoneIds.* in resource rds error, error message: query 8 seconds timeout"
}
]
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-04 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-07-18 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-06-21 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2023-06-02 | OpenAPI 返回結構發生變更 | 查看變更詳情 |