Os parâmetros comuns incluem parâmetros de solicitação e de resposta comuns.
Parâmetros de solicitação comuns
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Format |
String |
Não |
Formato da resposta. Valores válidos:
|
|
Version |
String |
Sim |
Número da versão da API. Formato: |
|
AccessKeyId |
String |
Sim |
ID do seu AccessKey. Para mais informações, consulte Create an AccessKey pair. |
|
Signature |
String |
Sim |
String de assinatura da solicitação. Para mais informações, consulte Signature mechanism. |
|
SignatureMethod |
String |
Sim |
Algoritmo de assinatura. Defina o valor como HMAC-SHA1. |
|
Timestamp |
String |
Sim |
Carimbo de data/hora da solicitação. Deve estar em UTC e no formato padrão ISO 8601: AAAA-MM-DDThh:mm:ssZ. Por exemplo, para especificar 10 de janeiro de 2013, 20:00:00 (UTC+8), defina o valor como 2013-01-10T12:00:00Z. |
|
SignatureVersion |
String |
Sim |
Versão do algoritmo de assinatura. Defina o valor como 1,0. |
|
SignatureNonce |
String |
Sim |
Número aleatório exclusivo para evitar ataques de repetição. Use um número diferente para cada solicitação. |
O código a seguir mostra um exemplo de parâmetros de solicitação comuns:
http://actiontrail.cn-hangzhou.aliyuncs.com
?SignatureVersion=1.0
&OssBucketName=yuanch****
&Name=CreateTest
&Format=JSON
&Timestamp=2015-12-01T07%3A04%3****
&Signature=iyEsE7vgGUWop7Term5HM48wzJ****
&AccessKeyId=QzW2********C21M
&SignatureMethod=HMAC-SHA1
&Version=2017-12-04
&RoleName=aliyunactiontraildefaultrole
&Action=CreateTrail
&SignatureNonce=c69b30de-97f9-11e5-afb0-7831c1c8****
&OssKeyPrefix=
Parâmetros de resposta comuns
As respostas da API usam um formato unificado. Se a chamada for bem-sucedida, a resposta retornará em formato XML ou JSON. Especifique o formato dos dados na solicitação. O formato padrão é XML. Cada chamada de API retorna um RequestId exclusivo, independentemente do resultado.
Um código de status HTTP
2xxindica sucesso na chamada.Um código de status HTTP
4xxou5xxindica falha na chamada.
Veja a seguir exemplos de parâmetros de resposta comuns:
-
Formato XML
<?xml version="1.0" encoding="utf-8"?> <!--The root node of the result--> <APIName+Response> <!--The request tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--The response data--> </APIName+Response> -
Formato JSON
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216" /*The response data*/ }