Updated on 2024-01-31 GMT+08:00

Querying the Process List

Function

This API is used to query the process list and query the number of servers based on the process path parameter.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/asset/process/statistics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Minimum: 1

Maximum: 256

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

path

No

String

Path

Minimum: 1

Maximum: 256

enterprise_project_id

No

String

Enterprise project

Minimum: 1

Maximum: 256

limit

No

Integer

Default value: 10

Minimum: 10

Maximum: 100

Default: 10

offset

No

Integer

Default value: 0

Minimum: 0

Maximum: 10000

Default: 0

category

No

String

Type. The default value is host. The options are as follows:

  • host

  • container

Minimum: 0

Maximum: 64

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

iam token

Minimum: 32

Maximum: 4096

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of process statistics

Minimum: 0

Maximum: 10000

data_list

Array of ProcessStatisticResponseInfo objects

Process statistics list

Array Length: 0 - 10000

Table 5 ProcessStatisticResponseInfo

Parameter

Type

Description

path

String

Process name

Minimum: 1

Maximum: 256

num

Integer

Number of processes

Minimum: 0

Maximum: 100000

Example Requests

The first 10 accounts are queried by default.

GET https://{endpoint}/v5/{project_id}/asset/process/statistics?category=host

Example Responses

Status code: 200

Number of servers having the process

{
  "total_num" : 1,
  "data_list" : [ {
    "num" : 13,
    "path" : "/usr/lib/systemd/systemd-journald"
  } ]
}

Status Codes

Status Code

Description

200

Number of servers having the process

Error Codes

See Error Codes.