:Opérations sur les piles

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackName

String

Yes

MyStack

Nom de la pile.

Le nom peut contenir jusqu'à 255 caractères, incluant des chiffres, des lettres, des traits d'union (-) et des traits de soulignement (_). Il doit commencer par un chiffre ou une lettre.

--TimeoutInMinutes

Long

Yes

10

Délai d'attente pour la création de la pile.

• Valeur par défaut : 60.

• Unité : minutes.

--Parameters.N.ParameterKey

String

No

InstanceId

Nom du paramètre N. Si vous ne spécifiez pas le nom et la valeur d'un paramètre, Resource Orchestration Service (ROS) utilise le nom et la valeur par défaut définis dans le modèle.

Valeur maximale de N : 200.

--Parameters.N.ParameterValue

String

No

i-xxxxxx

Valeur du paramètre N.

Valeur maximale de N : 200.

--DisableRollback

Boolean

No

false

Indique s'il faut désactiver le retour arrière en cas d'échec de la création de la pile.

• true

• false (par défaut)

--TemplateBody

String

No

{ "ROSTemplateFormatVersion": "2015-09-01" }

Structure contenant le corps du modèle. La taille du corps du modèle doit être comprise entre 1 et 524 288 octets.

Si la taille du corps du modèle dépasse la limite supérieure, nous vous recommandons d'ajouter des paramètres au corps de la requête HTTP POST pour éviter les échecs de requête dus à des URL trop longues.

Vous pouvez spécifier TemplateBody ou TemplateURL, mais pas les deux simultanément.

--StackPolicyURL

String

No

oss://ros-stack-policy/demo

URL du fichier contenant la politique de pile. L'URL doit pointer vers une politique située sur un serveur web HTTP ou HTTPS ou dans un compartiment Object Storage Service (OSS), tel que oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. Le fichier de politique peut atteindre 16 384 octets.

Vous pouvez spécifier StackPolicyBody ou StackPolicyURL, mais pas les deux simultanément.

L'URL peut atteindre 1 350 octets.

--StackPolicyBody

String

No

{"Statement": [{"Action": "Update:", "Resource": "", "Effect": "Allow", "Principal": "*"}]}

Structure contenant le corps de la politique de pile. Le corps de la politique doit être compris entre 1 et 16 384 octets.

Vous pouvez spécifier StackPolicyBody ou StackPolicyURL, mais pas les deux simultanément.

--NotificationURLs.N

RepeatList

No

http://example.com/ros-event

URL de rappel pour recevoir l'événement de pile N. Seule la méthode HTTP POST est prise en charge.

• Valeur maximale de N : 5.

• Chaque URL peut atteindre 1 024 octets.

Lorsque l'état d'une pile change, ROS envoie une notification à l'URL spécifiée. Lorsque le retour arrière est activé pour la pile, des notifications sont envoyées si la pile est dans l'état CREATE_ROLLBACK ou ROLLBACK, mais pas si elle est dans l'état CREATE_FAILED, UPDATE_FAILED ou IN_PROGRESS.

ROS envoie des notifications, que vous ayez ou non configuré la section Outputs. L'exemple de code suivant illustre le contenu d'une notification :

{
    "Outputs": [
        {
            "Description": "No description given",
            "OutputKey": "InstanceId",
            "OutputValue": "i-xxx"
        }
    ],
    "StackId": "80bd6b6c-e888-4573-ae3b-93d29113****",
    "StackName": "test-notification-url",
    "Status": "CREATE_COMPLETE"
}

--TemplateURL

String

No

oss://ros-template/demo

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, tel que oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. Le corps du modèle peut atteindre 524 288 octets.

Vous pouvez spécifier TemplateBody ou TemplateURL, mais pas les deux simultanément.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

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, incluant uniquement des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_).

Pour plus d'informations, consultez Assurer l'idempotence.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackName.N

RepeatList

No

MyStack

Nom de la pile N.

Le nom peut contenir jusqu'à 255 caractères, incluant des chiffres, des lettres, des traits d'union (-) et des traits de soulignement (_). Il doit commencer par un chiffre ou une lettre. La recherche floue avec le caractère générique (*) est prise en charge.

Valeurs valides de N : 1 à 5.

--Status.N

RepeatList

No

CREATE_COMPLETE

État de la pile N.

Valeurs valides :

• CREATE_IN_PROGRESS

• CREATE_FAILED

• CREATE_COMPLETE

• UPDATE_IN_PROGRESS

• UPDATE_FAILED

• UPDATE_COMPLETE

• DELETE_IN_PROGRESS

• DELETE_FAILED

• DELETE_COMPLETE

• ROLLBACK_IN_PROGRESS

• ROLLBACK_FAILED

• ROLLBACK_COMPLETE

• CHECK_IN_PROGRESS

