Querying the Description of a Port

Function

Check details about a port. Example: Local port: 80. Type: TCP. Risk level: normal. Port description: It is usually used for Secure Shell (SSH) remote login, secure login, file transfer (via SCP and SFTP), and port redirection.

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/common-port-info

**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
port	Yes	Integer	Definition Port number. Constraints N/A Range Minimum value: 1. Maximum value: 65535. 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
port	Integer	Definition Port Number Range Minimum value: 1. Maximum value: 65535.
type	String	Definition Port Type Range TCP: TCP protocol UDP: UDP protocol TCP6: TCP6 protocol UDP6: UDP6 protocol
status	String	Definition Status. Range normal danger unknown
description	String	Definition Chinese description. Range The value can contain 1 to 256 characters.
description_en	String	Definition English description. Range The value can contain 1 to 256 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "port" : 666,
  "type" : "TCP",
  "status" : "normal",
  "description" : "Trojan horses Attack FTP and Satanz Backdoor",
  "description_en" : "Trojan horses Attack FTP and Satanz Backdoor"
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Asset Management

Previous topic: Querying the Service List of Auto-Started Items

Next topic: Exporting Asset Fingerprint Information

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot