ListListenerCertificates - List NLB listener certificates - Server Load Balancer

Lists the certificates of a TCP/SSL listener.

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

get

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The listener ID. The listener must use SSL over TCP.	lsn-j49ht1jxxqyg45****@80
CertType	string	No	The type of the certificate. Valid values: Ca: CA certificate. Server: server certificate.	Ca
NextToken	string	No	The pagination token for the next page. Valid values: Not required for the first request. Use the NextToken value from the previous response.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 20.	20
RegionId	string	No	The region ID of the NLB instance. Call the DescribeRegions operation to query available regions.	cn-hangzhou
CertificateIds	array	No	The server certificate. Only one server certificate is supported. Note This parameter takes effect only for TCP/SSL listeners.
	string	No	The server certificate. Only one server certificate is supported. Note This parameter takes effect only for TCP/SSL listeners.	123157******

Response elements

Element	Type	Description	Example
	object	Lists the certificates of a TCP/SSL listener.
RequestId	string	The request ID.	2198BD6D-9EBB-5E1C-9C48-E0ABB79CF831
CertificateIds	array	The server certificates.
	string	The server certificates.	[ "931****-cn-hangzhou"]
Certificates	array<object>	The certificates.
	object	The certificate.
CertificateId	string	The certificate ID. Only one server certificate is supported.	12315790343_166f8204689_1714763408_70998****
IsDefault	boolean	Whether the certificate is the default listener certificate. Valid values: true false	true
Status	string	The association status of the certificate. Valid values: Associating Associated Diassociating	Associating
CertificateType	string	The type of the certificate.	Server
TotalCount	integer	The total number of entries returned.	1
NextToken	string	The pagination token for the next page. Valid values: Not required for the first request. Use the NextToken value from the previous response.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries per page. Valid values: 1 to 50. Default value: 20.	20

Examples

Success response

JSON format

{
  "RequestId": "2198BD6D-9EBB-5E1C-9C48-E0ABB79CF831",
  "CertificateIds": [
    "[ \"931****-cn-hangzhou\"]"
  ],
  "Certificates": [
    {
      "CertificateId": "12315790343_166f8204689_1714763408_70998****",
      "IsDefault": true,
      "Status": "Associating",
      "CertificateType": "Server"
    }
  ],
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

Error codes

HTTP status code	Error code	Error message
400	OperationDenied.Protocol	The operation is not allowed because of %s.
400	IllegalParam.%s	The param of %s is illegal.
404	ResourceNotFound.loadbalancer	The specified resource %s is not found.
404	ResourceNotFound.listener	The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.