Help Center/ Server Migration Service/ API Reference(ME-Abu Dhabi Region)/ Calling APIs/ Response
Updated on 2025-02-13 GMT+08:00
View PDF
Share

Response

Status Code

After sending a request, you will receive a response, including a status code, response header, and response body.

A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.

For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

The following shows part of the response body for the API to obtain a user token. In the response header, x-subject-token is the desired user token. You can use the token to authenticate other API calls.
Figure 1 Header fields of the response to the request for creating an IAM user
Figure 2 Header fields of the response to the request for obtaining a user token

(Optional) Response Body

The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.

The following shows part of the response body for the API to obtain a user token. For the sake of space, only part of the content is displayed here.

{ 
    "user": { 
        "id": "c131886aec...", 
        "name": "IAMUser", 
        "description": "IAM User Description", 
        "areacode": "", 
        "phone": "", 
        "email": "***@***.com", 
        "status": null, 
        "enabled": true, 
        "pwd_status": false, 
        "access_mode": "default", 
        "is_domain_owner": false, 
        "xuser_id": "", 
        "xuser_type": "", 
        "password_expires_at": null, 
        "create_time": "2024-05-21T09:03:41.000000", 
        "domain_id": "d78cbac1..........", 
        "xdomain_id": "30086000........", 
        "xdomain_type": "", 
        "default_project_id": null 
    } 
}

If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.

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

In the response body, error_code is an error code, and error_msg provides information about the error.

Parent topic: Calling APIs