ListHttpsApplicationConfigurations - Edge Security Acceleration

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 HTTPS application 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:ListHttpsApplicationConfigurations	list	*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.	123456****
ConfigId	long	No	Configuration ID.	3528160969****
ConfigType	string	No	Configuration type, which can be used to query global or rule-based configurations. Possible values: global: Query global configuration. rule: Query rule-based configuration. This parameter is optional. If not provided, it will not distinguish between global and rule-based configurations.	global
RuleName	string	No	Rule name, which can be used to find the rule with the specified name.	rule_example
PageNumber	integer	No	Page number, default is 1 if not provided.	1
PageSize	integer	No	Number of items per page, maximum is 500, default is 500 if not provided.	20
SiteVersion	integer	No	Site version number. For sites with version management enabled, this parameter can specify the site version for which the configuration is effective, default is 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 configurations.
configs	object
ConfigId	long	Configuration ID.	395386449776640
SiteVersion	integer	Site configuration version number. For sites with version management enabled, this parameter can specify the site version for which the configuration is effective, default is 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. Possible values: 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-based configurations. Possible values: global: Query global configuration. rule: Query rule-based configuration.	global
HttpsForce	string	Whether to enable forced HTTPS, default is disabled. Possible values: on: Enabled. off: Disabled.	on
HttpsForceCode	string	Forced HTTPS redirect status code. Possible values: 301 302 307 308	301
AltSvc	string	Alt-Svc feature switch, default is off. Value range: on: enabled. off: disabled.	on
AltSvcClear	string	Whether the Alt-Svc header includes the clear parameter, default is off. Values: on: Enabled. off: Disabled.	on
AltSvcPersist	string	Whether the Alt-Svc header includes the persist parameter, default is off. Values: on: Enabled. off: Disabled.	on
AltSvcMa	string	The validity period of Alt-Svc in seconds, default is 86400 seconds.	86400
Hsts	string	Whether HSTS is enabled, default is off. Value range: on: Enabled. off: Disabled.	on
HstsMaxAge	string	The expiration time of HSTS in seconds.	3600
HstsIncludeSubdomains	string	Whether to include subdomains in HSTS, default is off. Value range: on: Enabled. off: Disabled.	on
HstsPreload	string	Whether HSTS preloading is enabled, default is off. Value range: on: Enabled. off: Disabled.	on
PageNumber	integer	Current page number.	1
PageSize	integer	Page size.	10
TotalCount	integer	Total number of records.	16
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",
      "HttpsForce": "on",
      "HttpsForceCode": 301,
      "AltSvc": "on",
      "AltSvcClear": "on",
      "AltSvcPersist": "on",
      "AltSvcMa": 86400,
      "Hsts": "on",
      "HstsMaxAge": 3600,
      "HstsIncludeSubdomains": "on",
      "HstsPreload": "on"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 16,
  "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.