Viewing a Dynamic Port Honeypot Policy

Function

This API is used to view the dynamic port honeypot policy.

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/policy-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	Yes	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 N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10

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 number. Range The value range is 0 to 2,147,483,647.
data_list	Array of data_list objects	policy list

**Table 5** data_list
Parameter	Type	Description
policy_name	String	Policy name
policy_id	String	Policy ID
host_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
is_default	Boolean	Default or not
port_list	Array of integers	Port list
os_type	String	OS type. Its value can be: Linux: Linux. Windows: Windows.
status	String	Protection status. It can be: applying: The protection is taking effect. success: The protection has taken effect. disable: The protection does not take effect.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 10,
  "data_list" : [ {
    "policy_name" : "Default Linux policy",
    "policy_id" : "71a15ecc-049f-4cca-bd28-5e90aca1817f",
    "host_num" : 10,
    "is_default" : true,
    "port_list" : [ 0 ],
    "os_type" : "Linux",
    "status" : "success"
  } ]
}