ListOriginRules - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query multiple origin rule configurations

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ListOriginRules	none	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	Site ID, which can be obtained by calling the ListSites interface.	1234567890123
ConfigId	long	No	Configuration ID.	35281609698****
ConfigType	string	No	Configuration type, which can be used to query global or rule configurations. Value range: global: Query global configuration. rule: Query rule configuration. This parameter is optional; if not provided, it does not distinguish between global and rule configurations.	global
RuleName	string	No	Rule name. This parameter is not required when adding a global configuration.	test
PageNumber	integer	No	Page number, defaulting to 1 if not provided.	1
PageSize	integer	No	Number of items per page, with a maximum of 500. Defaults to 500 if not provided.	20
SiteVersion	integer	No	Version number of the site. For sites with version management enabled, this parameter can specify the version of the site for which the configuration is effective, defaulting to version 0.	1

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Configs	array<object>	Response body configuration.
configs	object
ConfigId	long	Configuration ID.	395386449776640
SiteVersion	integer	Version number of the site configuration. For sites with version management enabled, this parameter can specify the version of the site for which the configuration is effective, defaulting to version 0.	1
Sequence	integer	Rule execution order. The smaller the value, the higher the priority.	1
RuleEnable	string	Rule switch. This parameter is not required when adding a global configuration. Value range: on: Enabled. off: Disabled.	on
Rule	string	Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios: Match all incoming requests: Set the value to true Match specific requests: Set the value to a custom expression, e.g., (http.host eq "video.example.com")	(http.host eq \"video.example.com\")
RuleName	string	Rule name. This parameter is not required when adding a global configuration.	rule_example
ConfigType	string	Configuration type, which can be used to query global or rule configurations. Value range: global: Query global configuration. rule: Query rule configuration.	global
OriginHost	string	HOST carried in the origin request.	origin.example.com
OriginScheme	string	Protocol used for the origin request. Value range: http: Use HTTP protocol for origin. https: Use HTTPS protocol for origin. follow: Follow the client's protocol for origin.	http
OriginSni	string	SNI carried in the back-to-origin request.	origin.example.com
DnsRecord	string	Rewrite the DNS resolution record for the origin request.	test.example.com
OriginHttpPort	string	The port of the origin server to access when using the HTTP protocol for origin requests.	8080
OriginHttpsPort	string	The port of the origin server to access when using the HTTPS protocol for origin requests.	4433
Range	string	Use range slicing to download files from the origin. Value range: on: Enable off: Disable force: Force	on
OriginMtls	string	mTLS switch. Value range: on: Enable. off: Disable.	on
OriginVerify	string	Origin certificate verification switch. Value range: on: Enable. off: Disable.	on
PageNumber	integer	Current page number.	1
PageSize	integer	Page size.	10
TotalCount	integer	Total number of records.	100
TotalPage	integer	Total number of pages.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")\n",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "OriginHost": "origin.example.com\n",
      "OriginScheme": "http",
      "OriginSni": "origin.example.com",
      "DnsRecord": "test.example.com\n",
      "OriginHttpPort": 8080,
      "OriginHttpsPort": 4433,
      "Range": "on",
      "OriginMtls": "on",
      "OriginVerify": "on"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "TotalPage": 2
}

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.FunctionName	The specified feature does not exist. Specify a valid feature name based on the related documentation.	The specified feature does not exist. Specify a valid feature name based on the related documentation.

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

Change history

Change time	Summary of changes	Operation
2025-02-27	The Error code has changed. The response structure of the API has changed	View Change Details