通過指定模板、資源棧、資源棧組、更改集其中任意信息查詢模板資源詳情。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ros:GetTemplateSummary | get |
|
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
StackId | string | 否 | 資源棧 ID。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個(gè)參數(shù)。 | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
TemplateBody | string | 否 | 模板的結(jié)構(gòu)。長(zhǎng)度為 1~524,288 個(gè)字節(jié)。 | {"ROSTemplateFormatVersion":"2015-09-01"} |
RegionId | string | 否 | 模板所屬資源棧或資源棧組的地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 僅在指定 StackId、ChangeSetId 或 StackGroupName 時(shí)生效。 | cn-hangzhou |
TemplateId | string | 否 | 模板 ID。支持共享模板和私有模板。 您僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個(gè)參數(shù)。 | 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
TemplateURL | string | 否 | 包含模板主體的文件的位置。URL 必須指向位于 Web 服務(wù)器(HTTP 或 HTTPS)或阿里云 OSS 存儲(chǔ)空間(例如:oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou)中的模板,模板最大為 524,288 個(gè)字節(jié)。 說明
如果 OSS 地域未指定,默認(rèn)與接口參數(shù) RegionId 相同。
您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個(gè)參數(shù)。 URL 的最大長(zhǎng)度為:1024 個(gè)字節(jié)。 | oss://ros/template/demo |
ChangeSetId | string | 否 | 更改集 ID。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個(gè)參數(shù)。 | 1f6521a4-05af-4975-afe9-bc4b45ad**** |
TemplateVersion | string | 否 | 模板版本。當(dāng)您設(shè)置 TemplateId 參數(shù)時(shí),本參數(shù)生效。 | v1 |
StackGroupName | string | 否 | 資源棧組名稱。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個(gè)參數(shù)。 | my-stack-group |
Parameters | array<object> | 否 | 模板中已定義的參數(shù)。 | |
object | 否 | |||
ParameterKey | string | 否 | 模板中已定義的參數(shù)的名稱。如果您未指定參數(shù)的名稱和值時(shí),ROS 將使用模板中指定的默認(rèn)值。 N 最大值為 200。 說明
Parameters 為可選參數(shù)。如果需要指定 Parameters,則 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必須同時(shí)指定。
| InstanceId |
ParameterValue | string | 否 | 模板中已定義的參數(shù)的取值。 N 最大值為 200。 說明
Parameters 為可選參數(shù)。如果需要指定 Parameters,則 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必須同時(shí)指定。
| i-rotp2e20whfrs2**** |
ClientToken | string | 否 | 保證請(qǐng)求的冪等性。該參數(shù)值由客戶端生成,并且必須全局唯一。 | 123e4567-e89b-12d3-a456-42665544**** |
關(guān)于公共請(qǐng)求參數(shù)的詳情,請(qǐng)參見公共參數(shù)。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"ResourceTypes": [
"[\"ALIYUN::ECS::VPC\"]"
],
"Description": "No description",
"Parameters": [
[
{
"Description": "",
"Label": "Name",
"NoEcho": "false",
"ParameterKey": "Name",
"Type": "String"
}
]
],
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
"Version": "2015-09-01",
"Metadata": {
"key": "value"
},
"ResourceIdentifierSummaries": [
{
"ResourceType": "ALIYUN::ECS::VPC",
"LogicalResourceIds": [
"[\"Vpc\"]"
],
"ResourceIdentifiers": [
"[\"VpcId\"]"
]
}
]
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|
HttpCode | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | StackValidationFailed | {reason}. | 資源棧校驗(yàn)失敗。reason 為具體原因。 |
404 | ChangeSetNotFound | The ChangeSet ({name}) of Stack ({stack}) could not be found. | 更改集不存在。name 為更改集名稱或 ID,stack 為資源棧名稱或 ID。 |
404 | ChangeSetNotFound | The ChangeSet {ID} could not be found. | 更改集不存在。ID 為更改集 ID。 |
404 | StackNotFound | The Stack ({name}) could not be found. | 資源棧不存在。name 為資源棧名稱或 ID。 |
404 | TemplateNotFound | The Tempalte ({ ID }) could not be found. | 模板不存在。ID 為模板 ID。 |
404 | TemplateNotFound | The Template { ID } with version { version } could not be found. | 模板或指定版本不存在。ID 為模板 ID,version 為模板版本。 |