GetTemplateParameterConstraints - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Consulta os valores válidos dos parâmetros em um modelo.

Descrição da operação

Descrição

Este tópico fornece um exemplo de como consultar os valores válidos para o parâmetro ZoneInfo em um modelo específico da região China (Hangzhou). O modelo é { "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } }.

Para obter mais informações sobre os parâmetros consultáveis e o conteúdo do modelo, consulte Restrições de parâmetros de consulta.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ros:GetTemplateParameterConstraints

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TemplateBody	string	Não	A estrutura do corpo do modelo. O corpo do modelo deve ter de 1 a 524.288 bytes de comprimento. Se o comprimento do corpo do modelo exceder o limite superior, recomendamos o uso do método HTTP POST + Body Param para passar o parâmetro no corpo da solicitação e evitar falhas na solicitação causadas por uma URL excessivamente longa. Nota Você pode especificar apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId e TemplateScratchId.	{ "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneInfo": { "Type": "String" }, "InstanceType": { "Type": "String" } }, "Resources": { "ECS": { "Type": "ALIYUN::ECS::Instance", "Properties": { "ZoneId": { "Ref": "ZoneInfo" }, "InstanceType": { "Ref": "InstanceType" } } } } }
RegionId	string	Sim	O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
TemplateURL	string	Não	A URL do arquivo que contém o corpo do modelo. A URL deve apontar para um modelo localizado em um servidor web HTTP ou HTTPS ou em um bucket do Alibaba Cloud OSS, como oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. O modelo deve ter de 1 a 524.288 bytes de comprimento. Se a região do OSS não for especificada, o padrão será o mesmo do parâmetro RegionId. Nota Você pode especificar apenas um dos parâmetros TemplateBody, TemplateURL e TemplateId.	oss://ros-template/demo
TemplateId	string	Não	O ID do modelo. Este parâmetro se aplica a modelos compartilhados e modelos privados. Nota Você pode especificar apenas um dos parâmetros TemplateBody, TemplateURL e TemplateId.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	Não	A versão do modelo. Se você não especificar este parâmetro, a versão mais recente será usada. Nota TemplateVersion é válido apenas quando TemplateId é especificado.	v1
Parameters	array<object>	Não	Os parâmetros definidos no modelo.
	object	Não
ParameterKey	string	Sim	O nome do parâmetro definido no modelo. Nota O parâmetro Parameters é opcional. Se você especificar Parameters, deverá especificar ParameterKey.	ZoneInfo
ParameterValue	string	Sim	O valor do parâmetro definido no modelo. Nota O parâmetro Parameters é opcional. Se você especificar Parameters, deverá especificar ParameterValue.	cn-hangzhou-h
ParametersKeyFilter	array	Não	A lista de parâmetros a serem consultados.
	string	Não	O parâmetro a ser consultado.	ZoneInfo
ClientToken	string	Não	Um token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode ter até 64 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_). Para obter mais informações, consulte Como garantir a idempotência.	123e4567-e89b-12d3-a456-42665544****
ParametersOrder	array	Não	A dependência dos parâmetros.
	string	Não	A ordem da dependência do parâmetro. Nota Por padrão, a dependência dos parâmetros é especificada pelo parâmetro Metadata no modelo.	["ZoneId", "InstanceType"]
StackId	string	Não	O ID da pilha. Se você especificar este parâmetro, as restrições de parâmetro para um cenário de upgrade ou downgrade serão consultadas.	c754d2a4-28f1-46df-b557-9586173a****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	9816785B-BCF8-514D-8B76-C1EC2BC954FC
ParameterConstraints	array<object>	As informações sobre as restrições de parâmetro.
	array<object>
ParameterKey	string	O nome do parâmetro.	ZoneInfo
Type	string	O tipo do parâmetro.	String
AllowedValues	array	A lista de valores válidos do parâmetro.
	string	O valor válido do parâmetro.	cn-hangzhou-h
Behavior	string	O comportamento do parâmetro. Valores válidos: NoLimit: O parâmetro não tem limite em seus valores válidos. NotSupport: Os valores válidos do parâmetro não podem ser consultados. QueryError: A consulta falhou. Nota Se AllowedValues não for retornado, Behavior e BehaviorReason serão retornados para indicar o comportamento do parâmetro e o motivo do comportamento.	NoLimit
BehaviorReason	string	O motivo do comportamento do parâmetro.	No resource property refer to the parameter
AssociationParameterNames	array	Os nomes dos parâmetros associados.
	string	O nome de um parâmetro associado.	InstanceType
IllegalValueByParameterConstraints	array	Os valores que não correspondem às restrições de parâmetro. Nota Se AllowedValues for retornado, IllegalValueByParameterConstraints e IllegalValueByRules serão retornados para indicar os valores inválidos que são filtrados pelas restrições de parâmetro e regras do modelo.
	any	O valor que não corresponde às restrições de parâmetro. Nota Se AllowedValues for retornado, os valores inválidos filtrados pelas restrições de parâmetro e regras do modelo serão retornados nos parâmetros IllegalValueByParameterConstraints e IllegalValueByRules.	cn-hangzhou-h
