Os parâmetros comuns são obrigatórios em todas as solicitações da API do Database Gateway. Eles incluem parâmetros comuns de solicitação e parâmetros comuns de resposta.
Parâmetros comuns de solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|
Format |
String |
Não |
Formato de retorno da resposta. Os dados retornados estão no formato JSON. |
|
Version |
String |
Sim |
Número da versão da API, no formato AAAA-MM-DD. A versão atual é 2019-03-27. |
|
AccessKeyId |
String |
Sim |
AccessKey ID fornecido a você pela Alibaba Cloud. |
|
Signature |
String |
Sim |
String de assinatura da solicitação atual. Para obter informações sobre como calcular a assinatura de uma solicitação, consulte Assinatura. |
|
Timestamp |
String |
Sim |
Carimbo de data/hora da solicitação. Especifique o horário no padrão ISO 8601, no formato aaaa-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Por exemplo, o valor 2013-08-15T12:00:00Z indica 20:00:00 em 15 de agosto de 2013, UTC+8. |
|
SignatureVersion |
String |
Sim |
Versão do algoritmo de criptografia de assinatura. Defina o valor como 1.0. |
|
SignatureNonce |
String |
Sim |
Número aleatório exclusivo usado para evitar ataques de replay. Utilize um número aleatório diferente para cada solicitação. |
Parâmetros comuns de resposta
Todas as respostas retornam um ID de solicitação exclusivo, independentemente do sucesso ou falha da chamada.
Exemplos de solicitações
https://dg.aliyuncs.com/
?Format=xml
&Version=2019-06-18
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z
Exemplos de respostas
As respostas da API utilizam o formato de resposta HTTP, em que um código de status 2xx indica uma chamada bem-sucedida, enquanto códigos 4xx ou 5xx indicam falha. Em chamadas bem-sucedidas, os dados retornados estão no formato JSON. Para sistemas externos, configure um parâmetro para definir o formato dos dados retornados ao configurar os parâmetros da solicitação. Para facilitar a leitura, os exemplos de respostas abaixo estão formatados. As respostas reais não incluem quebras de linha nem recuos.
Formato XML
<?xml version="1.0" encoding="utf-8"?>
<!--Result root node-->
<Operation name + Response>
<!--Return request tag-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--Return result data-->
</Operation name + Response>
Formato JSON
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* Return Result Data */
}