Queries the supported custom ports of a website.

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 DescribeWebCustomPorts

The operation that you want to perform. Set the value to DescribeWebCustomPorts.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

Response parameters

Parameter Type Example Description
RequestId String 0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

The ID of the request.

WebCustomPorts Array

Details about supported custom ports of a website.

ProxyPorts List [80,8080]

The supported custom ports.

ProxyType String http

The protocol of supported ports. Valid values:

  • http
  • https

Examples

Sample requests

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

Sample success responses

XML format

<DescribeWebCustomPortsResponse>
      <RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>
      <WebCustomPorts>
            <ProxyType>https</ProxyType>
            <ProxyPorts>443</ProxyPorts>
            <ProxyPorts>8443</ProxyPorts>
      </WebCustomPorts>
      <WebCustomPorts>
            <ProxyType>http</ProxyType>
            <ProxyPorts>80</ProxyPorts>
            <ProxyPorts>8080</ProxyPorts>
      </WebCustomPorts>
</DescribeWebCustomPortsResponse>

JSON format

{
    "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
    "WebCustomPorts": [
        {
            "ProxyType": "https",
            "ProxyPorts": [
                443,
                8443
            ]
        },
        {
            "ProxyType": "http",
            "ProxyPorts": [
                80,
                8080
            ]
        }
    ]
}

Error codes

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