全部产品
Search

搜索本产品

    负载均衡：API概览

    文档中心

    负载均衡：API概览

    更新时间：Oct 15, 2024
    本产品（负载均衡/2014-05-15）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
    在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

    资源

    API标题API概述
    DescribeAvailableResource查询资源售卖情况查询某个Region的可用区支持的资源售卖情况，可用的资源。

    地域与可用区

    API标题API概述
    DescribeRegions查询可用地域查询可用地域。
    DescribeZones查询指定地域的可用区信息查询指定地域的可用区信息。

    实例

    API标题API概述
    CreateLoadBalancer创建传统型负载均衡实例创建负载均衡实例。
    DeleteLoadBalancer删除后付费的负载均衡实例删除后付费的负载均衡实例。
    ModifyLoadBalancerInstanceSpec修改负载均衡的实例规格修改负载均衡的实例规格。
    ModifyLoadBalancerInternetSpec修改公网负载均衡实例的计费方式修改公网负载均衡实例的计费方式。
    SetLoadBalancerDeleteProtection设置实例删除保护状态设置实例删除保护状态。
    SetLoadBalancerModificationProtection设置实例修改保护状态设置负载均衡实例修改保护状态。
    SetLoadBalancerName修改负载均衡实例的名称修改负载均衡实例的名称。
    SetLoadBalancerStatus设置负载均衡实例的状态设置负载均衡实例的状态。
    ModifyLoadBalancerInstanceChargeType变更按量付费CLB实例的实例计费方式变更按量付费CLB实例的实例计费方式。
    DescribeLoadBalancerAttribute查询指定负载均衡实例的详细信息查询指定负载均衡实例的详细信息。
    DescribeLoadBalancers查询已创建的负载均衡实例查询已创建的负载均衡实例。

    监听

    API标题API概述
    DeleteLoadBalancerListener删除监听删除监听。
    StartLoadBalancerListener启动监听启动监听。
    StopLoadBalancerListener停止监听停止监听。
    DescribeLoadBalancerListeners查询负载均衡监听列表查询负载均衡监听列表详情。

    TCP监听

    API标题API概述
    CreateLoadBalancerTCPListener创建TCP监听创建TCP监听。
    SetLoadBalancerTCPListenerAttribute修改TCP监听的配置修改TCP监听的配置。
    DescribeLoadBalancerTCPListenerAttribute查询TCP监听配置查询TCP监听配置。

    UDP监听

    API标题API概述
    CreateLoadBalancerUDPListener创建UDP监听创建UDP监听。
    SetLoadBalancerUDPListenerAttribute修改UDP协议监听的配置修改UDP协议监听的配置。
    DescribeLoadBalancerUDPListenerAttribute查询UDP监听的配置查询UDP监听的配置。

    HTTP监听

    API标题API概述
    CreateLoadBalancerHTTPListener创建HTTP监听创建HTTP监听。
    SetLoadBalancerHTTPListenerAttribute修改HTTP监听的配置修改HTTP监听的配置。
    DescribeLoadBalancerHTTPListenerAttribute查询HTTP监听配置查询HTTP监听配置。

    HTTPS监听

    API标题API概述
    CreateLoadBalancerHTTPSListener创建HTTPS监听创建HTTPS监听。
    SetLoadBalancerHTTPSListenerAttribute修改HTTPS监听的配置修改HTTPS监听的配置。
    DescribeLoadBalancerHTTPSListenerAttribute查询HTTPS监听配置查询HTTPS监听配置。

    转发规则

    API标题API概述
    CreateRules为HTTP或HTTPS监听添加转发规则为指定的HTTP或HTTPS监听添加转发规则。
    SetRule修改目标虚拟服务器组的转发规则修改目标虚拟服务器组的转发规则。
    DeleteRules删除转发规则删除转发规则。
    DescribeRuleAttribute查询指定转发规则的配置详情查询指定转发规则的配置详情。
    DescribeRules查询指定监听已配置的转发规则查询指定监听已配置的转发规则。

    默认服务器组

    API标题API概述
    AddBackendServers添加后端服务器添加后端服务器。
    DescribeHealthStatus查询后端服务器的健康状态查询后端服务器的健康状态。
    RemoveBackendServers移除后端服务器移除后端服务器。
    SetBackendServers设置后端服务器权重设置后端服务器权重。

    虚拟服务器组

    API标题API概述
    CreateVServerGroup创建虚拟服务器组并添加后端服务器创建虚拟服务器组并向指定的服务器组中添加后端服务器。
    DeleteVServerGroup删除虚拟服务器组删除虚拟服务器组。
    SetVServerGroupAttribute修改虚拟服务器组的配置修改虚拟服务器组的配置。
    DescribeVServerGroups查询虚拟服务器组列表查询虚拟服务器组列表。
    DescribeVServerGroupAttribute查询虚拟服务器组的详细信息查询虚拟服务器组的详细信息。
    AddVServerGroupBackendServers向指定的虚拟服务器组中添加后端服务器向指定的虚拟服务器组中添加后端服务器。
    ModifyVServerGroupBackendServers替换虚拟服务器组中的后端服务器替换虚拟服务器组中的后端服务器。
    RemoveVServerGroupBackendServers从指定的虚拟服务器组中移除后端服务器从指定的虚拟服务器组中移除后端服务器。

    主备服务器组

    API标题API概述
    CreateMasterSlaveServerGroup创建主备服务器组创建主备服务器组。一个主备服务器组只能包含两个后端服务器，一个为主服务器，另一个为备服务器。
    DeleteMasterSlaveServerGroup删除指定的主备服务器组删除指定的主备服务器组。
    DescribeMasterSlaveServerGroupAttribute查询指定主备服务器组的详细信息查询指定主备服务器组的详细信息。
    DescribeMasterSlaveServerGroups查询主备服务器组列表查询主备服务器组列表。

    证书

    API标题API概述
    DeleteCACertificate删除CA证书删除CA证书。
    DeleteServerCertificate删除服务器证书删除服务器证书。
    SetCACertificateName设置CA证书名称设置CA证书名称。
    SetServerCertificateName设置服务器证书名称设置服务器证书名称。
    DescribeCACertificates查询CA证书列表查询CA证书列表。
    DescribeServerCertificates查询指定地域的服务器证书列表查询指定地域的服务器证书列表。
    UploadCACertificate上传CA证书上传CA证书。
    UploadServerCertificate上传服务器证书上传服务器证书。

    扩展域名

    API标题API概述
    CreateDomainExtension创建扩展域名创建扩展域名。
    SetDomainExtensionAttribute修改扩展域名的证书修改扩展域名的证书。
    DeleteDomainExtension删除扩展域名删除扩展域名。
    DescribeDomainExtensionAttribute查询已添加的扩展域名属性查询已添加的扩展域名属性。
    DescribeDomainExtensions查询已添加的扩展域名查询已添加的扩展域名。

    安全策略

    API标题API概述
    CreateTLSCipherPolicy创建TLS策略创建TLS策略。
    DeleteTLSCipherPolicy删除TLS策略删除TLS策略。
    SetTLSCipherPolicyAttribute设置TLS策略设置TLS策略。
    ListTLSCipherPolicies查询TLS策略查询TLS策略。

    访问控制

    API标题API概述
    CreateAccessControlList创建访问控制策略组创建访问控制策略组。
    AddAccessControlListEntry在访问控制策略组中添加IP条目在访问控制策略组中添加IP条目。
    DeleteAccessControlList删除访问控制策略组删除访问控制策略组。
    SetAccessControlListAttribute修改访问控制策略组的名称修改访问控制策略组的名称。
    DescribeAccessControlListAttribute查询访问控制策略组的配置查询访问控制策略组的配置。
    DescribeAccessControlLists查询已创建的访问控制策略组查询已创建的访问控制策略组。
    RemoveAccessControlListEntry删除访问控制策略组中的IP条目删除访问控制策略组中的IP条目。

    访问控制（旧版）

    API标题API概述
    SetListenerAccessControlStatus是否开启指定监听的白名单访问控制是否开启指定监听的白名单访问控制。
    RemoveListenerWhiteListItem删除监听白名单中的IP删除监听白名单中的IP。
    AddListenerWhiteListItem添加监听访问控制白名单添加监听访问控制白名单。
    DescribeListenerAccessControlAttribute查询监听的白名单配置查询监听的白名单配置。

    标签

    API标题API概述
    AddTags为指定的负载均衡实例添加标签为指定的负载均衡实例添加标签。
    DescribeTags查询已有标签列表查询标签列表。
    ListTagResources查询实例已绑定的标签列表查询实例已经绑定的标签列表。
    TagResources给资源添加标签为指定的资源列表统一创建并绑定标签。
    UntagResources为指定的资源列表统一解绑标签为指定的资源列表统一解绑标签。
    RemoveTags解绑指定负载均衡实例下的标签解绑指定负载均衡实例下的标签。

    访问日志

    API标题API概述
    DeleteAccessLogsDownloadAttribute删除访问日志下载任务删除指定传统型负载均衡实例的访问日志。
    SetAccessLogsDownloadAttribute修改访问日志的下载配置为传统型负载均衡实例添加访问日志转发规则。
    DescribeAccessLogsDownloadAttribute查询指定实例的访问日志查询指定传统型负载均衡实例的访问日志。

    秒级监控

    API标题API概述
    EnableHighDefinationMonitor开启实例的秒级监控启用当前地域的秒级监控功能。
    ModifyHighDefinationMonitor修改秒级监控配置信息修改高精度秒级监控的配置信息。
    DescribeHighDefinationMonitor查询实例业务运行监控数据查询指定地域的秒级监控配置信息。

    资源组

    API标题API概述
    MoveResourceGroup修改资源组修改云资源所属的资源组。