BindSlb - Bind an SLB instance to a SAE application - Serverless App Engine

Binds a Server Load Balancer (SLB) instance to the application.

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

sae:BindSlb

create

*All Resource

*

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****
InternetSlbChargeType	string	No	Billing method for the Internet-facing SLB instance. Valid values: PayBySpec: Pay-by-specification. PayByCLCU: Pay-by-CLCU.	PayBySpec
IntranetSlbChargeType	string	No	Billing method for the internal-facing SLB instance. Valid values: PayBySpec: Pay-by-specification. PayByCLCU: Pay-by-CLCU.	PayBySpec

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The response message.	success
TraceId	string	The trace ID. Use it to query request details.	0a98a02315955564772843261e****
Data	object	The response data.
ChangeOrderId	string	The change order ID. Use it to query task status.	01db03d3-3ee9-48b3-b3d0-dfce2d88****
ErrorCode	string	The error code. Not returned on success. Returned on failure. The Error codes section lists possible values.	N/A
Code	string	The HTTP status code. Valid values: 2xx: Success. 3xx: Redirection. 4xx: Client error. 5xx: Server error.	200
Success	boolean	Whether the SLB instance was bound to the application. Valid values: true: Binding succeeded. false: Binding failed.	true

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.