Todos os produtos
Search
Central de documentação

ApsaraMQ for RabbitMQ:Calling API Operations

Última atualização: Jun 28, 2026

O ApsaraMQ for RabbitMQ permite chamar operações de API por meio de HTTP, SDKs e OpenAPI Explorer.

Uso de HTTP

Para chamar uma operação de API via HTTP, envie uma solicitação HTTP GET para o endpoint do ApsaraMQ for RabbitMQ. Adicione também os parâmetros de solicitação correspondentes à operação de API chamada. O sistema retorna uma resposta após a chamada da operação. As solicitações e respostas usam codificação UTF-8. As operações de API do ApsaraMQ for RabbitMQ utilizam o protocolo RPC. Você pode chamar essas operações enviando solicitações HTTP GET.

Use a seguinte sintaxe de solicitação:

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

Descrição dos parâmetros:

  • Endpoint: endpoint usado para acessar a operação de API do ApsaraMQ for RabbitMQ. Para mais informações, consulte Endpoints.

  • Action: operação de API a ser chamada. Por exemplo, para consultar instâncias criadas do ApsaraMQ for RabbitMQ, defina este parâmetro como ListInstances.

  • Version: número da versão da API do ApsaraMQ for RabbitMQ. Defina o valor como 2019-12-12.

  • Parameters: parâmetros da solicitação. Separe vários parâmetros com "e" comercial (&).

    Os parâmetros de solicitação incluem parâmetros comuns e específicos da operação. Os parâmetros comuns abrangem o número da versão da API e informações de autenticação. Para mais detalhes, veja a seção a seguir.

Parâmetros comuns

Parâmetros comuns de solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Format

String

Não

Formato da resposta. Valores válidos:

JSON e XML. Valor padrão: JSON.

Version

String

Sim

Número da versão da API. Especifique o número da versão no formato AAAA-MM-DD. Defina o valor como

2019-12-12

AccessKeyId

String

Sim

AccessKey ID usado para acessar o ApsaraMQ for RabbitMQ.

Signature

String

Sim

String de assinatura da solicitação atual.

SignatureMethod

String

Sim

Método de criptografia da string de assinatura. Defina este parâmetro como

HMAC-SHA1

Timestamp

String

Sim

Carimbo de data/hora da solicitação. Especifique o valor no padrão ISO 8601, no formato AAAA-MM-DDThh:mm:ssZ. O horário deve estar em UTC.

Exemplo: 2013-01-10T20:00:00Z, que especifica 20:00:00 em 10 de janeiro de 2013 (UTC+8).

SignatureVersion

String

Sim

Versão do algoritmo de assinatura. Defina este parâmetro como

1,0

SignatureNonce

String

Sim

Número aleatório e único usado para evitar ataques de replay.

Use números diferentes para solicitações distintas. Recomendamos o uso de identificadores universalmente únicos (UUIDs).

ResourceOwnerAccount

String

Não

Conta Alibaba Cloud à qual pertence o recurso que você deseja acessar.

Exemplos

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
...

Parâmetros comuns de resposta

As respostas da API seguem o formato de resposta HTTP e podem ser retornadas em JSON ou XML. Especifique o formato de resposta na solicitação. O formato padrão é JSON. Toda resposta retorna um ID de solicitação exclusivo, indicado pelo parâmetro RequestId, independentemente do sucesso da solicitação.

  • Um código de status HTTP 2xx indica que a solicitação foi bem-sucedida.

  • Um código de status HTTP 4xx ou 5xx indica falha na solicitação.

Exemplos de respostas

  • Formato 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>                        
  • Formato JSON

    {
        "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC",
        /*Returned data*/
    }

Uso de SDKs

O ApsaraMQ for RabbitMQ oferece SDKs para diversas linguagens de programação. Esses SDKs assinam as solicitações automaticamente. A tabela a seguir fornece os links de baixe e a documentação relacionada aos SDKs do ApsaraMQ for RabbitMQ para diferentes linguagens de programação.

Linguagem de programação

Link de baixe

Referências

Java

Alibaba Cloud AMQP SDK for Java

Introdução ao Alibaba Cloud Darabonba SDK for Java

Go

Alibaba Cloud AMQP SDK for Go

Introdução ao Alibaba Cloud Darabonba SDK for Go

Python

Alibaba Cloud AMQP SDK for Python

Introdução ao Alibaba Cloud Darabonba SDK for Python

PHP

Alibaba Cloud AMQP for PHP

Introdução ao Alibaba Cloud Darabonba SDK for PHP

Uso do OpenAPI Explorer

O OpenAPI Explorer é uma ferramenta gráfica para chamar operações de API. Com ele, você pode invocar operações de API de serviços da Alibaba Cloud e aquelas disponíveis no Alibaba Cloud API Marketplace. Faça as chamadas via página web ou interface de linha de comando (CLI). O OpenAPI Explorer também permite visualizar os parâmetros de solicitação e resposta de cada chamada de API e gera dinamicamente códigos de exemplo para diferentes SDKs. Para acessar o OpenAPI Explorer, clique em OpenAPI Explorer.