GetTemplateParameterConstraints - - Alibaba Cloud Documentation Center

Retrieves the allowed values for parameters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:GetTemplateParameterConstraints

get

*Template

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

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
TemplateVersion	string	No	The version of the template.	v1
TemplateContent	string	No	The template content in JSON or YAML format.	{ "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	No	The name of the template. The name can contain letters, digits, hyphens (-), and underscores (_). The name can be up to 200 characters in length.	MyTemplate
TemplateURL	string	No	The URL of the file that contains the template body. The URL must point to a template that is located on a web server (HTTP or HTTPS) or in an Alibaba Cloud Object Storage Service (OSS) bucket, such as oss://ros/template/demo or oss://ros/template/demo?RegionId=cn-hangzhou. The template can be up to 524,288 bytes in length. If you do not specify the region of the OSS bucket, the region specified by the RegionId parameter is used. Note You can specify only one of the TemplateContent, TemplateURL, and TemplateId parameters.	http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json
Parameters	string	No	The parameters of the template.	{\"endDate\": \"2022-04-13T03:31:20Z\", \"Status\": \"Stopped\"}

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CBEC8072-BEC2-478E-8EAE-E723BA79CF19
ParameterConstraints	object	The information about the parameter constraints.	[ { "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" } ]

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.