Obtaining the Historical Change Records of Auto-started Items
Function
This API is used to obtain the historical change records of auto-startup items.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/asset/auto-launch/change-history
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_id |
No |
String |
Server ID Minimum: 0 Maximum: 128 |
host_ip |
No |
String |
Server IP address Minimum: 0 Maximum: 128 |
host_name |
No |
String |
Server name Minimum: 0 Maximum: 128 |
auto_launch_name |
No |
String |
Auto-started item name Minimum: 0 Maximum: 128 |
type |
No |
Integer |
Auto-started item type.
Minimum: 0 Maximum: 100 |
variation_type |
No |
String |
Change type. Its value can be:
Minimum: 0 Maximum: 10 |
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Minimum: 0 Maximum: 256 |
sort_key |
No |
String |
Key value used for sorting. Currently, data can only be sorted by recent_scan_time, and the value of sort_dir determines whether to sort the data in ascending or descending order. Minimum: 0 Maximum: 128 |
sort_dir |
No |
String |
Sorting order. The default order is descending. If sort_key is set to recent_scan_time, this parameter determines the sorting order. If sort_key is set to other values, data is sort in descending order.
Minimum: 0 Maximum: 32 |
limit |
No |
Integer |
Number of records on each page Minimum: 10 Maximum: 200 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 2000000 Default: 0 |
start_time |
No |
Long |
Start time of a change. Its value is a 13-digit timestamp. Minimum: 0 Maximum: 9007199254740992 |
end_time |
No |
Long |
End time of a change. Its value is a 13-digit timestamp. Minimum: 0 Maximum: 9007199254740992 |
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 user token. Minimum: 32 Maximum: 4096 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Number of changes of auto-started items Minimum: 0 Maximum: 10000 |
data_list |
Array of AutoLaunchChangeResponseInfo objects |
Account change history Array Length: 0 - 10000 |
Parameter |
Type |
Description |
---|---|---|
agent_id |
String |
Agent ID Minimum: 0 Maximum: 128 |
variation_type |
String |
Type of change.
Minimum: 0 Maximum: 10 |
type |
Integer |
Auto-started item type
Minimum: 0 Maximum: 11 |
host_id |
String |
host_id Minimum: 1 Maximum: 128 |
host_name |
String |
ECS name Minimum: 1 Maximum: 256 |
host_ip |
String |
Server IP address Minimum: 1 Maximum: 256 |
path |
String |
Path of the auto-startup item Minimum: 1 Maximum: 256 |
hash |
String |
Hash value of the file generated using the SHA256 algorithm Minimum: 1 Maximum: 128 |
run_user |
String |
User who starts the execution Minimum: 1 Maximum: 64 |
name |
String |
Auto-started item name Minimum: 1 Maximum: 256 |
recent_scan_time |
Long |
Last update time. The value is a 13-bit timestamp. Minimum: 0 Maximum: 4824430336000 |
Example Requests
The first 10 auto-startup item change records whose start time is 1693101881568 and end time is 1701050681569 are queried by default.
GET https://{endpoint}/v5/{project_id}/asset/auto-launch/change-history?start_time=1693101881568&end_time=1701050681569
Example Responses
Status code: 200
App change history info list
{ "total_num" : 1, "data_list" : [ { "agent_id" : "d83c7be8a106485a558f97446617443b87604c8116e3cf0453c2a44exxxxxxxx", "variation_type" : "add", "type" : 0, "host_id" : "host_id", "host_name" : "host_name", "host_ip" : "host_ip", "path" : "/path", "hash" : "xxxxxxxx227bffa0c04425ba6c8e0024046caa38dfbca6281b40109axxxxxxxx", "run_user" : "SYSTEM", "name" : "S12hostguard", "recent_scan_time" : 1668246126302 } ] }
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 48 49 50 51 52 53 54 55 56 57 58 |
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 ListAutoLaunchChangeHistoriesSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListAutoLaunchChangeHistoriesRequest request = new ListAutoLaunchChangeHistoriesRequest(); request.withHostId("<host_id>"); request.withHostIp("<host_ip>"); request.withHostName("<host_name>"); request.withAutoLaunchName("<auto_launch_name>"); request.withType(<type>); request.withVariationType("<variation_type>"); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withSortKey("<sort_key>"); request.withSortDir("<sort_dir>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withStartTime(<start_time>L); request.withEndTime(<end_time>L); try { ListAutoLaunchChangeHistoriesResponse response = client.listAutoLaunchChangeHistories(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 32 33 34 35 36 37 38 39 40 41 42 43 |
# 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"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAutoLaunchChangeHistoriesRequest() request.host_id = "<host_id>" request.host_ip = "<host_ip>" request.host_name = "<host_name>" request.auto_launch_name = "<auto_launch_name>" request.type = <type> request.variation_type = "<variation_type>" request.enterprise_project_id = "<enterprise_project_id>" request.sort_key = "<sort_key>" request.sort_dir = "<sort_dir>" request.limit = <limit> request.offset = <offset> request.start_time = <start_time> request.end_time = <end_time> response = client.list_auto_launch_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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAutoLaunchChangeHistoriesRequest{} hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest hostIpRequest:= "<host_ip>" request.HostIp = &hostIpRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest autoLaunchNameRequest:= "<auto_launch_name>" request.AutoLaunchName = &autoLaunchNameRequest typeRequest:= int32(<type>) request.Type = &typeRequest variationTypeRequest:= "<variation_type>" request.VariationType = &variationTypeRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest sortDirRequest:= "<sort_dir>" request.SortDir = &sortDirRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest startTimeRequest:= int64(<start_time>) request.StartTime = &startTimeRequest endTimeRequest:= int64(<end_time>) request.EndTime = &endTimeRequest response, err := client.ListAutoLaunchChangeHistories(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 |
App change history info list |
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