Querying the Service List of Auto-Started Items

Function

This API is used to query the service list of auto-started items.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/asset/auto-launchs

**Table 1** Path Parameters
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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
host_id	No	String	Definition Unique ID of a server. Constraints N/A Range The value can contain 1 to 64 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
name	No	String	Definition Auto-started item name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
host_ip	No	String	Definition Server IP address Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
type	No	String	Definition Auto-started item type. Constraints N/A Range 0: auto-started service 1: scheduled task 2: preloaded dynamic library 3: run registry key 4: startup folder 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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range 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.
part_match	No	Boolean	Definition Whether fuzzy match is used. Constraints N/A Range true: Yes false: No Default Value N/A

Request Parameters

**Table 3** Request header 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

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of AutoLauchResponseInfo objects	Definition Auto-started item list. Range N/A

**Table 5** AutoLauchResponseInfo
Parameter	Type	Description
agent_id	String	Definition Agent ID Range The value can contain 1 to 64 characters.
host_id	String	Definition Unique ID of a server (host). 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.
name	String	Definition Auto-started item name. Range The value contains 1 to 256 characters.
type	Integer	Definition Auto-started item type. Range 0: auto-started service 1: scheduled task 2: preloaded dynamic library 3: run registry key 4: startup folder
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 128 characters.
recent_scan_time	Long	Definition Last scan time. Range The value range is 0 to 9,223,372,036,854,775,807.

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

Request succeeded.

{
  "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
  } ]
}