• CHECK_FAILED

• CHECK_COMPLETE

• REVIEW_IN_PROGRESS

--ParentStackId

String

No

fgce558a-bdd6-d52j-555b-63755971****

ID de la pile parente.

--ShowNestedStack

Boolean

No

true

Indique s'il faut renvoyer les piles imbriquées.

--PageNumber

Long

No

1

Numéro de page.

• Les pages commencent à partir de la page 1.

• Valeur par défaut : 1.

--PageSize

Long

No

10

Nombre d'entrées par page.

• Valeur maximale : 100.

• Valeur par défaut : 10.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID de la pile.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

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, incluant uniquement des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_).

Pour plus d'informations, consultez Assurer l'idempotence.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-beijing

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID de la pile.

--Parameters.N.ParameterKey

String

No

InstanceId

Nom du paramètre N. Si vous ne spécifiez pas le nom et la valeur d'un paramètre, ROS utilise le nom et la valeur par défaut définis dans le modèle.

Valeur maximale de N : 200.

--Parameters.N.ParameterValue

String

No

i-xxxxxx

Valeur du paramètre N.

Valeur maximale de N : 200.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

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, incluant uniquement des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_).

Pour plus d'informations, consultez Assurer l'idempotence.

--StackPolicyDuringUpdateBody

String

No

{"Statement":[{"Effect": "Allow", "Action": "Update:", "Principal": "", "Resource": "*"}]}

Structure contenant le corps de la politique de pile temporaire de remplacement. Le corps de la politique doit être compris entre 1 et 16 384 octets.

Si vous souhaitez mettre à jour des ressources protégées, vous devez spécifier une politique de pile temporaire de remplacement lors de la mise à jour. Si vous ne spécifiez pas de politique de pile temporaire de remplacement, la politique existante associée à la pile est utilisée.

Ce paramètre prend effet uniquement lorsque l'ensemble de modifications est de type UPDATE. Vous ne pouvez spécifier qu'un seul des paramètres suivants :

• StackPolicyBody

• StackPolicyURL

• StackPolicyDuringUpdateBody

• StackPolicyDuringUpdateURL

--TimeoutInMinutes

Long

No

10

Délai d'attente pour la mise à jour de la pile.

• Valeur par défaut : 60.

• Unité : minutes.

--TemplateBody

String

No

{ "ROSTemplateFormatVersion": "2015-09-01" }

Structure contenant le corps du modèle. La taille du corps du modèle doit être comprise entre 1 et 524 288 octets.

Si la taille du corps du modèle dépasse la limite supérieure, nous vous recommandons d'ajouter des paramètres au corps de la requête HTTP POST pour éviter les échecs de requête dus à des URL trop longues.

Vous pouvez spécifier TemplateBody ou TemplateURL, mais pas les deux simultanément.

--StackPolicyURL

String

No

oss://ros-stack-policy/demo

URL du fichier contenant la politique de pile. L'URL doit pointer vers une politique située sur un serveur web HTTP ou HTTPS ou dans un compartiment OSS, tel que oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. Le fichier de politique peut atteindre 16 384 octets.

Vous pouvez spécifier StackPolicyBody ou StackPolicyURL, mais pas les deux simultanément.

L'URL peut atteindre 1 350 octets.

--StackPolicyDuringUpdateURL

String

No

oss://ros-stack-policy/demo

URL du fichier contenant la politique de mise à jour de la pile. L'URL doit pointer vers une politique située sur un serveur web HTTP ou HTTPS ou dans un compartiment OSS, tel que oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. Le fichier de politique peut atteindre 16 384 octets.

L'URL peut atteindre 1 350 octets.

Si vous souhaitez mettre à jour des ressources protégées, vous devez spécifier une politique de pile temporaire de remplacement lors de la mise à jour. Si vous ne spécifiez pas de politique de pile temporaire de remplacement, la politique existante associée à la pile est utilisée. Ce paramètre prend effet uniquement lorsque l'ensemble de modifications est de type UPDATE. Vous ne pouvez spécifier qu'un seul des paramètres suivants :

• StackPolicyBody

• StackPolicyURL

• StackPolicyDuringUpdateBody

• StackPolicyDuringUpdateURL

--StackPolicyBody

String

No

{"Statement": [{"Action": "Update:", "Resource": "", "Effect": "Allow", "Principal": "*"}]}

Structure contenant le corps de la politique de pile. Le corps de la politique doit être compris entre 1 et 16 384 octets.

Vous pouvez spécifier StackPolicyBody ou StackPolicyURL, mais pas les deux simultanément.

--UsePreviousParameters

Boolean

No

true

Indique s'il faut utiliser les valeurs spécifiées dans la requête précédente pour les paramètres que vous ne spécifiez pas dans la requête actuelle.

--DisableRollback

Boolean

