GetServiceTemplateParameterConstraints - Compute Nest - Alibaba Cloud Documentation Center

Queries the parameter constraints for a Resource Orchestration Service (ROS) template.

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

computenestsupplier:GetServiceTemplateParameterConstraints

get

*Service

acs:computenestsupplier:{#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-1c11f365190c44xxxxxx
ServiceVersion	string	No	The service version.	draft
TemplateName	string	Yes	The template name.	模板1
Parameters	array<object>	No	The parameter information.
	object	No
ParameterKey	string	No	The parameter name.	PayType
ParameterValue	string	No	The parameter value.	PostPaid
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The value of ClientToken can contain only ASCII characters.	10CM943JP0EN9D51H
DeployRegionId	string	Yes	The ID of the deployment region.	cn-huhehaote
ServiceInstanceId	string	No	The service instance ID.	si-d6ab3a63ccbb4b17****
EnablePrivateVpcConnection	boolean	No	Indicates whether PrivateLink is enabled. Valid values: true: Enabled false: Not enabled	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C81C0732-DEBC-559C-B563-7EB2BEB21088
ParameterConstraints	array<object>	The parameter information.
	object
Type	string	The type of the parameter.	String
AllowedValues	array	The valid values of the parameter.
	string	A valid value of the parameter.	"ecs.hfr6.16xlarge"
AssociationParameterNames	array	The list of associated parameters.
	string	An associated parameter.	"ZoneId1", "VSwitchId1"
ParameterKey	string	The name of the parameter.	PayType
Behavior	string	The behavior of the parameter. Valid values: NoLimit: The parameter has no value limit. NotSupport: The parameter does not support value queries. QueryError: The query failed. Note If the query result does not include AllowedValues, Behavior and BehaviorReason are returned to describe the behavior of the parameter and the reason for the behavior.	NoLimit
BehaviorReason	string	The reason for the parameter behavior.	none
OriginalConstraints	array<object>	The original constraint information.
	object
AllowedValues	array	The valid values of the parameter.
	string	A valid value of the parameter.	"ecs.hfr6.16xlarge"
PropertyName	string	The property name.	lnch_Source
ResourceName	string	The resource name.	i-8vb0smn1lf6g77md****
ResourceType	string	The resource type.	serviceinstance
FamilyConstraints	array	The family constraints.
	string	A family constraint.	[]

Examples

Success response

JSON format

{
  "RequestId": "C81C0732-DEBC-559C-B563-7EB2BEB21088",
  "ParameterConstraints": [
    {
      "Type": "String",
      "AllowedValues": [
        "\"ecs.hfr6.16xlarge\""
      ],
      "AssociationParameterNames": [
        "\"ZoneId1\",\n \"VSwitchId1\""
      ],
      "ParameterKey": "PayType",
      "Behavior": "NoLimit",
      "BehaviorReason": "none",
      "OriginalConstraints": [
        {
          "AllowedValues": [
            "\"ecs.hfr6.16xlarge\""
          ],
          "PropertyName": "lnch_Source",
          "ResourceName": "i-8vb0smn1lf6g77md****",
          "ResourceType": "serviceinstance"
        }
      ]
    }
  ],
  "FamilyConstraints": [
    "[]"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.