GetHttpsApplicationConfiguration - 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 a Single HTTPS Application Configuration

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:GetHttpsApplicationConfiguration	get	*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	Yes	ConfigId of the configuration, which can be obtained by calling the listHttpsApplicationConfigurations interface.	352816096987136

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	A3790430-3A06-535F-A424-0998BD9A6C9F
ConfigId	long	Configuration ID.	352816096987136
ConfigType	string	Configuration type, which can be used to query global or rule configurations. Possible values: global: Query global configuration. rule: Query rule configuration.	global
SiteVersion	integer	Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site for which the configuration takes effect. The 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 does not need to be set when adding a global configuration. Possible values: on: Enable. off: Disable.	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 specific 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
HttpsForce	string	Whether to enable forced HTTPS. Default is disabled. Possible values: on: Enable. off: Disable.	on
HttpsForceCode	string	Status code for forced HTTPS redirection. Possible values: 301 302 307 308	301
AltSvc	string	Alt-Svc feature switch. Default is disabled. Possible values: on: Enable. off: Disable.	on
AltSvcClear	string	Whether the Alt-Svc header includes the clear parameter. Default is disabled. Possible values: on: Enable. off: Disable.	on
AltSvcPersist	string	Whether the Alt-Svc header includes the persist parameter. Default is disabled. Possible values: on: Enable. off: Disable.	on
AltSvcMa	string	Alt-Svc validity period in seconds. The default is 86400 seconds.	86400
Hsts	string	Whether to enable HSTS. Default is disabled. Possible values: on: Enable. off: Disable.	on
HstsMaxAge	string	HSTS expiration time in seconds.	3600
HstsIncludeSubdomains	string	Whether to include subdomains in HSTS, default is off. Value range: on: enabled. off: disabled.	on
HstsPreload	string	Whether to enable HSTS preload, default is off. Value range: on: enabled. off: disabled.	on

Examples

Sample success responses

JSONformat

{
  "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"
}

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.