API调用说明

更新时间:

云消息队列 RabbitMQ 版支持HTTP调用、SDK调用和OpenAPI Explorer调用。

HTTP调用

云消息队列 RabbitMQ 版HTTP调用是向云消息队列 RabbitMQ 版API的服务端地址发送HTTP请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。云消息队列 RabbitMQ 版的API是RPC风格,您可以通过发送HTTP GET请求调用云消息队列 RabbitMQ 版的API。

其请求结构如下:

https://Endpoint/?Action=xx&Parameters

其中:

  • Endpoint云消息队列 RabbitMQ 版API的服务接入地址。详情请参见服务接入点

  • Action:要执行的操作,如调用ListInstances查询已创建的云消息队列 RabbitMQ 版实例。

  • Version:要使用的API版本,云消息队列 RabbitMQ 版的API版本是2019-12-12

  • Parameters:请求参数,每个参数之间用“&”分隔。

    请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息。详情请参见下文。

公共参数

公共请求参数

名称

类型

是否必选

描述

Format

String

返回消息的格式。取值:

JSON(默认值) | XML

Version

String

API版本号,使用YYYY-MM-DD日期格式。取值:

2019-12-12

AccessKeyId

String

访问服务使用的密钥ID。

Signature

String

签名结果串。

SignatureMethod

String

签名方式,取值:

HMAC-SHA1

Timestamp

String

请求的时间戳,为日期格式。使用UTC时间按照ISO8601标准,格式为YYYY-MM-DDThh:mm:ssZ。

例如,北京时间2013年1月10日20点0分0秒,表示为2013-01-10T20:00:00Z。

SignatureVersion

String

签名算法版本,取值:

1.0

SignatureNonce

String

唯一随机数,用于防止网络重放攻击。

在不同请求间要使用不同的随机数值,建议使用通用唯一识别码(Universally Unique Identifier, UUID)。

ResourceOwnerAccount

String

本次API请求访问到的资源拥有者账户,即登录用户名。

示例

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
…

公共返回参数

API返回结果采用统一格式,调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId

  • 返回2xx HTTP状态码表示调用成功。

  • 返回4xx5xx HTTP状态码表示调用失败。

公共返回参数示例如下:

  • XML格式

    <?xml version="1.0" encoding="utf-8"?> 
        <!--结果的根结点-->
        <接口名称+Response>
            <!--返回请求标签-->
            <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId>
            <!--返回结果数据-->
        </接口名称+Response>                        
  • JSON格式

    {
        "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC",
        /*返回结果数据*/
    }

SDK调用

云消息队列 RabbitMQ 版提供多语言SDK。阿里云SDK免去您手动签名的过程。SDK的下载地址及说明文档如下。

语言

下载地址

说明文档

Java

Alibaba Cloud AMQP SDK for Java

开始使用

Go

Alibaba Cloud AMQP SDK for Go

快速开始

Python

Alibaba Cloud AMQP SDK for Python

开始使用

PHP

Alibaba Cloud AMQP for PHP

快速开始

OpenAPI Explorer调用

OpenAPI Explorer是可视化的API调用工具。通过该工具,您可以通过网页或者命令行调用各云产品以及API市场上开放的API,查看每次的API请求和返回结果,并生成相应SDK调用示例。您可以直接访问OpenAPI Explorer