Querying the Number of Assets

Function

This API is used to collect statistics on assets, such as accounts, ports, and processes.

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/statistics

**Table 1** Path Parameters
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

**Table 2** Query Parameters
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.
host_id	No	String	Definition Unique ID of a server. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
category	Yes	String	Definition Asset Type Constraints N/A Range host: server asset container: container asset Default Value host

Request Parameters

**Table 3** Request header 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

**Table 4** Response body parameters
Parameter	Type	Description
account_num	Long	Definition Total number of server accounts on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
port_num	Long	Definition Total number of open ports on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
process_num	Long	Definition Total number of processes on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
app_num	Long	Definition Total number of software installed on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
auto_launch_num	Long	Definition Total number of auto-started processes on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
web_framework_num	Long	Definition Total number of web frameworks deployed on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
web_site_num	Long	Definition Total number of websites deployed on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
jar_package_num	Long	Definition Total number of JAR packages on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
kernel_module_num	Long	Definition Total number of kernel modules loaded to the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
web_service_num	Long	Definition Total number of web services deployed on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
web_app_num	Long	Definition Total number of web applications deployed on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.
database_num	Long	Definition Total number of databases deployed on the assets (servers or containers) that meet the query criteria. Range The value range is 0 to 2,147,483,647.

Example Requests

This API is used to query the fingerprint information, accounts, ports, and processes of a server.

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

Example Responses

Status code: 200

Request succeeded.

{
  "account_num" : 5,
  "port_num" : 5,
  "process_num" : 5,
  "app_num" : 5,
  "auto_launch_num" : 5,
  "web_framework_num" : 5,
  "web_site_num" : 5,
  "jar_package_num" : 5,
  "kernel_module_num" : 5,
  "database_num" : 1,
  "web_app_num" : 8,
  "web_service_num" : 2
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Asset Management

Previous topic: Querying Website Statistics

Next topic: Obtaining the Account Change History

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot