CreateTemplateScratch - - Centre de documentation Alibaba Cloud

Description

Appelez cette opération pour créer un scénario permettant de spécifier une portée de ressources via une interface visuelle, afin de répliquer et de gérer facilement les ressources sélectionnées. Pour en savoir plus sur les scénarios, consultez la rubrique Présentation.

Cette rubrique explique comment créer un scénario de type « réplication de ressources » dans la région Chine (Hangzhou). Dans cet exemple, le scénario sert à répliquer un VPC nommé vpc-bp1m6fww66xbntjyc****.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération depuis OpenAPI Explorer, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateTemplateScratch	Nom de l'action à effectuer. Définissez la valeur sur CreateTemplateScratch.
RegionId	String	Oui	cn-hangzhou	ID de la région dans laquelle vous souhaitez créer le scénario. Appelez l'opération DescribeRegions pour obtenir la liste actualisée des régions.
TemplateScratchType	String	Oui	ArchitectureReplication	Type de scénario. Valeurs valides : ResourceImport : gestion des ressources ArchitectureReplication : réplication des ressources ResourceMigration : migration des ressources
Description	String	Non	Répliquer un VPC.	Description du scénario.
SourceResources	Array	Non		Ressources sources.
ResourceId	String	Oui	vpc-bp1m6fww66xbntjyc****	ID de la ressource.
ResourceType	String	Oui	ALIYUN::ECS::VPC	Type de ressource.
SourceTag	Object	Non		Tag source.
ResourceTags	Map	Oui	{"a": "b"}	Tags sources constitués de paires clé-valeur. Pour ne spécifier que la clé du tag, laissez la valeur vide. Exemple : `{"TagKey": ""}`. Vous pouvez ajouter jusqu'à 10 tags sources.
ResourceTypeFilter	Array of String	Non	ALIYUN::ECS::VPC	Filtre par types de ressources. Si ce paramètre est défini, seules les ressources correspondant aux types spécifiés et portant les tags indiqués sont analysées. À défaut, toutes les ressources portant les tags spécifiés sont analysées. Vous pouvez spécifier jusqu'à 20 types de ressources.
SourceResourceGroup	Object	Non		Groupe de ressources source.
ResourceGroupId	String	Oui	rg-acfmzawhxxc****	ID du groupe de ressources source.
ResourceTypeFilter	Array of String	Non	ALIYUN::ECS::VPC	Filtre par types de ressources. Si ce paramètre est défini, seules les ressources correspondant aux types spécifiés et appartenant aux groupes de ressources indiqués sont analysées. À défaut, toutes les ressources des groupes de ressources spécifiés sont analysées. Vous pouvez spécifier jusqu'à 20 types de ressources.
PreferenceParameters	Array	Non		Paramètres à configurer pour le scénario.
ParameterKey	String	Oui	DeletionPolicy	Nom du paramètre. Pour connaître les valeurs valides du paramètre ParameterKey, reportez-vous à la section « Informations complémentaires sur les paramètres de requête » de cette rubrique. Remarque Le paramètre PreferenceParameters est facultatif. Toutefois, si vous le renseignez, vous devez obligatoirement définir les paramètres ParameterKey et ParameterValue. Si le paramètre TemplateScratchType a la valeur ResourceImport, définissez ParameterKey sur DeletionPolicy.
ParameterValue	String	Oui	Retain	Valeur du paramètre. La valeur acceptée pour ParameterValue dépend de celle définie pour ParameterKey. Pour connaître les valeurs valides du paramètre ParameterValue, reportez-vous à la section « Informations complémentaires sur les paramètres de requête » de cette rubrique. Remarque Le paramètre PreferenceParameters est facultatif. Toutefois, si vous le renseignez, vous devez obligatoirement définir les paramètres ParameterKey et ParameterValue.
LogicalIdStrategy	String	Non	LongTypePrefixAndIndexSuffix	Stratégie de génération de l'ID logique. Valeur par défaut : LongTypePrefixAndIndexSuffix. Valeurs valides : LongTypePrefixAndIndexSuffix : préfixe long + suffixe indexé LongTypePrefixAndHashSuffix : préfixe long + suffixe haché ShortTypePrefixAndHashSuffix : préfixe court + suffixe haché
ClientToken	String	Non	123e4567-e89b-12d3-a456-42665544****	Jeton client garantissant l'idempotence de la requête. Générez cette valeur depuis votre client en veillant à son unicité entre différentes requêtes. La longueur maximale est de 64 caractères ; seuls les lettres, chiffres, tirets (-) et underscores (_) sont autorisés. Pour en savoir plus, consultez la rubrique Garantir l'idempotence.
ExecutionMode	String	Non	Sync	Mode d'exécution. Valeur par défaut : Async. Valeurs valides : Async : mode asynchrone Sync : mode synchrone Remarque Lorsque la portée des ressources est étendue, le mode synchrone prend plus de temps que le mode asynchrone. Si vous définissez ExecutionMode sur Sync, nous vous recommandons de renseigner le paramètre ClientToken pour éviter les erreurs de délai d'attente.
Tags.N.Key	String	Oui	usage	Clé du tag N à ajouter au scénario. Remarque Le paramètre Tags est facultatif. Si vous l'utilisez, vous devez obligatoirement renseigner le paramètre Tags.N.Key.
Tags.N.Value	String	Non	test	Valeur du tag N à ajouter au scénario.

