All Products
Search
Document Center

Cloud Firewall:DescribeInternetOpenService

Last Updated:Nov 12, 2025

Queries services exposed to the Internet.

Operation description

QPS limits

You can make up to 10 queries per second (QPS). If you exceed this limit, API calls are throttled. This may affect your business. We recommend that you make API calls at a reasonable rate.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

SourceIp

string

No

The source IP address of the visitor.

122.200.64.XXX

Lang

string

No

The language of the response.

Valid values:

  • en :

    English

  • zh :

    Chinese

zh

Lang

string

No

The language of the response.

Valid values:

  • en :

    English

  • zh :

    Chinese

zh

ServiceName

string

No

The name of the application for an exact match. If you do not specify this parameter, all applications are queried.

SMB

ServiceNameFuzzy

string

No

The name of the application for a fuzzy match. If you do not specify this parameter, all applications are queried.

SMB

RiskLevel

string

No

The risk level.

Valid values:

  • 0 :

    None

  • 1 :

    Low

  • 2 :

    Medium

  • 3 :

    High

  • -1 :

    In assessment

2

SuggestLevel

string

No

The recommended policy level.

Valid values:

  • 0 :

    Unknown

  • 10 :

    Allow

  • 20 :

    Alert

  • 30 :

    Deny

  • -1 :

    In assessment

10

Port

string

No

The port number.

3389

StartTime

string

No

The start of the time range to query. The value is a UNIX timestamp in seconds.

1755742107

EndTime

string

No

The end of the time range to query. The value is a UNIX timestamp in seconds.

1753804800

CurrentPage

string

No

The page number.

1

PageSize

string

No

The number of entries per page.

10

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

99A65AA0-C5B5-5092-BFCF-8111B436****

PageInfo

object

The paging information.

CurrentPage

integer

The page number.

1

PageSize

integer

The number of entries per page.

20

TotalCount

integer

The total number of entries.

10

DataList

array<object>

The list of data.

object

The list of data.

RiskLevel

integer

The risk level.

Valid values:

  • 0 :

    None

  • 1 :

    Low

  • 2 :

    Medium

  • 3 :

    High

  • -1 :

    In assessment

3

ProbRiskDesc

string

The description of the security threat.

test

TrafficPercent1Day

string

The traffic percentage over the last 24 hours.

0

Protocol

string

The protocol type.

Valid values:

  • tcp :

    TCP

  • udp :

    UDP

tcp

PublicIpNum

integer

The number of exposed public IP addresses.

3

SuggestLevel

integer

The recommended policy level.

Valid values:

  • 0 :

    Unknown

  • 10 :

    Allow

  • 20 :

    Alert

  • 30 :

    Deny

  • -1 :

    In assessment

20

DetailNum

integer

The number of details.

5

TrafficPercent7Day

string

The traffic percentage over the last 7 days.

77

TrafficPercent30Day

string

The traffic percentage over the last 30 days.

0

ProbRisk

string

The security threat.

test

ServiceName

integer

The application name.

SMB

RiskReason

string

The description of the risk.

test

PortList

array

The list of open ports.

string

The list of open ports.

[ 80, 8080, 80, 21 ]

InBytes

integer

The inbound traffic.

447458.0

OutBytes

integer

The outbound traffic.

1123

TotalBytes

integer

The total traffic.

621404

UnknownReason

array

The reason why the protocol is not identified if the detected protocol is `Unknown`.

string

The reason why the protocol is not identified if the detected protocol is `Unknown`.

no_payload

Examples

Success response

JSON format

{
  "RequestId": "99A65AA0-C5B5-5092-BFCF-8111B436****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 10
  },
  "DataList": [
    {
      "RiskLevel": 3,
      "ProbRiskDesc": "test",
      "TrafficPercent1Day": "0",
      "Protocol": "tcp",
      "PublicIpNum": 3,
      "SuggestLevel": 20,
      "DetailNum": 5,
      "TrafficPercent7Day": "77",
      "TrafficPercent30Day": " 0",
      "ProbRisk": "test",
      "ServiceName": 0,
      "RiskReason": "test",
      "PortList": [
        "[\n  80,\n  8080,\n  80,\n  21\n]"
      ],
      "InBytes": 447458,
      "OutBytes": 1123,
      "TotalBytes": 621404,
      "UnknownReason": [
        "no_payload"
      ]
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
400 ErrorParameters A parameter error occurred. A parameter error occurred.
400 ErrorMarshalJSON internal error. Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.