UpdateK8sSlb - Enterprise Distributed Application Service

Call UpdateK8sSlb to update the Server Load Balancer (SLB) instance attached to a Container Service for Kubernetes 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

edas:ManageApplication

update

*Application

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

None

Request syntax

PUT /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. Call ListApplication to get this ID.	5a166fbd-**-**-a286-781659d9f54c
ClusterId	string	Yes	The ID of the cluster. Call GetK8sCluster to get this ID.	712082c3-**-**-9217-a947b5cde6ee
Type	string	Yes	The type of the SLB instance. Internet: An Internet-facing instance. Intranet: An internal-facing instance.	Internet
SlbProtocol	string	No	The protocol of the SLB instance. Currently, only TCP is supported.	TCP
TargetPort	string	No	The backend port, which is the service port of the application. The value ranges from 1 to 65535.	8082
Port	string	No	The frontend port. The value ranges from 1 to 65535.	80
ServicePortInfos	string	No	This parameter is used for scenarios that involve multiple ports or protocols other than TCP. The value must be a JSON array. For 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 ranges from 1 to 65535. Each port number must be unique. targetPort: Required. The backend port. The value ranges from 1 to 65535. loadBalancerProtocol: Required. Only TCP and HTTPS are supported. For HTTP listeners, set this parameter to TCP. certId: This parameter is required for HTTPS listeners. It specifies the ID of a certificate that you can purchase in the SLB console. Note: This parameter is used to support multiple ports and must be used with the appId, clusterId, type, and slbId parameters.	{"targetPort":8080,"port":82,"loadBalancerProtocol":"TCP"},{"port":81,"certId":"136246975637380916c185d6fa21914500329_-xxxxxxx","targetPort":8181,"lo adBalancerProtocol":"HTTPS"}
Specification	string	No	The specification of the SLB instance. The following specifications are supported: slb.s1.small slb.s2.small slb.s2.medium slb.s3.small slb.s3.medium slb.s3.large If you do not set this parameter, the default value is slb.s1.small.	slb.s1.small
Scheduler	string	No	The scheduling algorithm of the SLB instance. If you do not set this parameter, rr is used. The supported algorithms are round-robin (rr) and weighted round-robin (wrr). Weighted round-robin (wrr): Backend servers with higher weights receive more requests. Round-robin (rr): Requests are distributed to backend servers in sequence.	wrr
SlbName	string	No	The name of the SLB instance.	SLB_doctest
DisableForceOverride	boolean	No	Specifies whether to disable overwriting the SLB listener configuration. true: Disables overwriting. false: Allows overwriting.	true

Response elements

Element	Type	Description	Example
	object
ChangeOrderId	string	The ID of the change order.	9a1dcdee-**-**-ad37-cbf9dc91fba9
Code	integer	The HTTP status code.	200
Message	string	The returned message.	success
RequestId	string	The ID of the request.	4823-bhjf-23u4-eiufh

Examples

Success response

JSON format

{
  "ChangeOrderId": "9a1dcdee-****-****-ad37-cbf9dc91fba9",
  "Code": 200,
  "Message": "success",
  "RequestId": "4823-bhjf-23u4-eiufh"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.