Ortak parametreler - - Alibaba Cloud Dokümantasyon Merkezi

Bu konu, ApsaraMQ for RocketMQ API işlemlerinin ortak istek ve yanıt parametrelerini açıklar.

Ortak istek parametreleri

Tüm Message Queue for Apache RocketMQ API isteklerinde ortak istek parametrelerini belirtmeniz gerekir.

Parametre	Tür	Zorunlu	Açıklama
Format	String	Hayır	Yanıtın döndürüleceği biçim. Geçerli değerler: JSON ve XML. Varsayılan değer: XML.
productName	String	Evet	API adı. Ons olarak girin.
Domain	String	Evet	API uç noktasının alan adı. Değer `ons.${RegionId}.aliyuncs.com` biçimindedir. domain parametresiyle belirtilen bölge, regionId parametresiyle belirtilen bölgeyle aynı olmalıdır.
Version	String	Evet	API sürüm numarası. Değer YYYY-AA-GG biçiminde olmalıdır. Örnek değer: 2019-02-14.
AccessKeyId	String	Evet	Alibaba Cloud tarafından sağlanan AccessKey çifti. Bir API işlemini çağırmak için Alibaba Cloud hesabı veya RAM kullanıcısı kullanıyorsanız bu parametreler, ilgili hesabın veya kullanıcının AccessKey ID ve AccessKey Secret değerleridir. Bir API işlemini çağırmak için RAM kullanıcısı kullanıyorsanız bu parametreler, elde ettiğiniz Security Token Service (STS) belirtecindeki AccessKey ID ve AccessKey Secret değerleridir. Daha fazla bilgi için bkz. RAM kullanıcılarına izin verme.
AccessKeySecret	String	Evet
Signature	String	Evet	Geçerli isteğin imza dizesi.
SignatureMethod	String	Evet	İmza dizesinin şifreleme yöntemi. Değeri HMAC-SHA1 olarak ayarlayın.
Timestamp	String	Evet	İsteğin zaman damgası. Zamanı yyyy-AA-GGTSS:dd:ssZ biçiminde ISO 8601 standardına göre belirtin. Saat UTC cinsinden olmalıdır. Örneğin, 10 Ocak 2013 saat 20:00:00 (UTC+8), 2013-01-10T12:00:00Z olarak yazılır.
SignatureVersion	String	Evet	İmza şifreleme algoritmasının sürümü. Değeri 1,0 olarak ayarlayın.
SignatureNonce	String	Evet	Tekrar saldırılarını önlemek için kullanılan benzersiz, rastgele bir sayı. Her istek için farklı bir sayı kullanmalısınız.

Örnek istekler

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

Ortak yanıt parametreleri

Çağrının başarılı olup olmadığından bağımsız olarak her yanıt benzersiz bir RequestID döndürür. Yanıtlar tek bir biçimde döndürülür. API yanıtları HTTP yanıt biçimini kullanır; burada 2xx durum kodu başarılı bir çağrıyı, 4xx veya 5xx durum kodu ise başarısız bir çağrıyı gösterir.

XML biçimi

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

JSON biçimi

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