tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Access Management
    Documentation

    Cloud Load Balancer

    Last updated: 2024-05-02 09:04:47

      Fundamental information

      Product Abbreviation in CAM Console Authorization by Tag Authorization Granularity IP Restriction
      Cloud Loader Balance clb Supported Supported Resource level Partially supported

      Note：

      The authorization granularity of cloud products is divided into three levels: service level, operation level, and resource level, based on the degree of granularity.

      • Service level: It defines whether a user has the permission to access the service as a whole. A user can have either full access or no access to the service. For the authorization granularity of cloud products at service level, the authorization of specific APIs are not supported.
      • Operation level: It defines whether a user has the permission to call a specific API of the service. For example, granting an account read-only access to the CVM service is an authorization at the operation level.
      • Resource level: It is the finest authorization granularity which defines whether a user has the permission to access specific resources. For example, granting an account read/write access to a specific CVM instance is an authorization at the resource level.

      API authorization granularity

      Two authorization granularity levels of API are supported: resource level, and operation level.

      • Resource level: It supports the authorization of a specific resource.
      • Operation level: It does not support the authorization of a specific resource. If the policy syntax restricts a specific resource during authorization, CAM will determine that this API is not within the scope of authorization, and deem it as unauthorized.

      Write operations

      API API Description Authorization Granularity Six-segment Resource Description IP Restriction
      AddCustomizedConfig Add customized configuration Operation level * Supported
      AddGatewayAclRule Add GatewayAclRule Operation level * Supported
      AssociateCustomizedConfig Association configuration to server or location Operation level * Supported
      AssociateGatewayAclGroup Associate GatewayAclGroup Resource level qcs::clb:${region}:uin/${uin}:gwlb/${loadbalanceid} Supported
      AssociateTargetGroups Regulate associated target groups Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      AutoRewrite auto rewrite Operation level * Supported
      BatchDeregisterTargets This API is used to unbind layer-4/layer-7 real servers in batches Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      BatchModifyTargetTag Batch modify weight of targets Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid
      qcs::clb:${region}:uin/${uin}:instance/$cvminstanceid
      qcs::clb:${region}:uin/${uin}:eni/$eniid      		 Supported
      BatchModifyTargetWeight Batch modify weight of targets Resource level qcs::clb:$region::clb/$loadbalancerid
      qcs::cvm:$region::instance/$cvminstanceid
      qcs::vpc:$region::eni/$eniid      		 Supported
      BatchRegisterTargets Operation level * Supported
      CloneLoadBalancer CloneLoadBalancer Resource level qcs::clb::uin/${uin}:clb/$loadbalancerid Supported
      CreateClsLogSet Create CLB proprietary log set Operation level * Supported
      CreateDashBoard Create dashboard Operation level * Supported
      CreateForwardLBFourthLayerListeners Operation level * not supported
      CreateForwardLBListenerRules Operation level * not supported
      CreateForwardLBSeventhLayerListeners Operation level * not supported
      CreateGatewayAclGroup Create GatewayAclGroup Operation level * Supported
      CreateGatewayLoadBalancer Create Gateway LoadBalancer Instance Resource level qcs::clb:${region}:uin/${uin}:gwlb/${loadbalanceid} Supported
      CreateListener Create listener. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      CreateListenerRules CreateListenerRules Resource level qcs::clb:$region::clb/$loadbalancerid
      qcs::clb:$region::listener/$listenerid
      qcs::cvm:$region::instance/$cvminstanceid
      qcs::clb:$region::targetgroup/$targetgroup
      qcs::vpc:$region::eni/$eniid      		 Supported
      CreateLoadBalancer Operation level * not supported
      CreateLoadBalancerListeners Create load balancer listeners. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      CreateLoadBalancerSnatIps add SnatIp Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      CreateLoadBalancerTask Create loadBalancer asynchronous task Operation level * Supported
      CreateRule Create rule. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      CreateTargetGroup Create target group Operation level * Supported
      CreateTopic CreateTopic Operation level * Supported
      DeleteCustomizedConfig Remove customized configuration Operation level * Supported
      DeleteForwardLBListener Operation level * not supported
      DeleteForwardLBListenerRules Operation level * not supported
      DeleteForwardLBSeventhListeners Operation level * not supported
      DeleteGatewayAclGroup Delete GatewayAclGroup Operation level * Supported
      DeleteGatewayAclRule Delete GatewayAclRule Operation level * Supported
      DeleteGatewayLoadBalancer delete gateway loadBalance Resource level qcs::clb:${region}:uin/${uin}:gwlb/${loadbalanceid} Supported
      DeleteLBService Operation level * not supported
      DeleteListener This API is used to delete a CLB listener. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      DeleteLoadBalancer Operation level * not supported
      DeleteLoadBalancerListeners Delete load balancer listeners. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      DeleteLoadBalancerSnatIps delete SnatIp Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      DeleteLoadBalancers Operation level * not supported
      DeleteRewrite Delete rewrite. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DeleteRule Delete rule. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      DeleteTargetGroups Delete target group Operation level * Supported
      DeregisterFunctionTargets Unbind serverless cloud functions from loadbalancer rules Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      DeregisterInstancesFromForwardLB Operation level * not supported
      DeregisterInstancesFromForwardLBFourthListener Operation level * not supported
      DeregisterInstancesFromLoadBalancer Operation level * not supported
      DeregisterTargetGroupInstances Remove instances from the target group Resource level qcs::clb::uin/${uin}:clb/$loadbalancerid Supported
      DeregisterTargets This API is used to unbind one or more real servers from a CLB listener or forwarding rule Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DeregisterTargetsFromClassicalLB This API is used to unbind a CLB real server Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DisassociateCustomizedConfig Unbinding customized configuration Operation level * Supported
      DisassociateGatewayAclGroup Disassociate GatewayAclGroup Resource level qcs::clb:${region}:uin/${uin}:gwlb/${loadbalanceid} Supported
      DisassociateTargetGroups Disassociate regulated target groups Operation level * Supported
      ManualRewrite Manually configure the redirect address. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      MeasureLcuPrice Measure Lcu price Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      MigrateAppIdVIP Migration of loadbalancer VIP among different developers Operation level * Supported
      ModifyBlockIPList Modify the blacklist of IP blocking for loadbalancer Operation level * not supported
      ModifyCustomizedConfig Modify customized configuration Operation level * Supported
      ModifyDnat ModifyDnat Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      ModifyDomain This API (ModifyDomain) is used to modify a domain name under a layer-7 CLB listener. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      ModifyDomainAttributes ModifyDomainAttributes Resource level * Supported
      ModifyForwardFourthBackendsPort Operation level * not supported
      ModifyForwardFourthBackendsWeight Operation level * not supported
      ModifyForwardLBFourthListener Operation level * not supported
      ModifyForwardLBName Operation level * not supported
      ModifyForwardLBRulesDomain Operation level * not supported
      ModifyForwardLBSeventhListener Operation level * not supported
      ModifyForwardSeventhBackends Operation level * not supported
      ModifyForwardSeventhBackendsPort Operation level * not supported
      ModifyGatewayAclGroup Modify GatewayAclGroup Operation level * Supported
      ModifyGatewayLoadBalancerAttribute Modify GatewayLoadBalancer Attribute Resource level qcs::clb:${region}:uin/${uin}:gwlb/${loadbalanceid} Supported
      ModifyLBHealth Modify the load balancing health check threshold Operation level * not supported
      ModifyLBNetwork Modify the bandwidth of the load balancer Operation level * not supported
      ModifyLBOperateProtect Modify LoadBalancer operate protect Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      ModifyLBProjectId Modify project ID Operation level * not supported
      ModifyLBWeight Operation level * not supported
      ModifyListener This API (ModifyListener) is used to modify the attributes of a CLB listener, such as listener name, health check parameter, certificate information. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      ModifyLoadBalancerAttributes Modify load balancing attribute information. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      ModifyLoadBalancerBackends Operation level * not supported
      ModifyLoadBalancerListener Operation level * not supported
      ModifyLoadBalancerMixIpTarget ModifyLoadBalancerMixIpTarget Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      ModifyLoadBalancerRulesProbe Operation level * not supported
      ModifyLoadBalancerSla Modify the load balancing configuration of performance guarantee type Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      ModifyQuota ModifyQuota Operation level * Supported
      ModifyRule Modify rule. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      ModifyTargetGroupAttribute Modify target group attributes Operation level * Supported
      ModifyTargetGroupInstancesPort Modify instance port in target group Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      ModifyTargetGroupInstancesWeight Modify the instance weight in the target group Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      ModifyTargetPort Modify target port. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      ModifyTargetWeight Modify target weight . Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      RegisterFunctionTargets Binding serverless cloud functions to loadbalancer rules Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      RegisterInstancesWithForwardLBFourthListener Operation level * not supported
      RegisterInstancesWithForwardLBSeventhListener Operation level * not supported
      RegisterInstancesWithLoadBalancer Operation level * not supported
      RegisterTargetGroupInstances Register the server to the target group Operation level * Supported
      RegisterTargets Register targets. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      RegisterTargetsWithClassicalLB Register targets with classical LoadBalance. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      ReplaceCert Replace old certificate with new one Operation level * not supported
      ReplaceCertForLoadBalancers Replace certificate Operation level * Supported
      SetCustomizedConfigForLoadBalancer SetCustomizedConfigForLoadBalancer Operation level * Supported
      SetListenerReschedule SetListenerReschedule Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      SetLoadBalancerClsLog Add, delete, and update load balancing log service (CLS) topics Resource level qcs::clb:$region::clb/$loadbalancerid not supported
      SetLoadBalancerCrossRegion Operation level * not supported
      SetLoadBalancerLog Set CLB Log. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      SetLoadBalancerSecurityGroups SetLoadBalancerSecurityGroups Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      SetLoadBalancerStartStatus SetLoadBalancerStartStatus Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      SetSecurityGroupForLoadbalancers SetSecurityGroupForLoadbalancers Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      SetSecurityGroupToLoadBalancers Set security group for load balancer Operation level * not supported
      SetSecurityGroups Operation level * not supported
      SetSeventhListenerDomainAttributes Operation level * not supported
      UnbindTrigger unbind scf from layer 7 listener Operation level * Supported
      UpgradeDomain Upgrade CLB to domain CLB. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported

      Read operations

      API API Description Authorization Granularity Six-segment Resource Description IP Restriction
      CheckCustomizedConfig Verify customized configuration Operation level * Supported
      CheckLcuUpgrade Check the load balancing configuration of performance guarantee type Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeAllLBBackends Operation level * not supported
      DescribeBlockIPList Query a list of IP blocked by loadbalancer. Resource level qcs::clb:$region::clb/$loadbalancerid not supported
      DescribeBlockIPTask Query the execution status of asynchronous tasks blocking IP Operation level * not supported
      DescribeCLBWhiteList Describe LoadBalancer whitelist Operation level * Supported
      DescribeClassicalLBByInstanceId Find traditional loadbalancers through back end target Operation level * Supported
      DescribeClassicalLBHealthStatus Describe classical LoadBalance targets. Resource level qcs::clb::uin/${uin}:clb/$loadbalancerid Supported
      DescribeClassicalLBListeners This API (DescribeClassicalLBListeners) is used to get the listener information of a classic CLB. Resource level qcs::clb::uin/${uin}:clb/$loadbalancerid Supported
      DescribeClassicalLBTargets Describe classical LoadBalance targets. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeClsLogSet Gets the CLB specific log set of the user Operation level * Supported
      DescribeClusterResources Query the list of resources in the exclusive cluster. Operation level * Supported
      DescribeCrossTargets Query information of cross targets Operation level * Supported
      DescribeCustomizedConfig Query customized configuration Operation level * not supported
      DescribeCustomizedConfigAssociateList Query the server or location bound on the customized configuration Operation level * Supported
      DescribeCustomizedConfigContent Query the content of customized configuration Operation level * Supported
      DescribeCustomizedConfigLBAssociateList Query the customized configuration list of CLB binding Operation level * Supported
      DescribeCustomizedConfigList Query customized configuration list Operation level * Supported
      DescribeExclusiveClusters Query cluster information list. Operation level * not supported
      DescribeForwardLBBackends Operation level * not supported
      DescribeForwardLBHealthStatus Operation level * not supported
      DescribeForwardLBListeners Operation level * not supported
      DescribeIdleLoadBalancers Describe Idle LoadBalancers Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeLBActionLimit Query the quota of CLB related operations Operation level * Supported
      DescribeLBConfLimit DescribeLBConfLimit Operation level * Supported
      DescribeLBFlowLimit DescribeLBFlowLimit Operation level * Supported
      DescribeLBHealth Query the LB health check threshold Operation level * not supported
      DescribeLBHealthStatus Operation level * not supported
      DescribeLBHealthStatusMc Operation level * not supported
      DescribeLBListeners DescribeLBListeners Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeLBOperateProtect Describe LoadBalancer operate protect info Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeLcuPriceResult Query asynchronous task results Operation level * Supported
      DescribeListeners This API is used to get the list of listeners by CLB ID. Resource level qcs::clb::uin/${uin}:clb/$loadbalancerid Supported
      DescribeLoadBalancerBackends Operation level * not supported
      DescribeLoadBalancerClsLog Query application layer CLS log of loadbalancer Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      DescribeLoadBalancerCount Query the total number of loadbalancers in a region Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      DescribeLoadBalancerErrLog Query loadbalancer error log Operation level * Supported
      DescribeLoadBalancerListByCertId Query loadbalancers through certificate ID Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeLoadBalancerListeners Operation level * not supported
      DescribeLoadBalancerLog Operation level * not supported
      DescribeLoadBalancerLogByCursor Query the full application level logs of load balancing through cursors Operation level * not supported
      DescribeLoadBalancerTraffic Query high traffic loadbalancers Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeLoadBalancerWafErrLog Query load balancing error log for WAF Operation level * Supported
      DescribeLoadBalancers This API is used to query the list of CLB instances in a region. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      DescribeLoadBalancersCount Query the number of load balancers by Region Operation level * not supported
      DescribeLoadBalancersFeature Get the functions supported by the load balancing instance Operation level * Supported
      DescribeLoadBalancersForVpc Query loadbalancer instance (basic information) Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeMasterZones Query master zones of a region Operation level * Supported
      DescribeQuota Query the quotas in the current region. Operation level * not supported
      DescribeRegions Query user supported region list Operation level * Supported
      DescribeResources Query the list of zones and resources supported by users in the current region Operation level * Supported
      DescribeRewrite Describe rewrite. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      DescribeSetByVip Query the exclusive cluster information of loadbalancer Operation level * Supported
      DescribeSetCapacity Query exclusive cluster capacity information Operation level * Supported
      DescribeSetVip Query the information of all load balancers in the exclusive cluster Operation level * Supported
      DescribeSets Query exclusive cluster list Operation level * Supported
      DescribeSingleIsp DescribeSingleIsp Operation level * Supported
      DescribeSlaCapacity Query specification parameters of performance guarantee type load balancing Operation level * Supported
      DescribeTargetGroupInstanceStatus Describe TargetGroupInstance Status Resource level qcs::clb:${region}:uin/${uin}:targetgroup/$targetgroup Supported
      DescribeTargetGroupInstances Get the server bound to the target group Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeTargetGroupList Get target group list Operation level * Supported
      DescribeTargetGroups Query target group infomation Operation level * Supported
      DescribeTargetHealth Describe target health status. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid not supported
      DescribeTargetHealthDetail DescribeTargetHealthDetail Resource level qcs::clb:$region::clb/$loadbalancerid Supported
      DescribeTargets Describe targets. Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      DescribeTargetsByVips Query the target service information bound on the load balancing according to the public VIP Resource level qcs::clb::uin/${uin}:clb/$loadbalancerid Supported
      DescribeTaskStatus Query asynchronous task status Operation level * not supported
      DescribeZone Query zone list of a region Operation level * Supported
      DescribeZoneSla Query the loadbalancer specification of the currently supported performance guarantee type Operation level * Supported
      InquiryPriceCreateLoadBalancer Loadbalancer inquiry (create) Operation level * Supported
      InquiryPriceModifyLoadBalancer Prepaid load balancing inquiry (modify configuration) Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      InquiryPriceRefundLoadBalancer Load balancing inquiry (refund) Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported
      InquiryPriceRenewLoadBalancer Load balancing inquiry (renew) Resource level qcs::clb:${region}:uin/${uin}:clb/$loadbalancerid Supported

      List Operations

      API API Description Authorization Granularity Six-segment Resource Description IP Restriction
      DescribeGatewayAclGroups Describe GatewayAclGroups Operation level * Supported
      DescribeGatewayAclRules Describe GatewayAclRules Operation level * Supported
      DescribeGatewayLoadBalancers describe gateway loadbalancers Resource level qcs::clb:${region}:uin/${uin}:gwlb/${loadbalanceid} Supported
      DescribeLoadBalancersDetail DescribeLoadBalancersDetail Resource level qcs::clb:$region::clb/$loadbalancerid not supported
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy