Querying Open Port Statistics
Function
This API is used to query the list of open ports. The number of servers can be queried by port or protocol type.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/asset/port/statistics
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
port |
No |
Integer |
Port number, which is used for exact match. Minimum: 1 Maximum: 65535 |
port_string |
No |
String |
Port string, which is used for fuzzy match. Minimum: 1 Maximum: 256 |
type |
No |
String |
Port type Minimum: 1 Maximum: 256 |
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Minimum: 0 Maximum: 128 |
sort_key |
No |
String |
Sort key. Currently, sorting by port number is supported. Minimum: 1 Maximum: 128 |
sort_dir |
No |
String |
Whether to sort data in ascending or descending order. Default value: asc Minimum: 1 Maximum: 32 |
limit |
No |
Integer |
Number of records on each page Minimum: 10 Maximum: 200 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 2000000 Default: 0 |
category |
No |
String |
Type. The default value is host. The options are as follows:
Minimum: 0 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 |
---|---|---|
total_num |
Integer |
Number of open ports Minimum: 0 Maximum: 10000 |
data_list |
Array of PortStatisticResponseInfo objects |
Open port statistics list Array Length: 0 - 10000 |
Example Requests
The first 10 open ports whose port number is 123 and type is host are queried by default.
GET https://{endpoint}/v5/{project_id}/asset/port/statistics?port=123&category=host
Example Responses
Status code: 200
Return the port information, including the port number, type, quantity, and risk status.
{ "total_num" : 1, "data_list" : [ { "num" : 4, "port" : 123, "type" : "UDP", "status" : "danger" } ] }
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 49 50 51 52 53 54 |
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 ListPortStatisticsSolution { 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(); ListPortStatisticsRequest request = new ListPortStatisticsRequest(); request.withPort(<port>); request.withPortString("<port_string>"); request.withType("<type>"); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withSortKey("<sort_key>"); request.withSortDir("<sort_dir>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withCategory("<category>"); try { ListPortStatisticsResponse response = client.listPortStatistics(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 34 35 36 37 38 39 |
# 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 = ListPortStatisticsRequest() request.port = <port> request.port_string = "<port_string>" request.type = "<type>" request.enterprise_project_id = "<enterprise_project_id>" request.sort_key = "<sort_key>" request.sort_dir = "<sort_dir>" request.limit = <limit> request.offset = <offset> request.category = "<category>" response = client.list_port_statistics(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 42 43 44 45 46 47 48 49 50 51 52 53 |
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.ListPortStatisticsRequest{} portRequest:= int32(<port>) request.Port = &portRequest portStringRequest:= "<port_string>" request.PortString = &portStringRequest typeRequest:= "<type>" request.Type = &typeRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest sortDirRequest:= "<sort_dir>" request.SortDir = &sortDirRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest categoryRequest:= "<category>" request.Category = &categoryRequest response, err := client.ListPortStatistics(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 |
Return the port information, including the port number, type, quantity, and risk status. |
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