| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541 |
- # Copyright (c) 2019 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 APP 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 AppBlbClient(bce_base_client.BceBaseClient):
- """
- APP 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_app_loadbalancer(self, vpc_id, subnet_id, name=None,
- desc=None, client_token=None, config=None):
- """
- Create a app 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, 'appblb')
- 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)
- @required(blb_id=(bytes, str))
- def update_app_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, 'appblb', 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)
- def describe_app_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, 'appblb')
- 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_app_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, 'appblb', blb_id)
- return self._send_request(http_methods.GET, path,
- config=config)
- @required(blb_id=(bytes, str))
- def delete_app_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, 'appblb', 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)
- """
- Listener API
- """
- @required(blb_id=(bytes, str),
- listener_port=int,
- scheduler=(bytes, str))
- def create_app_tcp_listener(self, blb_id, listener_port,
- scheduler, client_token=None,
- config=None):
- """
- Create a app 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 scheduler
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection' or 'Hash'
- :type scheduler: 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, 'appblb', 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,
- 'scheduler': compat.convert_to_string(scheduler)
- }
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- listener_port=int,
- scheduler=(bytes, str))
- def create_app_udp_listener(self, blb_id, listener_port,
- scheduler, client_token=None,
- config=None):
- """
- Create a app 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 scheduler
- balancing algorithm
- :value 'RoundRobin' or 'LeastConnection' or 'Hash'
- :type scheduler: 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, 'appblb', 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,
- 'scheduler': compat.convert_to_string(scheduler)
- }
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str), listener_port=int,
- scheduler=(bytes, str))
- def create_app_http_listener(self, blb_id, listener_port,
- scheduler, keep_session=None,
- keep_session_type=None,
- keep_session_timeout=None,
- keep_session_cookie_name=None,
- x_forwarded_for=None,
- server_timeout=None,
- redirect_port=None,
- client_token=None,
- config=None):
- """
- Create a app 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 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_timeout:
- 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_timeout: 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_forwarded_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_forwarded_for: bool
- :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, 'appblb', 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,
- '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_timeout is not None:
- body['keepSessionTimeout'] = keep_session_timeout
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forwarded_for is not None:
- body['xForwardedFor'] = x_forwarded_for
- 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,
- scheduler=(bytes, str), cert_ids=list)
- def create_app_https_listener(self, blb_id, listener_port,
- scheduler, cert_ids,
- keep_session=None,
- keep_session_type=None,
- keep_session_timeout=None,
- keep_session_cookie_name=None,
- x_forwarded_for=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 app 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 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_timeout:
- 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_timeout: 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_forwarded_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_forwarded_for: bool
- :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/incompatibleIE/userDefind,
- corresponding to:
- IE-compatible encryption/disabled unsecure encryption/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 additional_cert_domains:
- Additional domain,each element is an object that contains two attributes, namely "cert_id" and "host"
- :type additional_cert_domains: list
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'appblb', 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,
- '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_timeout is not None:
- body['keepSessionTimeout'] = keep_session_timeout
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forwarded_for is not None:
- body['xForwardedFor'] = x_forwarded_for
- 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,
- scheduler=(bytes, str), cert_ids=list)
- def create_app_ssl_listener(self, blb_id, listener_port,
- scheduler, cert_ids,
- ie6_compatible=None,
- encryption_type=None,
- encryption_protocols=None,
- dual_auth=None, client_certIds=None,
- client_token=None, config=None):
- """
- Create a app 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 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 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/incompatibleIE/userDefind,
- corresponding to:
- IE-compatible encryption/disabled unsecure encryption/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, 'appblb', 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,
- 'scheduler': compat.convert_to_string(scheduler),
- '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.POST, path,
- body=json.dumps(body),
- params=params, config=config)
- @required(blb_id=(bytes, str),
- listener_port=int)
- def update_app_tcp_listener(self, blb_id, listener_port,
- scheduler=None,
- client_token=None,
- config=None):
- """
- update a app 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 scheduler
- balancing algorithm
- :value 'RoundRobin'or'LeastConnection'or'Hash'
- :type scheduler: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, 'appblb', blb_id, 'TCPlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- params[b'listenerPort'] = listener_port
- body = {}
- if scheduler is not None:
- body['scheduler'] = compat.convert_to_string(scheduler)
- 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_app_udp_listener(self, blb_id, listener_port,
- scheduler=None, client_token=None,
- config=None):
- """
- update a app 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 scheduler
- balancing algorithm
- :value 'RoundRobin'or'LeastConnection'or'Hash'
- :type scheduler: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, 'appblb', blb_id, 'UDPlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- params[b'listenerPort'] = listener_port
- body = {
- 'scheduler': compat.convert_to_string(scheduler)
- }
- 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_app_http_listener(self, blb_id, listener_port,
- scheduler=None, keep_session=None,
- keep_session_type=None,
- keep_session_timeout=None,
- keep_session_cookie_name=None,
- x_forwarded_for=None,
- server_timeout=None,
- redirect_port=None,
- client_token=None,
- config=None):
- """
- update a app 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 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_timeout:
- 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_timeout: 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_forwarded_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_forwarded_for: bool
- :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, 'appblb', blb_id, 'HTTPlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- params[b'listenerPort'] = listener_port
- body = {}
- 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_timeout is not None:
- body['keepSessionTimeout'] = keep_session_timeout
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forwarded_for is not None:
- body['xForwardedFor'] = x_forwarded_for
- 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_app_https_listener(self, blb_id, listener_port,
- scheduler=None,
- keep_session=None,
- keep_session_type=None,
- keep_session_timeout=None,
- keep_session_cookie_name=None,
- x_forwarded_for=None,
- server_timeout=None,
- cert_ids=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):
- """
- update a app 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 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_timeout:
- 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_timeout: 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_forwarded_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_forwarded_for: bool
- :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 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 encryption_type:
- Encryption options, support three types:
- compatibleIE/incompatibleIE/userDefind,
- corresponding to:
- IE-compatible encryption/disabled unsecure encryption/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 "cert_id" 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, 'appblb', blb_id, 'HTTPSlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- params[b'listenerPort'] = listener_port
- body = {}
- 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_timeout is not None:
- body['keepSessionTimeout'] = keep_session_timeout
- if keep_session_cookie_name is not None:
- body['keepSessionCookieName'] = keep_session_cookie_name
- if x_forwarded_for is not None:
- body['xForwardedFor'] = x_forwarded_for
- if server_timeout is not None:
- body['serverTimeout'] = server_timeout
- if cert_ids is not None:
- body['certIds'] = cert_ids
- if ie6_compatible is not None:
- body['compatibleIE'] = 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.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str), listener_port=int)
- def update_app_ssl_listener(self, blb_id, listener_port,
- scheduler=None,
- cert_ids=None,
- ie6_compatible=None,
- encryption_type=None,
- encryption_protocols=None,
- dual_auth=None,
- client_certIds=None,
- client_token=None,
- config=None):
- """
- update a app 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 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 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/incompatibleIE/userDefind,
- corresponding to:
- IE-compatible encryption/disabled unsecure encryption/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, 'appblb', blb_id, 'SSLlistener')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- params[b'listenerPort'] = listener_port
- body = {}
- if scheduler is not None:
- body['scheduler'] = compat.convert_to_string(scheduler)
- if cert_ids is not None:
- body['certIds'] = cert_ids
- if ie6_compatible is not None:
- body['compatibleIE'] = 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))
- def describe_app_tcp_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None,
- config=None):
- """
- get app tcp listeners identified by bibID
- :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, 'appblb', 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_app_udp_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None,
- config=None):
- """
- get app udp listeners identified by bibID
- :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, 'appblb', 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_app_http_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None,
- config=None):
- """
- get app http listeners identified by bibID
- :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, 'appblb', 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_app_https_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None,
- config=None):
- """
- get app https listeners identified by bibID
- :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, 'appblb', 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_app_ssl_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None, config=None):
- """
- get app ssl listeners identified by bibID
- :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, 'appblb', 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_app_all_listener(self, blb_id, listener_port=None,
- marker=None, max_keys=None, config=None):
- """
- get app all listeners identified by bibID
- :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, 'appblb', 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),
- portList=list)
- def delete_app_listeners(self, blb_id, portList,
- client_token=None,
- config=None):
- """
- Release app 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, 'appblb', 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)
- @required(blb_id=(bytes, str),
- listener_port=int,
- app_policy_vos=list)
- def create_policys(self, blb_id, listener_port,
- app_policy_vos, client_token=None,
- config=None):
- """
- Create policys.
- :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 app_policy_vos
- policy list the listener binds.
- If the listener type is TCP,
- there is only one policy
- and only the full match is supported.
- https://cloud.baidu.com/doc/BLB/API.html#AppPolicy
- :type app_policy_vos: list<AppPolicy>
- :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, 'appblb', blb_id, 'policys')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'listenerPort': listener_port,
- 'appPolicyVos': app_policy_vos
- }
- 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_policys(self, blb_id, listener_port,
- marker=None, max_keys=None,
- config=None):
- """
- get policys
- :param blb_id
- the id of blb which the listener work on
- :type blb_id:string
- :param listener_port
- The listener port used by listener
- :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, 'appblb', blb_id, 'policys')
- params = {}
- params[b'port'] = 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,
- policys_list=list)
- def delete_policys(self, blb_id, listener_port,
- policys_list,
- 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 listener_port
- The listener port used by listener
- :type listener_port:int
- :param policys_list
- All policy identifiers to be released
- :type policys_list:list<str>
- :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, 'appblb', blb_id, 'policys')
- params = {}
- params[b'batchdelete'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'port': listener_port,
- 'policyIdList': policys_list
- }
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- """
- ServerGroup API
- """
- @required(blb_id=(bytes, str))
- def create_app_server_group(self, blb_id,
- name=None,
- desc=None,
- backend_server_list=None,
- client_token=None,
- config=None):
- """
- create server group for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param name:
- name of server group
- :type name:string
- :param desc:
- description of server group
- :type desc:string
- :param backend_server_list
- List of backend servers to be added
- https://cloud.baidu.com/doc/BLB/API.html#AppBackendServer
- :type backend_server_list:List<AppBackendServer>
- :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, 'appblb', blb_id, 'appservergroup')
- 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)
- if backend_server_list is not None:
- 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),
- sg_id=(bytes, str))
- def update_app_server_group(self, blb_id, sg_id,
- name=None,
- desc=None,
- client_token=None,
- config=None):
- """
- update the information of the app server group
- of the specified LoadBalancer
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group to be updated
- :type sg_id:string
- :param name:
- name of server group
- :type name:string
- :param desc:
- description of server group
- :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, 'appblb', blb_id, 'appservergroup')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['sgId'] = compat.convert_to_string(sg_id)
- 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,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str))
- def describe_app_server_group(self, blb_id,
- name=None,
- exactly_match=None,
- marker=None,
- max_keys=None, config=None):
- """
- Query the imformation of app server group
- of the specified LoadBalancer
- :param blb_id:
- Id of LoadBalancer
- :type blb_id:string
- :param name:
- name of server group
- :type name:string
- :param exactly_match:
- Set whether the name matches globally
- :type exactly_match:boolean
- :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, 'appblb', blb_id, 'appservergroup')
- params = {}
- if name is not None:
- params[b'name'] = name
- if exactly_match is not None:
- params[b'exactlyMatch'] = exactly_match
- 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),
- sg_id=(bytes, str))
- def delete_app_server_group(self, blb_id, sg_id,
- client_token=None,
- config=None):
- """
- delete the app server group of the specified LoadBalancer,
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group to be updated
- :type sg_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, 'appblb', blb_id, 'appservergroup')
- params = {}
- params[b'delete'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['sgId'] = compat.convert_to_string(sg_id)
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- sg_id=(bytes, str), port=int,
- protocol_type=(bytes, str))
- def create_app_server_group_port(self, blb_id, sg_id,
- port, protocol_type,
- health_check=None,
- health_check_port=None,
- health_check_urlpath=None,
- health_check_timeout_insecond=None,
- health_check_interval_insecond=None,
- health_check_down_retry=None,
- health_check_up_retry=None,
- health_check_normal_status=None,
- udp_health_check_string=None,
- client_token=None,
- config=None):
- """
- create server group for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param port:
- Port number, integer between 1 and 65535
- :type port:string
- :param protocol_type:
- Protocol type of listening port, "TCP"/"UDP"/"HTTP"
- :type protocol_type:string
- :param health_check:
- Health check protocol
- :value 'HTTP' or 'TCP',default:'HTTP'
- :type health_check: string
- :param health_check_port:
- Health check port, the default is the same as port
- :type health_check_port: int
- :param health_check_urlpath:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_urlpath: string
- :param health_check_timeout_insecond:
- Health check timeout (unit: second)
- :value 1-60, default: 3
- :type health_check_timeout_insecond: int
- :param health_check_interval_insecond:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval_insecond: int
- :param health_check_down_retry:
- The unhealthy down retry, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type health_check_down_retry: int
- :param health_check_up_retry:
- Health up retry, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_check_up_retry: 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 udp_health_check_string:
- The health check string for the udp listener,
- it must be passed when the health check type is "UDP"
- :type udp_health_check_string: 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, 'appblb', blb_id, 'appservergroupport')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'sgId': compat.convert_to_string(sg_id),
- 'port': port,
- 'type': compat.convert_to_string(protocol_type)
- }
- if health_check is not None:
- body['healthCheck'] = compat.convert_to_string(health_check)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_urlpath is not None:
- body['healthCheckUrlPath'] = \
- compat.convert_to_string(health_check_urlpath)
- if health_check_timeout_insecond is not None:
- body['healthCheckTimeoutInSecond'] = health_check_timeout_insecond
- if health_check_interval_insecond is not None:
- body['healthCheckIntervalInSecond'] = health_check_interval_insecond
- if health_check_down_retry is not None:
- body['healthCheckDownRetry'] = health_check_down_retry
- if health_check_up_retry is not None:
- body['healthCheckUpRetry'] = health_check_up_retry
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if udp_health_check_string is not None:
- body['udpHealthCheckString'] = \
- compat.convert_to_string(udp_health_check_string)
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- sg_id=(bytes, str),
- port_id=(bytes, str))
- def update_app_server_group_port(self, blb_id, sg_id, port_id,
- health_check=None,
- health_check_port=None,
- health_check_urlpath=None,
- health_check_timeout_insecond=None,
- health_check_interval_insecond=None,
- health_check_down_retry=None,
- health_check_up_retry=None,
- health_check_normal_status=None,
- udp_health_check_string=None,
- client_token=None,
- config=None):
- """
- update server group for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param port_id:
- The id of the server group port to be updated
- :type port_id:string
- :param health_check:
- Health check protocol
- :value 'HTTP' or 'TCP',default:'HTTP'
- :type health_check: string
- :param health_check_port:
- Health check port, the default is the same as port
- :type health_check_port: int
- :param health_check_urlpath:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_urlpath: string
- :param health_check_timeout_insecond:
- Health check timeout (unit: second)
- :value 1-60, default: 3
- :type health_check_timeout_insecond: int
- :param health_check_interval_insecond:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval_insecond: int
- :param health_check_down_retry:
- The unhealthy down retry, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type health_check_down_retry: int
- :param health_check_up_retry:
- Health up retry, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_check_up_retry: 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 udp_health_check_string:
- The health check string for the udp listener
- :type udp_health_check_string: 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, 'appblb', blb_id, 'appservergroupport')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'sgId': compat.convert_to_string(sg_id),
- 'portId': compat.convert_to_string(port_id)
- }
- if health_check is not None:
- body['healthCheck'] = compat.convert_to_string(health_check)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_urlpath is not None:
- body['healthCheckUrlPath'] = \
- compat.convert_to_string(health_check_urlpath)
- if health_check_timeout_insecond is not None:
- body['healthCheckTimeoutInSecond'] = health_check_timeout_insecond
- if health_check_interval_insecond is not None:
- body['healthCheckIntervalInSecond'] = health_check_interval_insecond
- if health_check_down_retry is not None:
- body['healthCheckDownRetry'] = health_check_down_retry
- if health_check_up_retry is not None:
- body['healthCheckUpRetry'] = health_check_up_retry
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if udp_health_check_string is not None:
- body['udpHealthCheckString'] = \
- compat.convert_to_string(udp_health_check_string)
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- sg_id=(bytes, str),
- port_list=list)
- def delete_app_server_group_port(self, blb_id, sg_id,
- port_list,
- client_token=None, config=None):
- """
- delete server group of the specified LoadBalancer,
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param port_list:
- The ports of listeners to be released
- :type port_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, 'appblb', blb_id, 'appservergroupport')
- params = {}
- params[b'batchdelete'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'sgId': compat.convert_to_string(sg_id),
- 'portIdList': port_list
- }
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- sg_id=(bytes, str),
- backend_server_list=list)
- def create_app_blb_rs(self, blb_id, sg_id,
- backend_server_list,
- client_token=None,
- config=None):
- """
- Add backend server for the specified LoadBalancer and server group,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param backend_server_list
- List of backend servers to be added
- https://cloud.baidu.com/doc/BLB/API.html#AppBackendServer
- :type backend_server_list:List<AppBackendServer>
- :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, 'appblb', blb_id, 'blbrs')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'sgId': compat.convert_to_string(sg_id),
- '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),
- sg_id=(bytes, str),
- backend_server_list=list)
- def update_app_blb_rs(self, blb_id, sg_id,
- backend_server_list,
- client_token=None,
- config=None):
- """
- update backend server for the specified LoadBalancer and server group,
- support batch update
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param backend_server_list
- List of backend servers to be added
- https://cloud.baidu.com/doc/BLB/API.html#AppBackendServer
- :type backend_server_list:List<AppBackendServer>
- :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, 'appblb', blb_id, 'blbrs')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'sgId': compat.convert_to_string(sg_id),
- '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),
- sg_id=(bytes, str))
- def describe_app_blb_rs(self, blb_id, sg_id,
- marker=None, max_keys=None,
- config=None):
- """
- Query the list of backend servers under the specified LoadBalancer
- and server group
- :param blb_id:
- Id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_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, 'appblb', blb_id, 'blbrs')
- params = {}
- params[b'sgId'] = compat.convert_to_string(sg_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),
- sg_id=(bytes, str),
- backend_server_list=list)
- def delete_app_blb_rs(self, blb_id, sg_id,
- backend_server_list,
- client_token=None,
- config=None):
- """
- delete backend server for the specified LoadBalancer and server group,
- support batch delete
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param backend_server_list
- List of backend servers to be deleted
- :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, 'appblb', blb_id, 'blbrs')
- params = {}
- params[b'batchdelete'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'sgId': compat.convert_to_string(sg_id),
- 'backendServerIdList': backend_server_list
- }
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- sg_id=(bytes, str))
- def describe_rs_mount(self, blb_id, sg_id, config=None):
- """
- describe servers of specific server group
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'appblb', blb_id, 'blbrsmount')
- params = {
- 'sgId': compat.convert_to_string(sg_id)
- }
- return self._send_request(http_methods.GET, path, params=params,
- config=config)
- @required(blb_id=(bytes, str),
- sg_id=(bytes, str))
- def describe_rs_unmount(self, blb_id, sg_id, config=None):
- """
- describe servers of specific server group
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param sg_id:
- id of the server group
- :type sg_id:string
- :param config:
- :type config: baidubce.BceClientConfiguration
- :return:
- :rtype baidubce.bce_response.BceResponse
- """
- path = utils.append_uri(self.version, 'appblb', blb_id, 'blbrsunmount')
- params = {
- 'sgId': compat.convert_to_string(sg_id)
- }
- return self._send_request(http_methods.GET, path, params=params,
- config=config)
- @required(blb_id=(bytes, str))
- def create_app_ip_group(self, blb_id,
- name=None,
- desc=None,
- member_list=None,
- client_token=None,
- config=None):
- """
- create ip group for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param name:
- name of ip group
- :type name:string
- :param desc:
- description of ip group
- :type desc:string
- :param member_list
- List of backend servers to be added
- https://cloud.baidu.com/doc/BLB/API.html#AppBackendServer
- :type member_list:List<AppIpGroupMemberVO>
- :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, 'appblb', blb_id, 'ipgroup')
- 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)
- if member_list is not None:
- body['memberList'] = member_list
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str))
- def update_app_ip_group(self, blb_id, ip_group_id,
- name=None,
- desc=None,
- client_token=None,
- config=None):
- """
- update the information of the app ip group
- of the specified LoadBalancer
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group to be updated
- :type ip_group_id:string
- :param name:
- name of server group
- :type name:string
- :param desc:
- description of server group
- :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, 'appblb', blb_id, 'ipgroup')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['ipGroupId'] = compat.convert_to_string(ip_group_id)
- 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,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str))
- def describe_app_ip_group(self, blb_id,
- name=None,
- exactly_match=None,
- marker=None,
- max_keys=None, config=None):
- """
- Query the imformation of app ip group
- of the specified LoadBalancer
- :param blb_id:
- Id of LoadBalancer
- :type blb_id:string
- :param name:
- name of ip group
- :type name:string
- :param exactly_match:
- Set whether the name matches globally
- :type exactly_match:boolean
- :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, 'appblb', blb_id, 'ipgroup')
- params = {}
- if name is not None:
- params[b'name'] = name
- if exactly_match is not None:
- params[b'exactlyMatch'] = exactly_match
- 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),
- ip_group_id=(bytes, str))
- def delete_app_ip_group(self, blb_id, ip_group_id,
- client_token=None,
- config=None):
- """
- delete the app ip group of the specified LoadBalancer,
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group to be updated
- :type ip_group_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, 'appblb', blb_id, 'ipgroup')
- params = {}
- params[b'delete'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['ipGroupId'] = compat.convert_to_string(ip_group_id)
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str),
- protocol_type=(bytes, str))
- def create_app_ip_group_port(self, blb_id, ip_group_id,
- protocol_type,
- health_check=None,
- health_check_port=None,
- health_check_urlpath=None,
- health_check_timeout_insecond=None,
- health_check_interval_insecond=None,
- health_check_down_retry=None,
- health_check_up_retry=None,
- health_check_normal_status=None,
- udp_health_check_string=None,
- client_token=None,
- config=None):
- """
- create server group for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group
- :type ip_group_id:string
- :param protocol_type:
- Protocol type of listening port, "TCP"/"UDP"/"HTTP"
- :type protocol_type:string
- :param health_check:
- Health check protocol
- :value 'HTTP' or 'TCP',default:'HTTP'
- :type health_check: string
- :param health_check_port:
- Health check port, the default is the same as port
- :type health_check_port: int
- :param health_check_urlpath:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_urlpath: string
- :param health_check_timeout_insecond:
- Health check timeout (unit: second)
- :value 1-60, default: 3
- :type health_check_timeout_insecond: int
- :param health_check_interval_insecond:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval_insecond: int
- :param health_check_down_retry:
- The unhealthy down retry, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type health_check_down_retry: int
- :param health_check_up_retry:
- Health up retry, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_check_up_retry: 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 udp_health_check_string:
- The health check string for the udp listener,
- it must be passed when the health check type is "UDP"
- :type udp_health_check_string: 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, 'appblb', blb_id, 'ipgroup', 'backendpolicy')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'ipGroupId': compat.convert_to_string(ip_group_id),
- 'type': compat.convert_to_string(protocol_type)
- }
- if health_check is not None:
- body['healthCheck'] = compat.convert_to_string(health_check)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_urlpath is not None:
- body['healthCheckUrlPath'] = \
- compat.convert_to_string(health_check_urlpath)
- if health_check_timeout_insecond is not None:
- body['healthCheckTimeoutInSecond'] = health_check_timeout_insecond
- if health_check_interval_insecond is not None:
- body['healthCheckIntervalInSecond'] = health_check_interval_insecond
- if health_check_down_retry is not None:
- body['healthCheckDownRetry'] = health_check_down_retry
- if health_check_up_retry is not None:
- body['healthCheckUpRetry'] = health_check_up_retry
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if udp_health_check_string is not None:
- body['udpHealthCheckString'] = \
- compat.convert_to_string(udp_health_check_string)
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str),
- port_id=(bytes, str))
- def update_app_ip_group_port(self, blb_id, ip_group_id, port_id,
- health_check=None,
- health_check_port=None,
- health_check_urlpath=None,
- health_check_timeout_insecond=None,
- health_check_interval_insecond=None,
- health_check_down_retry=None,
- health_check_up_retry=None,
- health_check_normal_status=None,
- udp_health_check_string=None,
- client_token=None,
- config=None):
- """
- update server group for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group
- :type ip_group_id:string
- :param port_id:
- The id of the server group port to be updated
- :type port_id:string
- :param health_check:
- Health check protocol
- :value 'HTTP' or 'TCP',default:'HTTP'
- :type health_check: string
- :param health_check_port:
- Health check port, the default is the same as port
- :type health_check_port: int
- :param health_check_urlpath:
- Health check URI, default '/'.
- Effective when the health check protocol is "HTTP"
- :type health_check_urlpath: string
- :param health_check_timeout_insecond:
- Health check timeout (unit: second)
- :value 1-60, default: 3
- :type health_check_timeout_insecond: int
- :param health_check_interval_insecond:
- Health check interval (unit: second)
- :value 1-10, default: 3
- :type health_check_interval_insecond: int
- :param health_check_down_retry:
- The unhealthy down retry, that is, how many consecutive health
- check failures, shields the backend server.
- :value 2-5, default: 3
- :type health_check_down_retry: int
- :param health_check_up_retry:
- Health up retry, that is, how many consecutive health checks
- are successful, then re-use the back-end server
- :value:2-5, default: 3
- :type health_check_up_retry: 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 udp_health_check_string:
- The health check string for the udp listener
- :type udp_health_check_string: 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, 'appblb', blb_id, 'ipgroup', 'backendpolicy')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'ipGroupId': compat.convert_to_string(ip_group_id),
- 'id': compat.convert_to_string(port_id)
- }
- if health_check is not None:
- body['healthCheck'] = compat.convert_to_string(health_check)
- if health_check_port is not None:
- body['healthCheckPort'] = health_check_port
- if health_check_urlpath is not None:
- body['healthCheckUrlPath'] = \
- compat.convert_to_string(health_check_urlpath)
- if health_check_timeout_insecond is not None:
- body['healthCheckTimeoutInSecond'] = health_check_timeout_insecond
- if health_check_interval_insecond is not None:
- body['healthCheckIntervalInSecond'] = health_check_interval_insecond
- if health_check_down_retry is not None:
- body['healthCheckDownRetry'] = health_check_down_retry
- if health_check_up_retry is not None:
- body['healthCheckUpRetry'] = health_check_up_retry
- if health_check_normal_status is not None:
- body['healthCheckNormalStatus'] = \
- compat.convert_to_string(health_check_normal_status)
- if udp_health_check_string is not None:
- body['udpHealthCheckString'] = \
- compat.convert_to_string(udp_health_check_string)
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str),
- port_list=list)
- def delete_app_ip_group_port(self, blb_id, ip_group_id,
- port_list,
- client_token=None, config=None):
- """
- delete server group of the specified LoadBalancer,
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group
- :type ip_group_id:string
- :param port_list:
- The ports of listeners to be released
- :type port_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, 'appblb', blb_id, 'ipgroup', 'backendpolicy')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {
- 'ipGroupId': compat.convert_to_string(ip_group_id),
- 'backendPolicyIdList': port_list
- }
- return self._send_request(http_methods.DELETE, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str))
- def create_app_ip_group_member(self, blb_id, ip_group_id, member_list,
- name=None,
- desc=None,
- client_token=None,
- config=None):
- """
- create ip group for the specified LoadBalancer,
- support batch add
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group to be updated
- :type ip_group_id:string
- :param member_list
- List of member to be added
- https://cloud.baidu.com/doc/BLB/API.html#AppBackendServer
- :type member_list:List<AppIpGroupMemberVO>
- :param name:
- name of ip group
- :type name:string
- :param desc:
- description of ip group
- :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, 'appblb', blb_id, 'ipgroup', 'member')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['ipGroupId'] = compat.convert_to_string(ip_group_id)
- body['memberList'] = member_list
- 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.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str))
- def update_app_ip_group_member(self, blb_id, ip_group_id, member_list,
- name=None,
- desc=None,
- client_token=None,
- config=None):
- """
- update the information of the app ip group
- of the specified LoadBalancer
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group to be updated
- :type ip_group_id:string
- :param member_list
- List of member to be updated
- https://cloud.baidu.com/doc/BLB/API.html#AppBackendServer
- :type member_list:List<AppIpGroupMemberVO>
- :param name:
- name of server group
- :type name:string
- :param desc:
- description of server group
- :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, 'appblb', blb_id, 'ipgroup', 'member')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['ipGroupId'] = compat.convert_to_string(ip_group_id)
- body['memberList'] = member_list
- 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,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str))
- def delete_app_ip_group_member(self, blb_id, ip_group_id, memberid_list,
- client_token=None,
- config=None):
- """
- delete the app ip group of the specified LoadBalancer,
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group to be updated
- :type ip_group_id:string
- :param memberid_list
- List of memberid to be deleted
- https://cloud.baidu.com/doc/BLB/API.html#AppBackendServer
- :type memberid_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, 'appblb', blb_id, 'ipgroup', 'member')
- params = {}
- params[b'delete'] = None
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['ipGroupId'] = compat.convert_to_string(ip_group_id)
- body['memberIdList'] = memberid_list
- return self._send_request(http_methods.PUT, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str),
- ip_group_id=(bytes, str))
- def describe_app_ip_group_member(self, blb_id, ip_group_id,
- name=None,
- exactly_match=None,
- marker=None,
- max_keys=None, config=None):
- """
- Query the imformation of app ip group
- of the specified LoadBalancer
- :param blb_id:
- Id of LoadBalancer
- :type blb_id:string
- :param ip_group_id:
- id of the ip group to be updated
- :type ip_group_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, 'appblb', blb_id, 'ipgroup', 'member')
- params = {}
- params[b'ipGroupId'] = ip_group_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)
- 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())
- @required(blb_id=(bytes, str),
- securitygroupids=list)
- def bind_app_security_groups(self, blb_id, securitygroupids,
- client_token=None, config=None):
- """
- bind the blb security groups (application/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_app_security_groups(self, blb_id, securitygroupids,
- client_token=None, config=None):
- """
- unbind the blb security groups (application/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_app_security_groups(self, blb_id,
- client_token=None, config=None):
- """
- describe the blb security groups (application/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_app_enterprise_security_groups(self, blb_id, enterprisesecuritygroupids,
- client_token=None, config=None):
- """
- bind the blb enterprise security groups (application/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_app_enterprise_security_groups(self, blb_id, enterprisesecuritygroupids,
- client_token=None, config=None):
- """
- unbind the blb enterprise security groups (application/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_app_enterprise_security_groups(self, blb_id,
- client_token=None, config=None):
- """
- describe the blb enterprise security groups (application/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)
- @required(blb_id=(bytes, str), listener_port=int, apppolicyvos=list)
- def create_app_ipgroup_policys(self, blb_id, listener_port, apppolicyvos, type=None,
- client_token=None, config=None):
- """
- create app blb ipgroup policys (application/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param listener_port:
- port of listener
- :type blb_id:int
- :param apppolicyvos:
- binding policy list of listener
- :type apppolicyvos:list
- :param type:
- protocol of listener
- :type type: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, 'appblb', blb_id, 'policys')
- params = {}
- if client_token is None:
- params[b'clientToken'] = generate_client_token()
- else:
- params[b'clientToken'] = client_token
- body = {}
- body['listenerPort'] = listener_port
- if type is not None:
- body['type'] = type
- body['appPolicyVos'] = apppolicyvos
- return self._send_request(http_methods.POST, path,
- body=json.dumps(body), params=params,
- config=config)
- @required(blb_id=(bytes, str), port=int)
- def describe_app_ipgroup_policys(self, blb_id, port, type=None, marker=None,
- maxkeys=None, client_token=None, config=None):
- """
- describe app blb ipgroup policys (application/ipv6 LoadBalancer)
- :param blb_id:
- id of LoadBalancer
- :type blb_id:string
- :param port:
- the listener port used by listener
- :type port:int
- :param type:
- protocol of listener
- :type type: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 maxkeys:
- The optional parameter to specifies the max number of
- list result to return.
- The default value is 1000.
- :type maxkeys: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, 'appblb', blb_id, 'policys')
- params = {}
- params[b'port'] = port
- if type is not None:
- params[b'type'] = type
- if marker is not None:
- params[b'marker'] = marker
- if maxkeys is not None:
- params[b'maxKeys'] = maxkeys
- 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)
- generate_client_token = generate_client_token_by_uuid
|