DescribePropertyPortDetail API Reference for Asset Port Fingerprints - Security Center - Alibaba Cloud - Security Center

Queries the asset fingerprint details of listening ports on your servers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribePropertyPortDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Remark	string	No	The name or IP address of the server.	192.168.XX.XX
Port	string	No	The listening port of the server.	22
ProcName	string	No	The name of the server process.	sshd
Uuid	string	No	The UUID of the server.	50d213b4-3a35-427a-b8a5-04b0c7e1****
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
BindIp	string	No	The IP address bound to the port.	0.0.XX.XX
Extend	string	No	Specifies whether to enable fuzzy search by port number. Set this parameter to 1 to enable fuzzy search. Other values or an empty value disables fuzzy search.	1
ResourceDirectoryAccountId	integer	No	The Alibaba Cloud account ID of the member in the resource directory. Note You can call the DescribeMonitorAccounts operation to obtain the IDs.	127608589417****
UseNextToken	boolean	No	Specifies whether to use token-based pagination. If set to true, TotalCount is not returned. Valid values: true: Token-based pagination is used. false: Token-based pagination is not used.	false
NextToken	string	No	The pagination token for the next page. You do not need to specify this parameter for the first request.	AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0FA7F1F4-488D-52CA-9BFC-3E47793B49D1
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	1
Count	integer	The number of entries returned on the current page.	1
NextToken	string	The pagination token for the next page.	B604532DEF982B875E8360A6EFA3B***
Propertys	array<object>	The port fingerprint details.
	object
InternetIp	string	The public IP address of the server.	192.168.XX.XX
Pid	string	The process ID (PID) of the process that listens on the port.	522
BindIp	string	The IP address bound to the port.	0.0.X.X
Ip	string	The IP address of the network interface card (NIC) bound to the listening port.	192.168.XX.XX
ProcName	string	The name of the server process.	sshd
InstanceId	string	The instance ID of the server.	i-hp35tftuh52wbp1g****
Port	string	The listener port.	22
IntranetIp	string	The private IP address of the server.	100.104.XX.XX
Uuid	string	The UUID of the server.	162eb349-c2d9-4f8b-805c-75b43d4c****
InstanceName	string	The instance name of the server.	hc-host-****
Proto	string	The network protocol used by the listening port.	tcp
CreateTimestamp	integer	The timestamp of the last fingerprint collection. Unit: milliseconds.	1649149566000

Examples

Success response

JSON format

{
  "RequestId": "0FA7F1F4-488D-52CA-9BFC-3E47793B49D1",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Count": 1,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "Propertys": [
    {
      "InternetIp": "192.168.XX.XX",
      "Pid": "522",
      "BindIp": "0.0.X.X",
      "Ip": "192.168.XX.XX",
      "ProcName": "sshd",
      "InstanceId": "i-hp35tftuh52wbp1g****",
      "Port": "22",
      "IntranetIp": "100.104.XX.XX",
      "Uuid": "162eb349-c2d9-4f8b-805c-75b43d4c****",
      "InstanceName": "hc-host-****",
      "Proto": "tcp",
      "CreateTimestamp": 1649149566000
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam	Illegal param
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	RdCheckInnerError	Resource directory account service internal error.
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.