CreateInstance - - Centre de documentation Alibaba Cloud

Crée une instance ApsaraMQ for RocketMQ 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 les systèmes de gestion et de contrôle. Ne vous appuyez pas sur l'OpenAPI dans le plan de données principal pour l'envoi et la réception de messages. Sinon, cela pourrait entraîner des risques.

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. 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 ne peut contenir que des caractères ASCII et sa longueur ne peut pas dépasser 64 caractères.	c2c5d1274a8d4317a13bc5b0d4******
body	object	Non	Les paramètres du corps.
instanceName	string	Non	Le nom de l'instance à créer.	rmq-cn-72u3048uxxx
serviceCode	string	Oui	Le code de service de l'instance. Le code de service pour MSMQ 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. Valeurs valides : serverless : Édition Serverless. cluster_ha : Édition haute disponibilité du cluster. single_node : Édition de test à nœud unique.	cluster_ha
paymentType	string	Oui	Le type de paiement de l'instance. MSMQ RocketMQ prend en charge l'abonnement et le paiement à l'usage. 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 type de paiement de l'instance est Abonnement.	3
periodUnit	string	Non	L'unité de temps 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 type de paiement de l'instance est Abonnement. Valeurs valides : true : Activer le renouvellement automatique. false : Désactiver le renouvellement automatique.	true
autoRenewPeriod	integer	Non	Le cycle de renouvellement automatique unifié. Ce paramètre prend effet uniquement lorsque le renouvellement automatique est activé. Unité : mois.	3
remark	string	Non	Les remarques de l'instance.	Ceci est la remarque de test
productInfo	object	Non	Les informations sur les spécifications 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 entre le TPS d'envoi de messages et le TPS total d'envoi et de réception de messages de l'instance.	0.5
autoScaling	boolean	Non	Indique si la mise à l'échelle élastique extensible au-delà de la spécification doit être activée. Valeurs valides : true : Activer la mise à l'échelle élastique. false : Désactiver la mise à l'échelle élastique.	true
messageRetentionTime	integer	Non	La période de rétention des messages. Unité : heures.	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 modèle 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 fonctionnalité de traçage des messages est activée.	true
drReplicationMode	string	Non	Le modèle 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
networkInfo	object	Oui	Les informations de configuration réseau.
vpcInfo	object	Oui	Les informations de configuration du VPC.
vpcId	string	Oui	The ID of the VPC to associate with the instance to be created.	vpc-wz9qt50xhtj9krb******
vSwitchId `deprecated`	string	Non	The ID of the vSwitch associated with the instance. If multiple vSwitches are specified, separate them with vertical bars (\|).	vsw-uf6gwtbn6etadpv*******
securityGroupIds	string	Non	The security group IDs.	sg-bp17hpmgz96tvnsdy6so
vSwitches	array<object>	Non	The list of vSwitches.
	object	Non
vSwitchId	string	Non	The ID of the vSwitch associated with the instance.	vsw-uf6gwtbn6etadpv*******
internetInfo	object	Oui	Les informations de configuration du réseau public.
internetSpec	string	Oui	Specifies whether to enable public network access. Valeurs valides : enable : Enable public network access. disable : Disable public network access.	disable
flowOutType	string	Oui	The billing type for public network usage. Valeurs valides : payByBandwidth : Fixed bandwidth billing. Set this parameter to this value when public network access is enabled. payByTraffic : Pay-by-traffic billing. Set this parameter to this value when public network access is enabled. uninvolved : Not applicable. Set this parameter to this value when public network access is disabled.	uninvolved
flowOutBandwidth	integer	Non	The Internet bandwidth specification. Unit: Mbit/s.	100
ipWhitelist `deprecated`	array	Non	The IP whitelist for public network access. Only public endpoints support IP whitelist configuration. VPC endpoints do not support this feature.
	string	Non	The CIDR block for the public network access whitelist.	192.168.x.x/24
commodityCode `deprecated`	string	Non	Le code produit.	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 depuis les points de terminaison VPC doit être autorisé lorsque le type de reconnaissance d'identité intelligente est utilisé.	false

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
requestId	string	L'identifiant de la requête. Chaque identifiant de requête est unique et peut être utilisé pour le dépannage.	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.