ValidateTemplateContent - API参考| 阿里云

校验一个模版是否合法。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateTemplate	系统规定参数。取值： ValidateTemplateContent
Content	String	是	{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}	模板内容。JSON或YAML格式，长度限制为 64 KB。

返回参数

名称	类型	示例值	描述
RequestId	String	ADF2066B-4017-4EF0-861C-C0FF3A9F1ED4	请求 ID。
Outputs	Map	{}	模板输出。
Parameters	Map	{ "Status": { "Description": "(Required) The status of the Ecs instance.", "Type": "String" } }	模板参数。
RamRole	String	OOSServiceRole	RAM角色
Tasks	String	-	模板中定义的任务。
└ Name	String	foo	任务名称。
└ Properties	Map	-	任务属性。
└ API	String	DescribeInstances	API 名称。
└ Parameters	Map	{ "Status": "{{ Status }}" }	API 参数。
└ Service	String	Ecs	服务名称。

示例

请求示例

https://oos.cn-hangzhou.aliyuncs.com/?Action=ValidateTemplateContent
&Content=%7B%22FormatVersion%22%3A+%22OOS-2019-06-01%22%2C+%22Description%22%3A+%22Describe+instances+of+given+status%22%2C+%22Parameters%22%3A+%7B%22Status%22%3A+%7B%22Type%22%3A+%22String%22%2C+%22Description%22%3A+%22%28Required%29+The+status+of+the+Ecs+instance.%22%7D%7D%2C+%22Tasks%22%3A+%5B%7B%22Properties%22%3A+%7B%22Parameters%22%3A+%7B%22Status%22%3A+%22%7B%7B+Status+%7D%7D%22%7D%2C+%22API%22%3A+%22DescribeInstances%22%2C+%22Service%22%3A+%22ECS%22%7D%2C+%22Name%22%3A+%22describeInstances%22%2C+%22Action%22%3A+%22ACS%3A%3AExecuteAPI%22%7D%5D%7D
&<公共请求参数>

正常返回示例
JSON 格式

{
  "RequestId": "ADF2066B-4017-4EF0-861C-C0FF3A9F1ED4",
  "Outputs": {},
  "Parameters": {
    "Status": {
      "Description": "(Required) The status of the Ecs instance.",
      "Type": "String"
    }
  },
  "RamRole": "OOSServiceRole",
  "Tasks": [
    {
      "Name": "foo",
      "Properties": {
        "API": "DescribeInstances",
        "Parameters": {
          "Status": "{{ Status }}"
        },
        "Service": "Ecs"
      }
    }
  ]
}

错误码

错误代码	HTTP 状态码	错误信息	描述
InvalidVersion	400	Specified parameter Version is not valid.	给定的Version非法。请检查URL中指定的Version的正确性。
InvalidAction.NotFound	400	Specified api is not found, please check your url and method.	给定的API不存在。请检查URL中指定的Action的正确性。
Throttling.User	400	Request was denied due to user flow control.	访问频率太高导致流控。
User.NoPermission	401	User has no permission to do the action: ({api_name})	用户没有调用某个API的权限。请检查是否在RAM中给当前用户赋予了OOS的API的权限。
InvalidStsToken	400	Invalid STS token to do the action: ({api_name})	给定的STS Token非法。
ExpiredStsToken	400	Expired STS token to do the action: ({api_name})	给定的STS Token过期。
InvalidAccountType	400	The account type ({account_type}) was not supported.	不支持给定的账号类型。
TemplateValidationError	400	{reason}	模板约束，如参数类型、数值等，校验不通过。
InvalidTemplateDependency	400	The specified dependency {location} key: {key} is not in {keys}	被引用的参数名在模版中未定义