ApsaraMQ for RabbitMQ vous permet d'appeler des opérations d'API via HTTP, les SDK et OpenAPI Explorer.
Utiliser HTTP
Pour appeler une opération d'API via HTTP, envoyez une requête HTTP GET à l'endpoint ApsaraMQ for RabbitMQ. Ajoutez les paramètres de requête correspondant à l'opération d'API appelée. Le système renvoie une réponse après l'appel. Les requêtes et les réponses sont encodées en UTF-8. Les opérations d'API ApsaraMQ for RabbitMQ utilisent le protocole RPC. Appelez les opérations d'API en envoyant des requêtes HTTP GET.
Voici la syntaxe de requête :
https://Endpoint/?Action=xx&Parameters
Description des paramètres :
Endpoint : endpoint utilisé pour accéder à l'opération d'API ApsaraMQ for RabbitMQ. Pour plus d'informations, consultez la section Endpoints.
Action : opération d'API à appeler. Par exemple, pour interroger les instances ApsaraMQ for RabbitMQ créées, définissez ce paramètre sur ListInstances.
Version : numéro de version de l'API ApsaraMQ for RabbitMQ. Définissez la valeur sur 2019-12-12.
-
Parameters : paramètres de requête. Séparez plusieurs paramètres par des esperluettes (&).
Les paramètres de requête incluent des paramètres communs et des paramètres spécifiques à l'opération. Les paramètres communs incluent le numéro de version de l'API et les informations d'authentification. Pour plus d'informations, consultez la section suivante.
Paramètres communs
Paramètres de requête communs
|
Parameter |
Type |
Required |
Description |
|
Format |
String |
No |
Format de la réponse. Valeurs valides : JSON et XML. Valeur par défaut : JSON. |
|
Version |
String |
Yes |
Numéro de version de l'API. Spécifiez le numéro de version au format AAAA-MM-JJ. Définissez la valeur sur 2019-12-12 |
|
AccessKeyId |
String |
Yes |
ID AccessKey utilisé pour accéder à ApsaraMQ for RabbitMQ. |
|
Signature |
String |
Yes |
Chaîne de signature de la requête actuelle. |
|
SignatureMethod |
String |
Yes |
Méthode de chiffrement de la chaîne de signature. Définissez ce paramètre sur HMAC-SHA1 |
|
Timestamp |
String |
Yes |
Horodatage de la requête. Spécifiez la valeur selon la norme ISO 8601 au format AAAA-MM-JJThh:mm:ssZ. L'heure doit être exprimée en UTC. Exemple : 2013-01-10T20:00:00Z, qui spécifie 20:00:00 le 10 janvier 2013 (UTC+8). |
|
SignatureVersion |
String |
Yes |
Version de l'algorithme de signature. Définissez ce paramètre sur 1.0 |
|
SignatureNonce |
String |
Yes |
Nombre unique et aléatoire utilisé pour empêcher les attaques par rejeu. Utilisez des nombres différents pour chaque requête. Nous vous recommandons d'utiliser des identifiants uniques universels (UUID). |
|
ResourceOwnerAccount |
String |
No |
Compte Alibaba Cloud auquel appartient la ressource à laquelle vous souhaitez accéder. |
Exemples
https://amqp-open.aliyuncs.com/?Action=ListInstances
&Format=JSON
&Version=2019-12-12
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e7b1f31150be45594905ce6d28561286
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2020-02-10T08%3A43%3A05Z
...
Paramètres de réponse communs
Les réponses d'API utilisent le format de réponse HTTP. Elles peuvent être renvoyées au format JSON ou XML. Vous pouvez spécifier le format de réponse dans la requête. Le format de réponse par défaut est JSON. Chaque réponse renvoie un ID de requête unique indiqué par le paramètre RequestId, que la requête aboutisse ou non.
Un code d'état HTTP
2xxindique que la requête a abouti.Un code d'état HTTP
4xxou5xxindique que la requête a échoué.
Exemples de réponses
-
Format XML
<?xml version="1.0" encoding="utf-8"?> <!--Root node of the response--> <Interface name+Response> <!--Returned request tag--> <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId> <!--Returned data--> </Interface name+Response> -
Format JSON
{ "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC", /*Returned data*/ }
Utiliser les SDK
ApsaraMQ for RabbitMQ propose des SDK pour plusieurs langages de programmation. Les SDK signent automatiquement les requêtes. Le tableau suivant fournit les liens de téléchargement et la documentation associée des SDK ApsaraMQ for RabbitMQ pour différents langages de programmation.
|
Programming language |
Download link |
References |
|
Java |
||
|
Go |
||
|
Python |
||
|
PHP |
Utiliser OpenAPI Explorer
OpenAPI Explorer est un outil graphique permettant d'appeler des opérations d'API. Utilisez OpenAPI Explorer pour appeler les opérations d'API des services Alibaba Cloud et celles fournies sur Alibaba Cloud API Marketplace. Vous pouvez appeler les opérations d'API sur une page Web ou via une interface de ligne de commande (CLI). OpenAPI Explorer permet également d'afficher les paramètres de requête et de réponse de chaque appel d'API. Il génère dynamiquement l'exemple de code pour différents SDK. Pour accéder à OpenAPI Explorer, cliquez sur OpenAPI Explorer.