Queries Transport Layer Security (TLS) policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListTLSCipherPolicies

The operation that you want to perform. Set the value to ListTLSCipherPolicies.

RegionId String Yes cn-hangzhou

The ID of the region where the Classic Load Balancer (CLB) instance is deployed.

You can call the DescribeRegions operation to query the most recent region list.

TLSCipherPolicyId String Yes tls-bp17elso1h323r****

The ID of the TLS policy.

Name String No TLSPolicy-test****

The name of the TLS policy. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

IncludeListener Boolean No false

Specifies whether to return the information about the associated listeners. Valid values:

  • true: returns the information about the associated listeners.
  • false (default): does not return the information about the associated listeners.
NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
MaxItems Integer No 20

The maximum number of TLS policies to be queried in this call. Valid values: 1 to 100. If you do not set this parameter, the default value 20 is used.

Response parameters

Parameter Type Example Description
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query. Valid values:

  • If NextToken is empty, it indicates that no next query is to be sent.
  • If NextToken is not empty, the value indicates the token that is used for the next query.
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

The ID of the request.

TotalCount Integer 1000

The total number of TLS policies returned.

IsTruncated Boolean false

Indicates whether the current page is the last page. Valid values:

  • true: The current page is the last page.
  • false: The current page is not the last page.
TLSCipherPolicies Array of TLSCipherPolicy

The list of TLS policies.

Status String normal

The status of the TLS policy. Valid values:

  • configuring: The TLS policy is being configured.
  • normal: The TLS policy works as expected.
InstanceId String tls-bp17elso1h323r****

The ID of the TLS policy.

Name String TLSPolicy-test****

The name of the TLS policy.

CreateTime Long 1608273800000

The timestamp generated when the TLS policy is created.

RelateListeners Array of RelateListener

The list of associated listeners.

Port Integer 80

The listening port. Valid values: 1 to 65535.

Protocol String HTTPS

The listening protocol. Valid values:

  • TCP
  • UDP
  • HTTP
  • HTTPS
LoadBalancerId String lb-bp1b6c719dfa08ex****

The ID of the CLB instance.

TLSVersions Array of String TLSv1.0

The version of the TLS protocol.

Ciphers Array of String ECDHE-ECDSA-AES128-SHA

The cipher suites supported by the TLS version.

TLS 1.0 and TLS 1.1 support the following cipher suites:

  • ECDHE-ECDSA-AES128-SHA
  • ECDHE-ECDSA-AES256-SHA
  • ECDHE-RSA-AES128-SHA
  • ECDHE-RSA-AES256-SHA
  • AES128-SHA AES256-SHA
  • DES-CBC3-SHA

TLS 1.2 supports the following cipher suites:

  • ECDHE-ECDSA-AES128-SHA
  • ECDHE-ECDSA-AES256-SHA
  • ECDHE-RSA-AES128-SHA
  • ECDHE-RSA-AES256-SHA
  • AES128-SHA AES256-SHA
  • DES-CBC3-SHA
  • ECDHE-ECDSA-AES128-GCM-SHA256
  • ECDHE-ECDSA-AES256-GCM-SHA384
  • ECDHE-ECDSA-AES128-SHA256
  • ECDHE-ECDSA-AES256-SHA384
  • ECDHE-RSA-AES128-GCM-SHA256
  • ECDHE-RSA-AES256-GCM-SHA384
  • ECDHE-RSA-AES128-SHA256
  • ECDHE-RSA-AES256-SHA384
  • AES128-GCM-SHA256
  • AES256-GCM-SHA384
  • AES128-SHA256 AES256-SHA256

TLS 1.3 supports the following cipher suites:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_CCM_SHA256
  • TLS_AES_128_CCM_8_SHA256

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTLSCipherPolicies
&RegionId=cn-hangzhou
&TLSCipherPolicyId=tls-bp17elso1h323r****
&Name=TLSPolicy-test****
&IncludeListener=false
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxItems=20
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTLSCipherPoliciesResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <TotalCount>1000</TotalCount>
    <IsTruncated>false</IsTruncated>
    <TLSCipherPolicies>
        <Status>normal</Status>
        <InstanceId>tls-bp17elso1h323r****</InstanceId>
        <Name>TLSPolicy-test****</Name>
        <CreateTime>1608273800000</CreateTime>
        <RelateListeners>
            <Port>80</Port>
            <Protocol>HTTPS</Protocol>
            <LoadBalancerId>lb-bp1b6c719dfa08ex****</LoadBalancerId>
        </RelateListeners>
        <TLSVersions>TLSv1.0</TLSVersions>
        <Ciphers>ECDHE-ECDSA-AES128-SHA</Ciphers>
    </TLSCipherPolicies>
</ListTLSCipherPoliciesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount" : 1000,
  "IsTruncated" : false,
  "TLSCipherPolicies" : [ {
    "Status" : "normal",
    "InstanceId" : "tls-bp17elso1h323r****",
    "Name" : "TLSPolicy-test****",
    "CreateTime" : 1608273800000,
    "RelateListeners" : [ {
      "Port" : 80,
      "Protocol" : "HTTPS",
      "LoadBalancerId" : "lb-bp1b6c719dfa08ex****"
    } ],
    "TLSVersions" : [ "TLSv1.0" ],
    "Ciphers" : [ "ECDHE-ECDSA-AES128-SHA" ]
  } ]
}

Error codes

HttpCode Error code Error message Description
400 QueryTokenInvalid The specified token is invalid. The error message returned because the specified token is invalid. Specify a valid value and try again.
400 QueryTokenNotExist The specified token is not exist. The error message returned because the specified token does not exist.

For a list of error codes, visit the API Error Center.