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 |
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 |
---|---|---|---|
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. |
host_id |
No |
String |
Definition Server ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A |
host_ip |
No |
String |
Definition Server IP address. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A |
host_name |
No |
String |
Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A |
auto_launch_name |
No |
String |
Definition Auto-started item name. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
type |
No |
Integer |
Definition Auto-started item type. Constraints N/A Range
Default Value N/A |
variation_type |
No |
String |
Definition Change type. Constraints N/A Range
Default Value N/A |
sort_key |
No |
String |
Definition 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. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
sort_dir |
No |
String |
Definition 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 sorted in descending order. Constraints N/A Range
Default Value N/A |
limit |
No |
Integer |
Parameter description: Number of records displayed on each page. Constraints: N/A Options: Value range: 10-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 2,000,000. Default Value The default value is 0. |
start_time |
No |
Long |
Definition Start time, which is a 13-digit timestamp. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A |
end_time |
No |
Long |
Definition End time, which is a 13-digit timestamp. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. 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. Range The value range is 0 to 2,147,483,647. |
data_list |
Array of AutoLaunchChangeResponseInfo objects |
Definition Software change history. Range N/A |
Parameter |
Type |
Description |
---|---|---|
agent_id |
String |
Definition Agent ID Range The value can contain 1 to 64 characters. |
variation_type |
String |
Definition Change type. Range
|
type |
Integer |
Definition Auto-started item type. Range
|
host_id |
String |
Definition Server ID. Range The value can contain 1 to 64 characters. |
host_name |
String |
Definition Server name. Range The value can contain 1 to 256 characters. |
host_ip |
String |
Definition Server IP address. Range The value can contain 1 to 128 characters. |
path |
String |
Definition Path of an auto-started item. Range The value contains 1 to 256 characters. |
hash |
String |
Definition Hash value of the file generated using the SHA256 algorithm. Range The value can contain 1 to 128 characters. |
run_user |
String |
Definition User who starts the execution. Range The value can contain 1 to 64 characters. |
name |
String |
Definition Auto-started item name. Range The value contains 1 to 256 characters. |
recent_scan_time |
Long |
Definition Last update time. The value is a 13-bit timestamp. Range The value range is 0 to 9,223,372,036,854,775,807. |
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
Request succeeded.
{ "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 |
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"); 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(); ListAutoLaunchChangeHistoriesRequest request = new ListAutoLaunchChangeHistoriesRequest(); 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 |
# 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 = ListAutoLaunchChangeHistoriesRequest() 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 |
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.ListAutoLaunchChangeHistoriesRequest{} 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 |
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