DescribeRoutine - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Note

The frequency of this API call 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:DescribeRoutine

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the Edge Routine. The name must be unique within an Alibaba Cloud account.	test

Response parameters

Parameter	Type	Description	Example
	object
Content	object	Contains information about the Edge Routine. For more information about the fields, see the following table.	CodeRevs、EnvConf、Description、Envs和CreationTime
RequestId	string	The request ID.	4DBA68F5-04A9-406B-B1E4-F2CB635E103F

Parameters of the Content field

Name	Type	Example	Description
CreationTime	String	2021-05-31T13:20:14Z	The time when the Edge Routine was created.
Description	String	InRoZSBkZXNjcmlwdGlvbiBvZiB0aGlzIHJvdXRpbmUi	The description of the Edge Routine. The value is Base64-encoded.
Envs	JSON	production	A collection of all canary release environments for the Edge Routine.
EnvConf	JSON		Information about all canary release environments for the Edge Routine. This includes the CPU specification (SpecName), code version number (CodeRev), and allowed DCDN domain names (AllowedHosts) for each canary release environment.
SpecName	String	100ms	The CPU time slice specification.
CodeRev	String	1622467214654495147	The code version number.
AllowedHosts	String	test-e.alicdn.com	The DCDN domain names that can be associated.
CodeRevs	JSON		All code versions of the Edge Routine. This includes the description (CodeDescription), creation time (CreationTime), and version number (CodeRevision) for each version.
CreationTime	String	2021-05-31T13:20:14Z	The time when the code was created.
CodeDescription	String	IkhlbGxvIFdvcmxkIg==	The description of the code version. The value is Base64-encoded.
CodeRevision	String	1622467236337778954	The code version number.

Examples

Success response

JSON format

{
  "Content": {
    "test": "test",
    "test2": 1
  },
  "RequestId": "4DBA68F5-04A9-406B-B1E4-F2CB635E103F"
}

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.