Parámetros comunes - - Centro de documentación de Alibaba Cloud

Este tema describe los parámetros de solicitud y respuesta comunes de las operaciones de la API de ApsaraMQ for RocketMQ.

Parámetros de solicitud comunes

Todas las solicitudes a la API de Message Queue for Apache RocketMQ deben incluir los parámetros de solicitud comunes.

Parámetro	Tipo	Obligatorio	Descripción
Format	String	No	El formato en el que se devuelve la respuesta. Valores válidos: JSON y XML. Valor predeterminado: XML.
productName	String	Sí	El nombre de la API. Introduzca Ons.
Domain	String	Sí	El dominio del endpoint de la API. El valor tiene el formato `ons.${RegionId}.aliyuncs.com`. La región especificada con el parámetro domain debe coincidir con la indicada en el parámetro regionId.
Version	String	Sí	El número de versión de la API. El valor debe tener el formato AAAA-MM-DD. Valor de ejemplo: 2019-02-14.
AccessKeyId	String	Sí	El par de AccessKey que le proporcionó Alibaba Cloud. Si utiliza una cuenta de Alibaba Cloud o un usuario de RAM para llamar a una operación de la API, estos parámetros corresponden al ID y al secreto de AccessKey de dicha cuenta o usuario. Si utiliza un usuario de RAM para llamar a una operación de la API, estos parámetros son el ID y el secreto de AccessKey incluidos en el token de Security Token Service (STS) que obtuvo. Para obtener más información, consulte Grant permissions to RAM users.
AccessKeySecret	String	Sí
Signature	String	Sí	La cadena de firma de la solicitud actual.
SignatureMethod	String	Sí	El método de cifrado de la cadena de firma. Establezca el valor en HMAC-SHA1.
Timestamp	String	Sí	La marca de tiempo de la solicitud. Especifique la hora según el estándar ISO 8601, con el formato aaaa-MM-ddTHH:mm:ssZ. La hora debe expresarse en UTC. Por ejemplo, las 20:00:00 del 10 de enero de 2013 (UTC+8) se escriben como 2013-01-10T12:00:00Z.
SignatureVersion	String	Sí	La versión del algoritmo de cifrado de la firma. Establezca el valor en 1.0.
SignatureNonce	String	Sí	Un número aleatorio único que evita los ataques de reproducción. Debe usar números distintos para cada solicitud.

Ejemplos de solicitudes

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 respuesta comunes

Cada respuesta devuelve un RequestID único, sin importar si la llamada fue exitosa o no. Las respuestas se devuelven en un formato unificado. Las respuestas de la API usan el formato de respuesta HTTP, donde un código de estado 2xx indica una llamada exitosa, mientras que un código 4xx o 5xx señala una llamada con errores.

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 */
}