Help Center/ Host Security Service/ API Reference/ API Description/ Asset Management/ Obtaining the Account Change History
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Obtaining the Account Change History

Function

This API is used to obtain the account change history.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/asset/user/change-history

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

host_name

No

String

Definition

Server name.

Constraints

N/A

Range

The value contains 1 to 256 characters.

Default Value

N/A

host_id

No

String

Definition

Unique ID of a server.

Constraints

N/A

Range

The value can contain 1 to 64 characters.

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

user_name

No

String

Definition

Username.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

root_permission

No

Boolean

Definition

Whether a user has root permissions.

Constraints

N/A

Range

true: The user has root permissions.

false: The user does not have root permissions.

Default Value

N/A

private_ip

No

String

Definition

Server private IP address.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

change_type

No

String

Definition

Account change type.

Constraints

N/A

Range

  • ADD

  • DELETE

  • MODIFY

Default Value

N/A

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 10,000.

Default Value

N/A

start_time

No

Long

Definition

Start time of a change. Its value is a 13-digit timestamp.

Constraints

N/A

Range

The value range is 0 to 4,070,880,000,000.

Default Value

N/A

end_time

No

Long

Definition

End time of a change. Its value is a 13-digit timestamp.

Constraints

N/A

Range

The value range is 0 to 4,070,880,000,000.

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number of changed accounts.

Range

The value range is 0 to 10,000,000.

data_list

Array of UserChangeHistoryResponseInfo objects

Definition

List of historical account changes.

Range

The value range is 0 to 200.
Table 5 UserChangeHistoryResponseInfo

Parameter

Type

Description

agent_id

String

Definition

Agent ID.

Range

Length: 1 to 128 characters

change_type

String

Definition

Change Type

Range

  • ADD

  • DELETE

  • MODIFY

host_id

String

Definition

Server ID.

Range

Length: 1 to 128 characters

host_name

String

Definition

Server name.

Range

Length: 1 to 128 characters

private_ip

String

Definition

Server private IP address.

Range

Length: 1 to 128 characters

login_permission

Boolean

Definition

Whether the user has the login permission.

Range

true: The user has the login permission.

false: The user does not have the login permission.

root_permission

Boolean

Definition

Whether a user has root permissions.

Range

true: The user has root permissions.

false: The user does not have root permissions.

user_group_name

String

Definition

User group name.

Range

Length: 1 to 128 characters

user_home_dir

String

Definition

User directory.

Range

Length: 1 to 128 characters

shell

String

Definition

User startup shell

Range

Length: 1 to 128 characters

user_name

String

Definition

Username.

Range

Length: 1 to 128 characters

expire_time

Long

Definition

Expiration time, which is a timestamp. The default unit is millisecond.

Range

Length: 0 to 4,070,880,000,000

recent_scan_time

Long

Definition

Time when an account was added, modified, or deleted.

Range

Length: 0 to 4,070,880,000,000

Example Requests

The first 10 account change records whose start time is 1700446129130 and end time is 1701050929130 are queried by default.

GET https://{endpoint}/v5/{project_id}/asset/user/change-history?start_time=1700446129130&end_time=1701050929130

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "agent_id" : "0bf792d910xxxxxxxxxxx52cb7e63exxx",
    "host_id" : "13xxxxxxxece69",
    "private_ip" : "192.168.0.1",
    "host_name" : "test",
    "user_home_dir" : "/test",
    "login_permission" : false,
    "recent_scan_time" : 1667039707730,
    "expire_time" : 1667039707730,
    "root_permission" : false,
    "shell" : "/sbin/nologin",
    "user_group_name" : "bin",
    "user_name" : "bin",
    "change_type" : "ADD"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Asset Management