All Products
Search

This Product

    Edge Security Acceleration:ListHttpsBasicConfigurations

    Document Center

    Edge Security Acceleration:ListHttpsBasicConfigurations

    Last Updated:Apr 16, 2025
    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 basic 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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    esa:ListHttpsBasicConfigurationsnone
    *Site
    acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SiteIdlongYes

    Site ID, which can be obtained by calling the ListSites interface.

    		123456****
    ConfigIdlongNo

    Configuration ID.

    		35281609698****
    ConfigTypestringNo

    Configuration type, which can be used to query global or rule configurations. Value range:

    • global: Query global configuration.
    • rule: Query rule configuration.

    This parameter is optional. If not provided, it does not distinguish between global and rule configurations.

    		global
    RuleNamestringNo

    Rule name, which can be used to find the rule with the specified name.

    		test
    PageNumberintegerNo

    Page number, default is 1 if not provided.

    		1
    PageSizeintegerNo

    Number of items per page, maximum is 500, default is 500 if not provided.

    		20

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    Request ID.

    		EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
    Configsarray<object>

    Response body configuration.

    configsobject
    ConfigIdlong

    Configuration ID.

    		395386449776640
    Sequenceinteger

    Rule execution order. The smaller the value, the higher the priority.

    		1
    RuleEnablestring

    Rule switch. This parameter is not required when adding a global configuration. Value range:

    • on: Enable.
    • off: Disable.
    		on
    Rulestring

    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, for example: (http.host eq "video.example.com")
    		(http.host eq \"video.example.com\")
    RuleNamestring

    Rule name. This parameter is not required when adding a global configuration.

    		rule_example
    ConfigTypestring

    Configuration type, which can be used to query global or rule configurations. Value range:

    • global: Query global configuration.
    • rule: Query rule configuration.
    		global
    Httpsstring

    Whether to enable HTTPS, default is enabled. Value range:

    • on: Enable.
    • off: Disable.
    		on
    Tls10string

    Whether to enable TLS1.0, default is disabled. Value range:

    • on: Enable.
    • off: Disable.
    		on
    Tls11string

    Whether to enable TLS1.1, default is disabled. Value range:

    • on: Enable.
    • off: Disable.
    		on
    Tls12string

    Whether to enable TLS1.2, default is disabled. Value range:

    • on: Enable.
    • off: Disable.
    		on
    Tls13string

    Whether to enable TLS1.3, default is disabled. Value range:

    • on: Enable.
    • off: Disable.
    		on
    CiphersuiteGroupstring

    Ciphersuite group, defaults to enabling all ciphersuites. Value range:

    • all: all ciphersuites.
    • strict: strong ciphersuites.
    • custom: custom ciphersuites.
    		strict
    Ciphersuitestring

    Custom ciphersuite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.

    		TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
    OcspStaplingstring

    Whether to enable OCSP, default is off. Value range:

    • on: enabled.
    • off: disabled.
    		on
    Http2string

    Whether to enable HTTP2, default is on. Value range:

    • on: enabled.
    • off: disabled.
    		on
    Http3string

    Whether to enable HTTP3, default is on. Value range:

    • on: enabled.
    • off: disabled.
    		on
    PageNumberinteger

    Current page number.

    		1
    PageSizeinteger

    Page size.

    		10
    TotalCountinteger

    Total number of records.

    		20
    TotalPageinteger

    Total number of pages.

    		2

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")\n",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "Https": "on",
      "Tls10": "on",
      "Tls11": "on",
      "Tls12": "on",
      "Tls13": "on",
      "CiphersuiteGroup": "strict",
      "Ciphersuite": "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
      "OcspStapling": "on",
      "Http2": "on",
      "Http3": "on"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "TotalPage": 2
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
    400InvalidParameter.FunctionNameThe 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.