Obtaining the Account Change History
Function
This API is used to obtain the account change history.
URI
GET /v5/{project_id}/asset/user/change-history
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user_name |
No |
String |
Username |
host_id |
No |
String |
Server ID |
root_permission |
No |
Boolean |
Whether the user has root permissions |
host_name |
No |
String |
Server name |
private_ip |
No |
String |
Server private IP address |
change_type |
No |
String |
Account change type. The options are as follows:
|
limit |
No |
Integer |
Number of records displayed on each page. The default value is 10. |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. |
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. |
start_time |
No |
Long |
Start time of a change. Its value is a 13-digit timestamp. |
end_time |
No |
Long |
End time of a change. Its value is a 13-digit timestamp. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number of changed accounts |
data_list |
Array of UserChangeHistoryResponseInfo objects |
Account change history |
Parameter |
Type |
Description |
---|---|---|
agent_id |
String |
Agent ID |
change_type |
String |
Change type. Its value can be:
|
host_id |
String |
Host ID |
host_name |
String |
Server name |
private_ip |
String |
Server private IP address |
login_permission |
Boolean |
Whether the user has the login permission |
root_permission |
Boolean |
Whether the user has root permissions |
user_group_name |
String |
User group name |
user_home_dir |
String |
User home directory |
shell |
String |
User startup shell |
user_name |
String |
Account name |
expire_time |
Long |
Expiration time, which is a timestamp. The default unit is millisecond. |
recent_scan_time |
Long |
Time when an account is added, modified, or deleted. |
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
account change history
{ "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 |
account change history |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.