Queries the details of all ports.

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 DescribePropertyPortItem

The operation that you want to perform.

Set the value to DescribePropertyPortItem.

ForceFlush Boolean No true

Specifies whether to forcibly refresh the data that you want to query.

Port String No 22

The port number.

CurrentPage Integer No 1

The page number of the current page.

PageSize Integer No 5

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
RequestId String 7E0618A9-D5EF-4220-9471-C42B5E92719F

The ID of the request.

PropertyItems Array

The details of the port.

Port String 22

The number of the listener port.

Proto String tcp

The network protocol of the port.

Count Integer 495

The number of servers that use the port.

PageInfo Struct

The page information.

Count Integer 5

The number of entries returned on the current page.

PageSize Integer 5

The number of entries returned per page.

TotalCount Integer 163

The total number of returned entries.

CurrentPage Integer 1

The page number of the current page.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribePropertyPortItemResponse>
        <RequestId>7E0618A9-D5EF-4220-9471-C42B5E92719F</RequestId>
        <PropertyItems>
			    <Port>22</Port>
			    <Proto>tcp</Proto>
			    <Count>495</Count>
	    </PropertyItems>
	    <PropertyItems>
			    <Port>111</Port>
			    <Proto>tcp</Proto>
			    <Count>43</Count>
	    </PropertyItems>
	    <PropertyItems>
			    <Port>6000</Port>
			    <Proto>tcp</Proto>
			    <Count>2</Count>
	    </PropertyItems>
	    <PropertyItems>
			    <Port>53</Port>
			    <Proto>tcp</Proto>
			    <Count>1</Count>
	    </PropertyItems>
	    <PropertyItems>
			    <Port>80</Port>
			    <Proto>tcp</Proto>
			    <Count>38</Count>
	    </PropertyItems>
        <PageInfo>
			    <Count>5</Count>
			    <PageSize>5</PageSize>
			    <TotalCount>163</TotalCount>
			    <CurrentPage>1</CurrentPage>
	    </PageInfo>
</DescribePropertyPortItemResponse>

JSON format 

{
  "requestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F", 
  "PropertyItems": [
      {
        "Port": "22",
        "Proto": "tcp",
        "Count": 495
      },
      {
        "Port": "111",
        "Proto": "tcp",
        "Count": 43
      },
      {
        "Port": "6000",
        "Proto": "tcp",
        "Count": 2
      },   
      {
        "Port": "53",
        "Proto": "tcp",
        "Count": 1
      },
      {
        "Port": "80",
        "Proto": "tcp",
        "Count": 38
      }
  ],
  "PageInfo": {
      "Count": 5,
      "PageSize": 5,
      "TotalCount": 163,
      "CurrentPage": 1
    }
}

Error codes

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