All Products
Search

This Product

    Edge Security Acceleration:DescribeDcdnIpaService

    Document Center

    Edge Security Acceleration:DescribeDcdnIpaService

    Last Updated:Aug 21, 2025

    Call DescribeDcdnIpaService to query the status of the DCDN IP Application Accelerator (IPA) service. The returned information includes the current billing method, service activation time, the next billing method to take effect, and the current service status.

    Operation description

    Note

    The call frequency for a single user is limited to 20 calls per second.

    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:DescribeDcdnIpaService

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Parameter

    Type

    Description

    Example

    object

    ChangingAffectTime

    string

    The time when the configuration change takes effect. The time is in GMT. This time is displayed in the console only when it is later than the current time.

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

    string

    The request ID.

    EF2AEBC2-EDBD-41CF-BF64-7E095D42D6EF
    ChangingChargeType

    string

    The billing method that will take effect next. Valid values:

    • PayByTraffic: pay-by-traffic.

    • PayByBandwidth: pay-by-bandwidth.

    • PayByBandwidth95: 95th percentile bandwidth (monthly).

    • PayByBandwidth_monthavg: average daily peak bandwidth (monthly).

    • PayByBandwidth_month4th: 4th peak bandwidth (monthly).

    • PayByBandwidth_monthday95avg: average 95th percentile bandwidth (monthly).

    • PayByBandwidth_nighthalf95: 95th percentile bandwidth with 50% off for nightly usage (monthly).

    PayByBandwidth
    OpeningTime

    string

    The time when the service was activated. The time is in the ISO 8601 standard.

    2018-03-19T11:16:11Z
    InternetChargeType

    string

    The current billing method. Valid values:

    • PayByTraffic: pay-by-traffic.

    • PayByBandwidth: pay-by-bandwidth.

    • PayByBandwidth95: 95th percentile bandwidth (monthly).

    • PayByBandwidth_monthavg: average daily peak bandwidth (monthly).

    • PayByBandwidth_month4th: 4th peak bandwidth (monthly).

    • PayByBandwidth_monthday95avg: average 95th percentile bandwidth (monthly).

    • PayByBandwidth_nighthalf95: 95th percentile bandwidth with 50% off for nightly usage (monthly).

    PayByBandwidth
    InstanceId

    string

    The instance ID.

    1883927335936173
    OperationLocks

    object

    LockReason

    array<object>

    The lock status of the service.

    object

    LockReason

    string

    The reason why the service is locked. For example, financial indicates an overdue payment.

    financial

    Examples

    Success response

    JSON format

    {
  "ChangingAffectTime": "2018-03-31T16:00:00Z",
  "RequestId": "EF2AEBC2-EDBD-41CF-BF64-7E095D42D6EF",
  "ChangingChargeType": "PayByBandwidth",
  "OpeningTime": "2018-03-19T11:16:11Z",
  "InternetChargeType": "PayByBandwidth",
  "InstanceId": "1883927335936173",
  "OperationLocks": {
    "LockReason": [
      {
        "LockReason": "financial"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    403 DcdnIpaServiceNotFound The DCDN IPA service has not been activated. IPA is not activated for DCDN.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.