:Resultados retornados

Após a chamada do serviço de API, os dados retornados seguem um formato unificado.

O código de status HTTP 2xx indica que a chamada foi bem-sucedida.

Os códigos de status HTTP 4xx ou 5xx indicam falha na chamada.

Os formatos dos dados retornados em chamadas bem-sucedidas são principalmente XML e JSON. Um sistema externo pode passar parâmetros durante a solicitação para especificar o formato dos dados de retorno. O XML é o formato padrão.

Os formatos apresentados nos exemplos deste documento foram ajustados para facilitar a visualização. Os resultados reais retornados não contêm quebras de linha, recuos ou outras formatações.

Resultados bem-sucedidos

Exemplo em 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>

Exemplo em JSON

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

Resultados de erro

Quando ocorre um erro na chamada de uma interface, nenhum dado de resultado é retornado. É possível identificar as causas do erro com base nos códigos de erro correspondentes a cada interface e nos códigos de erro públicos listados na Tabela de códigos de erro.

Em caso de erro durante uma chamada, o sistema retorna um código de status HTTP 4xx ou 5xx. O corpo da mensagem retornada contém o código de erro específico e a mensagem de erro. Esse corpo também inclui um RequestId globalmente único e o HostId solicitado. Caso não consiga identificar a causa do erro, entre em contato com o suporte ao cliente da Alibaba Cloud e forneça o HostId e o RequestId para que possamos resolver o problema o mais rápido possível.

Exemplo em XML

<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>dm.aliyuncs.com</HostId>
   <Code>InvalidTemplate.NotFound</Code>
   <Message>The specified template is not found.</Message>
</Error>

Exemplo em JSON

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "HostId": "dm.aliyuncs.com",
    "Code": "InvalidTemplate.NotFound",
    "Message": "The specified template does not found."
}