All Products
Search

This Product

    Edge Security Acceleration:GetHttpsBasicConfiguration

    Document Center

    Edge Security Acceleration:GetHttpsBasicConfiguration

    Last Updated:Jun 25, 2026

    Queries the HTTPS basic configuration for a site.

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

    get

    *Site

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    Yes

    Site ID. Call the ListSites operation to obtain this value.

    123456****
    ConfigId

    integer

    Yes

    Configuration ID. Call the ListHttpsBasicConfigurations operation to obtain this value.

    352816096987136

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Request ID.

    C370DAF1-C838-4288-A1A0-9A87633D2***
    ConfigId

    integer

    Configuration ID.

    352816096987136
    ConfigType

    string

    Configuration type. Valid values:

    • global: Global configuration.

    • rule: Rule-specific configuration.

    global
    Sequence

    integer

    Rule execution sequence.

    1
    RuleEnable

    string

    Whether the rule is enabled. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Rule

    string

    Rule matching expression.

    (http.host eq \"video.example.com\")

    RuleName

    string

    Rule name.

    rule_example
    Https

    string

    Whether HTTPS is enabled. Default: on. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Tls10

    string

    Whether TLS 1.0 is enabled. Default: off. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Tls11

    string

    Whether TLS 1.1 is enabled. Default: off. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Tls12

    string

    Whether TLS 1.2 is enabled. Default: off. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Tls13

    string

    Whether TLS 1.3 is enabled. Default: off. Valid values:

    • on: Enable.

    • off: Disable.

    on
    CiphersuiteGroup

    string

    Cipher suite group. Default: all. Valid values:

    • all: All cipher suites.

    • strict: Strong cipher suites.

    • custom: Custom cipher suites.

    all
    Ciphersuite

    string

    Custom cipher suite. Takes effect when CiphersuiteGroup is set to custom.

    TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
    OcspStapling

    string

    Whether OCSP stapling is enabled. Default: off. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Http2

    string

    Whether HTTP/2 is enabled. Default: on. Valid values:

    • on: Enable.

    • off: Disable.

    on
    Http3

    string

    Whether HTTP/3 is enabled. Default: on. Valid values:

    • on: Enable.

    • off: Disable.

    on

    Examples

    Success response

    JSON format

    {
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D2***",
  "ConfigId": 352816096987136,
  "ConfigType": "global",
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \\\"video.example.com\\\")\n",
  "RuleName": "rule_example",
  "Https": "on",
  "Tls10": "on",
  "Tls11": "on",
  "Tls12": "on",
  "Tls13": "on",
  "CiphersuiteGroup": "all",
  "Ciphersuite": "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
  "OcspStapling": "on",
  "Http2": "on",
  "Http3": "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.