Asset Fingerprints - Port - Server List
Function
Servers or containers having the port
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/asset/ports/detail
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: 1 Maximum: 256 |
host_name |
No |
String |
Server name Minimum: 1 Maximum: 256 |
host_ip |
No |
String |
Server IP address Minimum: 1 Maximum: 256 |
port |
Yes |
Integer |
Port number Minimum: 1 Maximum: 65535 |
type |
No |
String |
Port type: TCP or UDP. Minimum: 1 Maximum: 256 |
category |
No |
String |
Type. The default value is host. The options are as follows:
Minimum: 0 Maximum: 64 |
limit |
No |
Integer |
Number of records on each page Minimum: 10 Maximum: 100 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 10000 Default: 0 |
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 |
Total servers Minimum: 0 Maximum: 10000 |
data_list |
Array of PortHostResponseInfo objects |
Server information list Array Length: 0 - 10000 |
Parameter |
Type |
Description |
---|---|---|
container_id |
String |
Image ID Minimum: 1 Maximum: 256 |
host_id |
String |
Server ID Minimum: 1 Maximum: 256 |
host_ip |
String |
Server IP address Minimum: 1 Maximum: 256 |
host_name |
String |
Server name Minimum: 1 Maximum: 256 |
laddr |
String |
Listening IP address Minimum: 1 Maximum: 256 |
path |
String |
Path of the process execution file. Minimum: 1 Maximum: 256 |
pid |
Integer |
pid Minimum: 0 Maximum: 100000 |
port |
Integer |
Port Minimum: 0 Maximum: 65535 |
status |
String |
Status Minimum: 1 Maximum: 256 |
type |
String |
Port type: TCP or UDP. Minimum: 1 Maximum: 256 |
container_name |
String |
Container name Minimum: 1 Maximum: 256 |
agent_id |
String |
Agent ID Minimum: 1 Maximum: 128 |
Example Requests
The first 10 servers whose port number is 22 are queried by default.
GET https://{endpoint}/v5/{project_id}/asset/ports/detail?port=22
Example Responses
Status code: 200
Servers having the port
{ "total_num" : 1, "data_list" : [ { "host_id" : "03117200-xxxx-xxxx-xxxx-a89a10e66dbe", "host_ip" : "192.168.0.1", "host_name" : "ecs-eule", "laddr" : "0.0.0.0", "path" : "C:\\Windows\\system32\\svchost.exe", "port" : 888, "status" : "unknow", "type" : "UDP", "container_id" : "ce794b8a6-xxxx-xxxx-xxxxx-36bedf2c7a4f6083fb82e5bbc82709b50018", "container_name" : "hss_imagescan_W73V1WO6", "agent_id" : "03jjj-xxxx-xxxx-wwwsedf" } ] }
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 |
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 ListPortHostSolution { 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(); ListPortHostRequest request = new ListPortHostRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withHostName("<host_name>"); request.withHostIp("<host_ip>"); request.withPort(<port>); request.withType("<type>"); request.withCategory("<category>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListPortHostResponse response = client.listPortHost(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 |
# 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 = ListPortHostRequest() request.enterprise_project_id = "<enterprise_project_id>" request.host_name = "<host_name>" request.host_ip = "<host_ip>" request.port = <port> request.type = "<type>" request.category = "<category>" request.limit = <limit> request.offset = <offset> response = client.list_port_host(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 |
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.ListPortHostRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest hostIpRequest:= "<host_ip>" request.HostIp = &hostIpRequest request.Port = int32(<port>) typeRequest:= "<type>" request.Type = &typeRequest categoryRequest:= "<category>" request.Category = &categoryRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListPortHost(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 |
Servers having the port |
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