Viewing the List of Servers Supporting Dynamic Port Honeypots

Function

This API is used to view the servers supporting dynamic port honeypots.

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}/honeypot-port/support-list

**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.
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
limit	No	Integer	Number of records displayed on each page.
ports	No	String	Port numbers to be specified. Use commas (,) to separate multiple port numbers.
os_type	Yes	String	OS type. Its value can be: Linux Windows
policy_id	No	String	Policy ID

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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of data_list objects	data list

**Table 5** data_list
Parameter	Type	Description
host_id	String	Definition Unique ID of a server (host). Range The value can contain 1 to 64 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
private_ip	String	Definition Server private IP address. Range The value can contain 1 to 128 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
conflict_port	Array of integers	Conflicting ports
os_type	String	OS type. Its value can be: Linux: Linux. Windows: Windows.
group_name	String	Group name
group_id	String	Group ID

Example Requests

View the list of servers that support dynamic port honeypots

GET https://{endpoint}/v5/{project_id}/honeypot-port/support-list?enterprise_project_id=all_granted_eps&os_type=Linux

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 10,
  "data_list" : [ {
    "host_id" : "71a15ecc-049f-4cca-bd28-5e90aca1817f",
    "host_name" : "HostName",
    "private_ip" : "192.168.1.1",
    "agent_id" : "bdcb6303b37c61342792f186e38d580b4b073e0024864019eaf982f30c9384db",
    "conflict_port" : [ 0 ],
    "os_type" : "Linux",
    "group_name" : "string",
    "group_id" : "string"
  } ]
}