| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609 |
- # Copyright (c) 2014 Baidu.com, Inc. All Rights Reserved
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing,
- # software distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions
- # and limitations under the License.
- """
- This module provides a client class for BLB.
- """
- import copy
- import json
- import logging
- import uuid
- import sys
- from baidubce import bce_base_client
- from baidubce.auth import bce_v1_signer
- from baidubce.http import bce_http_client
- from baidubce.http import handler
- from baidubce.http import http_methods
- from baidubce import utils
- from baidubce.utils import required
- from baidubce import compat
- if sys.version < '3':
- reload(sys)
- sys.setdefaultencoding('utf-8')
- _logger = logging.getLogger(__name__)
- class BlbClient(bce_base_client.BceBaseClient):
- """
- BLB base sdk client
- """
- version = b'/v1'
- def __init__(self, config=None):
- bce_base_client.BceBaseClient.__init__(self, config)
- def _merge_config(self, config=None):
- """
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- """
- if config is None:
- return self.config
- else:
- new_config = copy.copy(self.config)
- new_config.merge_non_none_values(config)
- return new_config
- def _send_request(self, http_method, path,
- body=None, headers=None, params=None,
- config=None, body_parser=None):
- config = self._merge_config(config)
- if body_parser is None:
- body_parser = handler.parse_json
- if headers is None:
- headers = {b'Accept': b'*/*',
- b'Content-Type': b'application/json;charset=utf-8'}
- return bce_http_client.send_request(
- config, bce_v1_signer.sign, [handler.parse_error, body_parser],
- http_method, path, body, headers, params)
- @required(vpc_id=(bytes, str),
- subnet_id=(bytes, str))
- def create_loadbalancer(self, vpc_id, subnet_id, name=None,
- desc=None, client_token=None, config=None):
- """
- Create a LoadBalancer with the specified options.
- :param name:
- the name of LoadBalancer to create
- :type name: string
- :param desc:
- The description of LoadBalancer
- :type desc: string
- :param vpc_id:
- id of vpc which the LoadBalancer belong to
- :type vpc_id: string
- :param subnet_id:
- id of subnet which the LoadBalancer belong to
- :type subnet_id: string
- :param client_token:
- If the clientToken is not specified by the user, a random String
- generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- if name is not None:
- body['name'] = compat.convert_to_string(name)
- if desc is not None:
- body['desc'] = compat.convert_to_string(desc)
- body['vpcId'] = compat.convert_to_string(vpc_id)
- body['subnetId'] = compat.convert_to_string(subnet_id)
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- def describe_loadbalancers(self, address=None, name=None, blb_id=None,
- bcc_id=None, marker=None, max_keys=None,
- config=None):
- """
- Return a list of LoadBalancers
- :param address:
- Intranet service address in dotted decimal notation
- :type address: string
- :param name:
- name of LoadBalancer to describe
- :type name: string
- :param blb_id:
- id of LoadBalancer to describe
- :type blb_id: string
- :param bcc_id:
- bcc which bind the LoadBalancers
- :type bcc_id: string
- :param marker:
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result
- which listing should begin.
- If the marker is not specified, the list result will
- listing from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of list
- result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb')
- params = {}
- if address is not None:
- params[b'address'] = address
- if name is not None:
- params[b'name'] = name
- if blb_id is not None:
- params[b'blbId'] = blb_id
- if bcc_id is not None:
- params[b'bccId'] = bcc_id
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def describe_loadbalancer_detail(self, blb_id, config=None):
- """
- Return detail imformation of specific LoadBalancer
- :param blb_id:
- id of LoadBalancer to describe
- :type blb_id: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id)
- return self._send_request(http_methods.GET, path,
- config=config)
- @required(blbId=(bytes, str))
- def update_loadbalancer(self, blb_id, name=None, desc=None,
- client_token=None, config=None):
- """
- Modify the special attribute to new value of the LoadBalancer
- owned by the user.
- :param name:
- name of LoadBalancer to describe
- :type name: string
- :param blb_id:
- id of LoadBalancer to describe
- :type blb_id: string
- :param desc:
- The description of LoadBalancer
- :type desc: string
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm
- will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id)
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- if name is not None:
- body['name'] = compat.convert_to_string(name)
- if desc is not None:
- body['desc'] = compat.convert_to_string(desc)
- return self._send_request(http_methods.PUT, path, json.dumps(body),
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def delete_loadbalancer(self, blb_id, client_token=None, config=None):
- """
- delete the LoadBalancer owned by the user.
- :param blb_id:
- id of LoadBalancer to describe
- :type blb_id: string
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm
- will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id)
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- return self._send_request(http_methods.DELETE, path,
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def update_loadbalancer_acl(self, blb_id, client_token=None, support_acl=None, config=None):
- """
- update the specified LoadBalancer to support the acl feature.
- :param blb_id:
- id of LoadBalancer to describe
- :type blb_id: string
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm
- will be used.
- :type client_token: string
- :param support_acl:
- parameters to support LoadBalancer acl, default is true.
- :type support_acl: Boolean
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb/acl', blb_id)
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- if support_acl is not None:
- body['supportAcl'] = support_acl
- else:
- body['supportAcl'] = True
- return self._send_request(http_methods.PUT, path, json.dumps(body),
- params=params, config=config)
- @required(vpc_id=(bytes, str),
- subnet_id=(bytes, str))
- def create_ipv6_loadbalancer(self, vpc_id, subnet_id, name=None,
- desc=None, client_token=None, config=None):
- """
- Create a LoadBalancer with the specified options.
- :param name:
- the name of LoadBalancer to create
- :type name: string
- :param desc:
- The description of LoadBalancer
- :type desc: string
- :param vpc_id:
- id of vpc which the LoadBalancer belong to
- :type vpc_id: string
- :param subnet_id:
- id of subnet which the LoadBalancer belong to
- :type subnet_id: string
- :param client_token:
- If the clientToken is not specified by the user, a random String
- generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- if name is not None:
- body['name'] = compat.convert_to_string(name)
- if desc is not None:
- body['desc'] = compat.convert_to_string(desc)
- body['vpcId'] = compat.convert_to_string(vpc_id)
- body['subnetId'] = compat.convert_to_string(subnet_id)
- body['type'] = compat.convert_to_string('ipv6')
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- def describe_ipv6_loadbalancers(self, address=None, name=None, blb_id=None,
- bcc_id=None, marker=None, max_keys=None,
- config=None):
- """
- Return a list of LoadBalancers
- :param address:
- Intranet service address in dotted decimal notation
- :type address: string
- :param name:
- name of LoadBalancer to describe
- :type name: string
- :param blb_id:
- id of LoadBalancer to describe
- :type blb_id: string
- :param bcc_id:
- bcc which bind the LoadBalancers
- :type bcc_id: string
- :param marker:
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result
- which listing should begin.
- If the marker is not specified, the list result will
- listing from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of list
- result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb')
- params = {}
- if address is not None:
- params[b'address'] = address
- if name is not None:
- params[b'name'] = name
- if blb_id is not None:
- params[b'blbId'] = blb_id
- if bcc_id is not None:
- params[b'bccId'] = bcc_id
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- params[b'type'] = compat.convert_to_string('ipv6')
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str),
- listener_port=int,
- backend_port=int,
- scheduler=(bytes, str))
- def create_tcp_listener(self, blb_id, listener_port,
- backend_port, scheduler,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealthy_threshold=None,
- healthy_threshold=None,
- client_token=None, config=None):
- """
- Create a tcp listener rule with the specified options.
- :param blb_id:
- the id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection' or 'Hash'
- :type scheduler: string
- :param health_check_timeout_in_second
- Health check timeout
- :value 1-60, default: 3, unit: seconds
- :type health_check_timeout_in_second: string
- :param health_check_interval
- Health check interval
- :value 1-10, default: 3, unit: seconds
- :type health_check_interval: string
- :param unhealthy_threshold
- Unhealthy threshold,
- how many consecutive health check failures,
- shielding the backend server
- :value 2-5, default: 3
- :type unhealthy_threshold: string
- :param healthy_threshold
- Health threshold,
- how many consecutive health checks are successful,
- then re-use the back-end server
- :value 2-5, default: 3
- :type healthy_threshold: string
- :param client_token:
- If the clientToken is not specified by the user, a random String
- generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'TCPlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'listenerPort': listener_port,
- 'backendPort': backend_port,
- 'scheduler': compat.convert_to_string(scheduler)
- }
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealthy_threshold is not None:
- body['unhealthyThreshold'] = unhealthy_threshold
- if healthy_threshold is not None:
- body['healthyThreshold'] = healthy_threshold
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- listener_port=int,
- backend_port=int,
- scheduler=(bytes, str),
- health_check_string=(bytes, str))
- def create_udp_listener(self, blb_id, listener_port, backend_port,
- scheduler, health_check_string,
- health_check_type=None,
- health_check_port=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealthy_threshold=None,
- healthy_threshold=None,
- client_token=None, config=None):
- """
- Create a udp listener rule with the specified options.
- :param blb_id:
- the id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection' or 'Hash'
- :type scheduler: string
- :param health_check_string
- The request string sent by the health,
- the backend server needs to respond after receiving it.
- :type health_check_string: string
- :param health_check_type
- Health check protocol
- :value 'UDP' or 'ICMP'
- :type health_check_type: string
- :param health_check_port
- Health check port, the default is the same as backend_port.
- :type health_check_port: int
- :param health_check_timeout_in_second
- Health check timeout
- :value 1-60, default: 3, unit: seconds
- :type health_check_timeout_in_second: string
- :param health_check_interval
- Health check interval
- :value 1-10, default: 3, unit: seconds
- :type health_check_interval: string
- :param unhealthy_threshold
- Unhealthy threshold,
- how many consecutive health check failures,
- shielding the backend server
- :value 2-5, default: 3
- :type unhealthy_threshold: string
- :param healthy_threshold
- Health threshold,
- how many consecutive health checks are successful,
- then re-use the back-end server
- :value 2-5, default: 3
- :type healthy_threshold: string
- :param client_token:
- If the clientToken is not specified by the user, a random String
- generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'UDPlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'listenerPort': listener_port,
- 'backendPort': backend_port,
- 'scheduler': compat.convert_to_string(scheduler),
- 'healthCheckString': compat.convert_to_string(health_check_string)
- }
- if health_check_type is not None:
- body['healthCheckType'] = health_check_type
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealthy_threshold is not None:
- body['unhealthyThreshold'] = unhealthy_threshold
- if healthy_threshold is not None:
- body['healthyThreshold'] = healthy_threshold
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str), listener_port=int,
- backend_port=int, scheduler=(bytes, str))
- def create_http_listener(self, blb_id, listener_port,
- backend_port, scheduler,
- keep_session=None, keep_session_type=None,
- keep_session_duration=None,
- keep_session_cookie_name=None,
- x_forward_for=None,
- health_check_type=None, health_check_port=None,
- health_check_uri=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealthy_threshold=None,
- healthy_threshold=None,
- health_check_normal_status=None,
- server_timeout=None, redirect_port=None,
- client_token=None, config=None):
- """
- Create a http listener rule with the specified options.
- :param blb_id:
- the id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler:
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection'
- :type scheduler: string
- :param keep_session:
- Whether to enable the session hold function,
- that is,the request sent by the same client will
- reach the same backend server
- :value true or false default:false
- :type keep_session: bool
- :param keep_session_type:
- The cookie handling method maintained by the session,
- valid only if the session is held open
- :value 'insert' or 'rewrite' default:insert
- :type keep_session_type: string
- :param keep_session_duration:
- The time the cookie is kept in session (in seconds),
- valid only if the session is held open
- :value 1-15552000 default:3600
- :type keep_session_duration: int
- :param keep_session_cookie_name:
- The session keeps the name of the cookie that needs to be
- overridden if and only if session persistence is enabled
- and keep_session_type="rewrite"
- :type keep_session_cookie_name: int
- :param x_forward_for:
- Whether to enable the real IP address of the client,
- the backend server can obtain the real address of the client
- through the X-Forwarded-For HTTP header.
- :value true or false, default: False
- :type x_forward_for: bool
- :param health_check_type:
- Health check protocol
- :value 'HTTP' or 'TCP'
- :type health_check_type: string
- :param health_check_port:
- Health check port, the default is the same as backend_port
- :type health_check_port: int
- :param health_check_uri:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_uri: string
- :param health_check_timeout_in_second:
- Health check timeout (unit: second)
- :value 1-60, default: 3
- :type health_check_timeout_in_second: int
- :param health_check_interval:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval: int
- :param unhealthy_threshold:
- The unhealthy threshold, that is,
- how many consecutive health check failures,
- shields the backend server.
- :value 2-5, default: 3
- :type unhealthy_threshold: int
- :param healthy_threshold:
- Health threshold, that is,
- how many consecutive health checks are successful,
- then re-use the back-end server
- value: 2-5, default: 3
- :type health_threshold: int
- :param health_check_normal_status:
- The HTTP status code when the health check is normal supports
- a combination of five types of status codes,
- such as "http_1xx|http_2xx",
- Effective when the health check protocol is "HTTP"
- :value default:http_2xx|http_3xx
- :type health_check_normal_status:string
- :param server_timeout:
- Backend server maximum timeout (unit: second)
- :value 1-3600, default: 30
- :type server_timeout:int
- :param redirect_port:
- Forward the request received by this listener to the
- HTTPS listener, which is specified by the HTTPS listener.
- :type redirect_port:int
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'HTTPlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'listenerPort': listener_port,
- 'backendPort': backend_port,
- 'scheduler': compat.convert_to_string(scheduler)}
- if keep_session is not None:
- body['keepSession'] = keep_session
- if keep_session_type is not None:
- body['keepSessionType'] = keep_session_type
- if keep_session_duration is not None:
- body['keepSessionDuration'] = keep_session_duration
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forward_for is not None:
- body['xForwardFor'] = x_forward_for
- if health_check_type is not None:
- body['healthCheckType'] = \
- compat.convert_to_string(health_check_type)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_uri is not None:
- body['healthCheckURI'] = \
- compat.convert_to_string(health_check_uri)
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealthy_threshold is not None:
- body['unhealthyThreshold'] = unhealthy_threshold
- if healthy_threshold is not None:
- body['healthyThreshold'] = healthy_threshold
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if server_timeout is not None:
- body['serverTimeout'] = server_timeout
- if redirect_port is not None:
- body['redirectPort'] = redirect_port
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str), listener_port=int,
- backend_port=int, scheduler=(bytes, str), cert_ids=list)
- def create_https_listener(self, blb_id, listener_port, backend_port,
- scheduler, cert_ids, keep_session=None,
- keep_session_type=None,
- keep_session_duration=None,
- keep_session_cookie_name=None,
- x_forward_for=None, health_check_type=None,
- health_check_port=None, health_check_uri=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealth_threshold=None, health_threshold=None,
- health_check_normal_status=None,
- server_timeout=None, ie6_compatible=None,
- encryption_type=None, encryption_protocols=None,
- dual_auth=None, client_certIds=None,
- additional_cert_domains=None,
- client_token=None, config=None):
- """
- Create a https listener rule with the specified options
- :param blb_id:
- The id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- Port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler:
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection'
- :type scheduler: string
- :param cert_ids:
- The certificate to be loaded by the listener.
- :type cert_ids: List<String>
- :param keep_session:
- Whether to enable the session hold function,
- that is, the request sent by the same client will reach the
- same backend server
- :value true or false, default: false
- :type keep_session: bool
- :param keep_session_type:
- The cookie handling method maintained by the session,
- valid only if the session is held open
- :value 'insert' or 'rewrite', default:insert
- :type keep_session_type: string
- :param keep_session_duration:
- The time the cookie is kept in session (in seconds),
- valid only if the session is held open
- :value 1-15552000, default:3600
- :type keep_session_duration: int
- :param keep_session_cookie_name:
- The session keeps the name of the cookie that needs
- to be overridden if and only if session persistence
- is enabled and keep_session_type="rewrite"
- :type keep_session_cookie_name: int
- :param x_forward_for:
- Whether to enable the real IP address of the client,
- the backend server can obtain the real address of the client
- through the X-Forwarded-For HTTP header.
- :value true or false, default: flase
- :type x_forward_for: bool
- :param health_check_type:
- Health check protocol
- :value 'HTTP' or 'TCP'
- :type health_check_type: string
- :param health_check_port:
- Health check port, the default is the same as backend_port
- :type health_check_port: int
- :param health_check_uri:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_uri: string
- :param health_check_timeout_in_second:
- Health check timeout (unit: second)
- :value 1-60, default:3
- :type health_check_timeout_in_second: int
- :param health_check_interval:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval: int
- :param unhealth_threshold:
- The unhealthy threshold, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type unhealth_threshold: int
- :param health_threshold:
- Health threshold, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_threshold: int
- :param health_check_normal_status:
- The HTTP status code when the health check is normal
- supports a combination of five types of status codes,
- such as "http_1xx|http_2xx", Effective when the health check
- protocol is "HTTP"
- :value default: http_2xx|http_3xx
- :type health_check_normal_status: string
- :param server_timeout:
- Backend server maximum timeout (unit: second)
- :value 1-3600, default: 30
- :type server_timeout: int
- :param ie6_compatible:
- compatible with IE6 HTTPS request
- (the protocol format is earlier SSL3.0, the security is poor)
- :value true or false, default: true
- :type ie6_compatible: bool
- :param encryption_type:
- Encryption options, support three types:
- compatibleIE or incompatibleIE or userDefind,
- corresponding to:
- IE-compatible encryption or disabled unsecure encryption
- or custom encryption,
- when encryptionType is valid and legitimate,
- ie6Compatible field transfer value will not take effect
- type: encryption_type:string
- :param encryption_protocols:
- When the encryptionType value is userDefind,
- the list of protocol types is a string list composed of four protocols:
- "sslv3", "tlsv10", "tlsv11", "tlsv12".
- type: encryption_protocols:list
- :param dual_auth:
- Whether to Open Two-way Authentication,
- default:false
- :type dual_auth: boolean
- :param client_certIds:
- When dualAuth is true, the loaded client certificate chain
- :type client_certIds: list
- :param additional_cert_domains:
- Additional domain name,each element is an object that contains two attributes, namely "certId" and "host"
- :type additional_cert_domains: list
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'HTTPSlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'listenerPort': listener_port, 'backendPort': backend_port,
- 'scheduler': compat.convert_to_string(scheduler),
- 'certIds': cert_ids}
- if keep_session is not None:
- body['keepSession'] = keep_session
- if keep_session_type is not None:
- body['keepSessionType'] = \
- compat.convert_to_string(keep_session_type)
- if keep_session_duration is not None:
- body['keepSessionDuration'] = keep_session_duration
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forward_for is not None:
- body['xForwardFor'] = x_forward_for
- if health_check_type is not None:
- body['healthCheckType'] = \
- compat.convert_to_string(health_check_type)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_uri is not None:
- body['healthCheckURI'] = \
- compat.convert_to_string(health_check_uri)
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealth_threshold is not None:
- body['unhealthyThreshold'] = unhealth_threshold
- if health_threshold is not None:
- body['healthyThreshold'] = health_threshold
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if server_timeout is not None:
- body['serverTimeout'] = server_timeout
- if ie6_compatible is not None:
- body['ie6Compatible'] = ie6_compatible
- if encryption_type is not None:
- body['encryptionType'] = \
- compat.convert_to_string(encryption_type)
- if encryption_protocols is not None:
- body['encryptionProtocols'] = encryption_protocols
- if dual_auth is not None:
- body['dualAuth'] = dual_auth
- if client_certIds is not None:
- body['clientCertIds'] = client_certIds
- if additional_cert_domains is not None:
- body['additionalCertDomains'] = additional_cert_domains
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body),
- params=params, config=config)
- @required(blb_id=(bytes, str), listener_port=int,
- backend_port=int, scheduler=(bytes, str), cert_ids=list)
- def create_ssl_listener(self, blb_id, listener_port, backend_port,
- scheduler, cert_ids,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealth_threshold=None, health_threshold=None,
- ie6_compatible=None, encryption_type=None,
- encryption_protocols=None,
- dual_auth=None, client_certIds=None,
- client_token=None, config=None):
- """
- Create a ssl listener rule with thSe specified options.
- :param blb_id:
- The id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- Port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler:
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection'
- :type scheduler: string
- :param cert_ids:
- The SSL certificate to be loaded by the listener.
- Currently HTTPS listeners can only bind one SSL certificate.
- :type cert_ids: List<String>
- :param health_check_timeout_in_second:
- Health check timeout (unit: second)
- :value 1-60, default:3
- :type health_check_timeout_in_second: int
- :param health_check_interval:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval: int
- :param unhealth_threshold:
- The unhealthy threshold, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type unhealth_threshold: int
- :param health_threshold:
- Health threshold, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_threshold: int
- :param ie6_compatible:
- compatible with IE6 HTTPS request
- (the protocol format is earlier SSL3.0, the security is poor)
- :value true or false, default: true
- :type ie6_compatible: bool
- :param encryption_type:
- Encryption options, support three types:
- compatibleIE or incompatibleIE or userDefind,
- corresponding to:
- IE-compatible encryption or disabled unsecure encryption
- or custom encryption,
- when encryptionType is valid and legitimate,
- ie6Compatible field transfer value will not take effect
- type: encryption_type:string
- :param encryption_protocols:
- When the encryptionType value is userDefind,
- the list of protocol types is a string list composed of four protocols:
- "sslv3", "tlsv10", "tlsv11", "tlsv12".
- type: encryption_protocols:list
- :param dual_auth:
- Whether to Open Two-way Authentication,
- default:false
- :type dual_auth: boolean
- :param client_certIds:
- When dualAuth is true, the loaded client certificate chain
- :type client_certIds: list
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'SSLlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'listenerPort': listener_port, 'backendPort': backend_port,
- 'scheduler': compat.convert_to_string(scheduler),
- 'certIds': cert_ids}
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealth_threshold is not None:
- body['unhealthyThreshold'] = unhealth_threshold
- if health_threshold is not None:
- body['healthyThreshold'] = health_threshold
- if ie6_compatible is not None:
- body['ie6Compatible'] = ie6_compatible
- if encryption_type is not None:
- body['encryptionType'] = \
- compat.convert_to_string(encryption_type)
- if encryption_protocols is not None:
- body['encryptionProtocols'] = encryption_protocols
- if dual_auth is not None:
- body['dualAuth'] = dual_auth
- if client_certIds is not None:
- body['clientCertIds'] = client_certIds
- # for test,if not,return internal server error
- # body['healthCheckType'] = "TCP"
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body),
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def describe_tcp_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None, config=None):
- """
- get tcp listeners identified by blbID
- :param blb_id
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port
- The listener port to query
- :type listener_port:int
- :param marker
- The optional parameter marker specified in the
- original request to specify
- where in the results to begin listing.
- Together with the marker, specifies the list result
- which listing should begin.
- If the marker is not specified, the list result will
- listing from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of
- list result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'TCPlistener')
- params = {}
- if listener_port is not None:
- params[b'listenerPort'] = listener_port
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def describe_udp_listener(self, blb_id, listener_port=None, marker=None,
- max_keys=None, config=None):
- """
- get udp listeners identified by blbID
- :param blb_id
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port
- The listener port to query
- :type listener_port:int
- :param marker
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result which
- listing should begin.
- If the marker is not specified, the list result will
- listing from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of
- list result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'UDPlistener')
- params = {}
- if listener_port is not None:
- params[b'listenerPort'] = listener_port
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def describe_http_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None, config=None):
- """
- get http listeners identified by blbID
- :param blb_id
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port
- The listener port to query
- :type listener_port:int
- :param marker
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result which
- listing should begin.
- If the marker is not specified, the list result will listing
- from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of list
- result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'HTTPlistener')
- params = {}
- if listener_port is not None:
- params[b'listenerPort'] = listener_port
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def describe_https_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None, config=None):
- """
- get https listeners identified by blbID
- :param blb_id
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port
- The listener port to query
- :type listener_port:int
- :param marker
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result which
- listing should begin.
- If the marker is not specified, the list result will listing
- from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of list
- result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'HTTPSlistener')
- params = {}
- if listener_port is not None:
- params[b'listenerPort'] = listener_port
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def describe_ssl_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None, config=None):
- """
- get ssl listeners identified by blbID
- :param blb_id
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port
- The listener port to query
- :type listener_port:int
- :param marker
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result which
- listing should begin.
- If the marker is not specified, the list result will listing
- from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of list
- result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'SSLlistener')
- params = {}
- if listener_port is not None:
- params[b'listenerPort'] = listener_port
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str))
- def describe_all_listeners(self, blb_id, listener_port=None,
- marker=None, max_keys=None, config=None):
- """
- get all listeners identified by blbID
- :param blb_id
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port
- The listener port to query
- :type listener_port:int
- :param marker
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result which
- listing should begin.
- If the marker is not specified, the list result will listing
- from the first one.
- :type marker: string
- :param max_keys
- The optional parameter to specifies the max number of list
- result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'listener')
- params = {}
- if listener_port is not None:
- params[b'listenerPort'] = listener_port
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path,
- params=params, config=config)
- @required(blb_id=(bytes, str),
- listener_port=int)
- def update_tcp_listener(self, blb_id, listener_port,
- backend_port=None, scheduler=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealth_threshold=None,
- health_threshold=None,
- config=None):
- """
- update a tcp listener rule with the specified options.
- :param blb_id:
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port:int
- :param backend_port:
- port to be listened owned by Backend server
- :value 1-65535
- :type backend_port:int
- :param scheduler
- balancing algorithm
- :value 'RoundRobin'or'LeastConnection'or'Hash'
- :type scheduler:string
- :param health_check_timeout_in_second
- Health check timeout
- :value 1-60 default:3 unit:seconds
- :type health_check_timeout_in_second:string
- :param health_check_interval
- Health check interval
- :value 1-10 default:3 unit:seconds
- :type health_check_interval:string
- :param unhealth_threshold
- Unhealthy threshold,
- how many consecutive health check failures,
- shielding the backend server
- :value 2-5 default:3
- :type unhealth_threshold:string
- :param health_threshold
- Health threshold,
- how many consecutive health checks are successful,
- then re-use the back-end server
- :value 2-5 default:3
- :type health_threshold:string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'TCPlistener')
- params = {}
- params[b'listenerPort'] = listener_port
- body = {}
- if backend_port is not None:
- body['backendPort'] = backend_port
- if scheduler is not None:
- body['scheduler'] = compat.convert_to_string(scheduler)
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealth_threshold is not None:
- body['unhealthyThreshold'] = unhealth_threshold
- if health_threshold is not None:
- body['healthyThreshold'] = health_threshold
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- listener_port=int,
- backend_port=int)
- def update_udp_listener(self, blb_id, listener_port, backend_port=None,
- scheduler=None,
- health_check_type=None,
- health_check_port=None,
- health_check_string=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealth_threshold=None,
- health_threshold=None,
- config=None):
- """
- update a udp listener rule with the specified options.
- :param blb_id:
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port:int
- :param backend_port:
- port to be listened owned by Backend server
- :value 1-65535
- :type backend_port:int
- :param scheduler
- balancing algorithm
- :value 'RoundRobin'or'LeastConnection'or'Hash'
- :type scheduler:string
- :param health_check_type
- Health check protocol
- :value 'UDP' or 'ICMP'
- :type health_check_type:string
- :param health_check_port
- Health check port, the default is the same as backend_port.
- This field can only be updated if health_check_type is UDP.
- :type health_check_port:int
- :param health_check_string
- The request string sent by the health,
- the backend server needs to respond after receiving it,
- and supports standard escaping
- :type health_check_string:string
- :param health_check_timeout_in_second
- Health check timeout
- :value 1-60 default:3 unit:seconds
- :type health_check_timeout_in_second:string
- :param health_check_interval
- Health check interval
- :value 1-10 default:3 unit:seconds
- :type health_check_interval:string
- :param unhealth_threshold
- Unhealthy threshold,
- how many consecutive health check failures,
- shielding the backend server
- :value 2-5 default:3
- :type unhealth_threshold:string
- :param health_threshold
- Health threshold,
- how many consecutive health checks are successful,
- then re-use the back-end server
- :value 2-5 default:3
- :type health_threshold:string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'UDPlistener')
- params = {}
- params[b'listenerPort'] = listener_port
- body = {}
- if backend_port is not None:
- body['backendPort'] = backend_port
- if scheduler is not None:
- body['scheduler'] = compat.convert_to_string(scheduler)
- if health_check_type is not None:
- body['healthCheckType'] = \
- compat.convert_to_string(health_check_type)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_string is not None:
- body['healthCheckString'] = \
- compat.convert_to_string(health_check_string)
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealth_threshold is not None:
- body['unhealthyThreshold'] = unhealth_threshold
- if health_threshold is not None:
- body['healthyThreshold'] = health_threshold
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body),
- params=params, config=config)
- @required(blb_id=(bytes, str),
- listener_port=int)
- def update_http_listener(self, blb_id, listener_port, backend_port=None,
- scheduler=None, keep_session=None,
- keep_session_type=None,
- keep_session_duration=None,
- keep_session_cookie_name=None,
- x_forward_for=None,
- health_check_type=None, health_check_port=None,
- health_check_uri=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealth_threshold=None, health_threshold=None,
- health_check_normal_status=None,
- server_timeout=None,
- redirect_port=None, config=None):
- """
- update a http listener rule with the specified options.
- :param blb_id:
- The id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- Port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler:
- Balancing algorithm
- :value 'RoundRobin' or 'LeastConnection' or 'Hash'
- :type scheduler: string
- :param keep_session:
- Whether to enable the session hold function, that is,
- the request sent by the same client will reach the
- same backend server
- :value true or false, default:false
- :type keep_session: bool
- :param keep_session_type:
- The cookie handling method maintained by the session,
- valid only if the session is held open
- :value 'insert' or 'rewrite', default:insert
- :type keep_session_type: string
- :param keep_session_duration:
- The time the cookie is kept in session (in seconds),
- valid only if the session is held open
- :value 1-15552000, default:3600
- :type keep_session_duration: int
- :param keep_session_cookie_name:
- The session keeps the name of the cookie that needs
- to be overridden,if and only if session persistence is
- enabled and keep_session_type="rewrite"
- :type keep_session_cookie_name: int
- :param x_forward_for:
- Whether to enable the real IP address of the client,
- the backend server can obtain the real address of the
- client through the X-Forwarded-For HTTP header.
- :value true or false, default: flase
- :type x_forward_for: bool
- :param health_check_type:
- Health check protocol
- :value 'HTTP' or 'TCP'
- :type health_check_type: string
- :param health_check_port:
- Health check port, the default is the same as backend_port
- :type health_check_port: int
- :param health_check_uri:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_uri: string
- :param health_check_timeout_in_second:
- Health check timeout (unit: second)
- :value 1-60, default: 3
- :type health_check_timeout_in_second: int
- :param health_check_interval:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval: int
- :param unhealth_threshold:
- The unhealthy threshold, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type unhealth_threshold: int
- :param health_threshold:
- Health threshold, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_threshold: int
- :param health_check_normal_status:
- The HTTP status code when the health check is normal supports
- a combination of five types of status codes,
- such as "http_1xx|http_2xx", Effective when the health check
- protocol is "HTTP"
- :value default: http_2xx|http_3xx
- :type health_check_normal_status: string
- :param server_timeout:
- Backend server maximum timeout (unit: second)
- :value 1-3600, default: 30
- :type server_timeout: int
- :param redirect_port:
- Forward the request received by this listener to the HTTPS
- listener, which is specified by the HTTPS listener.
- :type redirect_port: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'HTTPlistener')
- params = {}
- params[b'listenerPort'] = listener_port
- body = {}
- if backend_port is not None:
- body['backendPort'] = backend_port
- if scheduler is not None:
- body['scheduler'] = compat.convert_to_string(scheduler)
- if keep_session is not None:
- body['keepSession'] = keep_session
- if keep_session_type is not None:
- body['keepSessionType'] = \
- compat.convert_to_string(keep_session_type)
- if keep_session_duration is not None:
- body['keepSessionDuration'] = keep_session_duration
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forward_for is not None:
- body['xForwardFor'] = x_forward_for
- if health_check_type is not None:
- body['healthCheckType'] = \
- compat.convert_to_string(health_check_type)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_uri is not None:
- body['healthCheckURI'] = \
- compat.convert_to_string(health_check_uri)
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealth_threshold is not None:
- body['unhealthyThreshold'] = unhealth_threshold
- if health_threshold is not None:
- body['healthyThreshold'] = health_threshold
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if server_timeout is not None:
- body['serverTimeout'] = server_timeout
- if redirect_port is not None:
- body['redirectPort'] = redirect_port
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body),
- params=params, config=config)
- @required(blb_id=(bytes, str), listener_port=int)
- def update_https_listener(self, blb_id, listener_port,
- backend_port=None,
- scheduler=None, keep_session=None,
- keep_session_type=None,
- keep_session_duration=None,
- keep_session_cookie_name=None,
- x_forward_for=None, health_check_type=None,
- health_check_port=None, health_check_uri=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealth_threshold=None, health_threshold=None,
- health_check_normal_status=None,
- server_timeout=None,
- cert_ids=None, additional_cert_domains=None,
- ie6_compatible=None, config=None):
- """
- update a https listener rule with the specified options.
- :param blb_id:
- The id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- Port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- Port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler:
- Balancing algorithm
- :value 'RoundRobin' or 'LeastConnection' or 'Hash'
- :type scheduler: string
- :param keep_session:
- Whether to enable the session hold function, that is, the request
- sent by the same client will reach the same backend server
- :value true or false, default: false
- :type keep_session: bool
- :param keep_session_type:
- The cookie handling method maintained by the session,
- valid only if the session is held open
- :value 'insert' or 'rewrite', default: insert
- :type keep_session_type: string
- :param keep_session_duration:
- The time the cookie is kept in session (in seconds),
- valid only if the session is held open
- :value 1-15552000, default:3600
- :type keep_session_duration: int
- :param keep_session_cookie_name:
- The session keeps the name of the cookie that needs to be
- overridden,if and only if session persistence is enabled and
- keep_session_type="rewrite"
- :type keep_session_cookie_name: int
- :param x_forward_for:
- Whether to enable the real IP address of the client,
- the backend server can obtain the real address of the client
- through the X-Forwarded-For HTTP header.
- :value true or false, default: False
- :type x_forward_for: bool
- :param health_check_type:
- Health check protocol
- :value 'HTTP' or 'TCP'
- :type health_check_type: string
- :param health_check_port:
- Health check port, the default is the same as backend_port
- :type health_check_port: int
- :param health_check_uri:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_uri: string
- :param health_check_timeout_in_second:
- Health check timeout (unit: second)
- :value 1-60, default: 3
- :type health_check_timeout_in_second: int
- :param health_check_interval:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval: int
- :param unhealth_threshold:
- The unhealthy threshold, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type unhealth_threshold: int
- :param health_threshold:
- Health threshold, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_threshold: int
- :param health_check_normal_status:
- The HTTP status code when the health check is normal supports
- a combination of five types of status codes,
- such as "http_1xx|http_2xx", Effective when the health check
- protocol is "HTTP"
- :value default: http_2xx|http_3xx
- :type health_check_normal_status: string
- :param server_timeout:
- Backend server maximum timeout (unit: second)
- :value 1-3600, default: 30
- :type server_timeout: int
- :param cert_ids:
- The SSL certificate to be loaded by the listener.
- Currently HTTPS listeners can only bind one SSL certificate.
- :type cert_ids:List<String>
- :param: additional_cert_domains:
- Additional domain name,each element is an object that contains two attributes, namely "cert_id" and "host"
- :type additional_cert_domains: list
- :param ie6_compatible:
- Is it compatible with IE6 HTTPS request
- (the protocol format is earlier SSL3.0, the security is poor)
- :value true or false, default: true
- :type ie6_compatible: bool
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'HTTPSlistener')
- params = {}
- params[b'listenerPort'] = listener_port
- body = {}
- if backend_port is not None:
- body['backendPort'] = backend_port
- if scheduler is not None:
- body['scheduler'] = compat.convert_to_string(scheduler)
- if keep_session is not None:
- body['keepSession'] = keep_session
- if keep_session_type is not None:
- body['keepSessionType'] = \
- compat.convert_to_string(keep_session_type)
- if keep_session_duration is not None:
- body['keepSessionDuration'] = keep_session_duration
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forward_for is not None:
- body['xForwardFor'] = x_forward_for
- if health_check_type is not None:
- body['healthCheckType'] = \
- compat.convert_to_string(health_check_type)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_uri is not None:
- body['healthCheckURI'] = \
- compat.convert_to_string(health_check_uri)
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealth_threshold is not None:
- body['unhealthyThreshold'] = unhealth_threshold
- if health_threshold is not None:
- body['healthyThreshold'] = health_threshold
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if server_timeout is not None:
- body['serverTimeout'] = server_timeout
- if cert_ids is not None:
- body['certIds'] = cert_ids
- if additional_cert_domains is not None:
- body['additionalCertDomains'] = additional_cert_domains
- if ie6_compatible is not None:
- body['ie6Compatible'] = ie6_compatible
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str), listener_port=int)
- def update_ssl_listener(self, blb_id, listener_port,
- backend_port=None, scheduler=None,
- health_check_timeout_in_second=None,
- health_check_interval=None,
- unhealth_threshold=None,
- health_threshold=None, cert_ids=None,
- ie6_compatible=None,
- encryption_type=None,
- encryption_protocols=None,
- dual_auth=None, client_certIds=None,
- config=None):
- """
- update a ssl listener rule with the specified options.
- :param blb_id:
- The id of blb which the listener work on
- :type blb_id: string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param backend_port:
- Port to be listened owned by Backend server
- :value 1-65535
- :type backend_port: int
- :param scheduler:
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection'
- :type scheduler: string
- :param health_check_timeout_in_second:
- Health check timeout (unit: second)
- :value 1-60, default:3
- :type health_check_timeout_in_second: int
- :param health_check_interval:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval: int
- :param unhealth_threshold:
- The unhealthy threshold, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type unhealth_threshold: int
- :param health_threshold:
- Health threshold, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_threshold: int
- :param cert_ids:
- The SSL certificate to be loaded by the listener.
- Currently HTTPS listeners can only bind one SSL certificate.
- :type cert_ids: List<String>
- :param ie6_compatible:
- compatible with IE6 HTTPS request
- (the protocol format is earlier SSL3.0, the security is poor)
- :value true or false, default: true
- :type ie6_compatible: bool
- :param encryption_type:
- Encryption options, support three types:
- compatibleIE or incompatibleIE or userDefind,
- corresponding to:
- IE-compatible encryption or disabled unsecure encryption or
- custom encryption,
- when encryptionType is valid and legitimate,
- ie6Compatible field transfer value will not take effect
- type: encryption_type:string
- :param encryption_protocols:
- When the encryptionType value is userDefind,
- the list of protocol types is a string list composed of four protocols:
- "sslv3", "tlsv10", "tlsv11", "tlsv12".
- type: encryption_protocols:list
- :param dual_auth:
- Whether to Open Two-way Authentication,
- default:false
- :type dual_auth: boolean
- :param client_certIds:
- When dualAuth is true, the loaded client certificate chain
- :type client_certIds: list
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'SSLlistener')
- params = {}
- params[b'listenerPort'] = listener_port
- body = {}
- if backend_port is not None:
- body['backendPort'] = backend_port
- if scheduler is not None:
- body['scheduler'] = compat.convert_to_string(scheduler)
- if health_check_timeout_in_second is not None:
- body['healthCheckTimeoutInSecond'] = \
- health_check_timeout_in_second
- if health_check_interval is not None:
- body['healthCheckInterval'] = health_check_interval
- if unhealth_threshold is not None:
- body['unhealthyThreshold'] = unhealth_threshold
- if health_threshold is not None:
- body['healthyThreshold'] = health_threshold
- if cert_ids is not None:
- body['certIds'] = cert_ids
- if ie6_compatible is not None:
- body['ie6Compatible'] = ie6_compatible
- if encryption_type is not None:
- body['encryptionType'] = \
- compat.convert_to_string(encryption_type)
- if encryption_protocols is not None:
- body['encryptionProtocols'] = encryption_protocols
- if dual_auth is not None:
- body['dualAuth'] = dual_auth
- if client_certIds is not None:
- body['clientCertIds'] = client_certIds
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body),
- params=params, config=config)
- @required(blb_id=(bytes, str),
- portList=list)
- def delete_listeners(self, blb_id, portList, client_token=None, config=None):
- """
- Release the listener under the specified LoadBalancer,
- the listener is specified by listening to the port.
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param portList:
- The ports of listeners to be released
- :type portList:list<int>
- :param client_token:
- If the clientToken is not specified by the user, a random String
- generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'listener')
- params = {}
- params[b'batchdelete'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['portList'] = portList
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- """
- BackendServer API
- """
- @required(blb_id=(bytes, str),
- backend_server_list=list)
- def add_backend_servers(self, blb_id, backend_server_list,
- client_token=None, config=None):
- """
- Add a backend server for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param backend_server_list
- List of backend servers to be added
- :type backend_server_list:List<BackendServerModel>
- BackendServerModel{:param:instanceId
- id of Backend server
- :type instanceId:string
- :param weight
- Backend server weight, value range [0, 100],
- weight 0 means not to forward traffic to
- the backend server
- :type weight:int
- }
- :param client_token:
- If the clientToken is not specified by the user, a random String
- generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'backendserver')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['backendServerList'] = backend_server_list
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- listener_port=int)
- def describe_health_status(self, blb_id, listener_port,
- marker=None, max_keys=None, config=None):
- """
- Query the information about the backend server under the specified
- LoadBalancer identified by listenPort
- :param blb_id:
- id of LoadBalancer
- :type blb_id: string
- :param listener_port:
- port to be linstened owned by listener
- :value 1-65535
- :type listener_port: int
- :param marker:
- The optional parameter marker specified in the original request
- to specify where in the results to begin listing.
- Together with the marker, specifies the list result which listing
- should begin. If the marker is not specified, the list result will
- listing from the first one.
- :type marker: string
- :param max_keys:
- The optional parameter to specifies the max number of list
- result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'backendserver')
- params = {}
- params[b'listenerPort'] = listener_port
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path, params=params,
- config=config)
- @required(blb_id=(bytes, str))
- def describe_backend_servers(self, blb_id, marker=None,
- max_keys=None, config=None):
- """
- Query the list of backend servers under the specified LoadBalancer
- :param blb_id:
- Id of LoadBalancer
- :type blb_id:string
- :param marker:
- The optional parameter marker specified in the original
- request to specify where in the results to begin listing.
- Together with the marker, specifies the list result which
- listing should begin. If the marker is not specified,
- the list result will listing from the first one.
- :type marker: string
- :param max_keys:
- The optional parameter to specifies the max number of
- list result to return.
- The default value is 1000.
- :type max_keys: int
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'backendserver')
- params = {}
- if marker is not None:
- params[b'marker'] = marker
- if max_keys is not None:
- params[b'maxKeys'] = max_keys
- return self._send_request(http_methods.GET, path, params=params,
- config=config)
- @required(blb_id=(bytes, str),
- backend_server_list=list)
- def update_backend_servers(self, blb_id, backend_server_list,
- client_token=None, config=None):
- """
- update the information about the backend server under
- the specified LoadBalancer
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param backend_server_list:
- List of backend servers to be updated
- :type backend_server_list:List<BackendServerModel>
- BackendServerModel{:param:instanceId
- id of Backend server
- :type instanceId:string
- :param weight
- Backend server weight, value range [0, 100],
- weight 0 means not to forward traffic to
- the backend server
- :type weight:int
- }
- :param client_token:
- If the clientToken is not specified by the user, a random String
- generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'backendserver')
- params = {}
- params[b'update'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['backendServerList'] = backend_server_list
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- backend_server_list=list)
- def remove_backend_servers(self, blb_id, backend_server_list,
- client_token=None, config=None):
- """
- Release the backend server under the specified LoadBalancer,
- which is specified by its backend server
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param backend_server_list:
- List of backend servers to be removed
- :type backend_server_list:List<string>
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'backendserver')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['backendServerList'] = backend_server_list
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- securitygroupids=list)
- def bind_security_groups(self, blb_id, securitygroupids,
- client_token=None, config=None):
- """
- bind the blb security groups (normal/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param securitygroupids:
- List of security group ids to be bind
- :type securitygroupids:List<string>
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'securitygroup')
- params = {}
- params[b'bind'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['securityGroupIds'] = securitygroupids
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- securitygroupids=list)
- def unbind_security_groups(self, blb_id, securitygroupids,
- client_token=None, config=None):
- """
- unbind the blb security groups (normal/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param securitygroupids:
- List of security group ids to be bind
- :type securitygroupids:List<string>
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'securitygroup')
- params = {}
- params[b'unbind'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['securityGroupIds'] = securitygroupids
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str))
- def describe_security_groups(self, blb_id,
- client_token=None, config=None):
- """
- describe the blb security groups (normal/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'securitygroup')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- return self._send_request(http_methods.GET, path, params=params,
- config=config)
- @required(blb_id=(bytes, str),
- enterprisesecuritygroupids=list)
- def bind_enterprise_security_groups(self, blb_id, enterprisesecuritygroupids,
- client_token=None, config=None):
- """
- bind the blb enterprise security groups (normal/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param enterprisesecuritygroupids:
- List of enterprise security group ids to be bind
- :type enterprisesecuritygroupids:List<string>
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'enterprise', 'securitygroup')
- params = {}
- params[b'bind'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['enterpriseSecurityGroupIds'] = enterprisesecuritygroupids
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- enterprisesecuritygroupids=list)
- def unbind_enterprise_security_groups(self, blb_id, enterprisesecuritygroupids,
- client_token=None, config=None):
- """
- unbind the blb enterprise security groups (normal/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param enterprisesecuritygroupids:
- List of enterprise security group ids to be unbind
- :type enterprisesecuritygroupids:List<string>
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'enterprise', 'securitygroup')
- params = {}
- params[b'unbind'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['enterpriseSecurityGroupIds'] = enterprisesecuritygroupids
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str))
- def describe_enterprise_security_groups(self, blb_id,
- client_token=None, config=None):
- """
- describe the blb enterprise security groups (normal/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param client_token:
- If the clientToken is not specified by the user,
- a random String generated by default algorithm will be used.
- :type client_token: string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'blb', blb_id, 'enterprise', 'securitygroup')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- return self._send_request(http_methods.GET, path, params=params,
- config=config)
- def generate_client_token_by_uuid():
- """
- The default method to generate the random string for client_token
- if the optional parameter client_token is not specified by the user.
- :return:
- :rtype string
- """
- return str(uuid.uuid4())
- generate_client_token = generate_client_token_by_uuid
|