OnsInstanceUpdate - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Vous pouvez déployer au maximum huit instances Message Queue for Apache RocketMQ par région.

Limite de QPS

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 10 fois par seconde. Si le nombre de requêtes envoyées chaque seconde dépasse la limite de QPS, un mécanisme de limitation du débit (throttling) se déclenche et peut interrompre votre activité. Pour plus d'informations, consultez la rubrique Limites de QPS.

Autorisation

Par défaut, seuls les comptes Alibaba Cloud peuvent appeler cette opération. Un utilisateur RAM (Resource Access Management) ne peut l'appeler qu'après avoir reçu les autorisations requises. Le tableau suivant décrit les autorisations nécessaires pour appeler cette opération. Pour plus d'informations, consultez la rubrique Politiques et exemples.

API

Action

Resource

OnsInstanceUpdate

mq:QueryInstanceBaseInfo

mq:UpdateInstance

acs:mq:::{instanceId}

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	OnsInstanceUpdate	Opération à effectuer. Définissez la valeur sur OnsInstanceUpdate.
Remark	String	No	Updateddescription	Description mise à jour de l'instance. Si vous ne configurez pas ce paramètre, la description de l'instance reste inchangée.
InstanceName	String	Yes	Updatedname	Nom mis à jour de l'instance. Configurez ce paramètre en respectant les règles suivantes : Le nom de l'instance doit être unique dans la région où elle est déployée. Le nom doit comporter entre 3 et 64 caractères et peut contenir des lettres, des chiffres, des traits d'union (-), des traits de soulignement (_) et des caractères chinois. Si vous ne configurez pas ce paramètre, le nom de l'instance reste inchangé.
InstanceId	String	Yes	MQ_INST_188077086902****_BXSuW61e	ID de l'instance dont vous souhaitez mettre à jour le nom ou la description.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	A07E3902-B92E-44A6-B6C5-6AA111111****	ID de la requête. Il s'agit d'un paramètre commun. Chaque requête possède un ID unique que vous pouvez utiliser pour le dépannage.

Exemples

Exemples de requêtes

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsInstanceUpdate
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&InstanceName=Updatedname
&Remark=Updateddescription
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<OnsInstanceUpdateResponse>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsInstanceUpdateResponse>

Format JSON

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

{
  "RequestId" : "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

Codes d'erreur

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

Mise à jour du nom et de la description d'une instance via la console

Outre l'appel de l'opération OnsInstanceUpdate, vous pouvez utiliser la console Message Queue for Apache RocketMQ pour mettre à jour le nom et la description d'une instance. Pour savoir comment procéder, consultez la rubrique Gérer les instances.