Collecting Asset Statistics, Including Accounts, Ports, and Processes
Function
This API is used to collect statistics on assets, such as accounts, ports, and processes.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/asset/statistics
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Minimum: 0 Maximum: 128 |
host_id |
No |
String |
Host ID Minimum: 1 Maximum: 128 |
category |
No |
String |
Type. The default value is host. The options are as follows:
Minimum: 1 Maximum: 64 |
Request 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. Minimum: 32 Maximum: 4096 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
account_num |
Long |
Number of server accounts Minimum: 0 Maximum: 2147483647 |
port_num |
Long |
Number of open ports Minimum: 0 Maximum: 2147483647 |
process_num |
Long |
Number of processes Minimum: 0 Maximum: 2147483647 |
app_num |
Long |
Pieces of software Minimum: 0 Maximum: 2147483647 |
auto_launch_num |
Long |
Number of auto-startup processes Minimum: 0 Maximum: 2147483647 |
web_framework_num |
Long |
Number of web frameworks Minimum: 0 Maximum: 2147483647 |
web_site_num |
Long |
Number of websites Minimum: 0 Maximum: 2147483647 |
jar_package_num |
Long |
Number of JAR packages Minimum: 0 Maximum: 2147483647 |
kernel_module_num |
Long |
Number of kernel modules Minimum: 0 Maximum: 2147483647 |
web_service_num |
Long |
Number of web services Minimum: 0 Maximum: 2147483647 |
web_app_num |
Long |
Number of web applications Minimum: 0 Maximum: 2147483647 |
database_num |
Long |
Number of databases Minimum: 0 Maximum: 2147483647 |
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
Asset statistic info
{ "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 }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ShowAssetStatisticSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ShowAssetStatisticRequest request = new ShowAssetStatisticRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withHostId("<host_id>"); request.withCategory("<category>"); try { ShowAssetStatisticResponse response = client.showAssetStatistic(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowAssetStatisticRequest() request.enterprise_project_id = "<enterprise_project_id>" request.host_id = "<host_id>" request.category = "<category>" response = client.show_asset_statistic(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowAssetStatisticRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest categoryRequest:= "<category>" request.Category = &categoryRequest response, err := client.ShowAssetStatistic(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Asset statistic info |
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