Retrieve HTTPS App Configs with ListHttpsApplicationConfigurations - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Query multiple HTTPS application configurations.

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

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	Site ID. You can obtain it by calling the ListSites API.	123456****
ConfigId	integer	No	Configuration ID.	3528160969****
ConfigType	string	No	Configuration type. You can use this parameter to query global configurations or rule configurations. Valid values: global: Query global configurations. rule: Query rule configurations. This parameter is optional. If not specified, no distinction is made between global and rule configurations. Valid values: rule : Rule configuration global : Global configuration	global
RuleName	string	No	Rule name. You can query the rule whose name matches the specified value.	rule_example
PageNumber	integer	No	The page number for paginated queries. The value must be greater than or equal to 1.	1
PageSize	integer	No	The number of entries per page for paginated queries. Valid values: 1-500.	20
SiteVersion	integer	No	The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: version 0.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Configs	array<object>	Response body configurations.
	object
ConfigId	integer	Configuration ID.	395386449776640
SiteVersion	integer	The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: version 0.	1
Sequence	integer	Rule execution order. A smaller value indicates a higher priority.	1
RuleEnable	string	Rule switch. This parameter does not need to be set when adding a global configuration. Valid values: on: Enabled. off: Disabled.	on
Rule	string	Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios: Match all incoming requests: Set the value to true. Match specified requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")	(http.host eq \"video.example.com\")
RuleName	string	Rule name. This parameter does not need to be set when adding a global configuration.	rule_example
ConfigType	string	Configuration type. You can use this parameter to query global configurations or rule configurations. Valid values: global: Query global configurations. rule: Query rule configurations.	global
HttpsForce	string	Whether to enable forced HTTPS. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
HttpsForceCode	string	Forced HTTPS redirect status code. Valid values: 301 302 307 308	301
AltSvc	string	Alt-Svc feature switch. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
AltSvcClear	string	Whether the Alt-Svc header includes the clear parameter. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
AltSvcPersist	string	Whether the Alt-Svc header includes the persist parameter. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
AltSvcMa	string	Alt-Svc validity period in seconds. Default value: 86400 seconds.	86400
Hsts	string	Whether to enable HSTS. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
HstsMaxAge	string	HSTS expiration time in seconds.	3600
HstsIncludeSubdomains	string	Whether to include subdomains in HSTS. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
HstsPreload	string	Whether to enable HSTS preload. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
HttpsSniVerify	string	Whether to enable SNI verification. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
HttpsNoSniDeny	string	Whether to enable denial of TLS handshake requests without SNI. Disabled by default. Valid values: on: Enabled. off: Disabled.	on
HttpsSniWhitelist	string	Specifies the list of allowed SNI whitelist entries, separated by spaces.	abc edf
PageNumber	integer	Current page number, same as the PageNumber request parameter.	1
PageSize	integer	Page size.	10
TotalCount	integer	Total number of records.	16
TotalPage	integer	Total number of pages.	2

Examples

Success response

JSON format

{
  "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",
      "HttpsSniVerify": "on",
      "HttpsNoSniDeny": "on",
      "HttpsSniWhitelist": "abc edf"
    }
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.