ListEdgeContainerRecords - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the records that are associated with Edge Container for a website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:ListEdgeContainerRecords	get	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	The website ID. You can call the ListSites operation to obtain the ID.	1234567890123
RecordName	string	No	The record name.	a.example.com
RecordMatchType	string	No	The match mode to filter the record names: fuzzy prefix suffix exact (default)	fuzzy
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 500.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Id of the request	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of records returned.	50
Records	array<object>	The records.
recordPageData	object	The queried record.
CreateTime	string	The time when the record was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-12-24T02:01:11Z
UpdateTime	string	The time when the record was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-22T08:32:02Z
RecordName	string	The record name.	a.example.com
RecordCname	string	The CNAME. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured.	a.example.com.cnamezone.com
SiteId	long	The website ID.	1234567890123
SiteName	string	The website name.	example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\n",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 50,
  "Records": [
    {
      "CreateTime": "2023-12-24T02:01:11Z",
      "UpdateTime": "2021-12-22T08:32:02Z",
      "RecordName": "a.example.com",
      "RecordCname": "a.example.com.cnamezone.com",
      "SiteId": 1234567890123,
      "SiteName": "example.com"
    }
  ]
}

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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-18	The Error code has changed	View Change Details