Updated on 2025-09-24 GMT+08:00

Querying the Account List

Function

This API is used to query the account list. The number of servers can be queried based on the account name parameter.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Account name. It must comply with the Windows file naming rules. The value can contain letters, digits, underscores (_), and the following special characters: !@.-. Chinese punctuations are not allowed.

enterprise_project_id

No

String

Enterprise project

limit

No

Integer

Default value: 10

offset

No

Integer

Default value: 0

category

No

String

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

  • host

  • container

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

iam token

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of accounts

data_list

Array of UserStatisticInfoResponseInfo objects

Account statistics list

Table 5 UserStatisticInfoResponseInfo

Parameter

Type

Description

user_name

String

Account name

num

Integer

Number of accounts

Example Requests

The first 10 accounts are queried by default.

GET https://{endpoint}/v5/{project_id}/asset/user/statistics

Example Responses

Status code: 200

Number of servers having the account

{
  "total_num" : 1,
  "data_list" : [ {
    "user_name" : "bin",
    "num" : 5
  } ]
}

Status Codes

Status Code

Description

200

Number of servers having the account

Error Codes

See Error Codes.