DescribeCdnService - CDN - Alibaba Cloud Documentation Center

You can call the DescribeCdnService operation to query the status of the Alibaba Cloud CDN service. The returned information includes the current metering method, the service activation time, the next metering method that will take effect, and the current service status.

Operation description

Note

A single user can call this operation up to 30 times 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

cdn:DescribeCdnService

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response parameters

Parameter	Type	Description	Example
	object
ChangingAffectTime	string	The time when the next metering method takes effect. The time is in GMT.	2019-11-27T16:00:00Z
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ChangingChargeType	string	The next metering method that will take effect. PayByTraffic: by traffic. PayByBandwidth: by peak bandwidth.	PayByTraffic
OpeningTime	string	The time when the service was activated. The time is in the ISO 8601 format.	2019-02-28T13:11:49Z
InternetChargeType	string	The current metering method. PayByTraffic: by traffic. PayByBandwidth: by peak bandwidth.	PayByTraffic
InstanceId	string	The instance ID.	aliuidxx
OperationLocks	object
LockReason	array<object>	The lock status of the service.
	object
LockReason	string	The reason why the service is locked. The value `financial` indicates an overdue payment.	financial
ChangingDynamicBillingType	string	The next metering method for dynamic acceleration that will take effect.	DynamicHourTraffic
DynamicBillingType	string	The metering method for dynamic acceleration.	DynamicHourTraffic

Examples

Success response

JSON format

{
  "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"
      }
    ]
  },
  "ChangingDynamicBillingType": "DynamicHourTraffic",
  "DynamicBillingType": "DynamicHourTraffic"
}

Error codes

HTTP status code	Error code	Error message	Description
400	UnsupportedParameter	There is unsupported parameters
400	InternetChargeTypeInvalid	The specified InternetChargeType is invalid.	The specified InternetChargeType is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.