API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Slb/2014-05-15) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Query resources
|
API |
Title |
Description |
| DescribeAvailableResource | DescribeAvailableResource | Queries the available resources and resources that are available for purchase in the zones of a region. |
Region and zone management
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries available regions. |
| DescribeZones | DescribeZones | Queries the zones in a region. |
Classic Load Balancer instances
|
API |
Title |
Description |
| CreateLoadBalancer | CreateLoadBalancer | Creates a Classic Load Balancer (CLB) instance. |
| DeleteLoadBalancer | DeleteLoadBalancer | Deletes a pay-as-you-go Server Load Balancer (SLB) instance. |
| ModifyLoadBalancerInstanceSpec | Modify the specification of a CLB instance | Modifies the specification of a CLB instance. |
| ModifyLoadBalancerInternetSpec | ModifyLoadBalancerInternetSpec | Modifies the metering method of an Internet-facing Classic Load Balancer (CLB) instance. |
| ModifyLoadBalancerPayType | ModifyLoadBalancerPayType | Changes the billing method of a Classic Load Balancer (CLB) instance from pay-as-you-go to subscription. |
| SetLoadBalancerDeleteProtection | SetLoadBalancerDeleteProtection | Enables or disables deletion protection for an SLB instance. |
| SetLoadBalancerModificationProtection | SetLoadBalancerModificationProtection | Enable or disable the configuration read-only mode for a Classic Load Balancer (CLB) instance. |
| SetLoadBalancerName | SetLoadBalancerName | Changes the name of a Classic Load Balancer (CLB) instance. |
| SetLoadBalancerStatus | SetLoadBalancerStatus | Modifies the state of a Classic Load Balancer (CLB) instance. |
| ModifyLoadBalancerInstanceChargeType | ModifyLoadBalancerInstanceChargeType | Changes the metering method of a pay-as-you-go Classic Load Balancer (CLB) instance. |
| DescribeLoadBalancerAttribute | DescribeLoadBalancerAttribute | Queries the detail of a Classic Load Balancer (CLB) instance. |
| DescribeLoadBalancers | DescribeLoadBalancers | Queries Classic Load Balancer (CLB) instances. |
Listeners
|
API |
Title |
Description |
| DeleteLoadBalancerListener | DeleteLoadBalancerListener | Deletes a listener. |
| StartLoadBalancerListener | StartLoadBalancerListener | Enables a listener. |
| StopLoadBalancerListener | StopLoadBalancerListener | Stops a listener. |
| DescribeLoadBalancerListeners | DescribeLoadBalancerListeners | Queries the listeners of a Classic Load Balancer (CLB) instance. |
TCP listeners
|
API |
Title |
Description |
| CreateLoadBalancerTCPListener | CreateLoadBalancerTCPListener | Creates a TCP listener. |
| SetLoadBalancerTCPListenerAttribute | SetLoadBalancerTCPListenerAttribute | Modifies the configurations of a TCP listener of Classic Load Balancer (CLB). |
| DescribeLoadBalancerTCPListenerAttribute | DescribeLoadBalancerTCPListenerAttribute | Queries the configurations of a TCP listener of Classic Load Balancer (CLB). |
UDP listeners
|
API |
Title |
Description |
| CreateLoadBalancerUDPListener | CreateLoadBalancerUDPListener | Creates a UDP listener. |
| SetLoadBalancerUDPListenerAttribute | SetLoadBalancerUDPListenerAttribute | Modifies the configurations of a UDP listener. |
| DescribeLoadBalancerUDPListenerAttribute | DescribeLoadBalancerUDPListenerAttribute | Queries the configurations of a UDP listener. |
HTTP listeners
|
API |
Title |
Description |
| CreateLoadBalancerHTTPListener | CreateLoadBalancerHTTPListener | Creates an HTTP listener for a Classic Load Balancer (CLB) instance. |
| SetLoadBalancerHTTPListenerAttribute | SetLoadBalancerHTTPListenerAttribute | Modifies the configurations of an HTTP listener. |
| DescribeLoadBalancerHTTPListenerAttribute | DescribeLoadBalancerHTTPListenerAttribute | Queries the configurations of an HTTP listener. |
HTTPS listeners
|
API |
Title |
Description |
| CreateLoadBalancerHTTPSListener | CreateLoadBalancerHTTPSListener | Creates an HTTPS listener. |
| SetLoadBalancerHTTPSListenerAttribute | SetLoadBalancerHTTPSListenerAttribute | Modifies the configurations of an HTTPS listener. |
| DescribeLoadBalancerHTTPSListenerAttribute | DescribeLoadBalancerHTTPSListenerAttribute | Queries the configurations of an HTTPS listener. |
Forwarding rules
|
API |
Title |
Description |
| CreateRules | CreateRules | Creates forwarding rules for an HTTP or HTTPS listener. |
| SetRule | SetRule | Modifies a forwarding rule that is associated with a vServer group. |
| DeleteRules | DeleteRules | Deletes forwarding rules. |
| DescribeRuleAttribute | DescribeRuleAttribute | Queries the configurations of a specified forwarding rule. |
| DescribeRules | DescribeRules | Queries the forwarding rules that are configured for a specified listener. |
Default server group
|
API |
Title |
Description |
| AddBackendServers | AddBackendServers | Adds backend servers. |
| DescribeHealthStatus | DescribeHealthStatus | Queries the health status of backend servers. |
| RemoveBackendServers | RemoveBackendServers | Removes backend servers. |
| SetBackendServers | SetBackendServers | Specifies weights for backend servers. |
vServer groups
|
API |
Title |
Description |
| CreateVServerGroup | CreateVServerGroup | Creates a vServer group and adds backend servers to the vServer group. |
| DeleteVServerGroup | DeleteVServerGroup | Deletes a VServer group. |
| SetVServerGroupAttribute | SetVServerGroupAttribute | Modifies the configurations of a vServer group. |
| DescribeVServerGroups | DescribeVServerGroups | Queries vServer groups. |
| DescribeVServerGroupAttribute | DescribeVServerGroupAttribute | Queries the detailed information about a vServer group. |
| AddVServerGroupBackendServers | AddVServerGroupBackendServers | Adds backend servers to a vServer group. |
| ModifyVServerGroupBackendServers | ModifyVServerGroupBackendServers | Replaces backend servers in a vServer group. |
| RemoveVServerGroupBackendServers | RemoveVServerGroupBackendServers | Removes backend servers from a vServer group. |
Primary secondary server groups
|
API |
Title |
Description |
| CreateMasterSlaveServerGroup | CreateMasterSlaveServerGroup | Creates a primary/secondary server group. Each primary/secondary server group consists of two backend servers. One backend server functions as the primary server, and the other backend server functions as the secondary backend server. |
| DeleteMasterSlaveServerGroup | DeleteMasterSlaveServerGroup | Deletes a primary/secondary server group. |
| DescribeMasterSlaveServerGroupAttribute | DescribeMasterSlaveServerGroupAttribute | Queries the detailed information about a primary/secondary server group. |
| DescribeMasterSlaveServerGroups | DescribeMasterSlaveServerGroups | Queries primary/secondary server groups. |
Certificates
|
API |
Title |
Description |
| DeleteCACertificate | DeleteCACertificate | Deletes a certificate authority (CA) certificate. |
| DeleteServerCertificate | DeleteServerCertificate | Deletes a server certificate. |
| SetCACertificateName | SetCACertificateName | Specifies a name for a CA certificate. |
| SetServerCertificateName | SetServerCertificateName | Sets a name for a server certificate. |
| DescribeCACertificates | DescribeCACertificates | Queries certificate authority (CA) certificates. |
| DescribeServerCertificates | DescribeServerCertificates | Queries the server certificates in a region. |
| UploadCACertificate | UploadCACertificate | Uploads a CA certificate. |
| UploadServerCertificate | UploadServerCertificate | Uploads a server certificate. |
Domain name extensions
|
API |
Title |
Description |
| CreateDomainExtension | CreateDomainExtension | Adds an additional domain name. |
| SetDomainExtensionAttribute | SetDomainExtensionAttribute | Replaces the certificate of an additional domain name. |
| DeleteDomainExtension | DeleteDomainExtension | Deletes an additional domain name. |
| DescribeDomainExtensionAttribute | DescribeDomainExtensionAttribute | Queries the attributes of an additional domain name. |
| DescribeDomainExtensions | DescribeDomainExtensions | Queries additional domain names. |
TLS policies
|
API |
Title |
Description |
| CreateTLSCipherPolicy | CreateTLSCipherPolicy | Creates a Transport Layer Security (TLS) policy. |
| DeleteTLSCipherPolicy | DeleteTLSCipherPolicy | Deletes a TLS policy. |
| SetTLSCipherPolicyAttribute | SetTLSCipherPolicyAttribute | Configures a Transport Layer Security (TLS) policy. |
| ListTLSCipherPolicies | ListTLSCipherPolicies | Queries Transport Layer Security (TLS) policies. |
Access control
|
API |
Title |
Description |
| CreateAccessControlList | CreateAccessControlList | Creates an access control list (ACL). |
| AddAccessControlListEntry | AddAccessControlListEntry | Adds IP entries to an access control list (ACL). |
| DeleteAccessControlList | DeleteAccessControlList | Deletes an access control list (ACL). |
| SetAccessControlListAttribute | SetAccessControlListAttribute | Renames an access control list (ACL). |
| DescribeAccessControlListAttribute | DescribeAccessControlListAttribute | Queries the configuration of an access control list (ACL). |
| DescribeAccessControlLists | DescribeAccessControlLists | Queries access control lists (ACLs). |
| RemoveAccessControlListEntry | RemoveAccessControlListEntry | Removes IP entries from the network access control list (ACL) of a Classic Load Balancer (CLB) instance. |
Access control (earlier version)
|
API |
Title |
Description |
| SetListenerAccessControlStatus | SetListenerAccessControlStatus | Enables or disables the whitelist of a listener. |
| RemoveListenerWhiteListItem | RemoveListenerWhiteListItem | Removes IP addresses or CIDR blocks from the whitelist of a listener. |
| AddListenerWhiteListItem | AddListenerWhiteListItem | Adds IP addresses to the whitelist of a listener. |
| DescribeListenerAccessControlAttribute | DescribeListenerAccessControlAttribute | Queries the whitelist configurations of a listener. |
Tags
|
API |
Title |
Description |
| AddTags | AddTags | Adds tags to an SLB instance. |
| DescribeTags | DescribeTags | Queries tags. |
| ListTagResources | ListTagResources | Queries the tags that are added to resources. |
| TagResources | TagResources | Creates tags and adds the tags to resources. |
| UntagResources | UntagResources | Removes tags from a resource. |
| RemoveTags | RemoveTags | Removes tags from a Server Load Balancer (SLB) instance. |
Access logs
|
API |
Title |
Description |
| DeleteAccessLogsDownloadAttribute | DeleteAccessLogsDownloadAttribute | Deletes the access log of a Classic Load Balancer (CLB) instance. |
| SetAccessLogsDownloadAttribute | SetAccessLogsDownloadAttribute | Adds an access log forwarding rule to a Classic Load Balancer (CLB) instance. |
| DescribeAccessLogsDownloadAttribute | DescribeAccessLogsDownloadAttribute | Queries the access log of a Classic Load Balancer (CLB) instance. |
Fine-grained monitoring
|
API |
Title |
Description |
| EnableHighDefinationMonitor | EnableHighDefinationMonitor | Enables fine-grained monitoring for the current region. |
| ModifyHighDefinationMonitor | ModifyHighDefinationMonitor | Modifies the configuration of fine-grained monitoring in a specified region. |
| DescribeHighDefinationMonitor | DescribeHighDefinationMonitor | Queries the configurations of fine-grained monitoring in a region. |
Resource group
|
API |
Title |
Description |
| MoveResourceGroup | MoveResourceGroup | Moves a resource to another resource group. |