Updated on 2024-01-31 GMT+08:00

Obtaining the Account Change History

Function

This API is used to obtain the account change history.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

User ID

Minimum: 1

Maximum: 256

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Username

Minimum: 1

Maximum: 128

host_id

No

String

Server ID

Minimum: 1

Maximum: 128

root_permission

No

Boolean

Whether the user has root permissions

host_name

No

String

Server name

Minimum: 1

Maximum: 128

private_ip

No

String

Server private IP address

Minimum: 1

Maximum: 128

change_type

No

String

Change type. Its value can be:

  • ADD

  • DELETE

  • MODIFY

Minimum: 1

Maximum: 128

limit

No

Integer

Default value: 10

Minimum: 10

Maximum: 100

Default: 10

offset

No

Integer

Default value: 0

Minimum: 0

Maximum: 10000

Default: 0

enterprise_project_id

No

String

Enterprise project

Minimum: 1

Maximum: 256

start_time

No

Long

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

Minimum: 0

Maximum: 4070880000000

end_time

No

Long

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

Minimum: 0

Maximum: 4070880000000

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

iam token

Minimum: 32

Maximum: 4096

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number

Minimum: 0

Maximum: 10000000

data_list

Array of UserChangeHistoryResponseInfo objects

Account change history

Array Length: 0 - 200

Table 5 UserChangeHistoryResponseInfo

Parameter

Type

Description

agent_id

String

Agent ID

Minimum: 1

Maximum: 128

change_type

String

Change type. Its value can be:

  • ADD

  • DELETE

  • MODIFY

Minimum: 1

Maximum: 128

host_id

String

Server ID

Minimum: 1

Maximum: 128

host_name

String

Server name

Minimum: 1

Maximum: 128

private_ip

String

Server private IP address

Minimum: 1

Maximum: 128

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

Minimum: 1

Maximum: 128

user_home_dir

String

User home directory

Minimum: 1

Maximum: 128

shell

String

User startup shell

Minimum: 1

Maximum: 128

user_name

String

Account name

Minimum: 1

Maximum: 128

expire_time

Long

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

Minimum: 0

Maximum: 4070880000000

recent_scan_time

Long

Change time

Minimum: 0

Maximum: 4070880000000

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" : "test"
  } ]
}

Status Codes

Status Code

Description

200

account change history

Error Codes

See Error Codes.