文档

GetServiceTemplateParameterConstraints - 查询ROS模板参数限定值

更新时间:

查询ROS模板参数限定值。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
computenest:GetServiceTemplateParameterConstraintsRead
  • Service
    acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
ServiceIdstring

服务 ID。

service-731f788406024axxxxxx
ServiceVersionstring

服务版本。

1
TemplateNamestring

模板名称。

模板1
Parametersobject []

服务实例配置参数。

ParameterKeystring

参数的名称。如果未指定参数的名称和值,则 ROS 将使用模板中指定的默认值。

说明 Parameters 为可选参数。若指定了 Parameters,则 ParameterKey 为必选参数。
InstanceType
ParameterValuestring

模板中已定义的参数的取值。

说明 Parameters 为可选参数。若指定了 Parameters,则 ParameterValue 为必选参数。
cn-hangzhou-j
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

123e4567-e89b-12d3-a456-426655440000
DeployRegionIdstring

部署地域 ID。

cn-hangzhou
TrialTypestring

使用类型。可选值:

  • Trial:支持试用。

  • NotTrial:不支持试用。

NotTrial
SpecificationNamestring

套餐规格名称。

套餐一
ServiceInstanceIdstring

服务实例 ID。

si-461ee95f46ca46xxxxxx
EnablePrivateVpcConnectionboolean

是否已开启私网连接。可能的值:

  • true:已开启

  • false:未开启

true

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

449DC03D-A039-56A6-8D6F-6EBCCCE0EE2C
ParameterConstraintsobject []

参数约束信息。

Typestring

参数的类型。

String
AllowedValuesarray

参数的取值。

string

参数的取值。

cn-hangzhou-h
AssociationParameterNamesarray

关联参数列表。

string

关联参数列表。

InstanceType
ParameterKeystring

参数的名称。

ZoneInfo
Behaviorstring

参数的行为。取值:

  • NoLimit:无限制,此参数没有取值限制。

  • NotSupport:不支持,此参数不支持查询取值。

  • QueryError:查询失败。

说明 当查询结果没有返回 AllowedValues 时,会额外返回 Behavior 和 BehaviorReason,说明参数的行为和原因。
NoLimit
BehaviorReasonstring

参数行为出现的原因。

No resource property refer to the parameter
OriginalConstraintsobject []

原始约束信息。

AllowedValuesarray

参数的取值。

string

参数的取值。

cn-hangzhou-a
PropertyNamestring

属性名称。

ZoneId
ResourceNamestring

模板中定义的资源名称。

MyECS
ResourceTypestring

资源类型。

ALIYUN::ECS::InstanceGroup
QueryErrorsobject []

查询失败的详情。

ErrorMessagestring

错误详情。

record not exist
ResourceNamestring

资源名称。

MyECS
ResourceTypestring

资源类型。

ALIYUN::ECS::InstanceGroup
FamilyConstraintsarray

套餐族约束。

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-05OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)