Updated on 2024-10-10 GMT+08:00

Response

Status Code

After sending a request, you will receive a response that includes 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 details, see Status Codes.

If status code 201 is returned for the API for creating an IAM user, the request is successful.

Response Header

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

For the API for creating an IAM user, the message header shown in Figure 1 is returned.

Figure 1 Response header

Response Body

A response body is often returned in structured format. It corresponds to content-type header field and passes content except the response header.

For the API for creating an IAM user, the message header shown in the following is returned. The following describes part of the request body.

{ 
    "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 the corresponding error message will be displayed. The following shows an error response body:

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

In the preceding information, error_code is an error code, and error_msg describes the error.