Updated on 2024-12-03 GMT+08:00

Response

Status Code

After sending a request, you can 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 response. For more information, see Status Codes.

If status code 201 is returned after the API used to create an IAM user as an administrator is called, the request is successful.

Response Header

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

The response header shown in Figure 1 is returned for the API used to create an IAM user as an administrator.

Figure 1 Response header for the API used to create an IAM user as an administrator

Response Body

The response body is optional. A response body is generally returned in a structured format (for example, JSON or XML), which is specified by Content-Type in the response header. It is used to transfer content other than the response header.

The following provides part of the response body returned 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 an error message will be displayed. The following is an example of an error response body.

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

error_code specifies an error code, and error_msg describes the error.