All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnIpaService

Last Updated:Mar 01, 2024

Queries the status of IPA. The information includes the time when the service was activated, the current service status, the current billing method, and the billing method of the next cycle.

Operation description

**

**The maximum number of times that each user can call this operation per second is 20.

Debugging

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

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
ChangingAffectTimestring

The time when the change of the billing method starts to take effect. The time is in GMT. This time appears on the frontend only when it is later than the current time.

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

The ID of the request.

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

The new billing method to take effect. Valid values:

  • PayByTraffic: pay-by-data-transfer
  • PayByBandwidth: pay-by-bandwidth
  • PayByBandwidth95: pay-by-95th percentile bandwidth
  • PayByBandwidth_monthavg: pay-by-monthly average bandwidth
  • PayByBandwidth_month4th: pay-by-fourth peak bandwidth per month
  • PayByBandwidth_monthday95avg: pay-by-monthly average 95th percentile bandwidth
  • PayByBandwidth_nighthalf95: pay-by-95th percentile bandwidth (50% off during nighttime)
PayByBandwidth
OpeningTimestring

The time when the DCDN service was activated. The time follows the ISO 8601 standard.

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

The billing method of the instance. Valid values:

  • PayByTraffic: pay-by-data-transfer
  • PayByBandwidth: pay-by-bandwidth
  • PayByBandwidth95: pay-by-95th percentile bandwidth
  • PayByBandwidth_monthavg: pay-by-monthly average bandwidth
  • PayByBandwidth_month4th: pay-by-fourth peak bandwidth per month
  • PayByBandwidth_monthday95avg: pay-by-monthly average 95th percentile bandwidth
  • PayByBandwidth_nighthalf95: pay-by-95th percentile bandwidth (50% off during nighttime)
PayByBandwidth
InstanceIdstring

The ID of the instance.

1883927335936173
OperationLocksobject []

The lock status of secure DCDN.

LockReasonstring

The reason why the instance is locked. For example, a value of financial indicates that an overdue payment exists.

financial

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403DcdnIpaServiceNotFoundThe DCDN IPA service has not been activated.IPA is not activated for DCDN.

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

Change history

Change timeSummary of changesOperation
No change history