Querying the Service List of Auto-Started Items
Function
This API is used to query the service list of auto-started items.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/asset/auto-launchs
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: 1 Maximum: 128 |
host_name |
No |
String |
Server name Minimum: 1 Maximum: 128 |
name |
No |
String |
Auto-started item name Minimum: 1 Maximum: 256 |
host_ip |
No |
String |
Server IP address Minimum: 1 Maximum: 128 |
type |
No |
String |
Auto-started item type
Minimum: 1 Maximum: 128 |
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Minimum: 1 Maximum: 256 |
limit |
No |
Integer |
Number of records on each page Minimum: 10 Maximum: 100 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 10000 Default: 0 |
part_match |
No |
Boolean |
Whether fuzzy match is used. The default value is false. |
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 |
Total number of auto-startup items Minimum: 0 Maximum: 10000 |
data_list |
Array of AutoLauchResponseInfo objects |
Auto-started item list Array Length: 0 - 10000 |
Parameter |
Type |
Description |
---|---|---|
agent_id |
String |
Agent ID Minimum: 0 Maximum: 128 |
host_id |
String |
Server ID Minimum: 1 Maximum: 128 |
host_name |
String |
Server name Minimum: 1 Maximum: 256 |
host_ip |
String |
Server IP address Minimum: 1 Maximum: 256 |
name |
String |
Auto-started item name Minimum: 1 Maximum: 256 |
type |
Integer |
Auto-started item type
Minimum: 0 Maximum: 11 |
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: 128 |
recent_scan_time |
Long |
Latest scan time Minimum: 0 Maximum: 4824430336000 |
Example Requests
The first 10 services whose auto-startup item name is S50multi-queue are queried by default.
GET https://{endpoint}/v5/{project_id}/asset/auto-launchs?name=S50multi-queue
Example Responses
Status code: 200
auto launch list
{ "total_num" : 1, "data_list" : [ { "agent_id" : "9e742932bff2894e3d0869d03989b05cefb27a6cbc201d98c4465296xxxxxxxx", "host_id" : "3d0581a5-03b9-4311-9149-c026b0726a7e", "host_name" : "name", "host_ip" : "3d0581a5-03b9-4311-9149-c026b0726a7e", "name" : "S12hostguard", "type" : 0, "path" : "/etc/hostguard", "hash" : "xxxxxxxx227bffa0c04425ba6c8e0024046caa38dfbca6281b40109axxxxxxxx", "run_user" : "user", "recent_scan_time" : 1668240858425 } ] }
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 |
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 ListAutoLaunchsSolution { 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(); ListAutoLaunchsRequest request = new ListAutoLaunchsRequest(); request.withHostId("<host_id>"); request.withHostName("<host_name>"); request.withName("<name>"); request.withHostIp("<host_ip>"); request.withType("<type>"); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withPartMatch(<part_match>); try { ListAutoLaunchsResponse response = client.listAutoLaunchs(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 |
# 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 = ListAutoLaunchsRequest() request.host_id = "<host_id>" request.host_name = "<host_name>" request.name = "<name>" request.host_ip = "<host_ip>" request.type = "<type>" request.enterprise_project_id = "<enterprise_project_id>" request.limit = <limit> request.offset = <offset> request.part_match = <PartMatch> response = client.list_auto_launchs(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 |
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.ListAutoLaunchsRequest{} hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest nameRequest:= "<name>" request.Name = &nameRequest hostIpRequest:= "<host_ip>" request.HostIp = &hostIpRequest typeRequest:= "<type>" request.Type = &typeRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest partMatchRequest:= <part_match> request.PartMatch = &partMatchRequest response, err := client.ListAutoLaunchs(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 |
auto launch 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