All Products
Search

This Product

    Edge Security Acceleration:DescribeDcdnDdosService

    Document Center

    Edge Security Acceleration:DescribeDcdnDdosService

    Last Updated:Sep 11, 2025

    Queries the status of the DCDN DDoS service.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dcdn:DescribeDcdnDdosService

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    Status

    string

    The status of the service. Valid values:

    • Normal: The service is running as expected.

    • WaitForExpire: The service is about to be suspended.

    • Expired: The service has expired.

    • Released: The service is released.

    Normal
    ChangingAffectTime

    string

    The time when the new settings will take effect. The time is in GMT.

    2018-03-31T16:00:00Z
    OpeningTime

    string

    The time when the service was enabled.

    2021-09-26T16:00:00Z
    ChangingEdition

    string

    The edition of the service after the change takes effect. Valid values:

    • poc: Proof of Concept (POC) Edition.

    • basic: Basic Edition.

    • insurance: Insurance Edition.

    • unlimited: Unlimited Edition.

    basic
    ChargeType

    string

    The billing method. Valid values:

    • PayByBandwidth: pay-by-daily-peak-bandwidth.

    • PayByTraffic: pay-by-traffic.

    • PayByBandwidth95: pay-by-95th-percentile-bandwidth.

    PayByTraffic
    DomianNum

    integer

    The number of protected domain names.

    20
    ChangingProtectNum

    integer

    The number of mitigation sessions after the change takes effect.

    100
    ChangingDomianNum

    integer

    The number of protected domain names after the change takes effect.

    30
    InstanceId

    string

    The instance ID.

    xxx-12345
    Edition

    string

    The current edition of the service. Valid values:

    • poc: POC Edition.

    • basic: Basic Edition.

    • insurance: Insurance Edition.

    • unlimited: Unlimited Edition.

    poc
    ChangingChargeType

    string

    The billing method after the change takes effect. Valid values:

    • PayByBandwidth: pay-by-daily-peak-bandwidth.

    • PayByTraffic: pay-by-traffic.

    • PayByBandwidth95: pay-by-95th-percentile-bandwidth.

    PayByBandwidth
    RequestId

    string

    The request ID.

    C370DAF1-C838-4288-A1A0-9A87633D248E
    ProtectNum

    integer

    The number of mitigation sessions.

    100
    Enabled

    string

    Indicates whether the service is enabled. Valid values:

    • on: Enabled.

    • off: Not enabled.

    on
    EndingTime

    string

    The expiration time of the service.

    2023-09-26T16:00:00Z

    Examples

    Success response

    JSON format

    {
  "Status": "Normal",
  "ChangingAffectTime": "2018-03-31T16:00:00Z",
  "OpeningTime": "2021-09-26T16:00:00Z",
  "ChangingEdition": "basic",
  "ChargeType": "PayByTraffic",
  "DomianNum": 20,
  "ChangingProtectNum": 100,
  "ChangingDomianNum": 30,
  "InstanceId": "xxx-12345",
  "Edition": "poc",
  "ChangingChargeType": "PayByBandwidth",
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
  "ProtectNum": 100,
  "Enabled": "on",
  "EndingTime": "2023-09-26T16:00:00Z"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.