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

Querying the Software List

Function

This API is used to query the software list. The number of servers can be queried by software name.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

User ID

Minimum: 1

Maximum: 256

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

app_name

No

String

Software name

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

Offset, which is the number of pages multiplied by the number of records displayed on each page.

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 AppStatisticResponseInfo objects

Process statistics list

Array Length: 0 - 10000

Table 5 AppStatisticResponseInfo

Parameter

Type

Description

app_name

String

Software name

Minimum: 1

Maximum: 128

num

Integer

Number of processes

Minimum: 0

Maximum: 100000

Example Requests

The first 10 software lists whose type is host are queried by default.

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

Example Responses

Status code: 200

Number of servers having the software

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "kernel",
    "num" : 13
  } ]
}

Status Codes

Status Code

Description

200

Number of servers having the software

Error Codes

See Error Codes.