No

false

Indique s'il faut désactiver le retour arrière en cas d'échec de la mise à jour de la pile. Valeurs valides :

• true

• false (par défaut)

--TemplateURL

String

No

oss://ros-template/demo

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, tel que oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. Le corps du modèle peut atteindre 524 288 octets.

Vous pouvez spécifier TemplateBody ou TemplateURL, mais pas les deux simultanément.

L'URL peut atteindre 1 024 octets.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-beijing

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackName

String

Yes

MyStack

Nom de la pile.

Le nom peut contenir jusqu'à 255 caractères, incluant des chiffres, des lettres, des traits d'union (-) et des traits de soulignement (_). Il doit commencer par un chiffre ou une lettre. La recherche floue avec le caractère générique (*) est prise en charge.

--TimeoutInMinutes

Long

Yes

10

Délai d'attente pour la création de la pile.

• Valeur par défaut : 60.

• Unité : minutes.

--Parameters.N.ParameterValue

String

No

ecs.cm4,6xlarge

Valeur du paramètre N.

Valeur maximale de N : 200.

--Parameters.N.ParameterKey

String

No

InstanceType

Nom du paramètre N. Si vous ne spécifiez pas le nom et la valeur d'un paramètre, ROS utilise le nom et la valeur par défaut définis dans le modèle.

Valeur maximale de N : 200.

--DisableRollback

Boolean

No

false

Indique s'il faut désactiver le retour arrière en cas d'échec de la création de la pile.

• true

• false (par défaut)

--TemplateBody

String

No

{ "ROSTemplateFormatVersion": "2015-09-01" }

Structure contenant le corps du modèle. La taille du corps du modèle doit être comprise entre 1 et 524 288 octets.

Si la taille du corps du modèle dépasse la limite supérieure, nous vous recommandons d'ajouter des paramètres au corps de la requête HTTP POST pour éviter les échecs de requête dus à des URL trop longues.

Vous pouvez spécifier TemplateBody ou TemplateURL, mais pas les deux simultanément.

--StackPolicyURL

String

No

oss://ros-stack-policy/demo

URL du fichier contenant la politique de pile. L'URL doit pointer vers une politique située sur un serveur web HTTP ou HTTPS ou dans un compartiment OSS, tel que oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. Le fichier de politique peut atteindre 16 384 octets.

Vous pouvez spécifier StackPolicyBody ou StackPolicyURL, mais pas les deux simultanément.

L'URL peut atteindre 1 350 octets.

--StackPolicyBody

String

No

{"Statement": [{"Action": "Update:", "Resource": "", "Effect": "Allow", "Principal": "*"}]}

Structure contenant le corps de la politique de pile. Le corps de la politique doit être compris entre 1 et 16 384 octets.

Vous pouvez spécifier StackPolicyBody ou StackPolicyURL, mais pas les deux simultanément.

--TemplateURL

String

No

oss://ros-template/demo

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, tel que oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. Le corps du modèle peut atteindre 524 288 octets.

Vous pouvez spécifier TemplateBody ou TemplateURL, mais pas les deux simultanément.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

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, incluant uniquement des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_).

Pour plus d'informations, consultez Assurer l'idempotence.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691f2ff

ID de la pile.

--RetainAllResources

Boolean

No

false

Indique s'il faut conserver les ressources de la pile.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID de la pile.

--CancelType

String

No

Safe

Méthode d'annulation de la mise à jour de la pile. Nous vous recommandons de définir DisableRollback sur true. Valeurs valides :

• Quick : annule la mise à jour de la pile dès que possible.

• Safe : annule la mise à jour de la pile de manière aussi sûre que possible.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID de la pile.

--RecreatingResources.N

RepeatList

No

WebServer

Ressource N que ROS continue de créer après l'échec de sa création.

Vous pouvez ajouter de nouvelles ressources aux ressources que ROS continue de créer. ROS poursuit la création de toutes les dépendances des nouvelles ressources.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID de la région de la pile. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID de la pile.

--Status.N

RepeatList

No

CREATE_IN_PROGRESS

État de la ressource N. Valeurs valides :

• CREATE_COMPLETE

• CREATE_FAILED

• CREATE_IN_PROGRESS

• DELETE_FAILED

• DELETE_IN_PROGRESS

• ROLLBACK_COMPLETE

• ROLLBACK_FAILED

• ROLLBACK_IN_PROGRESS

--ResourceType.N

RepeatList

No

ALIYUN::ECS::Instance

Type de ressource N.

Valeur maximale de N : 200.

--PageNumber

Long

No

1

Numéro de page.

• Les pages commencent à partir de la page 1.

• Valeur par défaut : 1.

--PageSize

Long

No

10

Nombre d'entrées par page.

• Valeur maximale : 100.

• Valeur par défaut : 10.