StartInstance - - Centre de documentation Alibaba Cloud

Démarre une instance Message Queue for Apache Kafka.

Remarque

Vous pouvez envoyer un maximum de deux requêtes par seconde (QPS).

Débogage

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

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	StartInstance	Opération à effectuer. Définissez la valeur sur StartInstance.
InstanceId	String	Yes	alikafka_post-cn-v0h1fgs2****	ID de l'instance Message Queue for Apache Kafka.
RegionId	String	Yes	cn-hangzhou	ID de région de l'instance Message Queue for Apache Kafka.
VpcId	String	Yes	vpc-bp1r4eg3yrxmygv****	ID du VPC dans lequel déployer l'instance Message Queue for Apache Kafka.
VSwitchId	String	Yes	vsw-bp1j3sg5979fstnpl****	ID du vSwitch dans lequel déployer l'instance Message Queue for Apache Kafka.
DeployModule	String	Yes	vpc	Mode de déploiement de l'instance Message Queue for Apache Kafka. Valeurs valides : vpc : déploie l'instance accessible uniquement depuis un VPC. eip : déploie l'instance accessible depuis Internet et un VPC. Le mode de déploiement doit correspondre au type d'instance. Définissez la valeur sur vpc si l'instance est accessible uniquement depuis un VPC. Définissez la valeur sur eip si l'instance est accessible depuis Internet et un VPC.
ZoneId	String	No	cn-hangzhou-k	ID de la zone dans laquelle déployer l'instance Message Queue for Apache Kafka. L'ID de zone de l'instance Message Queue for Apache Kafka doit être identique à celui du vSwitch. La valeur doit respecter le format zoneX ou ID de région-X. Exemples : zonea et cn-hangzhou-k.
IsEipInner	Boolean	No	false	Indique si l'instance Message Queue for Apache Kafka prend en charge les adresses IP élastiques (EIP). Valeurs valides : true : prend en charge les EIP et permet l'accès depuis Internet et un VPC. false : ne prend pas en charge les EIP et permet l'accès uniquement depuis un VPC. La valeur de ce paramètre doit correspondre au type d'instance. Par exemple, si l'instance est accessible uniquement depuis un VPC, définissez ce paramètre sur false.
IsSetUserAndPassword	Boolean	No	false	Indique s'il faut définir un nouveau nom d'utilisateur et un nouveau mot de passe pour l'instance Message Queue for Apache Kafka. Valeurs valides : true : définit un nouveau nom d'utilisateur et un nouveau mot de passe. false : ne définit ni nouveau nom d'utilisateur ni nouveau mot de passe. Ce paramètre s'applique uniquement aux instances accessibles depuis Internet et un VPC.
Username	String	No	username	Nom d'utilisateur de l'instance Message Queue for Apache Kafka. Ce paramètre s'applique uniquement aux instances accessibles depuis Internet et un VPC.
Password	String	No	password	Mot de passe de l'instance Message Queue for Apache Kafka. Ce paramètre s'applique uniquement aux instances accessibles depuis Internet et un VPC.
Name	String	No	newInstanceName	Nom de l'instance Message Queue for Apache Kafka. Remarque Veillez à ce que la valeur du paramètre soit unique dans la région de l'instance.
SecurityGroup	String	No	sg-bp13wfx7kz9pkow***	Groupe de sécurité de l'instance Message Queue for Apache Kafka. Si vous omettez ce paramètre, Message Queue for Apache Kafka configure automatiquement un groupe de sécurité pour l'instance. Si vous spécifiez ce paramètre, vous devez créer un groupe de sécurité au préalable. Pour plus d'informations, consultez Créer un groupe de sécurité.
ServiceVersion	String	No	0.10.2	Version de l'instance Message Queue for Apache Kafka. Valeurs valides : 0.10.2 et 2.2.0.
Config	String	No	{"kafka.log.retention.hours":"33"}	Configurations initiales de l'instance Message Queue for Apache Kafka. La valeur doit être une chaîne JSON valide. Si vous omettez ce paramètre, il reste vide. Le paramètre Config accepte les paramètres suivants : enable.vpc_sasl_ssl : indique s'il faut activer le chiffrement de la transmission VPC. Valeurs valides : true : active le chiffrement de la transmission VPC. Si vous activez le chiffrement de la transmission VPC, activez également la liste de contrôle d'accès (ACL). false : désactive le chiffrement de la transmission VPC. Le chiffrement de la transmission VPC est désactivé par défaut. enable.acl : indique s'il faut activer l'ACL. Valeurs valides : true : active l'ACL. false : désactive l'ACL. L'ACL est désactivée par défaut. kafka.log.retention.hours : durée maximale de conservation des messages lorsque la capacité du disque est suffisante. Unité : heures. Valeurs valides : 24 à 480. Valeur par défaut : 72. Lorsque l'utilisation du disque atteint 85 %, la capacité du disque est considérée comme insuffisante et le système supprime les messages dans l'ordre de stockage, du plus ancien au plus récent. kafka.message.max.bytes : taille maximale des messages que Message Queue for Apache Kafka peut envoyer et recevoir. Unité : octets. Valeurs valides : 1048576 à 10485760. Valeur par défaut : 1048576. Avant de modifier la taille maximale des messages, assurez-vous que la nouvelle valeur correspond à celle configurée sur le producteur et le consommateur.
KMSKeyId	String	No	0d24xxxx-da7b-4786-b981-9a164dxxxxxx	ID de la clé utilisée pour chiffrer les données sur les disques SSD standard dans la région de l'instance. Vous pouvez obtenir l'ID de la clé depuis la console Key Management Service (KMS) ou créer une clé. Pour plus d'informations, consultez Gérer les CMK. Si ce paramètre est spécifié, le chiffrement est activé pour l'instance. Vous ne pouvez pas désactiver le chiffrement après son activation. Lors de l'appel à cette opération, le système vérifie si le rôle lié au service AliyunServiceRoleForAlikafkaInstanceEncryption existe. Sinon, il le crée automatiquement. Pour plus d'informations, consultez Rôles liés au service.

Paramètres de réponse

Parameter	Type	Example	Description
Code	Integer	200	Code d'état HTTP. Le code 200 indique que la requête a abouti.
Message	String	operation success.	Message renvoyé.
RequestId	String	ABA4A7FD-E10F-45C7-9774-A5236015A***	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti.

Exemples

Exemple de requête

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=StartInstance
&InstanceId=alikafka_post-cn-v0h1fgs2****
&RegionId=cn-hangzhou
&VpcId=vpc-bp1r4eg3yrxmygv****
&VSwitchId=vsw-bp1j3sg5979fstnpl****
&DeployModule=vpc
&ZoneId=cn-hangzhou-k
&IsEipInner=false
&IsSetUserAndPassword=false
&Username=username
&Password=password
&Name=newInstanceName
&SecurityGroup=sg-bp13wfx7kz9pkow***
&ServiceVersion= 0.10.2
&Config={"kafka.log.retention.hours":"33"}
&KMSKeyId=0d24xxxx-da7b-4786-b981-9a164dxxxxxx 
&<Common request parameters>

Exemple de réponse réussie

XML format

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

<StartInstanceResponse>
    <Code>200</Code>
    <Message>operation success.</Message>
    <RequestId>ABA4A7FD-E10F-45C7-9774-A5236015A***</RequestId>
    <Success>true</Success>
</StartInstanceResponse>

JSON format

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

{
  "Code" : 200,
  "Message" : "operation success.",
  "RequestId" : "ABA4A7FD-E10F-45C7-9774-A5236015A***",
  "Success" : true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.