All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDdosSpecInfo

Last Updated:Apr 11, 2024

Queries the specifications of DCDN DDoS versions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnDdosSpecInfoRead
  • All Resources
    *
    none
none

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
SpecInfosobject []

The code and configurations of the security rules.

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
Configsobject []

The configurations of the version rule.

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 changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 500
Output ParametersThe response structure of the API has changed.