Parâmetros comuns - : Central de Documentação do Alibaba Cloud

Este tópico descreve os parâmetros de solicitação e de resposta comuns das operações da API do ApsaraMQ for RocketMQ.

Parâmetros de solicitação comuns

Inclua os parâmetros de solicitação comuns em todas as chamadas à API do Message Queue for Apache RocketMQ.

Parâmetro	Tipo	Obrigatório	Descrição
Format	String	Não	Formato de retorno da resposta. Valores válidos: JSON e XML. Valor padrão: XML.
productName	String	Sim	Nome da API. Insira Ons.
Domain	String	Sim	Domínio do endpoint da API, no formato `ons.${RegionId}.aliyuncs.com`. A região especificada no parâmetro domain deve corresponder à definida no parâmetro regionId.
Version	String	Sim	Versão da API. O valor deve seguir o formato AAAA-MM-DD. Exemplo: 2019-02-14.
AccessKeyId	String	Sim	Par de AccessKey fornecido pela Alibaba Cloud. Se você usar uma conta Alibaba Cloud ou um usuário RAM para chamar a API, esses parâmetros correspondem ao AccessKey ID e ao AccessKey secret dessa conta ou desse usuário. Se você usar um usuário RAM com token do Security Token Service (STS), utilize o AccessKey ID e o AccessKey secret contidos nesse token. Para mais informações, consulte Conceder permissões a usuários RAM.
AccessKeySecret	String	Sim
Signature	String	Sim	String de assinatura da solicitação atual.
SignatureMethod	String	Sim	Método de criptografia da string de assinatura. Defina o valor como HMAC-SHA1.
Timestamp	String	Sim	Carimbo de data/hora da solicitação. Especifique o horário no padrão ISO 8601, formato aaaa-MM-ddTHH:mm:ssZ, em UTC. Por exemplo, 20:00:00 de 10 de janeiro de 2013 (UTC+8) deve ser escrito como 2013-01-10T12:00:00Z.
SignatureVersion	String	Sim	Versão do algoritmo de criptografia da assinatura. Defina o valor como 1,0.
SignatureNonce	String	Sim	Número aleatório exclusivo para evitar ataques de replay. Utilize valores diferentes para cada solicitação.

Exemplos de solicitação

https:/ons.cn-hangzhou.aliyuncs.com/? Action=OnsRegionList
&Format=JSON
&Version=2019-02-14
&AccessKeyId=key-test
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&Timestamp=2020-01-01T12:00:00Z
&SignatureNonce=1521552885****
&SignatureVersion=1.0
...

Parâmetros de resposta comuns

Toda resposta retorna um RequestID único, independentemente do sucesso da chamada. As respostas seguem um formato unificado baseado no protocolo HTTP: códigos de status 2xx indicam sucesso; já os códigos 4xx ou 5xx sinalizam falha.

Formato XML

<? xml version="1.0" encoding="UTF-8"? >
<!--Result Root Node-->
<Interface Name+Response>
 | <!--Return Request Tag-->
 | <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
 | <!--Return Result Data-->
</Interface Name+Response>

Formato JSON

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* Return Result Data */
}