API overview

Updated at:
Copy as MD

API standards and multilingual preset SDKs

The OpenAPI of this product (Slb/2014-05-15) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Regions and zones

API

Title

Description

CreateLoadBalancer CreateLoadBalancer Creates a Classic Load Balancer (CLB) instance.
ModifyLoadBalancerInstanceSpec Modify the specification of a CLB instance Modifies the specification of a CLB instance.
DescribeLoadBalancers DescribeLoadBalancers You can query created SLB instances.

Instances

API

Title

Description

ListTLSCipherPolicies ListTLSCipherPolicies Queries Transport Layer Security (TLS) policies.

Listeners

API

Title

Description

AddAccessControlListEntry AddAccessControlListEntry Adds IP entries to an access control list (ACL).
AddBackendServers AddBackendServers Adds backend servers.
AddListenerWhiteListItem AddListenerWhiteListItem Adds IP addresses to the whitelist of a listener.
AddTags AddTags Adds tags to an SLB instance.
AddVServerGroupBackendServers AddVServerGroupBackendServers Adds backend servers to a vServer group.
CreateAccessControlList CreateAccessControlList Creates an access control list (ACL).
CreateDomainExtension CreateDomainExtension Adds an additional domain name.
CreateLoadBalancerHTTPListener CreateLoadBalancerHTTPListener Creates an HTTP listener for a Classic Load Balancer (CLB) instance.
CreateLoadBalancerHTTPSListener CreateLoadBalancerHTTPSListener Creates an HTTPS listener.
CreateLoadBalancerTCPListener CreateLoadBalancerTCPListener Creates a TCP listener.
CreateLoadBalancerUDPListener CreateLoadBalancerUDPListener Creates a UDP listener.
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.
CreateRules CreateRules Adds one or more forwarding rules to a specified HTTP or HTTPS listener.
CreateTLSCipherPolicy CreateTLSCipherPolicy Creates a Transport Layer Security (TLS) policy.
CreateVServerGroup CreateVServerGroup Creates a vServer group and adds backend servers to the vServer group.
DeleteAccessControlList DeleteAccessControlList Deletes an access control list (ACL).
DeleteAccessLogsDownloadAttribute DeleteAccessLogsDownloadAttribute Deletes the access log of a Classic Load Balancer (CLB) instance.
DeleteCACertificate DeleteCACertificate Deletes a certificate authority (CA) certificate.
DeleteDomainExtension DeleteDomainExtension Deletes an additional domain name.
DeleteLoadBalancer DeleteLoadBalancer Deletes a pay-as-you-go Server Load Balancer (SLB) instance.
DeleteLoadBalancerListener DeleteLoadBalancerListener Deletes a listener.
DeleteMasterSlaveServerGroup DeleteMasterSlaveServerGroup Deletes a primary/secondary server group.
DeleteRules DeleteRules Deletes forwarding rules.
DeleteServerCertificate DeleteServerCertificate Deletes a server certificate.
DeleteTLSCipherPolicy DeleteTLSCipherPolicy Deletes a TLS policy.
DeleteVServerGroup DeleteVServerGroup Deletes a VServer group.
DescribeAccessControlListAttribute DescribeAccessControlListAttribute Queries the configuration of an access control list (ACL).
DescribeAccessControlLists DescribeAccessControlLists Queries access control lists (ACLs).
DescribeAccessLogsDownloadAttribute DescribeAccessLogsDownloadAttribute Queries the access log of a Classic Load Balancer (CLB) instance.
DescribeAvailableResource DescribeAvailableResource Queries the available resources and resources that are available for purchase in the zones of a region.
DescribeCACertificates DescribeCACertificates Queries certificate authority (CA) certificates.
DescribeDomainExtensionAttribute DescribeDomainExtensionAttribute Queries the attributes of an additional domain name.
DescribeDomainExtensions DescribeDomainExtensions Queries additional domain names.
DescribeHealthStatus DescribeHealthStatus Queries the health status of backend servers.
DescribeHighDefinationMonitor DescribeHighDefinationMonitor Queries the configurations of fine-grained monitoring in a region.
DescribeListenerAccessControlAttribute DescribeListenerAccessControlAttribute Queries the whitelist configurations of a listener.
DescribeLoadBalancerAttribute DescribeLoadBalancerAttribute Queries the detail of a Classic Load Balancer (CLB) instance.
DescribeLoadBalancerHTTPListenerAttribute DescribeLoadBalancerHTTPListenerAttribute Queries the configurations of an HTTP listener.
DescribeLoadBalancerHTTPSListenerAttribute DescribeLoadBalancerHTTPSListenerAttribute View the HTTPS listener configuration.
DescribeLoadBalancerListeners List SLB listeners Queries the listeners of a Classic Load Balancer (CLB) instance.
DescribeLoadBalancerTCPListenerAttribute DescribeLoadBalancerTCPListenerAttribute Queries the configuration of a TCP listener.
DescribeLoadBalancerUDPListenerAttribute DescribeLoadBalancerUDPListenerAttribute Queries the configuration of a UDP listener.
DescribeMasterSlaveServerGroupAttribute DescribeMasterSlaveServerGroupAttribute Queries the detailed information about a primary/secondary server group.
DescribeMasterSlaveServerGroups DescribeMasterSlaveServerGroups Queries primary/secondary server groups.
DescribeRegions DescribeRegions Queries available regions.
DescribeRuleAttribute DescribeRuleAttribute Queries the configurations of a specified forwarding rule.
DescribeRules DescribeRules Queries the forwarding rules that are configured for a specified listener.
DescribeServerCertificates DescribeServerCertificates Queries the server certificates in a region.
DescribeTags DescribeTags Queries tags.
DescribeVServerGroupAttribute DescribeVServerGroupAttribute Queries the detailed information about a vServer group.
DescribeVServerGroups DescribeVServerGroups Queries vServer groups.
DescribeZones DescribeZones Queries the zones in a region.
EnableHighDefinationMonitor EnableHighDefinationMonitor Enables fine-grained monitoring for the current region.
ListTagResources ListTagResources Queries the tags that are added to resources.
ModifyHighDefinationMonitor ModifyHighDefinationMonitor Modifies the configuration of fine-grained monitoring in a specified region.
ModifyLoadBalancerInstanceChargeType ModifyLoadBalancerInstanceChargeType Changes the metering method of a pay-as-you-go Classic Load Balancer (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.
ModifyVServerGroupBackendServers ModifyVServerGroupBackendServers Replaces backend servers in a vServer group.
MoveResourceGroup MoveResourceGroup Moves a resource to another resource group.
RemoveAccessControlListEntry RemoveAccessControlListEntry Removes IP entries from the network access control list (ACL) of a Classic Load Balancer (CLB) instance.
RemoveBackendServers RemoveBackendServers Removes backend servers.
RemoveListenerWhiteListItem RemoveListenerWhiteListItem Removes IP addresses or CIDR blocks from the whitelist of a listener.
RemoveTags RemoveTags Removes tags from a Server Load Balancer (SLB) instance.
RemoveVServerGroupBackendServers RemoveVServerGroupBackendServers Removes backend servers from a vServer group.
SetAccessControlListAttribute SetAccessControlListAttribute Renames an access control list (ACL).
SetAccessLogsDownloadAttribute SetAccessLogsDownloadAttribute Adds an access log forwarding rule to a Classic Load Balancer (CLB) instance.
SetBackendServers SetBackendServers Specifies weights for backend servers.
SetCACertificateName SetCACertificateName Specifies a name for a CA certificate.
SetDomainExtensionAttribute SetDomainExtensionAttribute Replaces the certificate of an additional domain name.
SetListenerAccessControlStatus SetListenerAccessControlStatus Enables or disables the whitelist of a listener.
SetLoadBalancerDeleteProtection SetLoadBalancerDeleteProtection Enables or disables deletion protection for an SLB instance.
SetLoadBalancerHTTPListenerAttribute SetLoadBalancerHTTPListenerAttribute Modify an HTTP listener's configuration.
SetLoadBalancerHTTPSListenerAttribute SetLoadBalancerHTTPSListenerAttribute Configure the HTTPS listener
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.
SetLoadBalancerTCPListenerAttribute SetLoadBalancerTCPListenerAttribute Modifies the configurations of a TCP listener of Classic Load Balancer (CLB).
SetLoadBalancerUDPListenerAttribute SetLoadBalancerUDPListenerAttribute Modify the configuration of the UDP listener.
SetRule SetRule Edit the forwarding rules for the target server group.
SetServerCertificateName SetServerCertificateName Sets a name for a server certificate.
SetTLSCipherPolicyAttribute SetTLSCipherPolicyAttribute Configures a Transport Layer Security (TLS) policy.
SetVServerGroupAttribute SetVServerGroupAttribute Modifies the configurations of a vServer group.
StartLoadBalancerListener StartLoadBalancerListener Enables a listener.
StopLoadBalancerListener StopLoadBalancerListener Stops a listener.
TagResources TagResources Creates tags and adds the tags to resources.
UntagResources UntagResources Removes tags from a resource.
UploadCACertificate UploadCACertificate Uploads a CA certificate.
UploadServerCertificate UploadServerCertificate Uploads a server certificate.