nav-img
Advanced

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.

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 ID. To query all enterprise projects, set this parameter to all_granted_eps.

limit

No

Integer

Number of records on each page

offset

No

Integer

Offset, which specifies the start position of the record to be returned.

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

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Container ID

data_list

Instance name of enterprise edition image

Table 5 UserStatisticInfoResponseInfo

Parameter

Type

Description

user_name

String

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

num

Integer

Number of servers of the account

Example Requests

The first 10 accounts are queried by default.

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

Example Responses

Status code: 200

Request succeeded.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes