Queries the details of a port.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribePropertyPortDetail

The operation that you want to perform.

Set the value to DescribePropertyPortDetail.

Remark String No 1.2.X.X

The name or IP address of the server.

Port String No 22

The port of the server.

ProcName String No sshd

The name of the process.

Uuid String No 50d213b4-3a35-427a-b8a5****

The UUID of the asset.

CurrentPage Integer No 1

The page number of the current page.

PageSize Integer No 6

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
PageInfo Struct

The pagination information.

Count Integer 5

The number of entries returned on the current page.

CurrentPage Integer 1

The page number of the current page.

PageSize Integer 5

The number of entries returned per page.

TotalCount Integer 762

The total number of returned entries.

Propertys Array of PropertyPort

The details of the port.

BindIp String 1.2.3.4

The IP address bound to the port.

Create String 2019-05-13T10:39Z

The time when the data was last collected.

CreateTimestamp Long 1557715141000

The time when the data was last collected. The value is a UNIX timestamp. Unit: milliseconds.

InstanceId String i-2ze645t5u9jo4****

The ID of the asset that is associated with the port.

InstanceName String test****

The name of the asset that is associated with the port.

InternetIp String 1.2.XX.XX

The public IP address of the asset.

IntranetIp String 1.3.XX.XX

The private IP address of the asset.

Ip String 1.2.XX.XX

This parameter is deprecated.

Port String 22

The port number.

ProcName String sshd

The name of the process that uses the port.

Proto String tcp

The network protocol of the port.

Uuid String 50d213b4-3a35-427a-b8a5-04b0c7e1****

The UUID of the asset that is associated with the port.

RequestId String FAA793EF-5B14-4CDD-B3E0-B14D4342C422

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribePropertyPortDetail
&<Common request parameters>

Sample success response

XML format

<DescribePropertyPortDetailResponse>
  <Propertys>
        <InstanceName>test****</InstanceName>
        <Uuid>50d213b4-3a35-427a-b8a5-04b0c7e1****</Uuid>
        <InternetIp>1.2.XX.XX</InternetIp>
        <Proto>tcp</Proto>
        <InstanceId>i-2ze645t5u9jo4****</InstanceId>
        <Create>2019-05-13T10:39Z</Create>
        <ProcName>sshd</ProcName>
        <Ip>1.2.XX.XX</Ip>
        <Port>22</Port>
        <IntranetIp>1.3.XX.XX</IntranetIp>
        <CreateTimestamp>1557715141000</CreateTimestamp>
        <BindIp>1.2.3.4</BindIp>
  </Propertys>
  <PageInfo>
        <TotalCount>762</TotalCount>
        <PageSize>5</PageSize>
        <CurrentPage>1</CurrentPage>
        <Count>5</Count>
  </PageInfo>
  <RequestId> FAA793EF-5B14-4CDD-B3E0-B14D4342C422</RequestId>
</DescribePropertyPortDetailResponse>

JSON format

{
    "Propertys": {
        "InstanceName": "test****",
        "Uuid": "50d213b4-3a35-427a-b8a5-04b0c7e1****",
        "InternetIp": "1.2.XX.XX",
        "Proto": "tcp",
        "InstanceId": "i-2ze645t5u9jo4****",
        "Create": "2019-05-13T10:39Z",
        "ProcName": "sshd",
        "Ip": "1.2.XX.XX",
        "Port": 22,
        "IntranetIp": "1.3.XX.XX",
        "CreateTimestamp": 1557715141000,
        "BindIp": "1.2.3.4"
    },
    "PageInfo": {
        "TotalCount": 762,
        "PageSize": 5,
        "CurrentPage": 1,
        "Count": 5
    },
    "RequestId": "FAA793EF-5B14-4CDD-B3E0-B14D4342C422"
}

Error codes

For a list of error codes, visit the API Error Center.