Use DescribeRoutine to retrieve Edge Routine metadata - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Operation description

Note

API call frequency: 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 function. The name must be unique within the same account.	test

Response elements

Element	Type	Description	Example
	object
Content	object	The information about the EdgeRoutine. For more information about the fields, see the following table.	CodeRevs, EnvConf, Description, Envs, and CreationTime
RequestId	string	The request ID.	4DBA68F5-04A9-406B-****-F2CB635E103F

Content field metric description

Name	Type	Example	Description
CreationTime	String	2021-05-31T13:20:14Z	The creation time of the routine.
Description	String	InRoZSBkZXNjcmlwdGlvbiBvZiB0aGlzIHJvdXRpbmUi	The description of the routine, stored in base64 encoding.
Envs	JSON	production	All canary environments of the routine.
EnvConf	JSON		The environment context of all canary environments of the routine, including the CPU specification (SpecName), code version number (CodeRev), and allowed associated DCDN domain names (AllowedHosts) for each canary environment.
ㄴSpecName	String	100ms	The CPU specification time slice.
ㄴCodeRev	String	1622467214654495147	The code version number.
ㄴAllowedHosts	String	test-e.alicdn.com	The allowed associated DCDN domain names.
CodeRevs	JSON		All code versions of the routine, including the description (CodeDescription), creation time (CreationTime), and version number (CodeRevision) for each version.
ㄴCreationTime	String	2021-05-31T13:20:14Z	The creation time of the code.
ㄴCodeDescription	String	IkhlbGxvIFdvcmxkIg==	The description of the code version, stored in base64 encoding.
ㄴCodeRevision	String	1622467236337778954	The code version number.

Examples

Success response

JSON format

{
  "Content": {
    "test": "test",
    "test2": 1
  },
  "RequestId": "4DBA68F5-04A9-406B-****-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.