IllegalValueByRules	array	Os valores que não correspondem às regras do modelo. Nota Se AllowedValues for retornado, IllegalValueByParameterConstraints e IllegalValueByRules serão retornados para indicar os valores inválidos que são filtrados pelas restrições de parâmetro e regras do modelo.
	any	O valor que não corresponde às regras do modelo. Nota Se AllowedValues for retornado, os valores inválidos filtrados pelas restrições de parâmetro e regras do modelo serão retornados nos parâmetros IllegalValueByParameterConstraints e IllegalValueByRules.	cn-hangzhou-h
NotSupportResources	array<object>	Os detalhes dos recursos não suportados.
	object	Os detalhes do recurso não suportado. Este parâmetro é retornado quando o valor de Behavior é NotSupport.
ResourceType	string	The resource type.	ALIYUN::ECS::InstanceGroup
PropertyName	string	The name of the resource property.	InstanceName
QueryErrors	array<object>	Os detalhes da falha na consulta.
	object	Os detalhes da falha na consulta. Este parâmetro é retornado quando o valor de Behavior é QueryError.
ErrorMessage	string	The error details.	ALIYUN::ECS::InstanceGroup
ResourceName	string	The name of the resource.	MyECS
ResourceType	string	The resource type.	InstanceType is needed while query DataDisk
OriginalConstraints	array<object>	As informações sobre as restrições originais.
	object	As informações sobre a restrição original.
ResourceName	string	The name of the resource that is defined in the template.	MyECS
AllowedValues	array	The list of valid values of the parameter.
	any	The valid value of the parameter.	cn-hangzhou-a
ResourceType	string	The resource type.	ALIYUN::ECS::InstanceGroup
PropertyName	string	The name of the property.	ZoneId
Behavior	string	The behavior of the parameter.	QueryError
BehaviorReason	string	The reason for the behavior of the parameter.	No resource property refer to the parameter
PropertiesData	string	The query parameters that are used during the query of parameter constraints.	{ "ZoneId":"cn-hangzhou-h", "SystemDiskCategory":"cloud_essd" }
RequestInfo	string	The request information of the operation that is called to query the parameter constraints of a cloud service.	ecs:2014-05-26:DescribeAvailableResource:4C5B6929-EB64-5086-A821-9CCB553A5AE9
QueryTimeoutDetails	array<object>	Os detalhes do tempo limite da consulta.
	object	Os detalhes do tempo limite da consulta.
ResourceType	string	The resource type.	ALIYUN::RDS::DBInstance
ResourceName	string	The name of the resource.	rds
ErrorMessage	string	The error message.	query property SlaveZoneIds.* in resource rds error, error message: query 8 seconds timeout

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9816785B-BCF8-514D-8B76-C1EC2BC954FC",
  "ParameterConstraints": [
    {
      "ParameterKey": "ZoneInfo",
      "Type": "String",
      "AllowedValues": [
        "cn-hangzhou-h"
      ],
      "Behavior": "NoLimit",
      "BehaviorReason": "No resource property refer to the parameter",
      "AssociationParameterNames": [
        "InstanceType"
      ],
      "IllegalValueByParameterConstraints": [
        "cn-hangzhou-h"
      ],
      "IllegalValueByRules": [
        "cn-hangzhou-h"
      ],
      "NotSupportResources": [
        {
          "ResourceType": "ALIYUN::ECS::InstanceGroup",
          "PropertyName": "InstanceName"
        }
      ],
      "QueryErrors": [
        {
          "ErrorMessage": "ALIYUN::ECS::InstanceGroup",
          "ResourceName": "MyECS",
          "ResourceType": "InstanceType is needed while query DataDisk"
        }
      ],
      "OriginalConstraints": [
        {
          "ResourceName": "MyECS",
          "AllowedValues": [
            "cn-hangzhou-a"
          ],
          "ResourceType": "ALIYUN::ECS::InstanceGroup\n",
          "PropertyName": "ZoneId",
          "Behavior": "QueryError",
          "BehaviorReason": "No resource property refer to the parameter",
          "PropertiesData": "{\n    \"ZoneId\":\"cn-hangzhou-h\",\n    \"SystemDiskCategory\":\"cloud_essd\"\n}",
          "RequestInfo": "ecs:2014-05-26:DescribeAvailableResource:4C5B6929-EB64-5086-A821-9CCB553A5AE9"
        }
      ],
      "QueryTimeoutDetails": [
        {
          "ResourceType": "ALIYUN::RDS::DBInstance",
          "ResourceName": "rds",
          "ErrorMessage": "query property SlaveZoneIds.* in resource rds error, error message: query 8 seconds timeout"
        }
      ]
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.