GetServiceTemplateParameterConstraints - Compute Nest - Alibaba Cloud Documentation Center

Queries the parameter constraints for a Resource Orchestration Service (ROS) template in a specified region using the template name and service ID.

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

computenest:GetServiceTemplateParameterConstraints

get

*Service

acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ServiceId	string	Yes	The service ID.	service-731f788406024axxxxxx
ServiceVersion	string	No	The service version.	1
TemplateName	string	Yes	The template name.	模板1
Parameters	array<object>	No	The configuration parameters of the service instance.
	object	No
ParameterKey	string	No	The name of the parameter. If you do not specify the name and value of the parameter, Resource Orchestration Service (ROS) uses the default value that is specified in the template. Note The Parameters parameter is optional. If you specify Parameters, ParameterKey is required.	InstanceType
ParameterValue	string	No	The value of the parameter that is defined in the template. Note The Parameters parameter is optional. If you specify Parameters, ParameterValue is required.	cn-hangzhou-j
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique value from your client for each request. The token can contain only ASCII characters and cannot be more than 64 characters long.	123e4567-e89b-12d3-a456-426655440000
DeployRegionId	string	Yes	The deployment region ID.	cn-hangzhou
TrialType	string	No	The usage type. Valid values: Trial: The service supports a trial. NotTrial: The service does not support a trial.	NotTrial
SpecificationName	string	No	The specification name.	套餐一
ServiceInstanceId	string	No	The service instance ID.	si-461ee95f46ca46xxxxxx
EnablePrivateVpcConnection	boolean	No	Indicates whether PrivateLink is enabled. Valid values: true: enabled false: disabled	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C
ParameterConstraints	array<object>	The parameter constraints.
	object
Type	string	The type of the parameter.	String
AllowedValues	array	The valid values of the parameter.
	string	A valid value of the parameter.	cn-hangzhou-h
AssociationParameterNames	array	The associated parameters.
	string	An associated parameter.	InstanceType
ParameterKey	string	The name of the parameter.	ZoneInfo
Behavior	string	The behavior of the parameter. Valid values: NoLimit: No limits are imposed on the value of this parameter. NotSupport: The values of this parameter cannot be queried. QueryError: The query failed. Note If AllowedValues is not returned, Behavior and BehaviorReason are returned to describe the behavior of the parameter and the reason.	NoLimit
BehaviorReason	string	The reason for the parameter behavior.	No resource property refer to the parameter
OriginalConstraints	array<object>	The original constraints.
	object
AllowedValues	array	The valid values of the parameter.
	string	A valid value of the parameter.	cn-hangzhou-a
PropertyName	string	The property name.	ZoneId
ResourceName	string	The name of the resource that is defined in the template.	MyECS
ResourceType	string	The resource type.	ALIYUN::ECS::InstanceGroup
QueryErrors	array<object>	The details of the query failure.
	object
ErrorMessage	string	The error details.	record not exist
ResourceName	string	The resource name.	MyECS
ResourceType	string	The resource type.	ALIYUN::ECS::InstanceGroup
FamilyConstraints	array	The constraints on the specification family.
	string	A constraint on the specification family.	约束族1

Examples

Success response

JSON format

{
  "RequestId": "449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C",
  "ParameterConstraints": [
    {
      "Type": "String",
      "AllowedValues": [
        "cn-hangzhou-h"
      ],
      "AssociationParameterNames": [
        "InstanceType"
      ],
      "ParameterKey": "ZoneInfo",
      "Behavior": "NoLimit",
      "BehaviorReason": "No resource property refer to the parameter",
      "OriginalConstraints": [
        {
          "AllowedValues": [
            "cn-hangzhou-a"
          ],
          "PropertyName": "ZoneId",
          "ResourceName": "MyECS",
          "ResourceType": "ALIYUN::ECS::InstanceGroup"
        }
      ],
      "QueryErrors": [
        {
          "ErrorMessage": "record not exist",
          "ResourceName": "MyECS",
          "ResourceType": "ALIYUN::ECS::InstanceGroup"
        }
      ]
    }
  ],
  "FamilyConstraints": [
    "约束族1"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.