All Products
Search
Document Center

Edge Security Acceleration:DescribeRoutineCanaryEnvs

Last Updated:Aug 21, 2025

Retrieves a list of canary environments supported by Edge Routine (ER).

Operation description

Note

The API call frequency is limited to 100 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:DescribeRoutineCanaryEnvs

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response parameters

Parameter

Type

Description

Example

object

Content

object

A list of supported canary environments.

presetCanaryShanghai

RequestId

string

The request ID.

CDCD94C0-F7FE-412F-B8F8-7E3C610C78E5

Examples

Success response

JSON format

{
  "Content": {
    "test": "test",
    "test2": 1
  },
  "RequestId": "CDCD94C0-F7FE-412F-B8F8-7E3C610C78E5"
}

Error codes

HTTP status code

Error code

Error message

Description

400 EdgeRoutine.GeneralError A server error occurred: %s A server error occurred. Try again later. If the error persists, submit a ticket.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.