BindSlb - - Alibaba Cloud Documentation Center

Associates a Server Load Balancer (SLB) 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:
- The required resource types are displayed in bold characters.
- 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:BindSlb	create	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	0099b7be-5f5b-4512-a7fc-56049ef1****	0099b7be-5f5b-4512-a7fc-56049ef1****
Internet	string	No	[{"port":80,"targetPort":8080,"protocol":"TCP"}]	[{"port":80,"targetPort":8080,"protocol":"TCP"}]
Intranet	string	No	[{"port":80,"targetPort":8080,"protocol":"TCP"}]	[{"port":80,"targetPort":8080,"protocol":"TCP"}]
InternetSlbId	string	No	lb-bp1tg0k6d9nqaw7l1****	lb-bp1tg0k6d9nqaw7l1****
IntranetSlbId	string	No	lb-bp1tg0k6d9nqaw7l1****	lb-bp1tg0k6d9nqaw7l1****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message.	success
TraceId	string	The ID of the trace. It can be used to query the details of a request.	0a98a02315955564772843261e****
Data	object	The returned data.
ChangeOrderId	string	The ID of the change order. It can be used to query the task status.	01db03d3-3ee9-48b3-b3d0-dfce2d88****
ErrorCode	string	The error code. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request was invalid. 5xx: indicates that a server error occurred.	200
Success	boolean	Indicates whether the SLB instance was successfully associated with the application. Valid values: true: The SLB instance was successfully associated with the application. false: The SLB instance could not be associated with the application.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ChangeOrderId": "01db03d3-3ee9-48b3-b3d0-dfce2d88****"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Slb.NotFound	The SLB instance does not exist: slbId [%s]	-
400	InvalidApplication.NotFound	The current application does not exist.	-
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	-
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	-
400	SlbHttpsCert.NotConsistent	The HTTPS listening certificate for each listener must match.	-
400	SlbHttpsCert.NotFound	You must configure the certificate before you configure HTTPS listening for the SLB instance.	-
400	SlbListenerPort.NotAvailable	The SLB listening port is unavailable: slbId [%s], port [%s]	-
400	SlbListenerType.Invalid	An SLB listener type error occurred. Only HTTPS and TCP are supported.	-
400	SlbSpec.NotSupport	Shared performance SLB instances are not supported.	-
400	SlbType.Invalid	An SLB network type error occurred.	-
400	SSLCert.NotFound	The specified SSL certificate cannot be found.	-
400	System.Upgrading	The system is being upgraded. Please try again later.	-
400	Application.ChangerOrderRunning	An application change process is in progress. Please try again later.	An application change process is in progress. Please try again later.
400	Application.InvalidStatus	The application status is abnormal. Please try again later.	The application status is abnormal. Please try again later.
400	Application.NotDeployYet	The application has not been deployed. Please deploy it and try again.	The application has not been deployed. Please deploy it and try again.
400	InvalidParam.ProtocolNotSupport	Only TCP protocol is supported.	Only TCP protocol is supported.
400	SLBInstanceQuota.OverQuota	The total number of SLB instances exceeds the quota. Please reduce the instances and try again.	The total number of SLB instances exceeds the quota. Please reduce the instances and try again.
400	Slb.Tag.Not.Qualified	The current SLB instance cannot be reused because it may have been occupied by %s.	The current SLB instance cannot be reused because it may have been occupied by %s.
400	Application.NoInstanceAvailable	No instance is available for the application. Please scale out and try again.	No instance is available for the application. Please scale out and try again.
400	SlbAppVSwitch.NotMatch	The SLB instance does not match the vSwitch of the current application.	The specified vSwitch does not exist. Please change the vSwitch.
404	InvalidAppId.NotFound	The specified AppId does not exist.	-

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

Change history

Change time	Summary of changes	Operation
2024-08-07	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-02-25	The Error code has changed	View Change Details