DocsICP FilingConsole
Documentation

DescribeDcdnService

Updated at:
Copy as MD
Product
My Favorites

Queries the status of Dynamic Route for CDN (DCDN), including the current billing method, service activation time, next effective billing method, and current service status.

Operation description

Note

Rate limit per user: 30 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:DescribeDcdnService

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

WebsocketChangingTime

string

The effective period of the WebSocket Upgrade/Downgrade, which is the same as the value of ChangingAffectTime. This value must be compared with the current time and is displayed on the frontend only if it is later than the current time. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

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

string

The next effective billing method for WebSocket. Valid values:

  • websockettraffic: traffic.

  • websocketbps: bandwidth.

websocketbps
ChangingAffectTime

string

The next effective period in GMT.

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

string

The next effective billing method. Valid values:

  • PayByTraffic: traffic.

  • PayByBandwidth: bandwidth.

  • PayByBandwidth95: monthly 95th percentile bandwidth.

  • PayByBandwidth_monthavg: monthly average bandwidth.

  • PayByBandwidth_month4th: monthly fourth peak bandwidth.

  • PayByBandwidth_monthday95avg: monthly average 95th percentile bandwidth.

  • PayByBandwidth_nighthalf95: monthly 95th percentile bandwidth with a 50% discount during nighttime.

PayByBandwidth
RequestId

string

The request ID.

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

string

The service activation time in the ISO 8601 format.

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

string

The current billing method. Valid values:

  • PayByTraffic: traffic.

  • PayByBandwidth: bandwidth.

  • PayByBandwidth95: monthly 95th percentile bandwidth.

  • PayByBandwidth_monthavg: monthly average bandwidth.

  • PayByBandwidth_month4th: monthly fourth peak bandwidth.

  • PayByBandwidth_monthday95avg: monthly average 95th percentile bandwidth.

  • PayByBandwidth_nighthalf95: monthly 95th percentile bandwidth with a 50% discount during nighttime.

PayByTraffic
WebsocketType

string

The current billing method for WebSocket. Valid values:

  • websockettraffic: traffic.

  • websocketbps: bandwidth.

websocketbps
InstanceId

string

The instance ID.

FP-mkqgwxxxx
OperationLocks

object

LockReason

array<object>

The service lock status.

object

LockReason

string

The lock reason. Example: financial (overdue payment).

financial

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.