| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102 |
- basePath: /
- consumes:
- - application/json
- definitions:
- ConfigCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- attribution:
- description: 'description: attribution'
- enum:
- - system
- - domain
- example: system
- type: string
- x-go-name: Attribution
- content:
- $ref: '#/definitions/SNotifyConfigContent'
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- type:
- description: 'description: config type'
- example: feishu
- type: string
- x-go-name: Type
- required:
- - name
- - type
- - content
- - attribution
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ConfigDetails:
- properties:
- attribution:
- type: string
- x-go-name: Attribution
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- content:
- $ref: '#/definitions/SNotifyConfigContent'
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- domain_src:
- description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: DomainSrc
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- type:
- type: string
- x-go-name: Type
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ConfigManagerGetTypesInput:
- properties:
- domain_ids:
- description: 'description: View the available notification channels for the domains with these DomainIds'
- items:
- type: string
- type: array
- x-go-name: DomainIds
- operation:
- description: 'description: Operation of reduce'
- enum:
- - union
- - merge
- type: string
- x-go-name: Operation
- receivers:
- description: 'description: View the available notification channels for the receivers'
- items:
- type: string
- type: array
- x-go-name: Receivers
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ConfigManagerGetTypesOutput:
- properties:
- types:
- items:
- type: string
- type: array
- x-go-name: Types
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ConfigUpdateInput:
- properties:
- content:
- $ref: '#/definitions/SNotifyConfigContent'
- required:
- - content
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ConfigValidateInput:
- properties:
- content:
- $ref: '#/definitions/SNotifyConfigContent'
- type:
- description: 'description: config type'
- example: feishu
- type: string
- x-go-name: Type
- required:
- - type
- - content
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ConfigValidateOutput:
- properties:
- is_valid:
- type: boolean
- x-go-name: IsValid
- message:
- type: string
- x-go-name: Message
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- EmailQueueCreateInput:
- properties:
- attachments:
- items:
- $ref: '#/definitions/SEmailAttachment'
- type: array
- x-go-name: Attachments
- bcc:
- items:
- type: string
- type: array
- x-go-name: Bcc
- body:
- type: string
- x-go-name: Body
- cc:
- items:
- type: string
- type: array
- x-go-name: Cc
- more_datails:
- additionalProperties:
- type: string
- type: object
- x-go-name: MoreDetails
- session_id:
- type: string
- x-go-name: SessionId
- subject:
- type: string
- x-go-name: Subject
- to:
- items:
- type: string
- type: array
- x-go-name: To
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- EmailQueueDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- content:
- type: object
- x-go-name: Content
- delete_fail_reason:
- $ref: '#/definitions/Error'
- dest:
- type: string
- x-go-name: Dest
- dest_bcc:
- type: string
- x-go-name: DestBcc
- dest_cc:
- type: string
- x-go-name: DestCc
- domain:
- type: string
- x-go-name: Domain
- domain_id:
- type: string
- x-go-name: DomainId
- id:
- format: int64
- type: integer
- x-go-name: Id
- more_details:
- type: object
- x-go-name: MoreDetails
- project:
- type: string
- x-go-name: Project
- project_domain:
- type: string
- x-go-name: ProjectDomain
- project_domain_id:
- type: string
- x-go-name: ProjectDomainId
- project_id:
- type: string
- x-go-name: ProjectId
- recv_at:
- format: date-time
- type: string
- x-go-name: RecvAt
- results:
- type: string
- x-go-name: Results
- roles:
- type: string
- x-go-name: Roles
- sent_at:
- format: date-time
- type: string
- x-go-name: SentAt
- session_id:
- type: string
- x-go-name: SessionId
- status:
- type: string
- x-go-name: Status
- subject:
- type: string
- x-go-name: Subject
- update_fail_reason:
- $ref: '#/definitions/Error'
- user:
- type: string
- x-go-name: User
- user_id:
- type: string
- x-go-name: UserId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- EmailQueueSendInput:
- properties:
- sync:
- type: boolean
- x-go-name: Sync
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- Error:
- properties:
- class:
- type: string
- x-go-name: Class
- code:
- format: int64
- type: integer
- x-go-name: Code
- details:
- type: string
- x-go-name: Details
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/httperrors
- FailedElem:
- properties:
- contact_type:
- type: string
- x-go-name: ContactType
- reason:
- type: string
- x-go-name: Reason
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- GetDetailsStatusOutput:
- properties:
- status:
- description: 状态
- type: string
- x-go-name: Status
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- Identification:
- properties:
- id:
- example: 036fed49483b412888a760c2bc995caa
- type: string
- x-go-name: ID
- name:
- example: test
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- JoinResourceBaseCreateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- JointResourceBaseDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- JointResourceBaseUpdateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ModelBaseCreateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ModelBaseDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ModelBaseUpdateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- NotificationCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- contact_type:
- description: |-
- description: contact type
- required: ture
- example: email
- type: string
- x-go-name: ContactType
- contacts:
- description: 'description: direct contact, admin privileges required'
- items:
- type: string
- type: array
- x-go-name: Contacts
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- ignore_nonexistent_receiver:
- type: boolean
- x-go-name: IgnoreNonexistentReceiver
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- message:
- description: |-
- description: message content or jsonobject
- required: ture
- type: string
- x-go-name: Message
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- priority:
- description: 'description: notification priority'
- enum:
- - fatal
- - important
- - nomal
- example: normal
- type: string
- x-go-name: Priority
- receivers:
- description: 'description: ids or names of receiver'
- example: '{"adfb720ccdd34c638346ea4fa7a713a8", "zhangsan"}'
- items:
- type: string
- type: array
- x-go-name: Receivers
- robots:
- description: 'description: robots'
- example: feishu robot
- items:
- type: string
- type: array
- x-go-name: Robots
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- tag:
- description: 'description: notification tag'
- example: alert
- type: string
- x-go-name: Tag
- topic:
- description: 'description: notification topic'
- example: IMAGE_ACTIVE
- type: string
- x-go-name: Topic
- required:
- - name
- - topic
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- NotificationDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- contact_type:
- type: string
- x-go-name: ContactType
- content:
- type: string
- x-go-name: Content
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- event_id:
- type: string
- x-go-name: EventId
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- priority:
- type: string
- x-go-name: Priority
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- receive_details:
- items:
- $ref: '#/definitions/ReceiveDetail'
- type: array
- x-go-name: ReceiveDetails
- received_at:
- format: date-time
- type: string
- x-go-name: ReceivedAt
- send_times:
- format: int64
- type: integer
- x-go-name: SendTimes
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- title:
- type: string
- x-go-name: Title
- topic_type:
- type: string
- x-go-name: TopicType
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- NotificationManagerContactNotifyInput:
- properties:
- body:
- type: string
- x-go-name: Body
- contact_type:
- description: 'description: contact types'
- example: email
- items:
- type: string
- type: array
- x-go-name: ContactTypes
- receiver_ids:
- description: 'description: ids or names of receiver'
- example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
- items:
- type: string
- type: array
- x-go-name: ReceiverIds
- robot_ids:
- description: 'description: ids of robot'
- example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
- items:
- type: string
- type: array
- x-go-name: RobotIds
- role_ids:
- items:
- type: string
- type: array
- x-go-name: RoleIds
- subject:
- type: string
- x-go-name: Subject
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- NotificationManagerEventNotifyInput:
- properties:
- action:
- $ref: '#/definitions/SAction'
- advance_days:
- description: 'description: day left before the event'
- example: 0
- format: int64
- type: integer
- x-go-name: AdvanceDays
- cloud_account_name:
- type: string
- x-go-name: CloudAccountName
- contact_type:
- description: 'description: contact types'
- example: email
- items:
- type: string
- type: array
- x-go-name: ContactTypes
- contacts:
- description: 'description: direct contact, admin privileges required'
- items:
- $ref: '#/definitions/SContact'
- type: array
- x-go-name: Contacts
- event:
- description: 'description: event trigger sending notification'
- example: SERVER_DELETE
- type: string
- x-go-name: Event
- is_failed:
- $ref: '#/definitions/SResult'
- priority:
- description: 'description: notification priority'
- enum:
- - fatal
- - important
- - nomal
- example: normal
- type: string
- x-go-name: Priority
- project_domain_id:
- description: 'description: domainId of the resource that triggered the event notification'
- example: default
- type: string
- x-go-name: ProjectDomainId
- project_id:
- description: 'description: projectId of the resource that triggered the event notification'
- example: f627e09f038645f08ce6880c8d9cb8fd
- type: string
- x-go-name: ProjectId
- receiver_ids:
- description: 'description: ids or names of receiver'
- example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
- items:
- type: string
- type: array
- x-go-name: ReceiverIds
- resource_details:
- description: |-
- description: resource details
- required: ture
- type: object
- x-go-name: ResourceDetails
- resource_type:
- type: string
- x-go-name: ResourceType
- result:
- $ref: '#/definitions/SResult'
- robot_ids:
- description: 消息机器人列表
- items:
- type: string
- type: array
- x-go-name: RobotIds
- required:
- - event
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- NotificationManagerEventNotifyOutput:
- properties:
- failed_list:
- items:
- $ref: '#/definitions/FailedElem'
- type: array
- x-go-name: FailedList
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- PerformChangeDomainOwnerInput:
- properties:
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformChangeProjectOwnerInput:
- properties:
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformDisableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformEnableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformPrivateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformPublicProjectInput:
- properties:
- scope:
- description: 共享项目资源的共享范围,可能的值为:project, domain和system
- pattern: project|domain|system
- type: string
- x-go-name: Scope
- shared_domain_ids:
- description: 如果共享范围为域,则在此列表中指定共享的目标域
- items:
- type: string
- type: array
- x-go-name: SharedDomainIds
- shared_project_ids:
- description: 如果共享范围为项目,则在此列表中指定共享的目标项目
- items:
- type: string
- type: array
- x-go-name: SharedProjectIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ReceiveDetail:
- properties:
- contact:
- type: string
- x-go-name: Contact
- failed_reason:
- type: string
- x-go-name: FailedReason
- receiver_id:
- type: string
- x-go-name: ReceiverId
- receiver_name:
- type: string
- x-go-name: ReceiverName
- receiver_type:
- type: string
- x-go-name: ReceiverType
- send_by:
- type: string
- x-go-name: SendBy
- sendAt:
- format: date-time
- type: string
- x-go-name: SendAt
- status:
- type: string
- x-go-name: Status
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- disabled:
- description: 该资源是否被管理员*人为*禁用, 和enabled互斥
- type: boolean
- x-go-name: Disabled
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- email:
- description: 'description: user email'
- example: example@gmail.com
- type: string
- x-go-name: Email
- enabled:
- description: 该资源是否被管理员*人为*启用或者禁用
- type: boolean
- x-go-name: Enabled
- enabled_contact_types:
- description: 'description: enabled contact types for user'
- example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}'
- items:
- type: string
- type: array
- x-go-name: EnabledContactTypes
- force_verified:
- description: force verified if admin create the records
- type: boolean
- x-go-name: ForceVerified
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- international_mobile:
- $ref: '#/definitions/SInternationalMobile'
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- is_system:
- description: 'description: indicate the resource is a system resource, which is not visible to user'
- type: boolean
- x-go-name: IsSystem
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- uid:
- description: 'description: user id in keystone'
- example: adfb720ccdd34c638346ea4fa7a713a8
- type: string
- x-go-name: UID
- uname:
- description: 'description: user name in keystone'
- example: hello
- type: string
- x-go-name: UName
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- email:
- type: string
- x-go-name: Email
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- enabled_contact_types:
- description: 'description: enabled contact types for user'
- example: eamil, mobile, feishu, dingtalk, workwx
- items:
- type: string
- type: array
- x-go-name: EnabledContactTypes
- freezed:
- description: 资源是否被冻结
- type: boolean
- x-go-name: Freezed
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- international_mobile:
- $ref: '#/definitions/SInternationalMobile'
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- is_system:
- description: 是否是系统资源
- type: boolean
- x-go-name: IsSystem
- lang:
- type: string
- x-go-name: Lang
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- pending_deleted:
- description: 资源是否处于回收站中
- type: boolean
- x-go-name: PendingDeleted
- pending_deleted_at:
- description: 资源放入回收站时间
- format: date-time
- type: string
- x-go-name: PendingDeletedAt
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- project_src:
- description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过'
- example: local
- type: string
- x-go-name: ProjectSrc
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- verified_infos:
- description: 'description: verified info'
- items:
- $ref: '#/definitions/VerifiedInfo'
- type: array
- x-go-name: VerifiedInfos
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverEnableContactTypeInput:
- properties:
- enabled_contact_types:
- items:
- type: string
- type: array
- x-go-name: EnabledContactTypes
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverGetSubscriptionOptions:
- properties:
- id:
- type: string
- x-go-name: Id
- show_disabled:
- type: boolean
- x-go-name: ShowDisabled
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverIntellijGetInput:
- properties:
- create_if_no:
- description: 'description: create if receiver with UserId does not exist'
- type: boolean
- x-go-name: CreateIfNo
- scope:
- description: 'description: scope'
- type: string
- x-go-name: Scope
- user_id:
- description: 'description: user id in keystone'
- type: string
- x-go-name: UserId
- required:
- - user_id
- - scope
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverTriggerVerifyInput:
- properties:
- contact_type:
- description: 'description: contact type'
- enum:
- - email
- - mobile
- example: email
- type: string
- x-go-name: ContactType
- required:
- - contact_type
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- email:
- description: 'description: user email'
- example: example@gmail.com
- type: string
- x-go-name: Email
- enabled_contact_types:
- description: 'description: enabled contacts for user'
- example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}'
- items:
- type: string
- type: array
- x-go-name: EnabledContactTypes
- force_verified:
- type: boolean
- x-go-name: ForceVerified
- international_mobile:
- $ref: '#/definitions/SInternationalMobile'
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- progress:
- format: float
- type: number
- x-go-name: Progress
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ReceiverVerifyInput:
- properties:
- contact_type:
- description: 'description: Contact type'
- enum:
- - email
- - mobile
- example: email
- type: string
- x-go-name: ContactType
- token:
- description: 'description: token user input'
- example: "123456"
- type: string
- x-go-name: Token
- required:
- - contact_type
- - token
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- ResourceBaseCreateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ResourceBaseDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ResourceBaseUpdateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- RobotCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- address:
- description: 'description: address'
- example: http://helloworld.io/test/webhook
- type: string
- x-go-name: Address
- body:
- type: object
- x-go-name: Body
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- disabled:
- description: 该资源是否被管理员*人为*禁用, 和enabled互斥
- type: boolean
- x-go-name: Disabled
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- enabled:
- description: 该资源是否被管理员*人为*启用或者禁用
- type: boolean
- x-go-name: Enabled
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- header:
- type: object
- x-go-name: Header
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- is_public:
- description: 是否共享
- type: boolean
- x-go-name: IsPublic
- is_system:
- description: 'description: indicate the resource is a system resource, which is not visible to user'
- type: boolean
- x-go-name: IsSystem
- lang:
- description: 'description: Language preference'
- example: zh_CN
- type: string
- x-go-name: Lang
- msg_key:
- type: string
- x-go-name: MsgKey
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- public_scope:
- description: 共享范围
- type: string
- x-go-name: PublicScope
- secret_key:
- type: string
- x-go-name: SecretKey
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- type:
- description: 'description: robot type'
- enum:
- - feishu
- - dingtalk
- - workwx
- - webhook
- example: webhook
- type: string
- x-go-name: Type
- use_template:
- $ref: '#/definitions/TriState'
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- RobotDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- shared_domains:
- description: 共享的域列表
- items:
- $ref: '#/definitions/SharedDomain'
- type: array
- x-go-name: SharedDomains
- shared_projects:
- description: 共享的项目列表
- items:
- $ref: '#/definitions/SharedProject'
- type: array
- x-go-name: SharedProjects
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- RobotUpdateInput:
- properties:
- address:
- description: 'description: address'
- example: http://helloworld.io/test/webhook
- type: string
- x-go-name: Address
- body:
- type: object
- x-go-name: Body
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- header:
- type: object
- x-go-name: Header
- lang:
- description: 'description: Language preference'
- example: en
- type: string
- x-go-name: Lang
- msg_key:
- type: string
- x-go-name: MsgKey
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- progress:
- format: float
- type: number
- x-go-name: Progress
- secret_key:
- type: string
- x-go-name: SecretKey
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SAction:
- type: string
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SContact:
- properties:
- contact:
- type: string
- x-go-name: Contact
- contact_type:
- type: string
- x-go-name: ContactType
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SEmailAttachment:
- properties:
- content:
- type: string
- x-go-name: Base64Content
- filename:
- type: string
- x-go-name: Filename
- mime:
- type: string
- x-go-name: Mime
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SInternationalMobile:
- properties:
- area_code:
- description: 'description: area code of mobile'
- example: "86"
- type: string
- x-go-name: AreaCode
- mobile:
- description: 'description: user mobile'
- example: "17812345678"
- type: string
- x-go-name: Mobile
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SNotifyConfigContent:
- properties:
- access_key_id:
- type: string
- x-go-name: AccessKeyId
- access_key_secret:
- type: string
- x-go-name: AccessKeySecret
- access_token:
- type: string
- x-go-name: AccessToken
- access_token_expire_time:
- format: date-time
- type: string
- x-go-name: AccessTokenExpireTime
- agent_id:
- description: workwx
- type: string
- x-go-name: AgentId
- alerts_code:
- type: string
- x-go-name: AlertsCode
- app_id:
- description: Lark
- type: string
- x-go-name: AppId
- app_key:
- description: |-
- dingtalk
- AgentId string
- AppSecret string
- type: string
- x-go-name: AppKey
- app_secret:
- type: string
- x-go-name: AppSecret
- corp_id:
- type: string
- x-go-name: CorpId
- error_code:
- type: string
- x-go-name: ErrorCode
- hostname:
- description: Email
- type: string
- x-go-name: Hostname
- hostport:
- format: int64
- type: integer
- x-go-name: Hostport
- password:
- type: string
- x-go-name: Password
- phone_number:
- type: string
- x-go-name: PhoneNumber
- secret:
- type: string
- x-go-name: Secret
- sender_address:
- type: string
- x-go-name: SenderAddress
- service_url:
- type: string
- x-go-name: ServiceUrl
- signature:
- type: string
- x-go-name: Signature
- sms_driver:
- type: string
- x-go-name: SmsDriver
- ssl_global:
- type: boolean
- x-go-name: SslGlobal
- username:
- type: string
- x-go-name: Username
- verifiy_code:
- description: sms
- type: string
- x-go-name: VerifiyCode
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SResult:
- type: string
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- STag:
- properties:
- key:
- description: 标签Kye
- type: string
- x-go-name: Key
- value:
- description: 标签Value
- type: string
- x-go-name: Value
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- STopicCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- actions:
- items:
- type: string
- type: array
- x-go-name: Actions
- advance_days:
- items:
- format: int64
- type: integer
- type: array
- x-go-name: AdvanceDays
- content_cn:
- type: string
- x-go-name: ContentCn
- content_en:
- type: string
- x-go-name: ContentEn
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- disabled:
- description: 该资源是否被管理员*人为*禁用, 和enabled互斥
- type: boolean
- x-go-name: Disabled
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- enabled:
- description: 该资源是否被管理员*人为*启用或者禁用
- type: boolean
- x-go-name: Enabled
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- group_keys:
- $ref: '#/definitions/STopicGroupKeys'
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- resources:
- items:
- type: string
- type: array
- x-go-name: Resources
- results:
- type: boolean
- x-go-name: Results
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- title_cn:
- type: string
- x-go-name: TitleCn
- title_en:
- type: string
- x-go-name: TitleEn
- type:
- type: string
- x-go-name: Type
- webconsole_disable:
- type: boolean
- x-go-name: WebconsoleDisable
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- STopicGroupKeys:
- items:
- type: string
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SharedDomain:
- properties:
- id:
- type: string
- x-go-name: Id
- name:
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- SharedProject:
- properties:
- domain:
- type: string
- x-go-name: Domain
- domain_id:
- type: string
- x-go-name: DomainId
- id:
- type: string
- x-go-name: Id
- name:
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StandaloneAnonResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StandaloneAnonResourceDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StatusStandaloneResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- progress:
- format: float
- type: number
- x-go-name: Progress
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- SubscriberChangeInput:
- properties:
- group_times:
- description: minutes
- format: uint32
- type: integer
- x-go-name: GroupTimes
- receivers:
- description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID'
- items:
- type: string
- type: array
- x-go-name: Receivers
- robot:
- description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID'
- type: string
- x-go-name: Robot
- role:
- description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID'
- type: string
- x-go-name: Role
- role_scope:
- description: 'description: The scope of role subscribers'
- enum:
- - system
- - domain
- - project
- type: string
- x-go-name: RoleScope
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SubscriberCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- domain_id:
- description: 'description: domain id of resource'
- example: 1e3824756bac4ac084e784ed297ec652
- type: string
- x-go-name: DomainId
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- group_times:
- description: minutes
- format: uint32
- type: integer
- x-go-name: GroupTimes
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- receivers:
- description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID'
- items:
- type: string
- type: array
- x-go-name: Receivers
- resource_attribution_id:
- description: 'description: project id or domain id of resource'
- example: 1e3824756bac4ac084e784ed297ec652
- type: string
- x-go-name: ResourceAttributionId
- resource_attribution_name:
- type: string
- x-go-name: ResourceAttributionName
- resource_scope:
- description: 'description: scope of resource'
- enum:
- - system
- - domain
- - project
- type: string
- x-go-name: ResourceScope
- robot:
- description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID'
- type: string
- x-go-name: Robot
- role:
- description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID'
- type: string
- x-go-name: Role
- role_scope:
- description: 'description: The scope of role subscribers'
- enum:
- - system
- - domain
- - project
- type: string
- x-go-name: RoleScope
- scope:
- description: 'description: scope'
- enum:
- - system
- - domain
- type: string
- x-go-name: Scope
- topic_id:
- description: |-
- description: Id of Topic
- required
- type: string
- x-go-name: TopicID
- type:
- description: 'description: Type of subscriber'
- enum:
- - receiver
- - robot
- - role
- type: string
- x-go-name: Type
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SubscriberDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- group_times:
- description: minutes
- format: uint32
- type: integer
- x-go-name: GroupTimes
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- identification:
- type: string
- x-go-name: Identification
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- receivers:
- description: 'description: receivers'
- items:
- $ref: '#/definitions/Identification'
- type: array
- x-go-name: Receivers
- resource_attribution_id:
- type: string
- x-go-name: ResourceAttributionId
- resource_attribution_name:
- type: string
- x-go-name: ResourceAttributionName
- resource_scope:
- type: string
- x-go-name: ResourceScope
- robot:
- $ref: '#/definitions/Identification'
- role:
- $ref: '#/definitions/Identification'
- role_scope:
- type: string
- x-go-name: RoleScope
- scope:
- type: string
- x-go-name: Scope
- topic_id:
- type: string
- x-go-name: TopicId
- type:
- type: string
- x-go-name: Type
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- SubscriberSetReceiverInput:
- properties:
- receivers:
- items:
- type: string
- type: array
- x-go-name: Receivers
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- TTagSet:
- items:
- $ref: '#/definitions/STag'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- TTagSetList:
- items:
- $ref: '#/definitions/TTagSet'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- TemplateCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- contact_type:
- description: |-
- description: Contact type, specifically, setting it to all means all contact type
- require: true
- example: email
- type: string
- x-go-name: ContactType
- content:
- description: 'description: Template content'
- example: 镜像 {{.name}} 上传完成
- type: string
- x-go-name: Content
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- example:
- description: 'description: Example for using this template'
- example: '{"name": "centos7.6"}'
- type: string
- x-go-name: Example
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- lang:
- description: 'description: Language'
- enum:
- - cn
- - en
- type: string
- x-go-name: Lang
- template_type:
- description: 'description: Template type'
- enum:
- - title
- - content
- - remote
- example: title
- type: string
- x-go-name: TemplateType
- topic:
- description: 'description: Template topic'
- example: IMAGE_ACTIVE
- type: string
- x-go-name: Topic
- required:
- - topic
- - content
- - example
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- TemplateManagerSaveInput:
- properties:
- contact_type:
- type: string
- x-go-name: ContactType
- force:
- type: boolean
- x-go-name: Force
- templates:
- items:
- $ref: '#/definitions/TemplateCreateInput'
- type: array
- x-go-name: Templates
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- TemplateUpdateInput:
- properties:
- content:
- description: 'description: template content'
- example: 镜像 {{.name}} 上传完成
- type: string
- x-go-name: Content
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- example:
- description: 'description: all example for using this template'
- example: '{"name": "centos7.6"}'
- type: string
- x-go-name: Example
- required:
- - content
- - example
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- TopicDetails:
- properties:
- actions:
- items:
- type: string
- type: array
- x-go-name: Actions
- advance_days:
- items:
- format: int64
- type: integer
- type: array
- x-go-name: AdvanceDays
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- content_cn:
- type: string
- x-go-name: ContentCn
- content_en:
- type: string
- x-go-name: ContentEn
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- group_keys:
- $ref: '#/definitions/STopicGroupKeys'
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- resource_types:
- description: 'description: resources managed'
- example:
- - server
- - eip
- - disk
- items:
- type: string
- type: array
- x-go-name: Resources
- results:
- type: boolean
- x-go-name: Results
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- title_cn:
- type: string
- x-go-name: TitleCn
- title_en:
- type: string
- x-go-name: TitleEn
- type:
- type: string
- x-go-name: Type
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- webconsole_disable:
- type: boolean
- x-go-name: WebconsoleDisable
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- TopicUpdateInput:
- properties:
- actions:
- items:
- type: string
- type: array
- x-go-name: Actions
- advance_days:
- items:
- format: int64
- type: integer
- type: array
- x-go-name: AdvanceDays
- content_cn:
- type: string
- x-go-name: ContentCn
- content_en:
- type: string
- x-go-name: ContentEn
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- progress:
- format: float
- type: number
- x-go-name: Progress
- resources:
- items:
- type: string
- type: array
- x-go-name: Resources
- title_cn:
- type: string
- x-go-name: TitleCn
- title_en:
- type: string
- x-go-name: TitleEn
- webconsole_disable:
- type: boolean
- x-go-name: WebconsoleDisable
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- TriState:
- type: string
- x-go-package: yunion.io/x/pkg/tristate
- VerifiedInfo:
- properties:
- contact_type:
- type: string
- x-go-name: ContactType
- note:
- type: string
- x-go-name: Note
- verified:
- type: boolean
- x-go-name: Verified
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/notify
- host: '"127.0.0.1:8889"'
- info:
- contact:
- email: lizexi@yunion.cn
- name: Zexi Li
- description: Notify API
- license:
- name: Apache 2.0
- url: http://www.apache.org/licenses/LICENSE-2.0.html
- version: "1.0"
- paths:
- /configs:
- get:
- description: 列表
- operationId: config_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - in: query
- name: type
- type: string
- x-go-name: Type
- - in: query
- name: attribution
- type: string
- x-go-name: Attribution
- responses:
- "200":
- $ref: '#/responses/config_ListItemFilterOutput'
- summary: 列表
- tags:
- - config
- post:
- description: 新建
- operationId: config_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/config_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - config
- /configs/{id}:
- delete:
- description: 删除
- operationId: config_CustomizeDelete
- parameters:
- - description: The Id or Name of config
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/config_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - config
- get:
- description: 获取详情
- operationId: config_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of config
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/config_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - config
- put:
- description: 更新
- operationId: config_ValidateUpdateData
- parameters:
- - description: The Id or Name of config
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/config_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - config
- /configs/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: config_PerformChangeOwner
- parameters:
- - description: The Id or Name of config
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- config:
- $ref: '#/definitions/PerformChangeDomainOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/config_PerformChangeOwnerOutput'
- summary: 更改项目
- tags:
- - config
- /configs/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: config_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of config
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/config_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - config
- /configs/capability:
- get:
- description: 获取指定资源类的信息Capability
- operationId: config_GetPropertyCapability
- responses:
- "200":
- $ref: '#/responses/config_GetPropertyCapabilityOutput'
- summary: 获取指定资源类的信息Capability
- tags:
- - config
- /configs/validate:
- post:
- description: 执行操作Validate
- operationId: config_PerformValidate
- parameters:
- - in: body
- name: body
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigValidateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/config_PerformValidateOutput'
- summary: 执行操作Validate
- tags:
- - config
- /email_queue_statuses:
- get:
- description: 列表
- operationId: email_queue_status_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- responses:
- "200":
- $ref: '#/responses/email_queue_status_ListItemFilterOutput'
- summary: 列表
- tags:
- - email_queue_status
- post:
- description: 新建
- operationId: email_queue_status_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- email_queue_status:
- $ref: '#/definitions/ModelBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/email_queue_status_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - email_queue_status
- /email_queue_statuses/{id}:
- delete:
- description: 删除
- operationId: email_queue_status_CustomizeDelete
- parameters:
- - description: The Id or Name of email_queue_status
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/email_queue_status_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - email_queue_status
- get:
- description: 获取详情
- operationId: email_queue_status_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of email_queue_status
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/email_queue_status_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - email_queue_status
- put:
- description: 更新
- operationId: email_queue_status_ValidateUpdateData
- parameters:
- - description: The Id or Name of email_queue_status
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- email_queue_status:
- $ref: '#/definitions/ModelBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/email_queue_status_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - email_queue_status
- /email_queues:
- get:
- description: 列表
- operationId: email_queue_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Id
- - description: Id []int `json:"id"`
- in: query
- items:
- type: string
- name: to
- type: array
- x-go-name: To
- - in: query
- name: subject
- type: string
- x-go-name: Subject
- - in: query
- items:
- type: string
- name: session_id
- type: array
- x-go-name: SessionId
- responses:
- "200":
- $ref: '#/responses/email_queue_ListItemFilterOutput'
- summary: 宿主机/物理机列表
- tags:
- - email_queue
- post:
- description: 新建
- operationId: email_queue_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- email_queue:
- $ref: '#/definitions/EmailQueueCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/email_queue_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - email_queue
- /email_queues/{id}:
- delete:
- description: 删除
- operationId: email_queue_CustomizeDelete
- parameters:
- - description: The Id or Name of email_queue
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/email_queue_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - email_queue
- get:
- description: 获取详情
- operationId: email_queue_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of email_queue
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/email_queue_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - email_queue
- put:
- description: 更新
- operationId: email_queue_ValidateUpdateData
- parameters:
- - description: The Id or Name of email_queue
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/email_queue_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - email_queue
- /email_queues/{id}/send:
- post:
- description: 执行操作Send
- operationId: email_queue_PerformSend
- parameters:
- - description: The Id or Name of email_queue
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- email_queue:
- $ref: '#/definitions/EmailQueueSendInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/email_queue_PerformSendOutput'
- summary: 执行操作Send
- tags:
- - email_queue
- /events:
- get:
- description: 列表
- operationId: event_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/event_ListItemFilterOutput'
- summary: 操作日志列表
- tags:
- - event
- post:
- description: 新建
- operationId: event_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- event:
- $ref: '#/definitions/ModelBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/event_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - event
- /events/{id}:
- delete:
- description: 删除
- operationId: event_CustomizeDelete
- parameters:
- - description: The Id or Name of event
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/event_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - event
- get:
- description: 获取详情
- operationId: event_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of event
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/event_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - event
- put:
- description: 更新
- operationId: event_ValidateUpdateData
- parameters:
- - description: The Id or Name of event
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/event_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - event
- /notification_groups:
- get:
- description: 列表
- operationId: notification_group_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- responses:
- "200":
- $ref: '#/responses/notification_group_ListItemFilterOutput'
- summary: 列表
- tags:
- - notification_group
- post:
- description: 新建
- operationId: notification_group_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- notification_group:
- $ref: '#/definitions/ModelBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/notification_group_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - notification_group
- /notification_groups/{id}:
- delete:
- description: 删除
- operationId: notification_group_CustomizeDelete
- parameters:
- - description: The Id or Name of notification_group
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_group_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - notification_group
- get:
- description: 获取详情
- operationId: notification_group_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of notification_group
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_group_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - notification_group
- put:
- description: 更新
- operationId: notification_group_ValidateUpdateData
- parameters:
- - description: The Id or Name of notification_group
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- notification_group:
- $ref: '#/definitions/ModelBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/notification_group_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - notification_group
- /notification_logs:
- get:
- description: 列表
- operationId: notification_log_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_log_ListItemFilterOutput'
- summary: 操作日志列表
- tags:
- - notification_log
- post:
- description: 新建
- operationId: notification_log_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- notification_log:
- $ref: '#/definitions/ModelBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/notification_log_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - notification_log
- /notification_logs/{id}:
- delete:
- description: 删除
- operationId: notification_log_CustomizeDelete
- parameters:
- - description: The Id or Name of notification_log
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_log_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - notification_log
- get:
- description: 获取详情
- operationId: notification_log_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of notification_log
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_log_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - notification_log
- put:
- description: 更新
- operationId: notification_log_ValidateUpdateData
- parameters:
- - description: The Id or Name of notification_log
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_log_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - notification_log
- /notifications:
- get:
- description: 列表
- operationId: notification_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - in: query
- name: contact_type
- type: string
- x-go-name: ContactType
- - in: query
- name: receiver_id
- type: string
- x-go-name: ReceiverId
- - in: query
- name: tag
- type: string
- x-go-name: Tag
- - in: query
- name: topic_type
- type: string
- x-go-name: TopicType
- responses:
- "200":
- $ref: '#/responses/notification_ListItemFilterOutput'
- summary: 通知消息列表
- tags:
- - notification
- post:
- description: 新建
- operationId: notification_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- notification:
- $ref: '#/definitions/NotificationCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/notification_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - notification
- /notifications/{id}:
- delete:
- description: 删除
- operationId: notification_CustomizeDelete
- parameters:
- - description: The Id or Name of notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - notification
- get:
- description: 获取详情
- operationId: notification_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - notification
- put:
- description: 更新
- operationId: notification_ValidateUpdateData
- parameters:
- - description: The Id or Name of notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- notification:
- $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/notification_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - notification
- /notifications/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: notification_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - notification
- /notifications/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: notification_GetDetailsStatus
- parameters:
- - description: The Id or Name of notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/notification_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - notification
- /notifications/contact-notify:
- post:
- description: 执行操作ContactNotify
- operationId: notification_PerformContactNotify
- parameters:
- - in: body
- name: body
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationManagerContactNotifyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/notification_PerformContactNotifyOutput'
- summary: 执行操作ContactNotify
- tags:
- - notification
- /notifications/event-notify:
- post:
- description: 执行操作EventNotify
- operationId: notification_PerformEventNotify
- parameters:
- - in: body
- name: body
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationManagerEventNotifyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/notification_PerformEventNotifyOutput'
- summary: 'TODO: support project and domain'
- tags:
- - notification
- /receivers:
- get:
- description: 列表
- operationId: receiver_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 列表中包含标记为"系统资源"的资源
- in: query
- name: system
- type: boolean
- x-go-name: System
- - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
- in: query
- name: pending_delete
- type: boolean
- x-go-name: PendingDelete
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - in: query
- name: uid
- type: string
- x-go-name: UID
- - in: query
- name: uname
- type: string
- x-go-name: UName
- - in: query
- name: enabled_contact_type
- type: string
- x-go-name: EnabledContactType
- - in: query
- name: verified_contact_type
- type: string
- x-go-name: VerifiedContactType
- - in: query
- name: project_domain_filter
- type: boolean
- x-go-name: ProjectDomainFilter
- responses:
- "200":
- $ref: '#/responses/receiver_ListItemFilterOutput'
- summary: 列表
- tags:
- - receiver
- post:
- description: 新建
- operationId: receiver_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- receiver:
- $ref: '#/definitions/ReceiverCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - receiver
- /receivers/{id}:
- delete:
- description: 删除
- operationId: receiver_CustomizeDelete
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/receiver_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - receiver
- get:
- description: 获取详情
- operationId: receiver_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/receiver_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - receiver
- put:
- description: 更新
- operationId: receiver_ValidateUpdateData
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - receiver
- /receivers/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: receiver_PerformChangeOwner
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/PerformChangeProjectOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformChangeOwnerOutput'
- summary: 更改项目
- tags:
- - receiver
- /receivers/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: receiver_PerformDisable
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformDisableOutput'
- summary: 执行操作Disable
- tags:
- - receiver
- /receivers/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: receiver_PerformEnable
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformEnableOutput'
- summary: 执行操作Enable
- tags:
- - receiver
- /receivers/{id}/enable-contact-type:
- post:
- description: 执行操作EnableContactType
- operationId: receiver_PerformEnableContactType
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverEnableContactTypeInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformEnableContactTypeOutput'
- summary: 执行操作EnableContactType
- tags:
- - receiver
- /receivers/{id}/get-subscription:
- post:
- description: 执行操作GetSubscription
- operationId: receiver_PerformGetSubscription
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverGetSubscriptionOptions'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformGetSubscriptionOutput'
- summary: 获取用户订阅
- tags:
- - receiver
- /receivers/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: receiver_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/receiver_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - receiver
- /receivers/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: receiver_GetDetailsStatus
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/receiver_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - receiver
- /receivers/{id}/trigger-verify:
- post:
- description: 执行操作TriggerVerify
- operationId: receiver_PerformTriggerVerify
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverTriggerVerifyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformTriggerVerifyOutput'
- summary: 执行操作TriggerVerify
- tags:
- - receiver
- /receivers/{id}/verify:
- post:
- description: 执行操作Verify
- operationId: receiver_PerformVerify
- parameters:
- - description: The Id or Name of receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverVerifyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformVerifyOutput'
- summary: 执行操作Verify
- tags:
- - receiver
- /receivers/get-types:
- post:
- description: 执行操作GetTypes
- operationId: receiver_PerformGetTypes
- parameters:
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ConfigManagerGetTypesInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformGetTypesOutput'
- summary: 执行操作GetTypes
- tags:
- - receiver
- /receivers/intellij-get:
- post:
- description: 执行操作IntellijGet
- operationId: receiver_PerformIntellijGet
- parameters:
- - in: body
- name: body
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverIntellijGetInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/receiver_PerformIntellijGetOutput'
- summary: 执行操作IntellijGet
- tags:
- - receiver
- /receivers/role-contact-type:
- get:
- description: 获取指定资源类的信息RoleContactType
- operationId: receiver_GetPropertyRoleContactType
- parameters:
- - in: query
- items:
- type: string
- name: role_ids
- type: array
- x-go-name: RoleIds
- - in: query
- name: scope
- type: string
- x-go-name: Scope
- - in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- responses:
- "200":
- $ref: '#/responses/receiver_GetPropertyRoleContactTypeOutput'
- summary: 获取指定资源类的信息RoleContactType
- tags:
- - receiver
- /robots:
- get:
- description: 列表
- operationId: robot_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 列表中包含标记为"系统资源"的资源
- in: query
- name: system
- type: boolean
- x-go-name: System
- - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
- in: query
- name: pending_delete
- type: boolean
- x-go-name: PendingDelete
- - description: 以资源是否共享过滤列表
- in: query
- name: is_public
- type: boolean
- x-go-name: IsPublic
- - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
- in: query
- name: public_scope
- type: string
- x-go-name: PublicScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - description: 'description: robot type'
- enum:
- - feishu
- - dingtalk
- - workwx
- - webhook
- example: webhook
- in: query
- name: type
- type: string
- x-go-name: Type
- - description: 'description: Language preference'
- example: en
- in: query
- name: lang
- type: string
- x-go-name: Lang
- responses:
- "200":
- $ref: '#/responses/robot_ListItemFilterOutput'
- summary: 列表
- tags:
- - robot
- post:
- description: 新建
- operationId: robot_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- robot:
- $ref: '#/definitions/RobotCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/robot_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - robot
- /robots/{id}:
- delete:
- description: 删除
- operationId: robot_CustomizeDelete
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/robot_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - robot
- get:
- description: 获取详情
- operationId: robot_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/robot_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - robot
- put:
- description: 更新
- operationId: robot_ValidateUpdateData
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- robot:
- $ref: '#/definitions/RobotUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/robot_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - robot
- /robots/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: robot_PerformChangeOwner
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- robot:
- $ref: '#/definitions/PerformChangeProjectOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/robot_PerformChangeOwnerOutput'
- summary: 更改项目
- tags:
- - robot
- /robots/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: robot_PerformDisable
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- robot:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/robot_PerformDisableOutput'
- summary: 执行操作Disable
- tags:
- - robot
- /robots/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: robot_PerformEnable
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- robot:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/robot_PerformEnableOutput'
- summary: 执行操作Enable
- tags:
- - robot
- /robots/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: robot_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/robot_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - robot
- /robots/{id}/private:
- post:
- description: 执行操作Private
- operationId: robot_PerformPrivate
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- robot:
- $ref: '#/definitions/PerformPrivateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/robot_PerformPrivateOutput'
- summary: 执行操作Private
- tags:
- - robot
- /robots/{id}/public:
- post:
- description: 执行操作Public
- operationId: robot_PerformPublic
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- robot:
- $ref: '#/definitions/PerformPublicProjectInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/robot_PerformPublicOutput'
- summary: 执行操作Public
- tags:
- - robot
- /robots/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: robot_GetDetailsStatus
- parameters:
- - description: The Id or Name of robot
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/robot_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - robot
- /subscriber_receivers:
- get:
- description: 列表
- operationId: subscriber_receiver_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- responses:
- "200":
- $ref: '#/responses/subscriber_receiver_ListItemFilterOutput'
- summary: 列表
- tags:
- - subscriber_receiver
- post:
- description: 新建
- operationId: subscriber_receiver_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- subscriber_receiver:
- $ref: '#/definitions/JoinResourceBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/subscriber_receiver_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - subscriber_receiver
- /subscriber_receivers/{id}:
- delete:
- description: 删除
- operationId: subscriber_receiver_CustomizeDelete
- parameters:
- - description: The Id or Name of subscriber_receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/subscriber_receiver_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - subscriber_receiver
- get:
- description: 获取详情
- operationId: subscriber_receiver_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of subscriber_receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/subscriber_receiver_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - subscriber_receiver
- put:
- description: 更新
- operationId: subscriber_receiver_ValidateUpdateData
- parameters:
- - description: The Id or Name of subscriber_receiver
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- subscriber_receiver:
- $ref: '#/definitions/JointResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/subscriber_receiver_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - subscriber_receiver
- /subscribers:
- get:
- description: 列表
- operationId: subscriber_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - description: 'description: topic id'
- in: query
- name: topic_id
- type: string
- x-go-name: TopicID
- - description: 'description: scope of resource'
- enum:
- - system
- - domain
- - project
- in: query
- name: resource_scope
- type: string
- x-go-name: ResourceScope
- - description: 'description: type'
- enum:
- - receiver
- - robot
- - role
- in: query
- name: type
- type: string
- x-go-name: Type
- - description: 'description: scope'
- enum:
- - system
- - domain
- in: query
- name: scope
- type: string
- x-go-name: Scope
- responses:
- "200":
- $ref: '#/responses/subscriber_ListItemFilterOutput'
- summary: 列表
- tags:
- - subscriber
- post:
- description: 新建
- operationId: subscriber_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- subscriber:
- $ref: '#/definitions/SubscriberCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/subscriber_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - subscriber
- /subscribers/{id}:
- delete:
- description: 删除
- operationId: subscriber_CustomizeDelete
- parameters:
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/subscriber_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - subscriber
- get:
- description: 获取详情
- operationId: subscriber_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/subscriber_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - subscriber
- put:
- description: 更新
- operationId: subscriber_ValidateUpdateData
- parameters:
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- subscriber:
- $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/subscriber_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - subscriber
- /subscribers/{id}/change:
- post:
- description: 执行操作Change
- operationId: subscriber_PerformChange
- parameters:
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- subscriber:
- $ref: '#/definitions/SubscriberChangeInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/subscriber_PerformChangeOutput'
- summary: 执行操作Change
- tags:
- - subscriber
- /subscribers/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: subscriber_PerformDisable
- parameters:
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/subscriber_PerformDisableOutput'
- summary: 执行操作Disable
- tags:
- - subscriber
- /subscribers/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: subscriber_PerformEnable
- parameters:
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/subscriber_PerformEnableOutput'
- summary: 执行操作Enable
- tags:
- - subscriber
- /subscribers/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: subscriber_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/subscriber_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - subscriber
- /subscribers/{id}/set-receiver:
- post:
- description: 执行操作SetReceiver
- operationId: subscriber_PerformSetReceiver
- parameters:
- - description: The Id or Name of subscriber
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- subscriber:
- $ref: '#/definitions/SubscriberSetReceiverInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/subscriber_PerformSetReceiverOutput'
- summary: 执行操作SetReceiver
- tags:
- - subscriber
- /templates:
- get:
- description: 列表
- operationId: template_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: |-
- description: Contact type, specifically, setting it to all means all contact type
- require: true
- example: email
- in: query
- name: contact_type
- type: string
- x-go-name: ContactType
- - description: 'description: Template type'
- enum:
- - title
- - content
- - remote
- example: title
- in: query
- name: template_type
- type: string
- x-go-name: TemplateType
- - description: 'description: template topic'
- example: IMAGE_ACTIVE
- in: query
- name: topic
- required: true
- type: string
- x-go-name: Topic
- - description: 'description: Language'
- enum:
- - cn
- - en
- in: query
- name: lang
- type: string
- x-go-name: Lang
- responses:
- "200":
- $ref: '#/responses/template_ListItemFilterOutput'
- summary: 列表
- tags:
- - template
- post:
- description: 新建
- operationId: template_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- template:
- $ref: '#/definitions/TemplateCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/template_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - template
- /templates/{id}:
- delete:
- description: 删除
- operationId: template_CustomizeDelete
- parameters:
- - description: The Id or Name of template
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/template_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - template
- get:
- description: 获取详情
- operationId: template_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of template
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/template_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - template
- put:
- description: 更新
- operationId: template_ValidateUpdateData
- parameters:
- - description: The Id or Name of template
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- template:
- $ref: '#/definitions/TemplateUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/template_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - template
- /templates/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: template_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of template
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/template_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - template
- /templates/save:
- post:
- description: 执行操作Save
- operationId: template_PerformSave
- parameters:
- - in: body
- name: body
- schema:
- properties:
- template:
- $ref: '#/definitions/TemplateManagerSaveInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/template_PerformSaveOutput'
- summary: 执行操作Save
- tags:
- - template
- /topic_actions:
- get:
- description: 列表
- operationId: topic_action_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- responses:
- "200":
- $ref: '#/responses/topic_action_ListItemFilterOutput'
- summary: 列表
- tags:
- - topic_action
- post:
- description: 新建
- operationId: topic_action_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- topic_action:
- $ref: '#/definitions/ResourceBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_action_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - topic_action
- /topic_actions/{id}:
- delete:
- description: 删除
- operationId: topic_action_CustomizeDelete
- parameters:
- - description: The Id or Name of topic_action
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_action_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - topic_action
- get:
- description: 获取详情
- operationId: topic_action_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of topic_action
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_action_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - topic_action
- put:
- description: 更新
- operationId: topic_action_ValidateUpdateData
- parameters:
- - description: The Id or Name of topic_action
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- topic_action:
- $ref: '#/definitions/ResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_action_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - topic_action
- /topic_resources:
- get:
- description: 列表
- operationId: topic_resource_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- responses:
- "200":
- $ref: '#/responses/topic_resource_ListItemFilterOutput'
- summary: 列表
- tags:
- - topic_resource
- post:
- description: 新建
- operationId: topic_resource_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- topic_resource:
- $ref: '#/definitions/ResourceBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_resource_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - topic_resource
- /topic_resources/{id}:
- delete:
- description: 删除
- operationId: topic_resource_CustomizeDelete
- parameters:
- - description: The Id or Name of topic_resource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_resource_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - topic_resource
- get:
- description: 获取详情
- operationId: topic_resource_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of topic_resource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_resource_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - topic_resource
- put:
- description: 更新
- operationId: topic_resource_ValidateUpdateData
- parameters:
- - description: The Id or Name of topic_resource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- topic_resource:
- $ref: '#/definitions/ResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_resource_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - topic_resource
- /topics:
- get:
- description: 列表
- operationId: topic_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- responses:
- "200":
- $ref: '#/responses/topic_ListItemFilterOutput'
- summary: 列表
- tags:
- - topic
- post:
- description: 新建
- operationId: topic_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- topic:
- $ref: '#/definitions/STopicCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - topic
- /topics/{id}:
- delete:
- description: 删除
- operationId: topic_CustomizeDelete
- parameters:
- - description: The Id or Name of topic
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - topic
- get:
- description: 获取详情
- operationId: topic_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of topic
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - topic
- put:
- description: 更新
- operationId: topic_ValidateUpdateData
- parameters:
- - description: The Id or Name of topic
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- topic:
- $ref: '#/definitions/TopicUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - topic
- /topics/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: topic_PerformDisable
- parameters:
- - description: The Id or Name of topic
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- topic:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_PerformDisableOutput'
- summary: 禁用资源
- tags:
- - topic
- /topics/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: topic_PerformEnable
- parameters:
- - description: The Id or Name of topic
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- topic:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/topic_PerformEnableOutput'
- summary: 启用资源
- tags:
- - topic
- /topics/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: topic_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of topic
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - topic
- /topics/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: topic_GetDetailsStatus
- parameters:
- - description: The Id or Name of topic
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/topic_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - topic
- produces:
- - application/json
- responses:
- config_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigDetails'
- type: object
- config_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigDetails'
- type: object
- config_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- config:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- config_GetPropertyCapabilityOutput:
- description: ""
- config_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- configs:
- items:
- $ref: '#/definitions/ConfigDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- config_PerformChangeOwnerOutput:
- description: ""
- config_PerformValidateOutput:
- description: ""
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigValidateOutput'
- type: object
- config_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigDetails'
- type: object
- config_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- config:
- $ref: '#/definitions/ConfigDetails'
- type: object
- email_queue_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- email_queue:
- $ref: '#/definitions/EmailQueueDetails'
- type: object
- email_queue_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- email_queue:
- $ref: '#/definitions/EmailQueueDetails'
- type: object
- email_queue_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- email_queues:
- items:
- $ref: '#/definitions/EmailQueueDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- email_queue_PerformSendOutput:
- description: ""
- email_queue_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- email_queue:
- $ref: '#/definitions/EmailQueueDetails'
- type: object
- email_queue_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- email_queue:
- $ref: '#/definitions/EmailQueueDetails'
- type: object
- email_queue_status_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- email_queue_status:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- email_queue_status_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- email_queue_status:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- email_queue_status_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- email_queue_statuses:
- items:
- $ref: '#/definitions/ModelBaseDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- email_queue_status_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- email_queue_status:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- email_queue_status_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- email_queue_status:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- event_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- event:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- event_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- event:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- event_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- events:
- items:
- $ref: '#/definitions/ModelBaseDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- event_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- event:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- event_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- event:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationDetails'
- type: object
- notification_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationDetails'
- type: object
- notification_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- notification:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- notification_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- notification:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- notification_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- notifications:
- items:
- $ref: '#/definitions/NotificationDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- notification_PerformContactNotifyOutput:
- description: ""
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationManagerEventNotifyOutput'
- type: object
- notification_PerformEventNotifyOutput:
- description: ""
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationManagerEventNotifyOutput'
- type: object
- notification_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationDetails'
- type: object
- notification_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- notification:
- $ref: '#/definitions/NotificationDetails'
- type: object
- notification_group_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- notification_group:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_group_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- notification_group:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_group_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- notification_groups:
- items:
- $ref: '#/definitions/ModelBaseDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- notification_group_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- notification_group:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_group_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- notification_group:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_log_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- notification_log:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_log_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- notification_log:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_log_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- notification_logs:
- items:
- $ref: '#/definitions/ModelBaseDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- notification_log_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- notification_log:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- notification_log_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- notification_log:
- $ref: '#/definitions/ModelBaseDetails'
- type: object
- receiver_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverDetails'
- type: object
- receiver_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverDetails'
- type: object
- receiver_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- receiver:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- receiver_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- receiver:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- receiver_GetPropertyRoleContactTypeOutput:
- description: ""
- receiver_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- receivers:
- items:
- $ref: '#/definitions/ReceiverDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- receiver_PerformChangeOwnerOutput:
- description: ""
- receiver_PerformDisableOutput:
- description: ""
- receiver_PerformEnableContactTypeOutput:
- description: ""
- receiver_PerformEnableOutput:
- description: ""
- receiver_PerformGetSubscriptionOutput:
- description: ""
- receiver_PerformGetTypesOutput:
- description: ""
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ConfigManagerGetTypesOutput'
- type: object
- receiver_PerformIntellijGetOutput:
- description: ""
- receiver_PerformTriggerVerifyOutput:
- description: ""
- receiver_PerformVerifyOutput:
- description: ""
- receiver_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverDetails'
- type: object
- receiver_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- receiver:
- $ref: '#/definitions/ReceiverDetails'
- type: object
- robot_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- robot:
- $ref: '#/definitions/RobotDetails'
- type: object
- robot_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- robot:
- $ref: '#/definitions/RobotDetails'
- type: object
- robot_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- robot:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- robot_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- robot:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- robot_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- robots:
- items:
- $ref: '#/definitions/RobotDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- robot_PerformChangeOwnerOutput:
- description: ""
- robot_PerformDisableOutput:
- description: ""
- robot_PerformEnableOutput:
- description: ""
- robot_PerformPrivateOutput:
- description: ""
- robot_PerformPublicOutput:
- description: ""
- robot_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- robot:
- $ref: '#/definitions/RobotDetails'
- type: object
- robot_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- robot:
- $ref: '#/definitions/RobotDetails'
- type: object
- subscriber_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- subscriber:
- $ref: '#/definitions/SubscriberDetails'
- type: object
- subscriber_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- subscriber:
- $ref: '#/definitions/SubscriberDetails'
- type: object
- subscriber_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- subscriber:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- subscriber_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- subscribers:
- items:
- $ref: '#/definitions/SubscriberDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- subscriber_PerformChangeOutput:
- description: ""
- subscriber_PerformDisableOutput:
- description: ""
- subscriber_PerformEnableOutput:
- description: ""
- subscriber_PerformSetReceiverOutput:
- description: ""
- subscriber_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- subscriber:
- $ref: '#/definitions/SubscriberDetails'
- type: object
- subscriber_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- subscriber:
- $ref: '#/definitions/SubscriberDetails'
- type: object
- subscriber_receiver_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- subscriber_receiver:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- subscriber_receiver_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- subscriber_receiver:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- subscriber_receiver_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- subscriber_receivers:
- items:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- subscriber_receiver_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- subscriber_receiver:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- subscriber_receiver_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- subscriber_receiver:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- template_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- template:
- $ref: '#/definitions/StandaloneAnonResourceDetails'
- type: object
- template_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- template:
- $ref: '#/definitions/StandaloneAnonResourceDetails'
- type: object
- template_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- template:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- template_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- templates:
- items:
- $ref: '#/definitions/StandaloneAnonResourceDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- template_PerformSaveOutput:
- description: ""
- template_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- template:
- $ref: '#/definitions/StandaloneAnonResourceDetails'
- type: object
- template_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- template:
- $ref: '#/definitions/StandaloneAnonResourceDetails'
- type: object
- topic_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- topic:
- $ref: '#/definitions/TopicDetails'
- type: object
- topic_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- topic:
- $ref: '#/definitions/TopicDetails'
- type: object
- topic_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- topic:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- topic_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- topic:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- topic_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- topics:
- items:
- $ref: '#/definitions/TopicDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- topic_PerformDisableOutput:
- description: ""
- topic_PerformEnableOutput:
- description: ""
- topic_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- topic:
- $ref: '#/definitions/TopicDetails'
- type: object
- topic_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- topic:
- $ref: '#/definitions/TopicDetails'
- type: object
- topic_action_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- topic_action:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- topic_action_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- topic_action:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- topic_action_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- topic_actions:
- items:
- $ref: '#/definitions/ResourceBaseDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- topic_action_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- topic_action:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- topic_action_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- topic_action:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- topic_resource_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- topic_resource:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- topic_resource_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- topic_resource:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- topic_resource_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- topic_resources:
- items:
- $ref: '#/definitions/ResourceBaseDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- topic_resource_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- topic_resource:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- topic_resource_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- topic_resource:
- $ref: '#/definitions/ResourceBaseDetails'
- type: object
- schemes:
- - https
- - http
- securityDefinitions:
- keystone:
- in: header
- name: X-Auth-Token
- type: apiKey
- swagger: "2.0"
|