GetTemplateParameterConstraints - - Centre de documentation Alibaba Cloud

Consulte les valeurs valides des paramètres d'un modèle.

Description de l'opération

Description.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ros:GetTemplateParameterConstraints

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
TemplateBody	string	Non	La structure du corps du modèle. Le corps du modèle doit avoir une longueur de 1 à 524 288 octets. Si la longueur du corps du modèle dépasse la limite supérieure, il est recommandé d'utiliser la méthode HTTP POST + Body Param pour transmettre le paramètre dans le corps de la requête afin d'éviter les échecs de requête causés par une URL trop longue.	{
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
TemplateURL	string	Non	L'URL du fichier contenant le corps du modèle. L'URL doit pointer vers un modèle situé sur un serveur Web HTTP ou HTTPS ou dans un compartiment OSS d'Alibaba Cloud, tel que oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. Le modèle doit avoir une longueur de 1 à 524 288 octets. Si la région OSS n'est pas spécifiée, la valeur par défaut est la même que celle du paramètre RegionId.	oss://ros-template/demo
TemplateId	string	Non	L'identifiant du modèle. Ce paramètre s'applique aux modèles partagés et aux modèles privés.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	Non	La version du modèle. Si vous ne spécifiez pas ce paramètre, la dernière version est utilisée.	v1
Parameters	array<object>	Non	Les paramètres définis dans le modèle.
	object	Non
ParameterKey	string	Oui	Le nom du paramètre défini dans le modèle.	ZoneInfo
ParameterValue	string	Oui	La valeur du paramètre défini dans le modèle.	cn-hangzhou-h
ParametersKeyFilter	array	Non	La liste des paramètres à interroger.
	string	Non	Le paramètre à interroger.	ZoneInfo
ClientToken	string	Non	Un jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer qu'il est unique pour chaque requête. Le jeton peut contenir jusqu'à 64 caractères et peut inclure des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). Pour plus d'informations, reportez-vous à Comment garantir l'idempotence.	123e4567-e89b-12d3-a456-42665544****
ParametersOrder	array	Non	La dépendance des paramètres.
	string	Non	L'ordre de dépendance des paramètres.	["ZoneId", "InstanceType"]
StackId	string	Non	L'identifiant de la pile.	c754d2a4-28f1-46df-b557-9586173a****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	9816785B-BCF8-514D-8B76-C1EC2BC954FC
ParameterConstraints	array<object>	Les informations sur les contraintes des paramètres.
	array<object>
ParameterKey	string	Le nom du paramètre.	ZoneInfo
Type	string	Le type du paramètre.	String
AllowedValues	array	La liste des valeurs valides du paramètre.
	string	La valeur valide du paramètre.	cn-hangzhou-h
Behavior	string	Le comportement du paramètre. Valeurs valides :	NoLimit
BehaviorReason	string	La raison du comportement du paramètre.	Aucune propriété de ressource ne fait référence au paramètre
AssociationParameterNames	array	Les noms des paramètres associés.
	string	Le nom d'un paramètre associé.	InstanceType
IllegalValueByParameterConstraints	array	Les valeurs qui ne correspondent pas aux contraintes des paramètres.
	any	La valeur qui ne correspond pas aux contraintes des paramètres.	cn-hangzhou-h
IllegalValueByRules	array	Les valeurs qui ne correspondent pas aux règles du modèle.
	any	La valeur qui ne correspond pas aux règles du modèle.	cn-hangzhou-h
NotSupportResources	array<object>	Les détails des ressources non prises en charge.
	object	Les détails de la ressource non prise en charge.
ResourceType	string	The resource type.	ALIYUN::ECS::InstanceGroup
PropertyName	string	The name of the resource property.	InstanceName
QueryErrors	array<object>	Les détails de l'échec de la requête.
	object	Les détails de l'échec de la requête.
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>	Les informations sur les contraintes d'origine.
	object	Les informations sur la contrainte d'origine.
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>	Les détails du délai d'expiration de la requête.
	object	Les détails du délai d'expiration de la requête.
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

Exemples

JSON format

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

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.