創(chuàng)建自定義模板。
接口說明
本文將提供一個示例,在杭州地域cn-hangzhou
創(chuàng)建一個名為MyTemplate
的模板,并將模板的結(jié)構(gòu)TemplateBody
設(shè)置為{"ROSTemplateFormatVersion": "2015-09-01"}
。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ros:CreateTemplate | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateURL | string | 否 | 包含模板主體的文件的位置。URL 必須指向位于 Web 服務(wù)器(HTTP 或 HTTPS)或阿里云 OSS 存儲空間(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的模板。 模板長度范圍為 1~1024 字節(jié)。 如未指定 OSS 地域,默認(rèn)與接口參數(shù) RegionId 相同。 說明
您必須且僅能指定 TemplateBody 和 TemplateURL 其中一個參數(shù)。
| oss://ros/template/demo |
Description | string | 否 | 模板的描述。最大長度為 256 個字符。 | It is a demo. |
TemplateBody | string | 否 | 模板主體的結(jié)構(gòu)。長度為 1~524,288 個字節(jié)。 如果長度較大,建議通過 HTTP POST+Body Param 的方式,將參數(shù)放在請求體中進(jìn)行傳遞,避免 URL 過長而導(dǎo)致請求失敗。 說明
您僅能指定 TemplateBody、TemplateURL 或 TemplateId 其中一個參數(shù)。
| {"ROSTemplateFormatVersion":"2015-09-01"} |
TemplateName | string | 是 | 模板的名稱。 長度不超過 255 個字符(utf-8 編碼),必須以數(shù)字、英文字母或中文開頭,可包含數(shù)字、英文字母、中文、短劃線(-)和下劃線(_)。 | MyTemplate |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmxazb4ph6aiy**** |
Tags | array<object> | 否 | 模板的標(biāo)簽。 | |
object | 否 | 模板的標(biāo)簽。 | ||
Key | string | 是 | 模板的標(biāo)簽鍵。 說明
Tags 為可選參數(shù)。如果需要指定 Tags,則 Tags.N.Key 必須指定。
| usage |
Value | string | 否 | 模板的標(biāo)簽值。 | test |
ValidationOptions | array | 否 | 校驗(yàn)選項(xiàng)。 默認(rèn)不啟用任何選項(xiàng),進(jìn)行嚴(yán)格校驗(yàn)。 | |
string | 否 | 校驗(yàn)選項(xiàng)。取值:
| BasicValidation |
關(guān)于公共請求參數(shù)的詳情,請參見公共參數(shù)。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "8C5D90E1-66B6-496C-9371-3807F8DA80A8",
"TemplateId": "5ecd1e10-b0e9-4389-a565-e4c15efc****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-08-01 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-01-12 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2022-10-27 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidSchema | {reason}. | 模板格式不正確。reason 為具體原因。 |
400 | InvalidTemplateAttribute | The Referenced Attribute ({resource} {name}) is incorrect. | 模板包含不正確的資源屬性(輸出)引用。resource 為資源名,name 為屬性名。 |
400 | InvalidTemplatePropertyType | The specified value type of ({resource} {section}) is incorrect. | 模板資源定義中的字段類型不正確。resource 為資源名,section 為字段名。 |
400 | InvalidTemplateReference | The specified reference "{name}" (in {referencer}) is incorrect. | 模板包含不正確的引用。name 為引用名,referencer 為引用者。 |
400 | InvalidTemplateSection | The template section is invalid: {section}. | 模板包含無效的字段。section 為字段名。 |
400 | InvalidTemplateVersion | The template version is invalid: {reason}. | 模板版本不正確。reason 為具體原因。 |