Querying the List of Servers with a Specified Open Port

Function

This API is used to query the list of servers or container hosts with the port.

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/ports/detail

**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_name	No	String	Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
host_ip	No	String	Definition Server IP address Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
category	Yes	String	Definition Asset Type Constraints N/A Range host: server asset container: container asset Default Value host
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.
port	Yes	Integer	Definition Port number. Constraints N/A Range Minimum value: 1; maximum value: 65535 (standard TCP/UDP port range) Default Value N/A
type	No	String	Definition Port type. Constraints N/A Range TCP and UDP Default Value N/A

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
total_num	Integer	Definition Total servers Range The value range is 0 to 10,000.
data_list	Array of PortHostResponseInfo objects	Definition Server information list Range The value range is 0 to 10,000.

**Table 5** PortHostResponseInfo
Parameter	Type	Description
container_id	String	Definition Container ID. Range The value can contain 1 to 128 characters.
host_id	String	Definition Unique ID of a server (host). Range The value can contain 1 to 64 characters.
host_ip	String	Definition Server IP Address Range The value can contain 1 to 128 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
laddr	String	Definition Listening IP address of the port (0.0.0.0 indicates that all NICs are listened on.) Range The value can be IPv4 or IPv6. An IPv4 address contains 7 to 15 characters, and an IPv6 address contains 15 to 39 characters.
path	String	Definition Absolute path of the executable file corresponding to the process that occupies the current port. Range The value can contain 0 to 512 characters.
pid	Integer	Definition ID of the process that occupies the current port. Range The value is a non-negative integer. The minimum value is 0 (indicating there are no corresponding processes).
port	Integer	Definition Specific port number. Range 1 to 65535 (standard TCP/UDP port range)
status	String	Status
type	String	Definition Port type. Range Currently, the options are TCP and UDP.
container_name	String	Definition Container instance name. This parameter is available only for container alarms. Range The value can contain 1 to 256 characters.
agent_id	String	Definition Unique ID of the antivirus agent installed on a server, which is used to associate the server with the antivirus service. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A

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

Request succeeded.

{
  "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"
  } ]
}