Resposta

Código de status

Depois de enviar uma solicitação, você pode receber uma resposta, incluindo um código de status, cabeçalho de resposta e corpo de resposta.

Um código de status é um grupo de dígitos, variando de 1xx a 5xx. Indica o status de uma resposta. Para obter mais informações, consulte Códigos de status.

Por exemplo, se o código de status 201 for retornado após você chamar a API para obter um token de usuário, a solicitação será bem-sucedida.

Cabeçalho de resposta

Semelhante a uma solicitação, uma resposta também tem um cabeçalho, por exemplo, Content-Type.

Figura 1 mostra os campos de cabeçalho de resposta da API usada para obter um token de usuário. O campo x-subject-token carrega um token de usuário. Você pode usar esse token para autenticar a chamada de outras API.

Figura 1 Cabeçalho de resposta para a API usada para obter um token de usuário

Corpo da resposta

Esta parte é opcional. Um corpo de resposta geralmente é enviado em um formato estruturado (por exemplo, JSON ou XML), que é especificado por Content-Type no cabeçalho da resposta. Ele é usado para transferir conteúdo diferente do cabeçalho da resposta.

A seguir é uma parte do corpo de resposta para a API usada para obter um token de usuário.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
    "token": {
        "expires_at": "2022-09-10T06:52:13.855000Z",
        "methods": [
            "password"
        ],
        "catalog": [
            {
                "endpoints": [
                    {
                        "region_id": "cn-north-04",
......

Se ocorrer um erro durante a chamada da API, um código de erro e uma mensagem de erro serão exibidos. O seguinte é um exemplo de um corpo de resposta de erro.

1
2
3
4

{
    "error_msg": "The format of message is error",
    "error_code": "AS.0001"
}

error_code especifica um código de erro e error_msg descreve o erro.