All Products
Search
Document Center

Security Center:DescribePropertyPortDetail

Last Updated:Nov 25, 2024

Queries the fingerprints of ports on a specified server.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribePropertyPortDetailget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RemarkstringNo

The name or IP address of the server.

192.168.XX.XX
PortstringNo

The listening port of the server.

22
ProcNamestringNo

The name of the server process.

sshd
UuidstringNo

The UUID of the server.

50d213b4-3a35-427a-b8a5-04b0c7e1****
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10
BindIpstringNo

The IP address bound to the port.

0.0.XX.XX
ExtendstringNo

Specifies whether fuzzy search by port number is supported. If you want to use fuzzy search, set the parameter to 1. If you set the parameter to a different value or leave the parameter empty, fuzzy search is not supported.

1
ResourceDirectoryAccountIdlongNo

The Alibaba Cloud account ID of the member in the resource directory.

Note You can call the DescribeMonitorAccounts operation to obtain the IDs.
127608589417****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

0FA7F1F4-488D-52CA-9BFC-3E47793B49D1
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page. Default value: 10.

10
TotalCountinteger

The total number of entries returned.

1
Countinteger

The number of entries returned on the current page.

1
Propertysarray<object>

The fingerprints of the ports.

PropertyPortobject
InternetIpstring

The public IP address of the server.

192.168.XX.XX
Pidstring

The ID of the server process that listens on the port.

522
BindIpstring

The IP address bound to the port.

0.0.X.X
Ipstring

The IP address of the network interface controller (NIC) that is bound to the listening port.

192.168.XX.XX
ProcNamestring

The name of the server process.

sshd
InstanceIdstring

The instance ID of the server.

i-hp35tftuh52wbp1g****
Portstring

The listener port.

22
IntranetIpstring

The private IP address of the server.

100.104.XX.XX
Uuidstring

The UUID of the server.

162eb349-c2d9-4f8b-805c-75b43d4c****
InstanceNamestring

The instance name of the server.

hc-host-****
Protostring

The network protocol that is used by the listening port.

tcp
CreateTimestamplong

The timestamp of the last fingerprint collection. Unit: milliseconds.

1649149566000

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FA7F1F4-488D-52CA-9BFC-3E47793B49D1",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Count": 1
  },
  "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 codeError codeError messageDescription
400IllegalParamIllegal param-
400RdCheckNoPermissionResource directory account verification has no permission.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500RdCheckInnerErrorResource directory account service internal error.-
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-14The Error code has changed. The request parameters of the API has changedView Change Details
2022-01-05The Error code has changed. The request parameters of the API has changedView Change Details