GetServiceTemplateParameterConstraints - 查询ROS模板参数限定值_计算巢服务(Compute Nest)-阿里云帮助中心

查询ROS模板参数限定值。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
computenest:GetServiceTemplateParameterConstraints	Read	Service acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ServiceId	string	是	服务 ID。	service-731f788406024axxxxxx
ServiceVersion	string	否	服务版本。	1
TemplateName	string	是	模板名称。	模板1
Parameters	object []	否	服务实例配置参数。
ParameterKey	string	否	参数的名称。如果未指定参数的名称和值，则 ROS 将使用模板中指定的默认值。说明 Parameters 为可选参数。若指定了 Parameters，则 ParameterKey 为必选参数。	InstanceType
ParameterValue	string	否	模板中已定义的参数的取值。说明 Parameters 为可选参数。若指定了 Parameters，则 ParameterValue 为必选参数。	cn-hangzhou-j
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。	123e4567-e89b-12d3-a456-426655440000
DeployRegionId	string	是	部署地域 ID。	cn-hangzhou
TrialType	string	否	使用类型。可选值： Trial：支持试用。 NotTrial：不支持试用。	NotTrial
SpecificationName	string	否	套餐规格名称。	套餐一
ServiceInstanceId	string	否	服务实例 ID。	si-461ee95f46ca46xxxxxx
EnablePrivateVpcConnection	boolean	否	是否已开启私网连接。可能的值： true：已开启 false：未开启	true

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C
ParameterConstraints	object []	参数约束信息。
Type	string	参数的类型。	String
AllowedValues	array	参数的取值。
	string	参数的取值。	cn-hangzhou-h
AssociationParameterNames	array	关联参数列表。
	string	关联参数列表。	InstanceType
ParameterKey	string	参数的名称。	ZoneInfo
Behavior	string	参数的行为。取值： NoLimit：无限制，此参数没有取值限制。 NotSupport：不支持，此参数不支持查询取值。 QueryError：查询失败。说明当查询结果没有返回 AllowedValues 时，会额外返回 Behavior 和 BehaviorReason，说明参数的行为和原因。	NoLimit
BehaviorReason	string	参数行为出现的原因。	No resource property refer to the parameter
OriginalConstraints	object []	原始约束信息。
AllowedValues	array	参数的取值。
	string	参数的取值。	cn-hangzhou-a
PropertyName	string	属性名称。	ZoneId
ResourceName	string	模板中定义的资源名称。	MyECS
ResourceType	string	资源类型。	ALIYUN::ECS::InstanceGroup
QueryErrors	object []	查询失败的详情。
ErrorMessage	string	错误详情。	record not exist
ResourceName	string	资源名称。	MyECS
ResourceType	string	资源类型。	ALIYUN::ECS::InstanceGroup
FamilyConstraints	array	套餐族约束。
	string	套餐族约束。	约束族1

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间

变更内容概要

操作

2024-03-05

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。