Modifying the Open Port Status

Function

This API is used to modify the open port status.

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

POST /v5/{project_id}/asset/batch-modify-port-status

**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.
category	Yes	String	Definition Asset Type Constraints N/A Range host: server asset container: container asset Default Value host

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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
operate_type	No	String	Definition Whether a port is ignored. Constraints N/A Range ignore: Ignore not_ignore: unignore Default Value N/A
data_list	No	Array of PortStatusRequestInfo objects	Definition Server information list. Constraints N/A Range The value range is 0 to 200. Default Value N/A

**Table 5** PortStatusRequestInfo
Parameter	Mandatory	Type	Description
agent_id	Yes	String	Definition agent id Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A
port	Yes	Integer	Definition Local port number. Constraints N/A Range The value range is 0 to 2,147,483,647. Default Value N/A
port_type	Yes	String	Definition Port type. Constraints N/A Range TCP UDP Default Value N/A
container_id	No	String	Definition Container ID. Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A
host_id	No	String	Definition Server ID. Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Change the risk status of local port 22 whose project_id is 2b31ed520xxxxxxebedb6e57xxxxxxxx and agent_id is xxx to unignored.

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/asset/batch-modify-port-status?enterprise_project_id=all_granted_eps

{
  "operate_type" : "not_ignore",
  "data_list" : [ {
    "port" : 22,
    "port_type" : "TCP",
    "container_id" : "xxx",
    "host_id" : "xxx",
    "agent_id" : "bc36c4f848c704bb2231b1d2b72a7d8f2ae732e0d5d0aca310c7070d7c8a2886"
  } ]
}