BindNlb - Serverless App Engine - Alibaba Cloud Documentation Center

Associates a Network Load Balancer (NLB) instance with an application.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
sae:BindNlb	create	All Resources ``	none	none

Request syntax

POST /pop/v1/sam/app/nlb HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The ID of the application to which the NLB instance is bound.	7171a6ca-d1cd-4928-8642-7d5cfe69****
NlbId	string	No	The ID of the NLB instance.	nlb-7z7jjbzz44d82c9***
Listeners	string	No	The listener that you want to manage. The value is a string that consists of JSON arrays. Each listener contains the following fields: port: the port number of the NLB listener. This field is required. Data type: integer. Valid values: 0 to 65535. TargetPort: the port number of the container listener. This field is required. Data type: integer. Valid values: 0 to 65535. Protocol: the listener protocol. This field is required. Data type: string. Valid values: TCP, UDP, and TCPSSL. CertIds: the IDs of the server certificates. This field is optional. Data type: string. This field is supported only by TCPSSL listeners.
ZoneMappings	string	No	The mappings between zones and vSwitches. The value is a JSON string. You can specify at most 10 zones. If the region supports two or more zones, specify at least two zones. A ZoneMapping contains the following fields: The ID of the vSwitch in the zone. Each zone can contain only one vSwitch and one subnet. Data type: string. The zone ID of the NLB instance. Data type: string.	vsw-sersdf**** cn-hangzhou-a
AddressType	string	No	The type of the IP addresses. Valid values: Internet: public endpoint. Intranet: private endpoint.	Internet

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned. Valid values: If the request was successful, success is returned. If the request failed, an error code is returned.	success
TraceId	string	The ID of the trace. The ID is used to query the details of a request.	0a06dfe717389800573793090e0589
Data	object	The returned data.
ChangeOrderId	string	The ID of the change order. The ID can be used to query the status of the change task.	ba386059-69b1-4e65-b1e5-0682d9fa****
ErrorCode	string	The status code. Value values: If the request was successful, ErrorCode is not returned. If the request failed, ErrorCode is returned. For more information, see Error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the applications were stopped. Valid values: true: The applications were stopped. false: The applications failed to be stopped.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a06dfe717389800573793090e0589",
  "Data": {
    "ChangeOrderId": "ba386059-69b1-4e65-b1e5-0682d9fa****"
  },
  "ErrorCode": "",
  "Code": 200,
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.