Updated on 2024-11-27 GMT+08:00

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.

If status code 201 is returned for the calling of 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

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.

For the API for creating an IAM user, the following message body is returned. The following describes part of the response 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 a message will be displayed. The following shows an error response body.

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

In the response body, errorCode is an error code, and errorMessage provides information about the error.