Queries the status of the IP Application Accelerator (IPA) service. The status information includes the current billing method, service activation time, next effective billing method, and current service status.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Position Type Required Example Description
Action Query String Yes DescribeDcdnIpaService

The operation that you want to perform. Set the value to DescribeDcdnIpaService.

Response parameters

Parameter Type Example Description
ChangingAffectTime String 2018-03-31T16:00:00Z

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.

ChangingChargeType String PayByBandwidth

The new billing method to take effect. Valid values:

  • PayByTraffic
  • PayByBandwidth
  • PayByBandwidth95
  • PayByBandwidth_monthavg
  • PayByBandwidth_month4th
  • PayByBandwidth_monthday95avg
  • PayByBandwidth_nighthalf95
InstanceId String 1883927335936173

The ID of the instance.

InternetChargeType String PayByBandwidth

The current billing method. Valid values:

  • PayByTraffic
  • PayByBandwidth
  • PayByBandwidth95
  • PayByBandwidth_monthavg
  • PayByBandwidth_month4th
  • PayByBandwidth_monthday95avg
  • PayByBandwidth_nighthalf95
OpeningTime String 2018-03-19T11:16:11Z

The time when the IPA service was activated. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format.

OperationLocks Array of LockReason

The lock status of the IPA service.

LockReason
LockReason String financial

The reason why the IPA service was locked. A value of financial indicates that your account has an overdue payment.

RequestId String EF2AEBC2-EDBD-41CF-BF64-7E095D42D6EF

The ID of the request.

Examples

Sample requests

https://dcdn.aliyuncs.com?Action=DescribeDcdnIpaService
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnIpaServiceResponse>
	  <ChangingChargeType>PayByBandwidth</ChangingChargeType>
	  <OpeningTime>2018-03-19T11:16:11Z</OpeningTime>
	  <InstanceId>1883927335936173</InstanceId>
	  <RequestId>EF2AEBC2-EDBD-41CF-BF64-7E095D42D6EF</RequestId>
	  <ChangingAffectTime>2018-03-31T16:00:00Z</ChangingAffectTime>
	  <OperationLocks>
		    <LockReason>
			      <LockReason>financial</LockReason>
		    </LockReason>
	  </OperationLocks>
	  <InternetChargeType>PayByTraffic</InternetChargeType>
</DescribeDcdnIpaServiceResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
403 DcdnIpaServiceNotFound The DCDN IPA service has not been activated. The error message returned because the IPA service is not activated.

For a list of error codes, visit the API Error Center.