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
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 |
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 Server ID. 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
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
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
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. |
Parameter |
Type |
Description |
---|---|---|
agent_id |
String |
Definition Agent ID. Range Length: 1 to 128 characters |
change_type |
String |
Definition Change type. Range
|
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" } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListUserChangeHistoriesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListUserChangeHistoriesRequest request = new ListUserChangeHistoriesRequest(); try { ListUserChangeHistoriesResponse response = client.listUserChangeHistories(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListUserChangeHistoriesRequest() response = client.list_user_change_histories(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListUserChangeHistoriesRequest{} response, err := client.ListUserChangeHistories(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot