All Products
Search
Document Center

CDN:DescribeCdnService

Last Updated:Nov 29, 2024

Queries the status of your Alibaba Cloud CDN service. The information includes the service activation time, the current service status, the current metering method, and the metering method for the next cycle.

Operation description

Note You can call this operation up to 30 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
cdn:DescribeCdnServiceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
ChangingAffectTimestring

The time when the metering method for the next cycle takes effect. The time is displayed in GMT.

2019-11-27T16:00:00Z
RequestIdstring

The ID of the request.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ChangingChargeTypestring

The metering method for the next cycle. Valid values:

  • PayByTraffic: pay-by-data-transfer
  • PayByBandwidth: pay-by-bandwidth
PayByTraffic
OpeningTimestring

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

2019-02-28T13:11:49Z
InternetChargeTypestring

The current metering method. Valid values:

  • PayByTraffic: pay-by-data-transfer
  • PayByBandwidth: pay-by-bandwidth
PayByTraffic
InstanceIdstring

The ID of the instance.

aliuidxx
OperationLocksarray<object>

The lock status.

LockReasonobject
LockReasonstring

The reason why the service is locked. A value of financial indicates that the service is locked due to overdue payments.

financial

Examples

Sample success responses

JSONformat

{
  "ChangingAffectTime": "2019-11-27T16:00:00Z",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "ChangingChargeType": "PayByTraffic",
  "OpeningTime": "2019-02-28T13:11:49Z",
  "InternetChargeType": "PayByTraffic",
  "InstanceId": "aliuidxx",
  "OperationLocks": {
    "LockReason": [
      {
        "LockReason": "financial"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400UnsupportedParameterThere is unsupported parameters
400InternetChargeTypeInvalidThe specified InternetChargeType is invalid.The specified InternetChargeType is invalid.

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