All Products
Search
Document Center

Enterprise Distributed Application Service:BindK8sSlb

Last Updated:Sep 15, 2025

Attaches a Server Load Balancer (SLB) instance to an application in a Container Service for Kubernetes cluster.

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

edas:SLBPurchase

get

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

None None

Request syntax

POST /pop/v5/k8s/acs/k8s_slb_binding HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AppId

string

Yes

The ID of the application.

5a166fbd-****-****-a286-781659d9f54c

ClusterId

string

No

The ID of the cluster.

712082c3-f554-****-****-a947b5cde6ee

Type

string

Yes

The type of the SLB instance.

  • internet: an internet-facing SLB instance.

  • intranet: an internal-facing SLB instance.

internet

SlbId

string

No

The ID of the SLB instance. If you do not specify this parameter, EDAS automatically purchases a new SLB instance.

lb-2ze1quax9t****iz82bjt

SlbProtocol

string

No

The frontend protocol for the SLB instance. Valid values: TCP, HTTP, and HTTPS.

TCP

TargetPort

string

No

The backend port. This port is also the service port of the application. The value must be an integer from 1 to 65,535.

8080

Port

string

No

The frontend port. The value must be an integer from 1 to 65,535.

80

ServicePortInfos

string

No

The information about the service ports. Use this parameter to configure multiple listeners or use protocols other than TCP. This parameter must be a JSON array. Example: [{"targetPort":8080,"port":82,"loadBalancerProtocol":"TCP"},{"port":81,"certId":"1362469756373809_16c185d6fa2_1914500329_-xxxxxxx","targetPort":8181,"loadBalancerProtocol":"HTTPS"}]

  • port: Required. The frontend port. The value must be an integer from 1 to 65,535. Each port number must be unique.

  • targetPort: Required. The backend port. The value must be an integer from 1 to 65,535.

  • loadBalancerProtocol: Required. The frontend protocol. Valid values: TCP and HTTPS. For HTTP, use TCP.

  • certId: Required if you use the HTTPS protocol. You can purchase a certificate in the SLB console.

Note

This parameter is used to configure multiple listeners. You must use it with the appId, clusterId, type, and slbId parameters.

[{"targetPort":8080,"port":82,"loadBalancerProtocol":"TCP"},{"port":81,"certId":"136246975637380916c185d6fa21914500329_-988as","targetPort":8181,"lo adBalancerProtocol":"HTTPS"}]

Specification

string

No

The specification of the SLB instance.

  • slb.s1.small

  • slb.s2.small

  • slb.s2.medium

  • slb.s3.small

  • slb.s3.medium

  • slb.s3.large

slb.s1.small

Scheduler

string

No

The scheduling algorithm. If you do not specify this parameter, `rr` is used. Valid values:

  • wrr: weighted round-robin. Backend servers with higher weights receive more requests.

  • rr: round-robin. Requests are distributed to backend servers in sequence.

wrr

Response elements

Element

Type

Description

Example

object

ChangeOrderId

string

The ID of the change process.

b4b37bde-a125-****-****-741f7f4a9ae3

Code

integer

The response code.

200

Message

string

The message that is returned.

success

RequestId

string

The ID of the request.

4823-bhjf-23u4-****

Examples

Success response

JSON format

{
  "ChangeOrderId": "b4b37bde-a125-****-****-741f7f4a9ae3",
  "Code": 200,
  "Message": "success",
  "RequestId": "4823-bhjf-23u4-****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.