Query Edge Function Routes and Records via ListRoutineRelatedRecords - Edge Security Acceleration

Operation description

Queries the list of related records for a specified edge routine. You can use pagination parameters to retrieve partial results, or use fuzzy keywords to filter specific record entries.

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:ListRoutineRelatedRecords

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the function.	test
PageNumber	integer	No	The page number of the returned page. Default value: 1	1
PageSize	integer	No	The number of entries per page. Valid values: an integer from 1 to 20.	20
SearchKeyWord	string	No	The keyword used for fuzzy search.	hello

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	16
RelatedRecords	array<object>	The list of records associated with the edge function.
	object	The information about the record associated with the function.
RecordName	string	The name of the record.	test-record-1.example.com
SiteId	integer	The website ID.	54362329990032
SiteName	string	The website name.	example.com
RecordId	integer	The record ID of the domain name.	509348423011904

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 16,
  "RelatedRecords": [
    {
      "RecordName": "test-record-1.example.com",
      "SiteId": 54362329990032,
      "SiteName": "example.com",
      "RecordId": 509348423011904
    }
  ]
}

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	DependedByOthers	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	RoutineNotExist	The routine name does not exist. Check the routine name and try again.	The routine name does not exist. Check the routine name and try again.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.