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.
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/user/statistics
| 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| 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. |
| user_name | No | String | Definition Account name, which is used to filter the statistics of a specified account (fuzzy match is supported). Constraints It must comply with the Windows file naming rule and cannot contain full-width punctuations. Range The value can contain 1 to 64 characters. Default Value N/A |
| category | Yes | String | Definition Asset Type Constraints N/A Range Default Value host |
Request 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
| Parameter | Type | Description |
|---|---|---|
| total_num | Integer | Definition Total accounts Range The value range is 0 to 10,000,000. |
| data_list | Array of UserStatisticInfoResponseInfo objects | Definition List of historical account change statistics. Range Minimum value: 0; maximum value: 10,000 |
| Parameter | Type | Description |
|---|---|---|
| user_name | String | Definition Account name in the asset, which uniquely identifies an account. Range The value contains 1 to 64 characters. It must comply with the Windows file naming rules. The value can contain letters, numbers, underscores (_), and the following special characters: !@.- |
| num | Integer | Definition Number of assets (servers or containers) associated with the current account. Range Non-negative integer. The minimum value is 0. |
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
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot