CreateInstance - - Centre de documentation Alibaba Cloud

Crée une instance ApsaraMQ for RocketMQ de la série 5.x.

Description de l'opération

Important L'OpenAPI fournie par Alibaba Cloud est une API de gestion et de contrôle utilisée pour gérer et interroger les ressources des services Alibaba Cloud. Intégrez-la uniquement dans la chaîne de gestion et de contrôle. Ne vous appuyez pas sur l'OpenAPI dans la chaîne de données principale pour l'envoi et la réception de messages. Sinon, des risques peuvent survenir sur la chaîne.

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.

rocketmq:CreateInstance

create

*Instance.

acs:rocketmq:{#regionId}:{#accountId}:Instance/*

rocketmq:InternetSpec

Aucune

Syntaxe de la requête

POST /instances HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
clientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Le client génère la valeur de ce paramètre, qui doit être unique pour chaque requête. Le jeton peut contenir jusqu'à 64 caractères ASCII.	c2c5d1274a8d4317a13bc5b0d4******
body	object	Non	Les paramètres du corps.
instanceName	string	Non	Le nom de l'instance à créer. Si vous ne spécifiez pas ce paramètre, l'identifiant de l'instance est utilisé comme nom d'instance.	rmq-cn-72u3048uxxx
serviceCode	string	Oui	Le code de service de l'instance. Le code de service pour MSMQ for RocketMQ est rmq.	rmq
seriesCode	string	Oui	Le code de la série principale de l'instance. Pour plus d'informations sur les différences entre les séries principales, consultez Sélection de produit. Valeurs valides : standard : Édition standard. dedicated : Édition dédiée. shared : Édition partagée. ultimate : Édition Platinum. professional : Édition professionnelle.	standard
subSeriesCode	string	Oui	Le code de la sous-série de l'instance. Pour plus d'informations sur les différences entre les sous-séries, consultez Sélection de produit. Si la série principale est définie sur ultimate (Édition Platinum), la sous-série ne peut être définie que sur cluster_ha (Édition haute disponibilité de cluster). Important Une fois l'instance créée, la sous-série ne peut plus être modifiée. Valeurs valides : serverless : Édition Serverless. cluster_ha : Édition haute disponibilité de cluster. single_node : Édition de test à nœud unique.	cluster_ha
paymentType	string	Oui	Le mode de facturation de l'instance. ApsaraMQ for RocketMQ prend en charge les modes de facturation par abonnement et à l'usage. Pour plus d'informations, consultez Modes de facturation. Valeurs valides : PayAsYouGo : Paiement à l'usage. Un mode de post-paiement où vous utilisez d'abord les ressources et payez ensuite. Subscription : Abonnement. Un mode de prépaiement où vous payez d'abord et utilisez les ressources ensuite.	Subscription
period	integer	Non	La durée de l'abonnement. Ce paramètre prend effet uniquement lorsque le mode de facturation de l'instance est défini sur Subscription. Valeurs valides : Abonnement mensuel : 1, 2, 3, 4, 5, 6 Abonnement annuel : 1, 2, 3	3
periodUnit	string	Non	L'unité de base minimale de la durée de l'abonnement. Valeurs valides : Month : Abonnement mensuel. Year : Abonnement annuel.	Month
autoRenew	boolean	Non	Indique si le renouvellement automatique doit être activé. Ce paramètre prend effet uniquement lorsque le mode de facturation de l'instance est défini sur Subscription. Valeurs valides : true : Le renouvellement automatique est activé. false : Le renouvellement automatique est désactivé.	true
autoRenewPeriod	integer	Non	Le cycle de renouvellement automatique unifié. Ce paramètre prend effet uniquement lorsque le renouvellement automatique est activé. Unité : mois. Valeurs valides : Renouvellement mensuel : 1, 2, 3, 6, 12	3
remark	string	Non	Les remarques de l'instance.	Ceci est une remarque de test
productInfo	object	Non	Les informations de spécification de l'instance.
msgProcessSpec	string	Non	La spécification de calcul pour l'envoi et la réception de messages. Pour plus d'informations sur la limite supérieure de TPS pour l'envoi et la réception de messages, consultez Spécifications de l'instance.	rmq.s2.2xlarge
sendReceiveRatio	number	Non	Le ratio du TPS d'envoi de messages sur le TPS total d'envoi et de réception de messages de l'instance. Par exemple, si la limite supérieure de TPS pour l'envoi et la réception de messages de l'instance est de 1 000 par seconde et que le ratio d'envoi de messages est de 0,8, la limite supérieure de TPS pour l'envoi de messages est de 800 par seconde et la limite supérieure de TPS pour la réception de messages est de 200 par seconde. Valeurs valides : [0.05, 0.95]. Valeur par défaut : 0.5.	0.5
autoScaling	boolean	Non	Indique si la capacité élastique extensible au-delà de la spécification doit être activée. Une fois la capacité élastique extensible activée, MSMQ for RocketMQ permet à l'instance de dépasser la limite de TPS de la spécification de base dans une certaine mesure. La partie qui dépasse la spécification de base entraîne des frais supplémentaires pour la spécification élastique. Pour plus d'informations sur la facturation, consultez Frais de calcul. Remarque Seules les instances de certaines spécifications prennent en charge la capacité élastique extensible. Pour plus d'informations sur les instances prises en charge, consultez Spécifications de l'instance. Valeurs valides : true : La capacité élastique est activée. false : La capacité élastique est désactivée.	true
messageRetentionTime	integer	Non	La période de rétention des messages. Unité : heures. Pour la plage de valeurs valides, consultez Limites > Quotas de ressources > Période de rétention des messages. Le courtier de journaux dans MSMQ for RocketMQ est entièrement serverless et élastique. Les frais sont facturés en fonction de l'espace de stockage réellement utilisé. Vous pouvez contrôler la capacité de stockage en ajustant la période de rétention des messages. Pour plus d'informations, consultez Frais de stockage.	72
storageEncryption	boolean	Non	Indique si le chiffrement du stockage est activé.	false
storageSecretKey	string	Non	La clé pour le chiffrement du stockage.	xxxxx
capacityType	string	Non	Le mode de capacité. Valeurs valides : provisioned : Provisionné + élastique. ondemand : Paiement à l'usage.	provisioned
provisionedCapacity	integer	Non	La capacité provisionnée.	5000
traceOn	boolean	Non	Indique si la fonction de traçage des messages doit être activée. true : active la fonction de traçage des messages. false : désactive la fonction de traçage des messages. Ce paramètre prend effet uniquement pour les instances Serverless. Si la fonction de traçage des messages est activée, des frais de traçage des messages sont engagés. Pour plus d'informations sur la facturation, consultez la description de la facturation Serverless. Pour les instances par paiement à l'usage et par abonnement, ce paramètre ne prend pas effet. La fonction de traçage des messages est prise en charge par défaut, que ce paramètre soit activé ou non.	true
drReplicationMode	string	Non	Le mode de réplication interrégionale. Valeurs valides : async_cross_az : Réplication asynchrone. sync_cross_az : Réplication synchrone.	async_cross_az
adaptiveElasticity	boolean	Non	Indique si l'élasticité adaptative doit être activée. La valeur true indique que l'élasticité adaptative est activée. La valeur false indique que l'élasticité adaptative est désactivée.
networkInfo	object	Oui	Les informations de configuration réseau.
vpcInfo	object	Oui	Les informations de configuration du VPC.
vpcId	string	Oui	L'identifiant du VPC à associer à l'instance. Remarque Une fois une instance ApsaraMQ for RocketMQ créée, le VPC sélectionné ne peut pas être modifié. Pour modifier le VPC associé, libérez l'instance ApsaraMQ for RocketMQ existante et achetez-en une nouvelle.	vpc-wz9qt50xhtj9krb******
vSwitchId `deprecated`	string	Non	L'identifiant du vSwitch associé à l'instance. S'il existe plusieurs vSwitches, séparez-les par des barres verticales (\|). Remarque Une fois une instance ApsaraMQ for RocketMQ créée, le vSwitch sélectionné ne peut pas être modifié. Pour modifier le vSwitch associé, libérez l'instance ApsaraMQ for RocketMQ existante et achetez-en une nouvelle. Important Ce champ n'est pas recommandé. Utilisez plutôt le champ vSwitches.	vsw-uf6gwtbn6etadpv*******
securityGroupIds	string	Non	L'identifiant du groupe de sécurité.	sg-bp17hpmgz96tvnsdy6so
vSwitches	array<object>	Non	La liste des vSwitches. Remarque Une fois une instance ApsaraMQ for RocketMQ créée, le vSwitch sélectionné ne peut pas être modifié. Pour modifier le vSwitch associé, libérez l'instance ApsaraMQ for RocketMQ existante et achetez-en une nouvelle. Important Ce champ est obligatoire. Étant donné que le champ vSwitchId n'est plus recommandé, utilisez ce champ pour configurer les vSwitches.
	object	Non
vSwitchId	string	Non	L'identifiant du vSwitch associé à l'instance.	vsw-uf6gwtbn6etadpv*******
internetInfo	object	Oui	Les informations de configuration Internet.
internetSpec	string	Oui	Indique si l'accès au réseau public doit être activé. Par défaut, les instances prennent en charge l'accès VPC. Si vous activez l'accès au réseau public, ApsaraMQ for RocketMQ facture des frais pour la bande passante descendante du réseau public. Pour plus d'informations sur la facturation, consultez Frais d'accès au réseau public. Valeurs valides : enable : Activer l'accès au réseau public. disable : Désactiver l'accès au réseau public.	disable
flowOutType	string	Oui	Le type de facturation Internet. Valeurs valides : payByBandwidth : Facturation à bande passante fixe. Définissez ce paramètre sur cette valeur lorsque l'accès au réseau public est activé. payByTraffic : Facturation au trafic. Définissez ce paramètre sur cette valeur lorsque l'accès au réseau public est activé. uninvolved : Non applicable. Définissez ce paramètre sur cette valeur lorsque l'accès au réseau public est désactivé.	uninvolved
flowOutBandwidth	integer	Non	La spécification de la bande passante Internet. Unité : Mb/s. Ce paramètre est requis uniquement lorsque le type de facturation Internet est défini sur facturation à bande passante fixe. Valeurs valides : 1 à 1000.	100
ipWhitelist `deprecated`	array	Non	La liste blanche d'adresses IP pour l'accès au réseau public. Seuls les points de terminaison publics prennent en charge la configuration de la liste blanche d'adresses IP. Les points de terminaison VPC ne prennent pas en charge cette fonctionnalité. Si aucune liste blanche d'adresses IP n'est configurée, toutes les plages d'adresses IP sont autorisées à accéder au serveur ApsaraMQ for RocketMQ via Internet par défaut. Si une liste blanche d'adresses IP est configurée, seules les adresses IP figurant dans la liste blanche sont autorisées à accéder au serveur ApsaraMQ for RocketMQ via Internet.
	string	Non	Le bloc CIDR dans la liste blanche d'accès au réseau public.	192.168.x.x/24
commodityCode `deprecated`	string	Non	Le code produit. ons_rmqpost_public_intl : prépayé. ons_rmqsub_public_intl : abonnement. ons_rmqsrvlesspost_public_intl : instance serverless. Ce paramètre est requis pour les instances serverless.	ons_ rmqpost_public_cn
resourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-aekzy6pist7uuna
tags	array<object>	Non	La liste des balises de ressource.
	object	Non	La balise de ressource.
key	string	Non	La clé de la balise de ressource.	xxxKey
value	string	Non	La valeur de la balise de ressource.	xxxValue
aclInfo	object	Non	Les informations de contrôle d'accès.
defaultVpcAuthFree	boolean	Non	Indique si l'accès sans authentification pour les points de terminaison VPC doit être activé lorsque le type de reconnaissance d'identité intelligente est utilisé. Valeurs valides : true : active l'accès sans authentification. false : désactive l'accès sans authentification.	false

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
requestId	string	L'identifiant de la requête. Chaque identifiant de requête est unique et peut être utilisé pour résoudre les problèmes.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indique si l'opération a réussi.	true
data	string	L'identifiant de l'instance créée.	rmq-cn-7e22ody****
code	string	Le code d'erreur.	200
message	string	Le message d'erreur.	Success
httpStatusCode	integer	Le code d'état HTTP.	200
dynamicCode	string	Le code d'erreur dynamique.	InstanceId
dynamicMessage	string	Le message d'erreur dynamique.	instanceId

Exemples

JSON format

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": "rmq-cn-7e22ody****",
  "code": "200",
  "message": "Success",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.