This product(
Alb/2020-06-16
) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Region and zone management
API | Title | Description |
---|---|---|
DescribeRegions | DescribeRegions | Queries available regions. |
DescribeZones | DescribeZones | Queries zones in a region. |
Application Load Balancer instances
API | Title | Description |
---|---|---|
CreateLoadBalancer | CreateLoadBalancer | Creates an Application Load Balancer (ALB) instance in a region. |
GetLoadBalancerAttribute | GetLoadBalancerAttribute | Queries the details of an Application Load Balancer (ALB) instance. |
DeleteLoadBalancer | DeleteLoadBalancer | Deletes an Application Load Balancer (ALB) instance. |
UpdateLoadBalancerAttribute | UpdateLoadBalancerAttribute | Modifies the attributes of an Application Load Balancer (ALB) instance, such as the name and the configuration read-only mode. |
UpdateLoadBalancerZones | UpdateLoadBalancerZones | Modifies the zones of an Application Load Balancer (ALB) instance. |
UpdateLoadBalancerEdition | UpdateLoadBalancerEdition | Changes the edition of an Application Load Balancer (ALB) instance. |
UpdateLoadBalancerAddressTypeConfig | UpdateLoadBalancerAddressTypeConfig | Modifies the network type of an Application Load Balancer (ALB) instance. |
ListLoadBalancers | ListLoadBalancers | Queries the configurations of instances. |
DisableDeletionProtection | DisableDeletionProtection | Disables deletion protection for an Application Load Balancer (ALB) instance. |
EnableDeletionProtection | EnableDeletionProtection | Enables deletion protection for a resource. |
StartShiftLoadBalancerZones | StartShiftLoadBalancerZones | Removes an elastic IP address (EIP) or a virtual IP address (VIP) of a zone from a DNS record. |
CancelShiftLoadBalancerZones | CancelShiftLoadBalancerZones | Adds the elastic IP address (EIP) and virtual IP address (VIP) of a zone to a DNS record. |
EnableLoadBalancerIpv6Internet | EnableLoadBalancerIpv6Internet | Changes the type of the IPv6 address that is used by a dual-stack Application Load Balancer (ALB) instance from private to public. |
DisableLoadBalancerIpv6Internet | DisableLoadBalancerIpv6Internet | Changes the type of the IPv6 address that is used by a dual-stack Application Load Balancer (ALB) instance from public to private. |
LoadBalancerJoinSecurityGroup | LoadBalancerJoinSecurityGroup | Adds an Application Load Balancer (ALB) instance to a security group. |
LoadBalancerLeaveSecurityGroup | LoadBalancerLeaveSecurityGroup | Removes an Application Load Balancer (ALB) instance from a security group. |
Listener management
API | Title | Description |
---|---|---|
CreateListener | CreateListener | Creates a listener. |
GetListenerAttribute | GetListenerAttribute | Queries the details about a listener. |
DeleteListener | DeleteListener | Deletes a listener. |
ListListeners | ListListeners | Queries the listeners in a region. |
StartListener | StartListener | Enables a listener. |
StopListener | StopListener | Disables a listener. |
UpdateListenerAttribute | UpdateListenerAttribute | Updates the attributes of a listener, such as the name and the default action. |
UpdateListenerLogConfig | UpdateListenerLogConfig | Updates the log configuration of a listener, such as the access log configuration. |
GetListenerHealthStatus | GetListenerHealthStatus | Queries the health check status of a listener and its forwarding rules. |
Server groups
API | Title | Description |
---|---|---|
AddServersToServerGroup | AddServersToServerGroup | Adds backend servers to a server group. |
CreateServerGroup | CreateServerGroup | Creates a server group in a region. |
DeleteServerGroup | DeleteServerGroup | Deletes a server group. |
UpdateServerGroupAttribute | UpdateServerGroupAttribute | Modifies the configurations of a server group, such as health checks, session persistence, server group names, routing algorithms, and protocols. |
UpdateServerGroupServersAttribute | UpdateServerGroupServersAttribute | Modifies the configurations, such as the backend server weight and description, of a server group. |
ListServerGroups | ListServerGroups | Queries server groups. |
ListServerGroupServers | ListServerGroupServers | Queries servers in a server group. |
RemoveServersFromServerGroup | RemoveServersFromServerGroup | Removes backend servers from a server group. |
ReplaceServersInServerGroup | ReplaceServersInServerGroup | Replaces backend servers in a server group. |
Forwarding rule management
API | Title | Description |
---|---|---|
CreateRule | CreateRule | Creates a forwarding rule for a listener. |
CreateRules | CreateRules | Creates multiple forwarding rules at a time. |
DeleteRule | DeleteRule | Deletes a forwarding rule. |
DeleteRules | DeleteRules | Deletes one or more forwarding rules from a listener at a time. |
UpdateRuleAttribute | UpdateRuleAttribute | Updates a forwarding rule, such as the match condition, action, and name. |
UpdateRulesAttribute | UpdateRulesAttribute | Modifies the attributes of forwarding rules. |
ListRules | ListRules | Queries the forwarding rules in a region. |
Listener certificates
API | Title | Description |
---|---|---|
AssociateAdditionalCertificatesWithListener | AssociateAdditionalCertificatesWithListener | Associates additional certificates with a listener. |
DissociateAdditionalCertificatesFromListener | DissociateAdditionalCertificatesFromListener | Disassociates additional certificates from a listener. |
ListListenerCertificates | ListListenerCertificates | Queries the certificates that are associated with a listener, including additional certificates and the default certificate. |
Common bandwidth package
API | Title | Description |
---|---|---|
DetachCommonBandwidthPackageFromLoadBalancer | DetachCommonBandwidthPackageFromLoadBalancer | Disassociates an elastic IP address (EIP) bandwidth plan from an Application Load Balancer (ALB) instance. |
AttachCommonBandwidthPackageToLoadBalancer | AttachCommonBandwidthPackageToLoadBalancer | Associates an EIP bandwidth plan with an Application Load Balancer (ALB) instance. |
Access logs
API | Title | Description |
---|---|---|
DisableLoadBalancerAccessLog | DisableLoadBalancerAccessLog | Disables the access log feature for a Server Load Balancer (SLB) instance. |
EnableLoadBalancerAccessLog | EnableLoadBalancerAccessLog | Enables the access log feature for an Application Load Balancer (ALB) instance. |
Health check template
API | Title | Description |
---|---|---|
CreateHealthCheckTemplate | CreateHealthCheckTemplate | Creates a health check template in a region. |
GetHealthCheckTemplateAttribute | GetHealthCheckTemplateAttribute | Queries the details about a health check template. |
DeleteHealthCheckTemplates | DeleteHealthCheckTemplates | Deletes health check templates. |
UpdateHealthCheckTemplateAttribute | UpdateHealthCheckTemplateAttribute | Modifies the attributes, such as the name and protocol, of a health check template. |
ListHealthCheckTemplates | ListHealthCheckTemplates | Queries health check templates in a region. |
ApplyHealthCheckTemplateToServerGroup | ApplyHealthCheckTemplateToServerGroup | Applies a health check template to a server group. |
Security policy management
API | Title | Description |
---|---|---|
CreateSecurityPolicy | CreateSecurityPolicy | Creates a custom security policy in a region. |
DeleteSecurityPolicy | DeleteSecurityPolicy | Deletes a custom security policy. |
UpdateSecurityPolicyAttribute | UpdateSecurityPolicyAttribute | Updates the attributes of a security policy, such as the TLS protocol version and the supported cipher suites. |
ListSecurityPolicies | ListSecurityPolicies | Queries custom security policies in a region. |
ListSecurityPolicyRelations | ListSecurityPolicyRelations | Queries the listeners that are associated with security policies. |
ListSystemSecurityPolicies | ListSystemSecurityPolicies | Queries system security policies in a region. |
Access control
API | Title | Description |
---|---|---|
AddEntriesToAcl | AddEntriesToAcl | Adds IP entries to an access control list (ACL). |
CreateAcl | CreateAcl | Creates an access control list (ACL) in a region. |
DeleteAcl | DeleteAcl | Deletes an access control list (ACL). |
UpdateAclAttribute | UpdateAclAttribute | Updates the attributes of an access control list (ACL), such as the name. |
ListAcls | ListAcls | Queries the access control lists (ACLs) in a region. |
ListAclEntries | ListAclEntries | Queries the entries of an access control list (ACL). |
AssociateAclsWithListener | AssociateAclsWithListener | Associates access control lists (ACLs) with a listener. |
ListAclRelations | ListAclRelations | Queries the listeners that are associated with access control lists (ACLs). |
DissociateAclsFromListener | DissociateAclsFromListener | Disassociates access control lists (ACLs) from a listener. |
RemoveEntriesFromAcl | RemoveEntriesFromAcl | Removes entries from an access control list (ACL). |
Resource groups
API | Title | Description |
---|---|---|
MoveResourceGroup | MoveResourceGroup | Moves a resource to another resource group. |
Tags
API | Title | Description |
---|---|---|
ListTagKeys | ListTagKeys | Queries tag keys. |
ListTagResources | ListTagResources | Queries the tags of resources. |
ListTagValues | ListTagValues | Queries tag values. |
TagResources | TagResources | Adds tags to resources. |
UnTagResources | UnTagResources | Removes tags from resources. |
Asynchronous tasks
API | Title | Description |
---|---|---|
ListAsynJobs | ListAsynJobs | Queries asynchronous tasks in a region. |
AScript
API | Title | Description |
---|---|---|
UpdateAScripts | UpdateAScripts | Updates AScript rules. |
CreateAScripts | CreateAScripts | Creates AScript rules. |
DeleteAScripts | DeleteAScripts | Deletes AScript rules. |
ListAScripts | ListAScripts | Queries AScript rules. |