调用GetTemplateParameterConstraints接口查询模板参数的取值。
接口说明
使用说明
本文将提供一个示例,查询杭州地域模板{"Parameters":{"ZoneInfo":{"Type": "String"},"InstanceType": {"Type": "String"}},"ROSTemplateFormatVersion": "2015-09-01","Resources":{"ECS":{"Properties":{"ZoneId":{"Ref": "ZoneInfo"},"InstanceType": {"Ref": "InstanceType"}},"Type": "ALIYUN::ECS::Instance"}}}
中参数ZoneInfo
的取值。
关于本接口支持查询的参数和模板内容,请参见参数约束查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateBody | string | 否 | 模板的结构。 说明您必须且仅能指定TemplateBody、TemplateURL和TemplateId其中一个参数。 | {"Parameters":{"ZoneInfo":{"Type": "String"},"InstanceType": {"Type": "String"}},"ROSTemplateFormatVersion": "2015-09-01","Resources":{"ECS":{"Properties":{"ZoneId":{"Ref": "ZoneInfo"},"InstanceType": {"Ref": "InstanceType"}},"Type": "ALIYUN::ECS::Instance"}}} |
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 | 否 | |||
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"
}
]
}
]
}
错误码
访问错误中心查看更多错误码。