All Products
Search

This Product

    Web Application Firewall:DescribeDefaultHttps

    Document Center

    Web Application Firewall:DescribeDefaultHttps

    Last Updated:Jul 31, 2026

    Queries the default SSL/TLS settings.

    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

    yundun-waf:DescribeDefaultHttps

    get

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the WAF instance.

    Note

    You can call DescribeInstance to query the ID of the current WAF instance.

    waf-cn-7pp26f1****
    RegionId

    string

    No

    The region where the WAF instance is deployed. Valid values:

    • cn-hangzhou: the Chinese mainland.

    • ap-southeast-1: outside the Chinese mainland.

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    No

    The Alibaba Cloud resource group ID.

    rg-acfm***q

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    F35F45B0-5D6B-4238-BE02-A62D****E840
    DefaultHttps

    object

    The default SSL/TLS settings.

    CustomCiphers

    string

    The custom cipher suites.

    ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384
    TLSVersion

    string

    The TLS version. Valid values:

    • tlsv1: TLS 1.0 and later are supported. This value provides the highest compatibility and the lowest security.

    • tlsv1.1: TLS 1.1 and later are supported. This value provides good compatibility and security.

    • tlsv1.2: TLS 1.2 and later are supported. This value provides good compatibility and the highest security.

    • tlsv1.3: Only TLS 1.3 is supported. This value provides the highest security and the lowest compatibility.

    tlsv1
    CertId

    string

    The ID of the certificate.

    123-cn-hangzhou
    CipherSuite

    string

    The type of the cipher suite. Valid values:

    • 1: All cipher suites are added.

    • 2: Strong cipher suites are added. This value is available only when TLSVersion is set to tlsv1.2.

    • 99: Custom cipher suites are added. This value is available only when TLSVersion is not set to tlsv1.3.

    1
    EnableTLSv3

    boolean

    Indicates whether TLS 1.3 is supported. Valid values:

    • true: TLS 1.3 is supported.

    • false: TLS 1.3 is not supported.

    Note

    This parameter takes effect only when HttpsPorts is not empty, which indicates that the domain name uses the HTTPS protocol. When TLSVersion is set to tlsv1.3, this value must be true.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D****E840",
  "DefaultHttps": {
    "CustomCiphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384",
    "TLSVersion": "tlsv1",
    "CertId": "123-cn-hangzhou",
    "CipherSuite": "1",
    "EnableTLSv3": true
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.