List Edge Routines via ListUserRoutines API for Account-Wide Visibility - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Retrieves a paginated list of Edge Routines created by the user along with quota information.

Operation description

This operation allows you to perform a paged query for all Edge Routines created under your account. It also returns the Edge Routine quota for your current plan and the number of Edge Routines already in use. You can specify the PageNumber and PageSize paging parameters to control the number of results returned, and use SearchKeyWord to perform a fuzzy search to filter Routine names.

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

esa:ListUserRoutines

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default value: 1. Maximum value: 10.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 20.	20
SearchKeyWord	string	No	The keyword for fuzzy match.	hello

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	1234567890ABCDEF
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	3
QuotaRoutineNumber	integer	The Routine quota for the current plan.	20
UsedRoutineNumber	integer	The number of Routines already created.	5
Routines	array<object>	The list of Routines.
	object	The array of Routine entries.
RoutineName	string	The Routine name.	hello
Description	string	The Routine description.	ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==
CreateTime	string	The time when the Edge Routine was created. The time follows the RFC 3339 standard in the UTC time zone.	2024-03-11T01:23:02.883361712Z
HasAssets	boolean	Indicates whether the Routine contains asset files.	false
DefaultRelatedRecord	string	The default access record associated with the Routine.	serverless-test-2.154edaf6.er.aliyun-esa.net

Examples

Success response

JSON format

{
  "RequestId": "1234567890ABCDEF",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 3,
  "QuotaRoutineNumber": 20,
  "UsedRoutineNumber": 5,
  "Routines": [
    {
      "RoutineName": "hello",
      "Description": "ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==",
      "CreateTime": "2024-03-11T01:23:02.883361712Z",
      "HasAssets": false,
      "DefaultRelatedRecord": "serverless-test-2.154edaf6.er.aliyun-esa.net"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalOperationError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	ParameterNotExist	The specified parameter does not exist. Check your configurations and try again.	The specified parameter does not exist. Check your configurations and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.