All Products
Search
Document Center

Edge Security Acceleration:DescribeDcdnDdosSpecInfo

Last Updated:Oct 17, 2024

Queries the specifications of DCDN DDoS versions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Editionstring

The version. Valid values:

  • poc: POC Edition
  • basic: Basic Edition
  • insurance: Insurance Edition
  • unlimited: Unlimited Edition
  • port_enhancement: Special Port Enhanced Edition
insurance
RequestIdstring

The ID of the request.

DEA8E7BE-33C6-56F5-AC56-74D50547CF34
Enablestring

Specifies whether to enable DDoS mitigation. Valid values:

  • on:
  • off.
on
ProtectedAreastring

Protected region. Valid values:

  • global: global
  • chinese_mainland: Chinese mainland
  • global_excluding_the_chinese_mainland: outside the Chinese mainland
global
BandwidthLimitstring

The bandwidth limit of a single instance.

40Gbps
QpsLimitstring

The QPS limit.

100
SpecInfosarray<object>

The code and configurations of the security rules.

RuleInfoItemobject
Rulestring

The version rule. Valid values:

  • version_defense_num: the rule for the number of version mitigation sessions
  • domain_num: the rule for the limit on the number of domain names
  • defence_package_num: the rule for extra mitigation session plans
version_defense_num
Configsarray<object>

The configurations of the version rule.

ConfigItemobject
Valuestring

The value of the configuration expression of the version rule.

1
Configstring

The configuration code of the version rule. Valid values:

  • total_defense_num: the total number of mitigation sessions of the version.
  • consume_defense_num: the number of used mitigation sessions of the version.
  • max_domain_num: the limit on the number of added domain names.
  • emain_domain_num: the number of added domain names.
  • defence_package_num: the total number of purchased additional mitigation sessions.
  • consume_defence_package_num: the number of used additional mitigation sessions.
total_defense_num
Exprstring

The configuration expression of the version rule.

equal
IsSpecialPortstring

Specifies whether custom ports are supported. Valid values:

  • yes
  • no
no

Examples

Sample success responses

JSONformat

{
  "Edition": "insurance",
  "RequestId": "DEA8E7BE-33C6-56F5-AC56-74D50547CF34",
  "Enable": "on",
  "ProtectedArea": "global",
  "BandwidthLimit": "40Gbps",
  "QpsLimit": "100",
  "SpecInfos": [
    {
      "Rule": "version_defense_num",
      "Configs": [
        {
          "Value": "1",
          "Config": "total_defense_num",
          "Expr": "equal"
        }
      ]
    }
  ],
  "IsSpecialPort": "no"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.A parameter is set to an invalid value.
500InternalErrorAn internal error occurred; please try again later.An internal error occurred. Try again later. If the error persists, submit a ticket.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-14The Error code has changed. The response structure of the API has changedView Change Details