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

Parâmetros comuns de solicitação

Todas as chamadas de API exigem parâmetros comuns de solicitação.

Nome	Tipo	Obrigatório	Descrição
Format	String	Não	Formato do valor de retorno. Valores válidos: JSON e XML. Valor padrão: XML.
Version	String	Sim	Número da versão da API. Formato: `YYYY-MM-DD`. Se o parâmetro RegionId for cn-hangzhou, defina este parâmetro como `2015-11-23`. Para outras regiões, como ap-southeast-1, use `2017-06-22`.
AccessKeyId	String	Sim	ID da chave de acesso ao serviço. A Alibaba Cloud emite esse ID. Crie um AccessKey no console Gerenciamento de AccessKey.
Signature	String	Sim	String de assinatura. Para mais informações sobre o cálculo da assinatura, consulte Mecanismo de assinatura.
SignatureMethod	String	Sim	Método de assinatura. Apenas HMAC-SHA1 é compatível.
Timestamp	String	Sim	Carimbo de data/hora da solicitação. Deve seguir o padrão ISO 8601 e estar em UTC. Formato: `YYYY-MM-DDThh:mm:ssZ`. Por exemplo, `2015-11-23T04:00:00Z` corresponde às 12:00:00 de 23 de novembro de 2015 (UTC+8).
SignatureVersion	String	Sim	Versão do algoritmo de assinatura. Versão atual: 1.0.
SignatureNonce	String	Sim	Número aleatório exclusivo para evitar ataques de replay. Cada solicitação exige um número único. Use um UUID (Universally Unique Identifier) ou uma string personalizada.
RegionId	String	Não	Informações da região. Para valores específicos, consulte o campo RegionId em Endpoints de API.

Exemplo

https://dm.aliyuncs.com/
?Format=xml
&Version=2015-11-23
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e1b44502-6d13-4433-9493-69eeb068e955
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2015-11-23T12:00:00Z

Parâmetros comuns de resposta

O sistema retorna um identificador exclusivo (RequestId) para cada solicitação de API, independentemente do sucesso da chamada.

Parâmetro	Tipo	Descrição
RequestId	String	Identificador exclusivo que a Alibaba Cloud gera para a solicitação.

Exemplos

Exemplo em XML

<?xml version="1.0" encoding="UTF-8"?> 
<!-- The root node of the result -->
<APINameResponse>
    <!-- The request tag -->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!-- The response data -->
</APINameResponse>

Exemplo em json

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* Response data */
}