GetTemplateParameterConstraints - Gets the available values for template parameters

获取参数可用值

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oos:GetTemplateParameterConstraints

get

*Template

acs:oos:{#regionId}:{#accountId}:template/{#TemplateName}

  • oos:TLSVersion

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

TemplateVersion

string

模板版本。

v1

TemplateContent

string

模板内容,JSON 或 YAML 格式。

{ "Description": "Example template, describe instances in some status", "FormatVersion": "OOS-2019-06-01", "Parameters": {}, "Tasks": [{ "Name": "describeInstances", "Action": "ACS::ExecuteAPI", "Description": "desc-en", "Properties": { "Service": "ECS", "API": "DescribeInstances", "Parameters": { "Status": "Running" } } }] }

TemplateName

string

模板名称。内容限制为字母、数字、中划线、下划线,长度 200 字符。

MyTemplate

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 其中一个参数。

http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json

Parameters

string

模板参数。

{\"endDate\": \"2022-04-13T03:31:20Z\", \"Status\": \"Stopped\"}

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

CBEC8072-BEC2-478E-8EAE-E723BA79CF19

ParameterConstraints

object

参数约束信息。

[ { "Type": "String", "AllowedValues": [ "ecs.n1.tiny", "ecs.r8a.4xlarge", "ecs.n2.xlarge", "ecs.c7.2xlarge", "ecs.c8i.4xlarge", "ecs.g8i.48xlarge", "ecs.c8a.4xlarge", "ecs.i2.4xlarge", "ecs.r8y.2xlarge" ], "AssociationParameterNames": [ "RegionId", "zoneId" ], "ParameterKey": "instanceType" }, { "Type": "String", "AllowedValues": [], "AssociationParameterNames": [ "RegionId", "zoneId", "InstanceType" ], "ParameterKey": "systemDiskCategory" } ]

示例

正常返回示例

JSON格式

{
  "RequestId": "CBEC8072-BEC2-478E-8EAE-E723BA79CF19",
  "ParameterConstraints": [
    {
      "Type": "String",
      "AllowedValues": [
        "ecs.n1.tiny",
        "ecs.r8a.4xlarge",
        "ecs.n2.xlarge",
        "ecs.c7.2xlarge",
        "ecs.c8i.4xlarge",
        "ecs.g8i.48xlarge",
        "ecs.c8a.4xlarge",
        "ecs.i2.4xlarge",
        "ecs.r8y.2xlarge"
      ],
      "AssociationParameterNames": [
        "RegionId",
        "zoneId"
      ],
      "ParameterKey": "instanceType"
    },
    {
      "Type": "String",
      "AllowedValues": [],
      "AssociationParameterNames": [
        "RegionId",
        "zoneId",
        "InstanceType"
      ],
      "ParameterKey": "systemDiskCategory"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情