Automate HTTPS Config Retrieval via ESA API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries a specific HTTPS application configuration.

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

get

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can obtain this ID by calling the ListSites operation.	1234567890123
ConfigId	integer	Yes	The configuration ID. You can obtain this ID by calling the listHttpsApplicationConfigurations operation.	352816096987136

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	A3790430-3A06-535F-A424-0998BD9A6C9F
ConfigId	integer	The configuration ID.	352816096987136
ConfigType	string	The configuration type. Valid values: `global`: a global configuration. `rule`: a rule configuration.	global
SiteVersion	integer	The site configuration version number. For sites with configuration versioning enabled, this indicates which version applies. Defaults to `0`.	1
Sequence	integer	The rule execution order. A smaller value indicates a higher priority.	1
RuleEnable	string	Whether the rule is enabled. Not required for global configurations. Valid values: `on`: Enabled. `off`: Disabled.	on
Rule	string	The conditional expression used to match user requests. Not required for global configurations. Two usage scenarios: To match all incoming requests, set the value to `true`. To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.	(http.host eq \"video.example.com\")
RuleName	string	The rule name. Not required for global configurations.	rule_example
HttpsForce	string	Whether force HTTPS is enabled. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
HttpsForceCode	string	The status code for the force HTTPS redirect. Valid values: `301` `302` `307` `308`	301
AltSvc	string	Whether the Alt-Svc feature is enabled. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
AltSvcClear	string	Whether the `clear` parameter is included in the Alt-Svc header. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
AltSvcPersist	string	Whether the `persist` parameter is included in the Alt-Svc header. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
AltSvcMa	string	The Alt-Svc max-age, in seconds. Default: `86400`.	86400
Hsts	string	Whether HSTS is enabled. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
HstsMaxAge	string	The value of the `max-age` directive for HSTS, in seconds.	3600
HstsIncludeSubdomains	string	Whether subdomains are included in the HSTS policy. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
HstsPreload	string	Whether HSTS preload is enabled. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
HttpsSniVerify	string	Whether SNI verification is enabled. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
HttpsNoSniDeny	string	Whether TLS handshakes without SNI are denied. Disabled by default. Valid values: `on`: Enabled. `off`: Disabled.	on
HttpsSniWhitelist	string	The SNI allowlist. Separate multiple values with a space.	abc edf

Examples

Success response

JSON format

{
  "RequestId": "A3790430-3A06-535F-A424-0998BD9A6C9F",
  "ConfigId": 352816096987136,
  "ConfigType": "global",
  "SiteVersion": 1,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \\\"video.example.com\\\")",
  "RuleName": "rule_example",
  "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"
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.