通過指定模板地址或模板內容驗證將要創建資源棧的模板。
接口說明
該接口不涉及用戶數據,只對模板進行校驗,無需進行 RAM 鑒權。
本文將提供一個示例,驗證將要創建資源棧的模板,包含模板主體的文件的位置TemplateURL
為oss://ros/template/demo
。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateURL | string | 否 | 包含模板主體的文件的位置。URL 必須指向位于 HTTP Web 服務器或阿里云 OSS 存儲空間(例如:oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou)中的模板,模板最大為 524,288 個字節。 說明
如果 OSS 地域未指定,默認與接口參數 RegionId 相同。
您可以指定 TemplateBody 或 TemplateURL 參數,但不能同時指定。 | oss://ros/template/demo |
RegionId | string | 否 | 資源棧模板所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
TemplateBody | string | 否 | 模板主體的結構。長度為 1~524,288 個字節。 | {"ROSTemplateFormatVersion":"2015-09-01"} |
ClientToken | string | 否 | 123e4567-e89b-12d3-a456-42665544**** | |
ValidationOption | string | 否 | 是否對模板開啟額外校驗。取值:
說明
EnableFastTerraformValidation 與 EnableTerraformValidation 相比速度較快,但校驗完整性稍有不足。
| None |
UpdateInfoOptions | array | 否 | 更新信息選項列表。列表最大長度為 2。 | |
string | 否 | 更新信息選項,用于控制資源棧更新的相關信息的生成。取值:
| ConsiderCondition |
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
JSON
格式
{
"Description": "No description",
"Parameters": [
[
{
"Description": "",
"Label": "param_integer",
"NoEcho": "false",
"ParameterKey": "param_integer",
"Type": "Number"
},
{
"Description": "",
"Label": "param_float",
"NoEcho": "false",
"ParameterKey": "param_float",
"Type": "Number"
}
]
],
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
"Outputs": [
{
"OutputKey": "instance_id",
"Description": "The instance ID of my ECS.",
"Label": "Instance ID"
}
],
"ResourceTypes": {
"Resources": [
"ALIYUN::ECS::InstanceGroup"
],
"DataSources": [
"DATASOURCE::VPC::Vpcs"
]
},
"Resources": [
{
"ResourceType": "ALIYUN::ECS::InstanceGroup",
"ResourcePath": "server",
"LogicalResourceIdPattern": "server"
}
],
"UpdateInfo": {
"ParametersAllowedToBeModified": [
"param1"
],
"ParametersCauseInterruptionIfModified": [
"param1"
],
"ParametersConditionallyAllowedToBeModified": [
"param2"
],
"ParametersConditionallyCauseInterruptionIfModified": [
"param2"
],
"ParametersNotAllowedToBeModified": [
"param3"
],
"ParametersUncertainlyAllowedToBeModified": [
"param4"
],
"ParametersUncertainlyCauseInterruptionIfModified": [
"param4"
],
"ParametersCauseReplacementIfModified": [
"param5"
],
"ParametersConditionallyCauseReplacementIfModified": [
"param6"
],
"ParametersUncertainlyCauseReplacementIfModified": [
"param7"
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-27 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-03-28 | API 內部配置變更,不影響調用 | 查看變更詳情 |
錯誤代碼 | 錯誤信息 | HTTP 狀態碼 | 描述 |
---|---|---|---|
InvalidTemplate | {reason}. | 400 | 模板不正確,reason 為具體原因。 |
IInvalidParameter | {reason}. | 400 | 模板參數不正確,reason 為具體原因。 |