You can call this operation to query port information.

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.

CurrentPage Integer No 1

The number of the page to return.

ForceFlush Boolean No true

Specifies whether to force refresh the data to be queried.

PageSize Integer No 5

The number of entries to return on each page.

Port String No 22

The port that you want to query.

Response parameters

Parameter Type Example Description
PageInfo

The page information.

Count Integer 5

The number of entries returned on the current page.

CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 5

The number of entries returned per page.

TotalCount Integer 163

The total number of returned entries.

PropertyItems

The returned port information.

Count Integer 495

The number of servers that correspond to the port.

Port String 22

The listener port number.

Proto String tcp

The network protocol that correspond to the port.

RequestId String 7E0618A9-D5EF-4220-9471-C42B5E92719F

The ID of the request.

Examples

Sample requests


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

Sample success responses

XML format

<DescribePropertyPortItem>
	  <code>200</code>
	  <data>
		    <PageInfo>
			      <Count>5</Count>
			      <PageSize>5</PageSize>
			      <TotalCount>163</TotalCount>
			      <CurrentPage>1</CurrentPage>
		    </PageInfo>
		    <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>
	  </data>
	  <success>true</success>
	  <requestId></requestId>
	  <message>successful</message>
    </DescribePropertyPortItem>

JSON format

{
	"message":"successful",
	"data":{
		"PropertyItems":[
			{
				"Port":"22",
				"Count":495,
				"Proto":"tcp"
			},
			{
				"Port":"111",
				"Count":43,
				"Proto":"tcp"
			},
			{
				"Port":"6000",
				"Count":2,
				"Proto":"tcp"
			},
			{
				"Port":"53",
				"Count":1,
				"Proto":"tcp"
			},
			{
				"Port":"80",
				"Count":38,
				"Proto":"tcp"
			}
		],
		"PageInfo":{
			"Count":5,
			"TotalCount":163,
			"PageSize":5,
			"CurrentPage":1
		}
	},
	"code":"200",
	"success":true
}

Error codes

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