ListSecurityPolicy - Query TLS security policies | NLB API - Server Load Balancer

Queries TLS security policies of an NLB instance.

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

nlb:ListSecurityPolicy

get

*SecurityPolicy

acs:nlb:{#regionId}:{#accountId}:securitypolicy/*

None

Request parameters

Parameter	Type	Required	Description	Example
SecurityPolicyIds	array	No	The TLS security policy IDs. You can specify up to 20 IDs per call.
	string	No	The TLS security policy ID. You can specify up to 20 IDs per call.	tls-bp14bb1e7dll4f****
SecurityPolicyNames	array	No	The TLS security policy names. You can specify up to 20 names.
	string	No	The TLS security policy name. You can specify up to 20 names.	TLSCipherPolicy
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The tag key. You can specify up to 10 tag keys. Maximum length: 64 characters. Cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	Test
Value	string	No	The tag value. You can specify up to 10 tag values. Maximum length: 128 characters. Cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	Test
ResourceGroupId	string	No	The resource group ID.	rg-atstuj3rtop****
NextToken	string	No	The pagination token for the next page of results. Valid values: Not required for the first request. Set to the NextToken value from the previous response.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default: 20.	20
RegionId	string	No	The NLB instance region ID. Call DescribeRegions to query available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The queried TLS security policies.
RequestId	string	The request ID.	D7A8875F-373A-5F48-8484-25B07A61F2AF
SecurityPolicies	array<object>	The TLS security policies.
	array<object>	The TLS security policy.
SecurityPolicyId	string	The TLS security policy ID.	tls-bp14bb1e7dll4f****
SecurityPolicyName	string	The TLS security policy name.	TLSCipherPolicy
TlsVersion	string	The TLS protocol versions. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, and TLSv1.3.	TLSv1.0
Ciphers	string	The supported cipher suites. Valid values vary by TlsVersion. Maximum: 32 cipher suites. TLSv1.0 and TLSv1.1: ECDHE-ECDSA-AES128-SHA ECDHE-ECDSA-AES256-SHA ECDHE-RSA-AES128-SHA ECDHE-RSA-AES256-SHA AES128-SHA AES256-SHA DES-CBC3-SHA TLSv1.2: 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 TLSv1.3: 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	ECDHE-ECDSA-AES128-SHA
RegionId	string	The NLB instance region ID.	cn-hangzhou
Tags	array<object>	The tags.
	object
Key	string	The tag key. You can specify up to 10 tag keys. Maximum length: 64 characters. Cannot contain `http://` or `https://`, or start with `aliyun` or `acs:`.	Test
Value	string	The tag value. You can specify up to 10 tag values. Maximum length: 128 characters. Cannot contain `http://` or `https://`, or start with `aliyun` or `acs:`.	Test
RelatedListeners	array<object>	The associated listeners.
	object	The associated listener.
ListenerId	string	The listener ID.	lsn-bp1bpn0kn908w4nbw****@443
ListenerPort	integer	The listener port.	443
ListenerProtocol	string	The listener protocol. Valid value: TCPSSL.	TCPSSL
LoadBalancerId	string	The NLB instance ID.	nlb-83ckzc8d4xlp8o****
ResourceGroupId	string	The resource group ID.	rg-atstuj3rtop****
SecurityPolicyStatus	string	The TLS security policy status. Valid values: Configuring Available	Available
TotalCount	integer	The total number of entries.	10
NextToken	string	The pagination token for the next page. Valid values: Empty: no more pages. Non-empty: use this value as NextToken in the next request.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries per page.	20

Examples

Success response

JSON format

{
  "RequestId": "D7A8875F-373A-5F48-8484-25B07A61F2AF",
  "SecurityPolicies": [
    {
      "SecurityPolicyId": "tls-bp14bb1e7dll4f****",
      "SecurityPolicyName": "TLSCipherPolicy",
      "TlsVersion": "TLSv1.0",
      "Ciphers": "ECDHE-ECDSA-AES128-SHA",
      "RegionId": "cn-hangzhou",
      "Tags": [
        {
          "Key": "Test",
          "Value": "Test"
        }
      ],
      "RelatedListeners": [
        {
          "ListenerId": "lsn-bp1bpn0kn908w4nbw****@443",
          "ListenerPort": 443,
          "ListenerProtocol": "TCPSSL",
          "LoadBalancerId": "nlb-83ckzc8d4xlp8o****"
        }
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "SecurityPolicyStatus": "Available"
    }
  ],
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

Error codes

HTTP status code	Error code	Error message	Description
400	SystemBusy	System is busy, please try again later.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.