Informations complémentaires sur les paramètres de requête

Pour en savoir plus sur les paramètres de requête communs, consultez la rubrique Paramètres communs.

Les valeurs des paramètres ParameterKey et ParameterValue varient selon le type de scénario.

Le tableau suivant décrit les valeurs des paramètres ParameterKey et ParameterValue pour un scénario de réplication de ressources.

ParameterKey	ParameterValue
DeletionPolicy	Politique de suppression des ressources. Valeurs valides : Retain : conserve les ressources. Si vous supprimez la stack après avoir répliqué les ressources dedans, celles-ci sont conservées. Delete : supprime les ressources. Si vous supprimez la stack après avoir répliqué les ressources dedans, celles-ci sont supprimées par défaut. Si vous choisissez de conserver certaines ressources lors de l'affichage de la boîte de dialogue Supprimer la stack, elles sont conservées.
RegionId	ID de la région de destination vers laquelle vous souhaitez répliquer les ressources. Si ce paramètre n'est pas spécifié, l'ID de la région actuelle est utilisé par défaut. Exemple : cn-shanghai.
ZoneId	ID de la zone de destination vers laquelle vous souhaitez répliquer les ressources. Si ce paramètre n'est pas spécifié, les règles suivantes s'appliquent : pour une réplication au sein de la même région, les ressources répliquées sont déployées dans la zone où résident les ressources sources ; pour une réplication inter-régions, les ressources répliquées sont déployées dans une zone disponible pour l'ensemble des ressources. Exemple : cn-shanghai-b.
VpcId	ID du VPC de destination vers lequel vous souhaitez répliquer les ressources. Si ce paramètre n'est pas spécifié, les règles suivantes s'appliquent : pour une réplication au sein de la même région, les ressources répliquées sont déployées dans le VPC auquel appartiennent les ressources sources ; pour une réplication inter-régions, un nouveau VPC est créé dans la région de destination. Exemple : vpc-bp1hye0s8b69xokfu****.
VSwitchId	ID du vSwitch de destination vers lequel vous souhaitez répliquer les ressources. Si ce paramètre n'est pas spécifié, les règles suivantes s'appliquent : pour une réplication au sein de la même région, les ressources répliquées sont associées au vSwitch utilisé par les ressources sources ; pour une réplication inter-régions, un nouveau vSwitch est créé dans la région de destination. Exemple : vsw-bp11ufkwqwggtm1cj****.
InstanceDataReplication	Indique si les données de l'instance Elastic Compute Service (ECS) doivent être répliquées. Valeurs valides : true : réplique les données de l'instance ECS. Pour une réplication au sein de la même région, une image personnalisée est créée à partir de l'instance source, puis une nouvelle instance est provisionnée à partir de cette image. Pour une réplication inter-régions, une image personnalisée est créée à partir de l'instance source et copiée vers la région de destination ; une nouvelle image y est générée, puis une nouvelle instance est provisionnée à partir de celle-ci. false : ne réplique pas les données de l'instance ECS.

Remarque

Si vous définissez ParameterKey sur InstanceDataReplication et ParameterValue sur true, arrêtez l'instance source avant de lancer la réplication afin de garantir la cohérence des données.

Le tableau suivant décrit les valeurs des paramètres ParameterKey et ParameterValue pour un scénario de gestion des ressources.

Remarque

Dans un scénario de gestion des ressources, vous devez définir ParameterKey sur DeletionPolicy.

ParameterKey

ParameterValue

DeletionPolicy

Politique de suppression des ressources. Valeurs valides :

Retain : conserve les ressources. Si vous supprimez la stack après avoir utilisé celle-ci pour gérer les ressources, celles-ci sont conservées.
Delete : supprime les ressources. Si vous supprimez la stack après avoir utilisé celle-ci pour gérer les ressources, celles-ci sont supprimées par défaut. Si vous choisissez de conserver certaines ressources lors de l'affichage de la boîte de dialogue Supprimer la stack, elles sont conservées.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	84980977-22F0-5421-B30D-B201311D5DCF	ID de la requête.
TemplateScratchId	String	ts-7f7a704cf71c49a6****	ID du scénario.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=CreateTemplateScratch
&RegionId=cn-hangzhou
&TemplateScratchType=ArchitectureReplication
&SourceResources=[{"ResourceId":"vpc-bp1m6fww66xbntjyc****","ResourceType":"ALIYUN::ECS::VPC"}]
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTemplateScratchResponse>
    <RequestId>84980977-22F0-5421-B30D-B201311D5DCF</RequestId>
    <TemplateScratchId>ts-7f7a704cf71c49a6****</TemplateScratchId>
</CreateTemplateScratchResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "84980977-22F0-5421-B30D-B201311D5DCF",
  "TemplateScratchId" : "ts-7f7a704cf71c49a6****"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la page Codes d'erreur de service.