Response

Status Code

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

For example, if status code 201 is returned after calling the API for creating an IAM user as an administrator, the request is successful.

Response Header

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

For example, the response headers shown in Figure 1 are returned after calling the API for creating an IAM user as an administrator.

Figure 1 Response headers

Response Body

A response body is often returned in a structured format defined by the response header field Content-Type and transfers information except the response header.

For example, the following is part of the response body for the API used to create an IAM user as an administrator:

{ 
    "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 returned. An error response body is shown as follows:

{ 
    "error_msg": "Request body is invalid.", 
    "error_code": "IAM.0011" 
}

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