swagger_notify.yaml 324 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102
  1. basePath: /
  2. consumes:
  3. - application/json
  4. definitions:
  5. ConfigCreateInput:
  6. properties:
  7. __meta__:
  8. additionalProperties:
  9. type: string
  10. description: 标签列表,最多支持20个
  11. example:
  12. user:rd: op
  13. type: object
  14. x-go-name: Metadata
  15. attribution:
  16. description: 'description: attribution'
  17. enum:
  18. - system
  19. - domain
  20. example: system
  21. type: string
  22. x-go-name: Attribution
  23. content:
  24. $ref: '#/definitions/SNotifyConfigContent'
  25. description:
  26. description: 资源描述
  27. example: test create network
  28. type: string
  29. x-go-name: Description
  30. dry_run:
  31. default: false
  32. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  33. type: boolean
  34. x-go-name: DryRun
  35. generate_name:
  36. description: |-
  37. 生成资源名称的模板,如果name为空,则为必填项
  38. description: generated resource name, given a pattern to generate name, required if name is not given
  39. example: test###
  40. type: string
  41. x-go-name: GenerateName
  42. is_emulated:
  43. description: |-
  44. 资源是否为模拟资源
  45. description: the resource is an emulated resource
  46. type: boolean
  47. x-go-name: IsEmulated
  48. name:
  49. description: |-
  50. 资源名称,如果generate_name为空,则为必填项
  51. description: resource name, required if generated_name is not given
  52. example: test-network
  53. type: string
  54. uniqueItems: true
  55. x-go-name: Name
  56. project_domain_id:
  57. description: 指定项目归属域名称或ID
  58. type: string
  59. x-go-name: ProjectDomainId
  60. type:
  61. description: 'description: config type'
  62. example: feishu
  63. type: string
  64. x-go-name: Type
  65. required:
  66. - name
  67. - type
  68. - content
  69. - attribution
  70. type: object
  71. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  72. ConfigDetails:
  73. properties:
  74. attribution:
  75. type: string
  76. x-go-name: Attribution
  77. can_delete:
  78. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  79. example: true
  80. type: boolean
  81. x-go-name: CanDelete
  82. can_update:
  83. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  84. example: true
  85. type: boolean
  86. x-go-name: CanUpdate
  87. content:
  88. $ref: '#/definitions/SNotifyConfigContent'
  89. created_at:
  90. description: 资源创建时间
  91. format: date-time
  92. type: string
  93. x-go-name: CreatedAt
  94. delete_fail_reason:
  95. $ref: '#/definitions/Error'
  96. deleted:
  97. description: 资源是否被删除
  98. type: boolean
  99. x-go-name: Deleted
  100. deleted_at:
  101. description: 资源删除时间
  102. format: date-time
  103. type: string
  104. x-go-name: DeletedAt
  105. description:
  106. description: 资源描述信息
  107. type: string
  108. x-go-name: Description
  109. domain_id:
  110. description: 域Id
  111. type: string
  112. x-go-name: DomainId
  113. domain_src:
  114. description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
  115. example: local
  116. type: string
  117. x-go-name: DomainSrc
  118. id:
  119. description: 资源UUID
  120. type: string
  121. x-go-name: Id
  122. is_emulated:
  123. description: |-
  124. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  125. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  126. type: boolean
  127. x-go-name: IsEmulated
  128. metadata:
  129. additionalProperties:
  130. type: string
  131. description: 标签
  132. type: object
  133. x-go-name: Metadata
  134. name:
  135. description: 资源名称
  136. type: string
  137. x-go-name: Name
  138. org_node_md5:
  139. description: 用以组织架构变更通知其他服务权限变更
  140. type: string
  141. x-go-name: OrgNodeMd5
  142. project_domain:
  143. description: 资源归属项目的域名称
  144. type: string
  145. x-go-name: ProjectDomain
  146. type:
  147. type: string
  148. x-go-name: Type
  149. update_fail_reason:
  150. $ref: '#/definitions/Error'
  151. update_version:
  152. description: 资源被更新次数
  153. format: int64
  154. type: integer
  155. x-go-name: UpdateVersion
  156. updated_at:
  157. description: 资源更新时间
  158. format: date-time
  159. type: string
  160. x-go-name: UpdatedAt
  161. type: object
  162. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  163. ConfigManagerGetTypesInput:
  164. properties:
  165. domain_ids:
  166. description: 'description: View the available notification channels for the domains with these DomainIds'
  167. items:
  168. type: string
  169. type: array
  170. x-go-name: DomainIds
  171. operation:
  172. description: 'description: Operation of reduce'
  173. enum:
  174. - union
  175. - merge
  176. type: string
  177. x-go-name: Operation
  178. receivers:
  179. description: 'description: View the available notification channels for the receivers'
  180. items:
  181. type: string
  182. type: array
  183. x-go-name: Receivers
  184. type: object
  185. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  186. ConfigManagerGetTypesOutput:
  187. properties:
  188. types:
  189. items:
  190. type: string
  191. type: array
  192. x-go-name: Types
  193. type: object
  194. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  195. ConfigUpdateInput:
  196. properties:
  197. content:
  198. $ref: '#/definitions/SNotifyConfigContent'
  199. required:
  200. - content
  201. type: object
  202. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  203. ConfigValidateInput:
  204. properties:
  205. content:
  206. $ref: '#/definitions/SNotifyConfigContent'
  207. type:
  208. description: 'description: config type'
  209. example: feishu
  210. type: string
  211. x-go-name: Type
  212. required:
  213. - type
  214. - content
  215. type: object
  216. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  217. ConfigValidateOutput:
  218. properties:
  219. is_valid:
  220. type: boolean
  221. x-go-name: IsValid
  222. message:
  223. type: string
  224. x-go-name: Message
  225. type: object
  226. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  227. EmailQueueCreateInput:
  228. properties:
  229. attachments:
  230. items:
  231. $ref: '#/definitions/SEmailAttachment'
  232. type: array
  233. x-go-name: Attachments
  234. bcc:
  235. items:
  236. type: string
  237. type: array
  238. x-go-name: Bcc
  239. body:
  240. type: string
  241. x-go-name: Body
  242. cc:
  243. items:
  244. type: string
  245. type: array
  246. x-go-name: Cc
  247. more_datails:
  248. additionalProperties:
  249. type: string
  250. type: object
  251. x-go-name: MoreDetails
  252. session_id:
  253. type: string
  254. x-go-name: SessionId
  255. subject:
  256. type: string
  257. x-go-name: Subject
  258. to:
  259. items:
  260. type: string
  261. type: array
  262. x-go-name: To
  263. type: object
  264. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  265. EmailQueueDetails:
  266. properties:
  267. can_delete:
  268. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  269. example: true
  270. type: boolean
  271. x-go-name: CanDelete
  272. can_update:
  273. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  274. example: true
  275. type: boolean
  276. x-go-name: CanUpdate
  277. content:
  278. type: object
  279. x-go-name: Content
  280. delete_fail_reason:
  281. $ref: '#/definitions/Error'
  282. dest:
  283. type: string
  284. x-go-name: Dest
  285. dest_bcc:
  286. type: string
  287. x-go-name: DestBcc
  288. dest_cc:
  289. type: string
  290. x-go-name: DestCc
  291. domain:
  292. type: string
  293. x-go-name: Domain
  294. domain_id:
  295. type: string
  296. x-go-name: DomainId
  297. id:
  298. format: int64
  299. type: integer
  300. x-go-name: Id
  301. more_details:
  302. type: object
  303. x-go-name: MoreDetails
  304. project:
  305. type: string
  306. x-go-name: Project
  307. project_domain:
  308. type: string
  309. x-go-name: ProjectDomain
  310. project_domain_id:
  311. type: string
  312. x-go-name: ProjectDomainId
  313. project_id:
  314. type: string
  315. x-go-name: ProjectId
  316. recv_at:
  317. format: date-time
  318. type: string
  319. x-go-name: RecvAt
  320. results:
  321. type: string
  322. x-go-name: Results
  323. roles:
  324. type: string
  325. x-go-name: Roles
  326. sent_at:
  327. format: date-time
  328. type: string
  329. x-go-name: SentAt
  330. session_id:
  331. type: string
  332. x-go-name: SessionId
  333. status:
  334. type: string
  335. x-go-name: Status
  336. subject:
  337. type: string
  338. x-go-name: Subject
  339. update_fail_reason:
  340. $ref: '#/definitions/Error'
  341. user:
  342. type: string
  343. x-go-name: User
  344. user_id:
  345. type: string
  346. x-go-name: UserId
  347. type: object
  348. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  349. EmailQueueSendInput:
  350. properties:
  351. sync:
  352. type: boolean
  353. x-go-name: Sync
  354. type: object
  355. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  356. Error:
  357. properties:
  358. class:
  359. type: string
  360. x-go-name: Class
  361. code:
  362. format: int64
  363. type: integer
  364. x-go-name: Code
  365. details:
  366. type: string
  367. x-go-name: Details
  368. type: object
  369. x-go-package: yunion.io/x/onecloud/pkg/httperrors
  370. FailedElem:
  371. properties:
  372. contact_type:
  373. type: string
  374. x-go-name: ContactType
  375. reason:
  376. type: string
  377. x-go-name: Reason
  378. type: object
  379. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  380. GetDetailsStatusOutput:
  381. properties:
  382. status:
  383. description: 状态
  384. type: string
  385. x-go-name: Status
  386. type: object
  387. x-go-package: yunion.io/x/onecloud/pkg/apis
  388. Identification:
  389. properties:
  390. id:
  391. example: 036fed49483b412888a760c2bc995caa
  392. type: string
  393. x-go-name: ID
  394. name:
  395. example: test
  396. type: string
  397. x-go-name: Name
  398. type: object
  399. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  400. JoinResourceBaseCreateInput:
  401. type: object
  402. x-go-package: yunion.io/x/onecloud/pkg/apis
  403. JointResourceBaseDetails:
  404. properties:
  405. can_delete:
  406. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  407. example: true
  408. type: boolean
  409. x-go-name: CanDelete
  410. can_update:
  411. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  412. example: true
  413. type: boolean
  414. x-go-name: CanUpdate
  415. delete_fail_reason:
  416. $ref: '#/definitions/Error'
  417. update_fail_reason:
  418. $ref: '#/definitions/Error'
  419. type: object
  420. x-go-package: yunion.io/x/onecloud/pkg/apis
  421. JointResourceBaseUpdateInput:
  422. type: object
  423. x-go-package: yunion.io/x/onecloud/pkg/apis
  424. ModelBaseCreateInput:
  425. type: object
  426. x-go-package: yunion.io/x/onecloud/pkg/apis
  427. ModelBaseDetails:
  428. properties:
  429. can_delete:
  430. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  431. example: true
  432. type: boolean
  433. x-go-name: CanDelete
  434. can_update:
  435. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  436. example: true
  437. type: boolean
  438. x-go-name: CanUpdate
  439. delete_fail_reason:
  440. $ref: '#/definitions/Error'
  441. update_fail_reason:
  442. $ref: '#/definitions/Error'
  443. type: object
  444. x-go-package: yunion.io/x/onecloud/pkg/apis
  445. ModelBaseUpdateInput:
  446. type: object
  447. x-go-package: yunion.io/x/onecloud/pkg/apis
  448. NotificationCreateInput:
  449. properties:
  450. __meta__:
  451. additionalProperties:
  452. type: string
  453. description: 标签列表,最多支持20个
  454. example:
  455. user:rd: op
  456. type: object
  457. x-go-name: Metadata
  458. contact_type:
  459. description: |-
  460. description: contact type
  461. required: ture
  462. example: email
  463. type: string
  464. x-go-name: ContactType
  465. contacts:
  466. description: 'description: direct contact, admin privileges required'
  467. items:
  468. type: string
  469. type: array
  470. x-go-name: Contacts
  471. description:
  472. description: 资源描述
  473. example: test create network
  474. type: string
  475. x-go-name: Description
  476. dry_run:
  477. default: false
  478. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  479. type: boolean
  480. x-go-name: DryRun
  481. generate_name:
  482. description: |-
  483. 生成资源名称的模板,如果name为空,则为必填项
  484. description: generated resource name, given a pattern to generate name, required if name is not given
  485. example: test###
  486. type: string
  487. x-go-name: GenerateName
  488. ignore_nonexistent_receiver:
  489. type: boolean
  490. x-go-name: IgnoreNonexistentReceiver
  491. is_emulated:
  492. description: |-
  493. 资源是否为模拟资源
  494. description: the resource is an emulated resource
  495. type: boolean
  496. x-go-name: IsEmulated
  497. message:
  498. description: |-
  499. description: message content or jsonobject
  500. required: ture
  501. type: string
  502. x-go-name: Message
  503. name:
  504. description: |-
  505. 资源名称,如果generate_name为空,则为必填项
  506. description: resource name, required if generated_name is not given
  507. example: test-network
  508. type: string
  509. uniqueItems: true
  510. x-go-name: Name
  511. priority:
  512. description: 'description: notification priority'
  513. enum:
  514. - fatal
  515. - important
  516. - nomal
  517. example: normal
  518. type: string
  519. x-go-name: Priority
  520. receivers:
  521. description: 'description: ids or names of receiver'
  522. example: '{"adfb720ccdd34c638346ea4fa7a713a8", "zhangsan"}'
  523. items:
  524. type: string
  525. type: array
  526. x-go-name: Receivers
  527. robots:
  528. description: 'description: robots'
  529. example: feishu robot
  530. items:
  531. type: string
  532. type: array
  533. x-go-name: Robots
  534. status:
  535. description: 用来存储资源的状态
  536. type: string
  537. x-go-name: Status
  538. tag:
  539. description: 'description: notification tag'
  540. example: alert
  541. type: string
  542. x-go-name: Tag
  543. topic:
  544. description: 'description: notification topic'
  545. example: IMAGE_ACTIVE
  546. type: string
  547. x-go-name: Topic
  548. required:
  549. - name
  550. - topic
  551. type: object
  552. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  553. NotificationDetails:
  554. properties:
  555. can_delete:
  556. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  557. example: true
  558. type: boolean
  559. x-go-name: CanDelete
  560. can_update:
  561. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  562. example: true
  563. type: boolean
  564. x-go-name: CanUpdate
  565. contact_type:
  566. type: string
  567. x-go-name: ContactType
  568. content:
  569. type: string
  570. x-go-name: Content
  571. created_at:
  572. description: 资源创建时间
  573. format: date-time
  574. type: string
  575. x-go-name: CreatedAt
  576. delete_fail_reason:
  577. $ref: '#/definitions/Error'
  578. deleted:
  579. description: 资源是否被删除
  580. type: boolean
  581. x-go-name: Deleted
  582. deleted_at:
  583. description: 资源删除时间
  584. format: date-time
  585. type: string
  586. x-go-name: DeletedAt
  587. description:
  588. description: 资源描述信息
  589. type: string
  590. x-go-name: Description
  591. event_id:
  592. type: string
  593. x-go-name: EventId
  594. id:
  595. description: 资源UUID
  596. type: string
  597. x-go-name: Id
  598. is_emulated:
  599. description: |-
  600. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  601. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  602. type: boolean
  603. x-go-name: IsEmulated
  604. metadata:
  605. additionalProperties:
  606. type: string
  607. description: 标签
  608. type: object
  609. x-go-name: Metadata
  610. name:
  611. description: 资源名称
  612. type: string
  613. x-go-name: Name
  614. org_node_md5:
  615. description: 用以组织架构变更通知其他服务权限变更
  616. type: string
  617. x-go-name: OrgNodeMd5
  618. priority:
  619. type: string
  620. x-go-name: Priority
  621. progress:
  622. description: 操作进度0-100
  623. format: float
  624. type: number
  625. x-go-name: Progress
  626. receive_details:
  627. items:
  628. $ref: '#/definitions/ReceiveDetail'
  629. type: array
  630. x-go-name: ReceiveDetails
  631. received_at:
  632. format: date-time
  633. type: string
  634. x-go-name: ReceivedAt
  635. send_times:
  636. format: int64
  637. type: integer
  638. x-go-name: SendTimes
  639. status:
  640. description: 资源状态
  641. type: string
  642. x-go-name: Status
  643. title:
  644. type: string
  645. x-go-name: Title
  646. topic_type:
  647. type: string
  648. x-go-name: TopicType
  649. update_fail_reason:
  650. $ref: '#/definitions/Error'
  651. update_version:
  652. description: 资源被更新次数
  653. format: int64
  654. type: integer
  655. x-go-name: UpdateVersion
  656. updated_at:
  657. description: 资源更新时间
  658. format: date-time
  659. type: string
  660. x-go-name: UpdatedAt
  661. type: object
  662. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  663. NotificationManagerContactNotifyInput:
  664. properties:
  665. body:
  666. type: string
  667. x-go-name: Body
  668. contact_type:
  669. description: 'description: contact types'
  670. example: email
  671. items:
  672. type: string
  673. type: array
  674. x-go-name: ContactTypes
  675. receiver_ids:
  676. description: 'description: ids or names of receiver'
  677. example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
  678. items:
  679. type: string
  680. type: array
  681. x-go-name: ReceiverIds
  682. robot_ids:
  683. description: 'description: ids of robot'
  684. example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
  685. items:
  686. type: string
  687. type: array
  688. x-go-name: RobotIds
  689. role_ids:
  690. items:
  691. type: string
  692. type: array
  693. x-go-name: RoleIds
  694. subject:
  695. type: string
  696. x-go-name: Subject
  697. type: object
  698. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  699. NotificationManagerEventNotifyInput:
  700. properties:
  701. action:
  702. $ref: '#/definitions/SAction'
  703. advance_days:
  704. description: 'description: day left before the event'
  705. example: 0
  706. format: int64
  707. type: integer
  708. x-go-name: AdvanceDays
  709. cloud_account_name:
  710. type: string
  711. x-go-name: CloudAccountName
  712. contact_type:
  713. description: 'description: contact types'
  714. example: email
  715. items:
  716. type: string
  717. type: array
  718. x-go-name: ContactTypes
  719. contacts:
  720. description: 'description: direct contact, admin privileges required'
  721. items:
  722. $ref: '#/definitions/SContact'
  723. type: array
  724. x-go-name: Contacts
  725. event:
  726. description: 'description: event trigger sending notification'
  727. example: SERVER_DELETE
  728. type: string
  729. x-go-name: Event
  730. is_failed:
  731. $ref: '#/definitions/SResult'
  732. priority:
  733. description: 'description: notification priority'
  734. enum:
  735. - fatal
  736. - important
  737. - nomal
  738. example: normal
  739. type: string
  740. x-go-name: Priority
  741. project_domain_id:
  742. description: 'description: domainId of the resource that triggered the event notification'
  743. example: default
  744. type: string
  745. x-go-name: ProjectDomainId
  746. project_id:
  747. description: 'description: projectId of the resource that triggered the event notification'
  748. example: f627e09f038645f08ce6880c8d9cb8fd
  749. type: string
  750. x-go-name: ProjectId
  751. receiver_ids:
  752. description: 'description: ids or names of receiver'
  753. example: '{"adfb720ccdd34c638346ea4fa7a713a8"}'
  754. items:
  755. type: string
  756. type: array
  757. x-go-name: ReceiverIds
  758. resource_details:
  759. description: |-
  760. description: resource details
  761. required: ture
  762. type: object
  763. x-go-name: ResourceDetails
  764. resource_type:
  765. type: string
  766. x-go-name: ResourceType
  767. result:
  768. $ref: '#/definitions/SResult'
  769. robot_ids:
  770. description: 消息机器人列表
  771. items:
  772. type: string
  773. type: array
  774. x-go-name: RobotIds
  775. required:
  776. - event
  777. type: object
  778. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  779. NotificationManagerEventNotifyOutput:
  780. properties:
  781. failed_list:
  782. items:
  783. $ref: '#/definitions/FailedElem'
  784. type: array
  785. x-go-name: FailedList
  786. type: object
  787. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  788. PerformChangeDomainOwnerInput:
  789. properties:
  790. project_domain_id:
  791. description: 指定项目归属域名称或ID
  792. type: string
  793. x-go-name: ProjectDomainId
  794. type: object
  795. x-go-package: yunion.io/x/onecloud/pkg/apis
  796. PerformChangeProjectOwnerInput:
  797. properties:
  798. project_domain_id:
  799. description: 指定项目归属域名称或ID
  800. type: string
  801. x-go-name: ProjectDomainId
  802. project_id:
  803. description: 指定项目的名称或ID
  804. type: string
  805. x-go-name: ProjectId
  806. type: object
  807. x-go-package: yunion.io/x/onecloud/pkg/apis
  808. PerformDisableInput:
  809. type: object
  810. x-go-package: yunion.io/x/onecloud/pkg/apis
  811. PerformEnableInput:
  812. type: object
  813. x-go-package: yunion.io/x/onecloud/pkg/apis
  814. PerformPrivateInput:
  815. type: object
  816. x-go-package: yunion.io/x/onecloud/pkg/apis
  817. PerformPublicProjectInput:
  818. properties:
  819. scope:
  820. description: 共享项目资源的共享范围,可能的值为:project, domain和system
  821. pattern: project|domain|system
  822. type: string
  823. x-go-name: Scope
  824. shared_domain_ids:
  825. description: 如果共享范围为域,则在此列表中指定共享的目标域
  826. items:
  827. type: string
  828. type: array
  829. x-go-name: SharedDomainIds
  830. shared_project_ids:
  831. description: 如果共享范围为项目,则在此列表中指定共享的目标项目
  832. items:
  833. type: string
  834. type: array
  835. x-go-name: SharedProjectIds
  836. type: object
  837. x-go-package: yunion.io/x/onecloud/pkg/apis
  838. ReceiveDetail:
  839. properties:
  840. contact:
  841. type: string
  842. x-go-name: Contact
  843. failed_reason:
  844. type: string
  845. x-go-name: FailedReason
  846. receiver_id:
  847. type: string
  848. x-go-name: ReceiverId
  849. receiver_name:
  850. type: string
  851. x-go-name: ReceiverName
  852. receiver_type:
  853. type: string
  854. x-go-name: ReceiverType
  855. send_by:
  856. type: string
  857. x-go-name: SendBy
  858. sendAt:
  859. format: date-time
  860. type: string
  861. x-go-name: SendAt
  862. status:
  863. type: string
  864. x-go-name: Status
  865. type: object
  866. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  867. ReceiverCreateInput:
  868. properties:
  869. __meta__:
  870. additionalProperties:
  871. type: string
  872. description: 标签列表,最多支持20个
  873. example:
  874. user:rd: op
  875. type: object
  876. x-go-name: Metadata
  877. description:
  878. description: 资源描述
  879. example: test create network
  880. type: string
  881. x-go-name: Description
  882. disabled:
  883. description: 该资源是否被管理员*人为*禁用, 和enabled互斥
  884. type: boolean
  885. x-go-name: Disabled
  886. dry_run:
  887. default: false
  888. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  889. type: boolean
  890. x-go-name: DryRun
  891. email:
  892. description: 'description: user email'
  893. example: example@gmail.com
  894. type: string
  895. x-go-name: Email
  896. enabled:
  897. description: 该资源是否被管理员*人为*启用或者禁用
  898. type: boolean
  899. x-go-name: Enabled
  900. enabled_contact_types:
  901. description: 'description: enabled contact types for user'
  902. example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}'
  903. items:
  904. type: string
  905. type: array
  906. x-go-name: EnabledContactTypes
  907. force_verified:
  908. description: force verified if admin create the records
  909. type: boolean
  910. x-go-name: ForceVerified
  911. generate_name:
  912. description: |-
  913. 生成资源名称的模板,如果name为空,则为必填项
  914. description: generated resource name, given a pattern to generate name, required if name is not given
  915. example: test###
  916. type: string
  917. x-go-name: GenerateName
  918. international_mobile:
  919. $ref: '#/definitions/SInternationalMobile'
  920. is_emulated:
  921. description: |-
  922. 资源是否为模拟资源
  923. description: the resource is an emulated resource
  924. type: boolean
  925. x-go-name: IsEmulated
  926. is_system:
  927. description: 'description: indicate the resource is a system resource, which is not visible to user'
  928. type: boolean
  929. x-go-name: IsSystem
  930. name:
  931. description: |-
  932. 资源名称,如果generate_name为空,则为必填项
  933. description: resource name, required if generated_name is not given
  934. example: test-network
  935. type: string
  936. uniqueItems: true
  937. x-go-name: Name
  938. project_domain_id:
  939. description: 指定项目归属域名称或ID
  940. type: string
  941. x-go-name: ProjectDomainId
  942. project_id:
  943. description: 指定项目的名称或ID
  944. type: string
  945. x-go-name: ProjectId
  946. status:
  947. description: 用来存储资源的状态
  948. type: string
  949. x-go-name: Status
  950. uid:
  951. description: 'description: user id in keystone'
  952. example: adfb720ccdd34c638346ea4fa7a713a8
  953. type: string
  954. x-go-name: UID
  955. uname:
  956. description: 'description: user name in keystone'
  957. example: hello
  958. type: string
  959. x-go-name: UName
  960. required:
  961. - name
  962. type: object
  963. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  964. ReceiverDetails:
  965. properties:
  966. can_delete:
  967. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  968. example: true
  969. type: boolean
  970. x-go-name: CanDelete
  971. can_update:
  972. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  973. example: true
  974. type: boolean
  975. x-go-name: CanUpdate
  976. created_at:
  977. description: 资源创建时间
  978. format: date-time
  979. type: string
  980. x-go-name: CreatedAt
  981. delete_fail_reason:
  982. $ref: '#/definitions/Error'
  983. deleted:
  984. description: 资源是否被删除
  985. type: boolean
  986. x-go-name: Deleted
  987. deleted_at:
  988. description: 资源删除时间
  989. format: date-time
  990. type: string
  991. x-go-name: DeletedAt
  992. description:
  993. description: 资源描述信息
  994. type: string
  995. x-go-name: Description
  996. domain_id:
  997. description: 域Id
  998. type: string
  999. x-go-name: DomainId
  1000. email:
  1001. type: string
  1002. x-go-name: Email
  1003. enabled:
  1004. description: 资源是否启用
  1005. type: boolean
  1006. x-go-name: Enabled
  1007. enabled_contact_types:
  1008. description: 'description: enabled contact types for user'
  1009. example: eamil, mobile, feishu, dingtalk, workwx
  1010. items:
  1011. type: string
  1012. type: array
  1013. x-go-name: EnabledContactTypes
  1014. freezed:
  1015. description: 资源是否被冻结
  1016. type: boolean
  1017. x-go-name: Freezed
  1018. id:
  1019. description: 资源UUID
  1020. type: string
  1021. x-go-name: Id
  1022. international_mobile:
  1023. $ref: '#/definitions/SInternationalMobile'
  1024. is_emulated:
  1025. description: |-
  1026. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1027. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1028. type: boolean
  1029. x-go-name: IsEmulated
  1030. is_system:
  1031. description: 是否是系统资源
  1032. type: boolean
  1033. x-go-name: IsSystem
  1034. lang:
  1035. type: string
  1036. x-go-name: Lang
  1037. metadata:
  1038. additionalProperties:
  1039. type: string
  1040. description: 标签
  1041. type: object
  1042. x-go-name: Metadata
  1043. name:
  1044. description: 资源名称
  1045. type: string
  1046. x-go-name: Name
  1047. org_node_md5:
  1048. description: 用以组织架构变更通知其他服务权限变更
  1049. type: string
  1050. x-go-name: OrgNodeMd5
  1051. pending_deleted:
  1052. description: 资源是否处于回收站中
  1053. type: boolean
  1054. x-go-name: PendingDeleted
  1055. pending_deleted_at:
  1056. description: 资源放入回收站时间
  1057. format: date-time
  1058. type: string
  1059. x-go-name: PendingDeletedAt
  1060. progress:
  1061. description: 操作进度0-100
  1062. format: float
  1063. type: number
  1064. x-go-name: Progress
  1065. project:
  1066. description: |-
  1067. 资源归属项目的名称(向后兼容别名)
  1068. Deprecated
  1069. type: string
  1070. x-go-name: Tenant
  1071. project_domain:
  1072. description: 资源归属项目的域名称
  1073. type: string
  1074. x-go-name: ProjectDomain
  1075. project_id:
  1076. description: |-
  1077. 资源归属项目的ID(向后兼容别名)
  1078. Deprecated
  1079. type: string
  1080. x-go-name: TenantId
  1081. project_metadata:
  1082. additionalProperties:
  1083. type: string
  1084. type: object
  1085. x-go-name: ProjectMetadata
  1086. project_src:
  1087. description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过'
  1088. example: local
  1089. type: string
  1090. x-go-name: ProjectSrc
  1091. status:
  1092. description: 资源状态
  1093. type: string
  1094. x-go-name: Status
  1095. tenant:
  1096. description: |-
  1097. 资源归属项目的名称
  1098. alias:project
  1099. type: string
  1100. x-go-name: Project
  1101. tenant_id:
  1102. description: 项目Id
  1103. type: string
  1104. x-go-name: ProjectId
  1105. update_fail_reason:
  1106. $ref: '#/definitions/Error'
  1107. update_version:
  1108. description: 资源被更新次数
  1109. format: int64
  1110. type: integer
  1111. x-go-name: UpdateVersion
  1112. updated_at:
  1113. description: 资源更新时间
  1114. format: date-time
  1115. type: string
  1116. x-go-name: UpdatedAt
  1117. verified_infos:
  1118. description: 'description: verified info'
  1119. items:
  1120. $ref: '#/definitions/VerifiedInfo'
  1121. type: array
  1122. x-go-name: VerifiedInfos
  1123. type: object
  1124. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1125. ReceiverEnableContactTypeInput:
  1126. properties:
  1127. enabled_contact_types:
  1128. items:
  1129. type: string
  1130. type: array
  1131. x-go-name: EnabledContactTypes
  1132. type: object
  1133. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1134. ReceiverGetSubscriptionOptions:
  1135. properties:
  1136. id:
  1137. type: string
  1138. x-go-name: Id
  1139. show_disabled:
  1140. type: boolean
  1141. x-go-name: ShowDisabled
  1142. type: object
  1143. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1144. ReceiverIntellijGetInput:
  1145. properties:
  1146. create_if_no:
  1147. description: 'description: create if receiver with UserId does not exist'
  1148. type: boolean
  1149. x-go-name: CreateIfNo
  1150. scope:
  1151. description: 'description: scope'
  1152. type: string
  1153. x-go-name: Scope
  1154. user_id:
  1155. description: 'description: user id in keystone'
  1156. type: string
  1157. x-go-name: UserId
  1158. required:
  1159. - user_id
  1160. - scope
  1161. type: object
  1162. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1163. ReceiverTriggerVerifyInput:
  1164. properties:
  1165. contact_type:
  1166. description: 'description: contact type'
  1167. enum:
  1168. - email
  1169. - mobile
  1170. example: email
  1171. type: string
  1172. x-go-name: ContactType
  1173. required:
  1174. - contact_type
  1175. type: object
  1176. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1177. ReceiverUpdateInput:
  1178. properties:
  1179. description:
  1180. description: 资源描述
  1181. type: string
  1182. x-go-name: Description
  1183. email:
  1184. description: 'description: user email'
  1185. example: example@gmail.com
  1186. type: string
  1187. x-go-name: Email
  1188. enabled_contact_types:
  1189. description: 'description: enabled contacts for user'
  1190. example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}'
  1191. items:
  1192. type: string
  1193. type: array
  1194. x-go-name: EnabledContactTypes
  1195. force_verified:
  1196. type: boolean
  1197. x-go-name: ForceVerified
  1198. international_mobile:
  1199. $ref: '#/definitions/SInternationalMobile'
  1200. name:
  1201. description: 资源名称
  1202. type: string
  1203. x-go-name: Name
  1204. progress:
  1205. format: float
  1206. type: number
  1207. x-go-name: Progress
  1208. type: object
  1209. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1210. ReceiverVerifyInput:
  1211. properties:
  1212. contact_type:
  1213. description: 'description: Contact type'
  1214. enum:
  1215. - email
  1216. - mobile
  1217. example: email
  1218. type: string
  1219. x-go-name: ContactType
  1220. token:
  1221. description: 'description: token user input'
  1222. example: "123456"
  1223. type: string
  1224. x-go-name: Token
  1225. required:
  1226. - contact_type
  1227. - token
  1228. type: object
  1229. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1230. ResourceBaseCreateInput:
  1231. type: object
  1232. x-go-package: yunion.io/x/onecloud/pkg/apis
  1233. ResourceBaseDetails:
  1234. properties:
  1235. can_delete:
  1236. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1237. example: true
  1238. type: boolean
  1239. x-go-name: CanDelete
  1240. can_update:
  1241. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1242. example: true
  1243. type: boolean
  1244. x-go-name: CanUpdate
  1245. delete_fail_reason:
  1246. $ref: '#/definitions/Error'
  1247. update_fail_reason:
  1248. $ref: '#/definitions/Error'
  1249. type: object
  1250. x-go-package: yunion.io/x/onecloud/pkg/apis
  1251. ResourceBaseUpdateInput:
  1252. type: object
  1253. x-go-package: yunion.io/x/onecloud/pkg/apis
  1254. RobotCreateInput:
  1255. properties:
  1256. __meta__:
  1257. additionalProperties:
  1258. type: string
  1259. description: 标签列表,最多支持20个
  1260. example:
  1261. user:rd: op
  1262. type: object
  1263. x-go-name: Metadata
  1264. address:
  1265. description: 'description: address'
  1266. example: http://helloworld.io/test/webhook
  1267. type: string
  1268. x-go-name: Address
  1269. body:
  1270. type: object
  1271. x-go-name: Body
  1272. description:
  1273. description: 资源描述
  1274. example: test create network
  1275. type: string
  1276. x-go-name: Description
  1277. disabled:
  1278. description: 该资源是否被管理员*人为*禁用, 和enabled互斥
  1279. type: boolean
  1280. x-go-name: Disabled
  1281. dry_run:
  1282. default: false
  1283. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1284. type: boolean
  1285. x-go-name: DryRun
  1286. enabled:
  1287. description: 该资源是否被管理员*人为*启用或者禁用
  1288. type: boolean
  1289. x-go-name: Enabled
  1290. generate_name:
  1291. description: |-
  1292. 生成资源名称的模板,如果name为空,则为必填项
  1293. description: generated resource name, given a pattern to generate name, required if name is not given
  1294. example: test###
  1295. type: string
  1296. x-go-name: GenerateName
  1297. header:
  1298. type: object
  1299. x-go-name: Header
  1300. is_emulated:
  1301. description: |-
  1302. 资源是否为模拟资源
  1303. description: the resource is an emulated resource
  1304. type: boolean
  1305. x-go-name: IsEmulated
  1306. is_public:
  1307. description: 是否共享
  1308. type: boolean
  1309. x-go-name: IsPublic
  1310. is_system:
  1311. description: 'description: indicate the resource is a system resource, which is not visible to user'
  1312. type: boolean
  1313. x-go-name: IsSystem
  1314. lang:
  1315. description: 'description: Language preference'
  1316. example: zh_CN
  1317. type: string
  1318. x-go-name: Lang
  1319. msg_key:
  1320. type: string
  1321. x-go-name: MsgKey
  1322. name:
  1323. description: |-
  1324. 资源名称,如果generate_name为空,则为必填项
  1325. description: resource name, required if generated_name is not given
  1326. example: test-network
  1327. type: string
  1328. uniqueItems: true
  1329. x-go-name: Name
  1330. project_domain_id:
  1331. description: 指定项目归属域名称或ID
  1332. type: string
  1333. x-go-name: ProjectDomainId
  1334. project_id:
  1335. description: 指定项目的名称或ID
  1336. type: string
  1337. x-go-name: ProjectId
  1338. public_scope:
  1339. description: 共享范围
  1340. type: string
  1341. x-go-name: PublicScope
  1342. secret_key:
  1343. type: string
  1344. x-go-name: SecretKey
  1345. status:
  1346. description: 用来存储资源的状态
  1347. type: string
  1348. x-go-name: Status
  1349. type:
  1350. description: 'description: robot type'
  1351. enum:
  1352. - feishu
  1353. - dingtalk
  1354. - workwx
  1355. - webhook
  1356. example: webhook
  1357. type: string
  1358. x-go-name: Type
  1359. use_template:
  1360. $ref: '#/definitions/TriState'
  1361. required:
  1362. - name
  1363. type: object
  1364. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1365. RobotDetails:
  1366. properties:
  1367. can_delete:
  1368. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1369. example: true
  1370. type: boolean
  1371. x-go-name: CanDelete
  1372. can_update:
  1373. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1374. example: true
  1375. type: boolean
  1376. x-go-name: CanUpdate
  1377. delete_fail_reason:
  1378. $ref: '#/definitions/Error'
  1379. metadata:
  1380. additionalProperties:
  1381. type: string
  1382. description: 标签
  1383. type: object
  1384. x-go-name: Metadata
  1385. project:
  1386. description: |-
  1387. 资源归属项目的名称(向后兼容别名)
  1388. Deprecated
  1389. type: string
  1390. x-go-name: Tenant
  1391. project_domain:
  1392. description: 资源归属项目的域名称
  1393. type: string
  1394. x-go-name: ProjectDomain
  1395. project_id:
  1396. description: |-
  1397. 资源归属项目的ID(向后兼容别名)
  1398. Deprecated
  1399. type: string
  1400. x-go-name: TenantId
  1401. project_metadata:
  1402. additionalProperties:
  1403. type: string
  1404. type: object
  1405. x-go-name: ProjectMetadata
  1406. shared_domains:
  1407. description: 共享的域列表
  1408. items:
  1409. $ref: '#/definitions/SharedDomain'
  1410. type: array
  1411. x-go-name: SharedDomains
  1412. shared_projects:
  1413. description: 共享的项目列表
  1414. items:
  1415. $ref: '#/definitions/SharedProject'
  1416. type: array
  1417. x-go-name: SharedProjects
  1418. tenant:
  1419. description: |-
  1420. 资源归属项目的名称
  1421. alias:project
  1422. type: string
  1423. x-go-name: Project
  1424. update_fail_reason:
  1425. $ref: '#/definitions/Error'
  1426. type: object
  1427. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1428. RobotUpdateInput:
  1429. properties:
  1430. address:
  1431. description: 'description: address'
  1432. example: http://helloworld.io/test/webhook
  1433. type: string
  1434. x-go-name: Address
  1435. body:
  1436. type: object
  1437. x-go-name: Body
  1438. description:
  1439. description: 资源描述
  1440. type: string
  1441. x-go-name: Description
  1442. header:
  1443. type: object
  1444. x-go-name: Header
  1445. lang:
  1446. description: 'description: Language preference'
  1447. example: en
  1448. type: string
  1449. x-go-name: Lang
  1450. msg_key:
  1451. type: string
  1452. x-go-name: MsgKey
  1453. name:
  1454. description: 资源名称
  1455. type: string
  1456. x-go-name: Name
  1457. progress:
  1458. format: float
  1459. type: number
  1460. x-go-name: Progress
  1461. secret_key:
  1462. type: string
  1463. x-go-name: SecretKey
  1464. type: object
  1465. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1466. SAction:
  1467. type: string
  1468. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1469. SContact:
  1470. properties:
  1471. contact:
  1472. type: string
  1473. x-go-name: Contact
  1474. contact_type:
  1475. type: string
  1476. x-go-name: ContactType
  1477. type: object
  1478. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1479. SEmailAttachment:
  1480. properties:
  1481. content:
  1482. type: string
  1483. x-go-name: Base64Content
  1484. filename:
  1485. type: string
  1486. x-go-name: Filename
  1487. mime:
  1488. type: string
  1489. x-go-name: Mime
  1490. type: object
  1491. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1492. SInternationalMobile:
  1493. properties:
  1494. area_code:
  1495. description: 'description: area code of mobile'
  1496. example: "86"
  1497. type: string
  1498. x-go-name: AreaCode
  1499. mobile:
  1500. description: 'description: user mobile'
  1501. example: "17812345678"
  1502. type: string
  1503. x-go-name: Mobile
  1504. type: object
  1505. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1506. SNotifyConfigContent:
  1507. properties:
  1508. access_key_id:
  1509. type: string
  1510. x-go-name: AccessKeyId
  1511. access_key_secret:
  1512. type: string
  1513. x-go-name: AccessKeySecret
  1514. access_token:
  1515. type: string
  1516. x-go-name: AccessToken
  1517. access_token_expire_time:
  1518. format: date-time
  1519. type: string
  1520. x-go-name: AccessTokenExpireTime
  1521. agent_id:
  1522. description: workwx
  1523. type: string
  1524. x-go-name: AgentId
  1525. alerts_code:
  1526. type: string
  1527. x-go-name: AlertsCode
  1528. app_id:
  1529. description: Lark
  1530. type: string
  1531. x-go-name: AppId
  1532. app_key:
  1533. description: |-
  1534. dingtalk
  1535. AgentId string
  1536. AppSecret string
  1537. type: string
  1538. x-go-name: AppKey
  1539. app_secret:
  1540. type: string
  1541. x-go-name: AppSecret
  1542. corp_id:
  1543. type: string
  1544. x-go-name: CorpId
  1545. error_code:
  1546. type: string
  1547. x-go-name: ErrorCode
  1548. hostname:
  1549. description: Email
  1550. type: string
  1551. x-go-name: Hostname
  1552. hostport:
  1553. format: int64
  1554. type: integer
  1555. x-go-name: Hostport
  1556. password:
  1557. type: string
  1558. x-go-name: Password
  1559. phone_number:
  1560. type: string
  1561. x-go-name: PhoneNumber
  1562. secret:
  1563. type: string
  1564. x-go-name: Secret
  1565. sender_address:
  1566. type: string
  1567. x-go-name: SenderAddress
  1568. service_url:
  1569. type: string
  1570. x-go-name: ServiceUrl
  1571. signature:
  1572. type: string
  1573. x-go-name: Signature
  1574. sms_driver:
  1575. type: string
  1576. x-go-name: SmsDriver
  1577. ssl_global:
  1578. type: boolean
  1579. x-go-name: SslGlobal
  1580. username:
  1581. type: string
  1582. x-go-name: Username
  1583. verifiy_code:
  1584. description: sms
  1585. type: string
  1586. x-go-name: VerifiyCode
  1587. type: object
  1588. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1589. SResult:
  1590. type: string
  1591. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1592. STag:
  1593. properties:
  1594. key:
  1595. description: 标签Kye
  1596. type: string
  1597. x-go-name: Key
  1598. value:
  1599. description: 标签Value
  1600. type: string
  1601. x-go-name: Value
  1602. type: object
  1603. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  1604. STopicCreateInput:
  1605. properties:
  1606. __meta__:
  1607. additionalProperties:
  1608. type: string
  1609. description: 标签列表,最多支持20个
  1610. example:
  1611. user:rd: op
  1612. type: object
  1613. x-go-name: Metadata
  1614. actions:
  1615. items:
  1616. type: string
  1617. type: array
  1618. x-go-name: Actions
  1619. advance_days:
  1620. items:
  1621. format: int64
  1622. type: integer
  1623. type: array
  1624. x-go-name: AdvanceDays
  1625. content_cn:
  1626. type: string
  1627. x-go-name: ContentCn
  1628. content_en:
  1629. type: string
  1630. x-go-name: ContentEn
  1631. description:
  1632. description: 资源描述
  1633. example: test create network
  1634. type: string
  1635. x-go-name: Description
  1636. disabled:
  1637. description: 该资源是否被管理员*人为*禁用, 和enabled互斥
  1638. type: boolean
  1639. x-go-name: Disabled
  1640. dry_run:
  1641. default: false
  1642. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1643. type: boolean
  1644. x-go-name: DryRun
  1645. enabled:
  1646. description: 该资源是否被管理员*人为*启用或者禁用
  1647. type: boolean
  1648. x-go-name: Enabled
  1649. generate_name:
  1650. description: |-
  1651. 生成资源名称的模板,如果name为空,则为必填项
  1652. description: generated resource name, given a pattern to generate name, required if name is not given
  1653. example: test###
  1654. type: string
  1655. x-go-name: GenerateName
  1656. group_keys:
  1657. $ref: '#/definitions/STopicGroupKeys'
  1658. is_emulated:
  1659. description: |-
  1660. 资源是否为模拟资源
  1661. description: the resource is an emulated resource
  1662. type: boolean
  1663. x-go-name: IsEmulated
  1664. name:
  1665. description: |-
  1666. 资源名称,如果generate_name为空,则为必填项
  1667. description: resource name, required if generated_name is not given
  1668. example: test-network
  1669. type: string
  1670. uniqueItems: true
  1671. x-go-name: Name
  1672. resources:
  1673. items:
  1674. type: string
  1675. type: array
  1676. x-go-name: Resources
  1677. results:
  1678. type: boolean
  1679. x-go-name: Results
  1680. status:
  1681. description: 用来存储资源的状态
  1682. type: string
  1683. x-go-name: Status
  1684. title_cn:
  1685. type: string
  1686. x-go-name: TitleCn
  1687. title_en:
  1688. type: string
  1689. x-go-name: TitleEn
  1690. type:
  1691. type: string
  1692. x-go-name: Type
  1693. webconsole_disable:
  1694. type: boolean
  1695. x-go-name: WebconsoleDisable
  1696. required:
  1697. - name
  1698. type: object
  1699. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1700. STopicGroupKeys:
  1701. items:
  1702. type: string
  1703. type: array
  1704. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1705. SharedDomain:
  1706. properties:
  1707. id:
  1708. type: string
  1709. x-go-name: Id
  1710. name:
  1711. type: string
  1712. x-go-name: Name
  1713. type: object
  1714. x-go-package: yunion.io/x/onecloud/pkg/apis
  1715. SharedProject:
  1716. properties:
  1717. domain:
  1718. type: string
  1719. x-go-name: Domain
  1720. domain_id:
  1721. type: string
  1722. x-go-name: DomainId
  1723. id:
  1724. type: string
  1725. x-go-name: Id
  1726. name:
  1727. type: string
  1728. x-go-name: Name
  1729. type: object
  1730. x-go-package: yunion.io/x/onecloud/pkg/apis
  1731. StandaloneAnonResourceBaseUpdateInput:
  1732. properties:
  1733. description:
  1734. description: 资源描述
  1735. type: string
  1736. x-go-name: Description
  1737. type: object
  1738. x-go-package: yunion.io/x/onecloud/pkg/apis
  1739. StandaloneAnonResourceDetails:
  1740. properties:
  1741. can_delete:
  1742. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1743. example: true
  1744. type: boolean
  1745. x-go-name: CanDelete
  1746. can_update:
  1747. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1748. example: true
  1749. type: boolean
  1750. x-go-name: CanUpdate
  1751. delete_fail_reason:
  1752. $ref: '#/definitions/Error'
  1753. metadata:
  1754. additionalProperties:
  1755. type: string
  1756. description: 标签
  1757. type: object
  1758. x-go-name: Metadata
  1759. update_fail_reason:
  1760. $ref: '#/definitions/Error'
  1761. type: object
  1762. x-go-package: yunion.io/x/onecloud/pkg/apis
  1763. StatusStandaloneResourceBaseUpdateInput:
  1764. properties:
  1765. description:
  1766. description: 资源描述
  1767. type: string
  1768. x-go-name: Description
  1769. name:
  1770. description: 资源名称
  1771. type: string
  1772. x-go-name: Name
  1773. progress:
  1774. format: float
  1775. type: number
  1776. x-go-name: Progress
  1777. type: object
  1778. x-go-package: yunion.io/x/onecloud/pkg/apis
  1779. SubscriberChangeInput:
  1780. properties:
  1781. group_times:
  1782. description: minutes
  1783. format: uint32
  1784. type: integer
  1785. x-go-name: GroupTimes
  1786. receivers:
  1787. description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID'
  1788. items:
  1789. type: string
  1790. type: array
  1791. x-go-name: Receivers
  1792. robot:
  1793. description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID'
  1794. type: string
  1795. x-go-name: Robot
  1796. role:
  1797. description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID'
  1798. type: string
  1799. x-go-name: Role
  1800. role_scope:
  1801. description: 'description: The scope of role subscribers'
  1802. enum:
  1803. - system
  1804. - domain
  1805. - project
  1806. type: string
  1807. x-go-name: RoleScope
  1808. type: object
  1809. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1810. SubscriberCreateInput:
  1811. properties:
  1812. __meta__:
  1813. additionalProperties:
  1814. type: string
  1815. description: 标签列表,最多支持20个
  1816. example:
  1817. user:rd: op
  1818. type: object
  1819. x-go-name: Metadata
  1820. description:
  1821. description: 资源描述
  1822. example: test create network
  1823. type: string
  1824. x-go-name: Description
  1825. domain_id:
  1826. description: 'description: domain id of resource'
  1827. example: 1e3824756bac4ac084e784ed297ec652
  1828. type: string
  1829. x-go-name: DomainId
  1830. dry_run:
  1831. default: false
  1832. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1833. type: boolean
  1834. x-go-name: DryRun
  1835. group_times:
  1836. description: minutes
  1837. format: uint32
  1838. type: integer
  1839. x-go-name: GroupTimes
  1840. is_emulated:
  1841. description: |-
  1842. 资源是否为模拟资源
  1843. description: the resource is an emulated resource
  1844. type: boolean
  1845. x-go-name: IsEmulated
  1846. receivers:
  1847. description: 'description: receivers which is required when the type is ''receiver'' will Subscribe TopicID'
  1848. items:
  1849. type: string
  1850. type: array
  1851. x-go-name: Receivers
  1852. resource_attribution_id:
  1853. description: 'description: project id or domain id of resource'
  1854. example: 1e3824756bac4ac084e784ed297ec652
  1855. type: string
  1856. x-go-name: ResourceAttributionId
  1857. resource_attribution_name:
  1858. type: string
  1859. x-go-name: ResourceAttributionName
  1860. resource_scope:
  1861. description: 'description: scope of resource'
  1862. enum:
  1863. - system
  1864. - domain
  1865. - project
  1866. type: string
  1867. x-go-name: ResourceScope
  1868. robot:
  1869. description: 'description: Robot(Id or Name) which is required when the type is ''robot'' will Subscribe TopicID'
  1870. type: string
  1871. x-go-name: Robot
  1872. role:
  1873. description: 'description: Role(Id or Name) which is required when the type is ''role'' will Subscribe TopicID'
  1874. type: string
  1875. x-go-name: Role
  1876. role_scope:
  1877. description: 'description: The scope of role subscribers'
  1878. enum:
  1879. - system
  1880. - domain
  1881. - project
  1882. type: string
  1883. x-go-name: RoleScope
  1884. scope:
  1885. description: 'description: scope'
  1886. enum:
  1887. - system
  1888. - domain
  1889. type: string
  1890. x-go-name: Scope
  1891. topic_id:
  1892. description: |-
  1893. description: Id of Topic
  1894. required
  1895. type: string
  1896. x-go-name: TopicID
  1897. type:
  1898. description: 'description: Type of subscriber'
  1899. enum:
  1900. - receiver
  1901. - robot
  1902. - role
  1903. type: string
  1904. x-go-name: Type
  1905. type: object
  1906. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  1907. SubscriberDetails:
  1908. properties:
  1909. can_delete:
  1910. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1911. example: true
  1912. type: boolean
  1913. x-go-name: CanDelete
  1914. can_update:
  1915. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1916. example: true
  1917. type: boolean
  1918. x-go-name: CanUpdate
  1919. created_at:
  1920. description: 资源创建时间
  1921. format: date-time
  1922. type: string
  1923. x-go-name: CreatedAt
  1924. delete_fail_reason:
  1925. $ref: '#/definitions/Error'
  1926. deleted:
  1927. description: 资源是否被删除
  1928. type: boolean
  1929. x-go-name: Deleted
  1930. deleted_at:
  1931. description: 资源删除时间
  1932. format: date-time
  1933. type: string
  1934. x-go-name: DeletedAt
  1935. description:
  1936. description: 资源描述信息
  1937. type: string
  1938. x-go-name: Description
  1939. domain_id:
  1940. type: string
  1941. x-go-name: DomainId
  1942. enabled:
  1943. description: 资源是否启用
  1944. type: boolean
  1945. x-go-name: Enabled
  1946. group_times:
  1947. description: minutes
  1948. format: uint32
  1949. type: integer
  1950. x-go-name: GroupTimes
  1951. id:
  1952. description: 资源UUID
  1953. type: string
  1954. x-go-name: Id
  1955. identification:
  1956. type: string
  1957. x-go-name: Identification
  1958. is_emulated:
  1959. description: |-
  1960. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1961. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1962. type: boolean
  1963. x-go-name: IsEmulated
  1964. metadata:
  1965. additionalProperties:
  1966. type: string
  1967. description: 标签
  1968. type: object
  1969. x-go-name: Metadata
  1970. org_node_md5:
  1971. description: 用以组织架构变更通知其他服务权限变更
  1972. type: string
  1973. x-go-name: OrgNodeMd5
  1974. receivers:
  1975. description: 'description: receivers'
  1976. items:
  1977. $ref: '#/definitions/Identification'
  1978. type: array
  1979. x-go-name: Receivers
  1980. resource_attribution_id:
  1981. type: string
  1982. x-go-name: ResourceAttributionId
  1983. resource_attribution_name:
  1984. type: string
  1985. x-go-name: ResourceAttributionName
  1986. resource_scope:
  1987. type: string
  1988. x-go-name: ResourceScope
  1989. robot:
  1990. $ref: '#/definitions/Identification'
  1991. role:
  1992. $ref: '#/definitions/Identification'
  1993. role_scope:
  1994. type: string
  1995. x-go-name: RoleScope
  1996. scope:
  1997. type: string
  1998. x-go-name: Scope
  1999. topic_id:
  2000. type: string
  2001. x-go-name: TopicId
  2002. type:
  2003. type: string
  2004. x-go-name: Type
  2005. update_fail_reason:
  2006. $ref: '#/definitions/Error'
  2007. update_version:
  2008. description: 资源被更新次数
  2009. format: int64
  2010. type: integer
  2011. x-go-name: UpdateVersion
  2012. updated_at:
  2013. description: 资源更新时间
  2014. format: date-time
  2015. type: string
  2016. x-go-name: UpdatedAt
  2017. type: object
  2018. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2019. SubscriberSetReceiverInput:
  2020. properties:
  2021. receivers:
  2022. items:
  2023. type: string
  2024. type: array
  2025. x-go-name: Receivers
  2026. type: object
  2027. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2028. TTagSet:
  2029. items:
  2030. $ref: '#/definitions/STag'
  2031. type: array
  2032. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  2033. TTagSetList:
  2034. items:
  2035. $ref: '#/definitions/TTagSet'
  2036. type: array
  2037. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  2038. TemplateCreateInput:
  2039. properties:
  2040. __meta__:
  2041. additionalProperties:
  2042. type: string
  2043. description: 标签列表,最多支持20个
  2044. example:
  2045. user:rd: op
  2046. type: object
  2047. x-go-name: Metadata
  2048. contact_type:
  2049. description: |-
  2050. description: Contact type, specifically, setting it to all means all contact type
  2051. require: true
  2052. example: email
  2053. type: string
  2054. x-go-name: ContactType
  2055. content:
  2056. description: 'description: Template content'
  2057. example: 镜像 {{.name}} 上传完成
  2058. type: string
  2059. x-go-name: Content
  2060. description:
  2061. description: 资源描述
  2062. example: test create network
  2063. type: string
  2064. x-go-name: Description
  2065. dry_run:
  2066. default: false
  2067. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  2068. type: boolean
  2069. x-go-name: DryRun
  2070. example:
  2071. description: 'description: Example for using this template'
  2072. example: '{"name": "centos7.6"}'
  2073. type: string
  2074. x-go-name: Example
  2075. is_emulated:
  2076. description: |-
  2077. 资源是否为模拟资源
  2078. description: the resource is an emulated resource
  2079. type: boolean
  2080. x-go-name: IsEmulated
  2081. lang:
  2082. description: 'description: Language'
  2083. enum:
  2084. - cn
  2085. - en
  2086. type: string
  2087. x-go-name: Lang
  2088. template_type:
  2089. description: 'description: Template type'
  2090. enum:
  2091. - title
  2092. - content
  2093. - remote
  2094. example: title
  2095. type: string
  2096. x-go-name: TemplateType
  2097. topic:
  2098. description: 'description: Template topic'
  2099. example: IMAGE_ACTIVE
  2100. type: string
  2101. x-go-name: Topic
  2102. required:
  2103. - topic
  2104. - content
  2105. - example
  2106. type: object
  2107. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2108. TemplateManagerSaveInput:
  2109. properties:
  2110. contact_type:
  2111. type: string
  2112. x-go-name: ContactType
  2113. force:
  2114. type: boolean
  2115. x-go-name: Force
  2116. templates:
  2117. items:
  2118. $ref: '#/definitions/TemplateCreateInput'
  2119. type: array
  2120. x-go-name: Templates
  2121. type: object
  2122. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2123. TemplateUpdateInput:
  2124. properties:
  2125. content:
  2126. description: 'description: template content'
  2127. example: 镜像 {{.name}} 上传完成
  2128. type: string
  2129. x-go-name: Content
  2130. description:
  2131. description: 资源描述
  2132. type: string
  2133. x-go-name: Description
  2134. example:
  2135. description: 'description: all example for using this template'
  2136. example: '{"name": "centos7.6"}'
  2137. type: string
  2138. x-go-name: Example
  2139. required:
  2140. - content
  2141. - example
  2142. type: object
  2143. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2144. TopicDetails:
  2145. properties:
  2146. actions:
  2147. items:
  2148. type: string
  2149. type: array
  2150. x-go-name: Actions
  2151. advance_days:
  2152. items:
  2153. format: int64
  2154. type: integer
  2155. type: array
  2156. x-go-name: AdvanceDays
  2157. can_delete:
  2158. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  2159. example: true
  2160. type: boolean
  2161. x-go-name: CanDelete
  2162. can_update:
  2163. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  2164. example: true
  2165. type: boolean
  2166. x-go-name: CanUpdate
  2167. content_cn:
  2168. type: string
  2169. x-go-name: ContentCn
  2170. content_en:
  2171. type: string
  2172. x-go-name: ContentEn
  2173. created_at:
  2174. description: 资源创建时间
  2175. format: date-time
  2176. type: string
  2177. x-go-name: CreatedAt
  2178. delete_fail_reason:
  2179. $ref: '#/definitions/Error'
  2180. deleted:
  2181. description: 资源是否被删除
  2182. type: boolean
  2183. x-go-name: Deleted
  2184. deleted_at:
  2185. description: 资源删除时间
  2186. format: date-time
  2187. type: string
  2188. x-go-name: DeletedAt
  2189. description:
  2190. description: 资源描述信息
  2191. type: string
  2192. x-go-name: Description
  2193. enabled:
  2194. description: 资源是否启用
  2195. type: boolean
  2196. x-go-name: Enabled
  2197. group_keys:
  2198. $ref: '#/definitions/STopicGroupKeys'
  2199. id:
  2200. description: 资源UUID
  2201. type: string
  2202. x-go-name: Id
  2203. is_emulated:
  2204. description: |-
  2205. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  2206. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  2207. type: boolean
  2208. x-go-name: IsEmulated
  2209. metadata:
  2210. additionalProperties:
  2211. type: string
  2212. description: 标签
  2213. type: object
  2214. x-go-name: Metadata
  2215. name:
  2216. description: 资源名称
  2217. type: string
  2218. x-go-name: Name
  2219. org_node_md5:
  2220. description: 用以组织架构变更通知其他服务权限变更
  2221. type: string
  2222. x-go-name: OrgNodeMd5
  2223. progress:
  2224. description: 操作进度0-100
  2225. format: float
  2226. type: number
  2227. x-go-name: Progress
  2228. resource_types:
  2229. description: 'description: resources managed'
  2230. example:
  2231. - server
  2232. - eip
  2233. - disk
  2234. items:
  2235. type: string
  2236. type: array
  2237. x-go-name: Resources
  2238. results:
  2239. type: boolean
  2240. x-go-name: Results
  2241. status:
  2242. description: 资源状态
  2243. type: string
  2244. x-go-name: Status
  2245. title_cn:
  2246. type: string
  2247. x-go-name: TitleCn
  2248. title_en:
  2249. type: string
  2250. x-go-name: TitleEn
  2251. type:
  2252. type: string
  2253. x-go-name: Type
  2254. update_fail_reason:
  2255. $ref: '#/definitions/Error'
  2256. update_version:
  2257. description: 资源被更新次数
  2258. format: int64
  2259. type: integer
  2260. x-go-name: UpdateVersion
  2261. updated_at:
  2262. description: 资源更新时间
  2263. format: date-time
  2264. type: string
  2265. x-go-name: UpdatedAt
  2266. webconsole_disable:
  2267. type: boolean
  2268. x-go-name: WebconsoleDisable
  2269. type: object
  2270. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2271. TopicUpdateInput:
  2272. properties:
  2273. actions:
  2274. items:
  2275. type: string
  2276. type: array
  2277. x-go-name: Actions
  2278. advance_days:
  2279. items:
  2280. format: int64
  2281. type: integer
  2282. type: array
  2283. x-go-name: AdvanceDays
  2284. content_cn:
  2285. type: string
  2286. x-go-name: ContentCn
  2287. content_en:
  2288. type: string
  2289. x-go-name: ContentEn
  2290. description:
  2291. description: 资源描述
  2292. type: string
  2293. x-go-name: Description
  2294. name:
  2295. description: 资源名称
  2296. type: string
  2297. x-go-name: Name
  2298. progress:
  2299. format: float
  2300. type: number
  2301. x-go-name: Progress
  2302. resources:
  2303. items:
  2304. type: string
  2305. type: array
  2306. x-go-name: Resources
  2307. title_cn:
  2308. type: string
  2309. x-go-name: TitleCn
  2310. title_en:
  2311. type: string
  2312. x-go-name: TitleEn
  2313. webconsole_disable:
  2314. type: boolean
  2315. x-go-name: WebconsoleDisable
  2316. type: object
  2317. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2318. TriState:
  2319. type: string
  2320. x-go-package: yunion.io/x/pkg/tristate
  2321. VerifiedInfo:
  2322. properties:
  2323. contact_type:
  2324. type: string
  2325. x-go-name: ContactType
  2326. note:
  2327. type: string
  2328. x-go-name: Note
  2329. verified:
  2330. type: boolean
  2331. x-go-name: Verified
  2332. type: object
  2333. x-go-package: yunion.io/x/onecloud/pkg/apis/notify
  2334. host: '"127.0.0.1:8889"'
  2335. info:
  2336. contact:
  2337. email: lizexi@yunion.cn
  2338. name: Zexi Li
  2339. description: Notify API
  2340. license:
  2341. name: Apache 2.0
  2342. url: http://www.apache.org/licenses/LICENSE-2.0.html
  2343. version: "1.0"
  2344. paths:
  2345. /configs:
  2346. get:
  2347. description: 列表
  2348. operationId: config_ListItemFilter
  2349. parameters:
  2350. - default: 20
  2351. description: 查询限制量
  2352. format: int64
  2353. in: query
  2354. name: limit
  2355. type: integer
  2356. x-go-name: Limit
  2357. - default: 0
  2358. description: 查询偏移量
  2359. format: int64
  2360. in: query
  2361. name: offset
  2362. type: integer
  2363. x-go-name: Offset
  2364. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  2365. in: query
  2366. items:
  2367. type: string
  2368. name: order_by
  2369. type: array
  2370. x-go-name: OrderBy
  2371. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  2372. example: desc|asc
  2373. in: query
  2374. name: order
  2375. type: string
  2376. x-go-name: Order
  2377. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  2378. in: query
  2379. name: details
  2380. type: boolean
  2381. x-go-name: Details
  2382. - description: 模糊搜索所有字段
  2383. in: query
  2384. name: search
  2385. type: string
  2386. x-go-name: Search
  2387. - description: |-
  2388. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  2389. 支持的操作符如下:
  2390. 操作符 | 参数个数 | 举例 | 说明 |
  2391. ---------------|----------|------------------------------------------------|-----------------------------|
  2392. in | > 0 | name.in("test", "good") | 在给定数组中 |
  2393. notin | > 0 | name.notin('test') | 不在给定数组中 |
  2394. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  2395. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  2396. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  2397. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  2398. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  2399. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  2400. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  2401. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  2402. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  2403. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  2404. notequals | 1 | name.notequals('test') | 不等于给定值 |
  2405. isnull | 0 | name.isnull() | 值为SQL的NULL |
  2406. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  2407. isempty | 0 | name.isempty('test') | 值为空字符串 |
  2408. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  2409. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  2410. in: query
  2411. items:
  2412. type: string
  2413. name: filter
  2414. type: array
  2415. x-go-name: Filter
  2416. - description: |-
  2417. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  2418. 和其他表关联的语法如下:
  2419. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  2420. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  2421. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  2422. 举例:
  2423. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  2424. in: query
  2425. items:
  2426. type: string
  2427. name: joint_filter
  2428. type: array
  2429. x-go-name: JointFilter
  2430. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  2431. in: query
  2432. name: filter_any
  2433. type: boolean
  2434. x-go-name: FilterAny
  2435. - description: 返回结果只包含指定的字段
  2436. in: query
  2437. items:
  2438. type: string
  2439. name: field
  2440. type: array
  2441. x-go-name: Field
  2442. - description: 用于数据导出,指定导出的数据字段
  2443. in: query
  2444. name: export_keys
  2445. type: string
  2446. x-go-name: ExportKeys
  2447. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  2448. in: query
  2449. name: show_fail_reason
  2450. type: boolean
  2451. x-go-name: ShowFailReason
  2452. - description: 是否返回状态统计信息,默认为False
  2453. in: query
  2454. name: summary_stats
  2455. type: boolean
  2456. x-go-name: SummaryStats
  2457. - $ref: '#/definitions/TTagSet'
  2458. description: 通过标签过滤(包含这些标签)
  2459. in: query
  2460. name: tags
  2461. x-go-name: Tags
  2462. - $ref: '#/definitions/TTagSetList'
  2463. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  2464. in: query
  2465. name: obj_tags
  2466. x-go-name: ObjTags
  2467. - $ref: '#/definitions/TTagSet'
  2468. description: 通过标签过滤(不包含这些标签)
  2469. in: query
  2470. name: no_tags
  2471. x-go-name: NoTags
  2472. - $ref: '#/definitions/TTagSetList'
  2473. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  2474. in: query
  2475. name: no_obj_tags
  2476. x-go-name: NoObjTags
  2477. - description: 通过标签排序
  2478. in: query
  2479. name: order_by_tag
  2480. type: string
  2481. x-go-name: OrderByTag
  2482. - description: |-
  2483. deprecated
  2484. 返回资源的标签不包含用户标签
  2485. in: query
  2486. name: without_user_meta
  2487. type: boolean
  2488. x-go-name: WithoutUserMeta
  2489. - description: 返回包含用户标签的资源
  2490. in: query
  2491. name: with_user_meta
  2492. type: boolean
  2493. x-go-name: WithUserMeta
  2494. - description: 返回包含外部标签的资源
  2495. in: query
  2496. name: with_cloud_meta
  2497. type: boolean
  2498. x-go-name: WithCloudMeta
  2499. - description: 返回包含任意标签的资源
  2500. in: query
  2501. name: with_any_meta
  2502. type: boolean
  2503. x-go-name: WithAnyMeta
  2504. - description: 返回列表数据中包含资源的标签数据(Metadata)
  2505. in: query
  2506. name: with_meta
  2507. type: boolean
  2508. x-go-name: WithMeta
  2509. - description: 显示所有的资源,包括模拟的资源
  2510. in: query
  2511. name: show_emulated
  2512. type: boolean
  2513. x-go-name: ShowEmulated
  2514. - description: 以资源ID过滤列表
  2515. in: query
  2516. items:
  2517. type: string
  2518. name: id
  2519. type: array
  2520. x-go-name: Ids
  2521. - description: 以资源名称过滤列表
  2522. in: query
  2523. items:
  2524. type: string
  2525. name: name
  2526. type: array
  2527. x-go-name: Names
  2528. - description: 指定查询的权限范围,可能值为project, domain or system
  2529. in: query
  2530. name: scope
  2531. type: string
  2532. x-go-name: Scope
  2533. - description: 指定项目归属域名称或ID
  2534. in: query
  2535. name: project_domain_id
  2536. type: string
  2537. x-go-name: ProjectDomainId
  2538. - description: 对具有域属性的资源,严格匹配域ID
  2539. in: query
  2540. items:
  2541. type: string
  2542. name: project_domain_ids
  2543. type: array
  2544. x-go-name: ProjectDomainIds
  2545. - description: 按domain名称排序,可能值为asc|desc
  2546. in: query
  2547. name: order_by_domain
  2548. pattern: asc|desc
  2549. type: string
  2550. x-go-name: OrderByDomain
  2551. - $ref: '#/definitions/TTagSetList'
  2552. description: filter by domain tags
  2553. in: query
  2554. name: domain_tags
  2555. x-go-name: DomainTags
  2556. - $ref: '#/definitions/TTagSetList'
  2557. description: filter by domain tags
  2558. in: query
  2559. name: no_domain_tags
  2560. x-go-name: NoDomainTags
  2561. - in: query
  2562. name: type
  2563. type: string
  2564. x-go-name: Type
  2565. - in: query
  2566. name: attribution
  2567. type: string
  2568. x-go-name: Attribution
  2569. responses:
  2570. "200":
  2571. $ref: '#/responses/config_ListItemFilterOutput'
  2572. summary: 列表
  2573. tags:
  2574. - config
  2575. post:
  2576. description: 新建
  2577. operationId: config_ValidateCreateData
  2578. parameters:
  2579. - in: body
  2580. name: body
  2581. schema:
  2582. properties:
  2583. config:
  2584. $ref: '#/definitions/ConfigCreateInput'
  2585. count:
  2586. default: 1
  2587. format: int64
  2588. type: integer
  2589. x-go-name: Count
  2590. type: object
  2591. x-go-name: Body
  2592. responses:
  2593. "200":
  2594. $ref: '#/responses/config_ValidateCreateDataOutput'
  2595. summary: 新建
  2596. tags:
  2597. - config
  2598. /configs/{id}:
  2599. delete:
  2600. description: 删除
  2601. operationId: config_CustomizeDelete
  2602. parameters:
  2603. - description: The Id or Name of config
  2604. in: path
  2605. name: id
  2606. required: true
  2607. type: string
  2608. x-go-name: Id
  2609. responses:
  2610. "200":
  2611. $ref: '#/responses/config_CustomizeDeleteOutput'
  2612. summary: 删除
  2613. tags:
  2614. - config
  2615. get:
  2616. description: 获取详情
  2617. operationId: config_FetchCustomizeColumns
  2618. parameters:
  2619. - description: The Id or Name of config
  2620. in: path
  2621. name: id
  2622. required: true
  2623. type: string
  2624. x-go-name: Id
  2625. responses:
  2626. "200":
  2627. $ref: '#/responses/config_FetchCustomizeColumnsOutput'
  2628. summary: 获取详情
  2629. tags:
  2630. - config
  2631. put:
  2632. description: 更新
  2633. operationId: config_ValidateUpdateData
  2634. parameters:
  2635. - description: The Id or Name of config
  2636. in: path
  2637. name: id
  2638. required: true
  2639. type: string
  2640. x-go-name: Id
  2641. - in: body
  2642. name: body
  2643. schema:
  2644. properties:
  2645. config:
  2646. $ref: '#/definitions/ConfigUpdateInput'
  2647. type: object
  2648. x-go-name: Body
  2649. responses:
  2650. "200":
  2651. $ref: '#/responses/config_ValidateUpdateDataOutput'
  2652. summary: 更新
  2653. tags:
  2654. - config
  2655. /configs/{id}/change-owner:
  2656. post:
  2657. description: 执行操作ChangeOwner
  2658. operationId: config_PerformChangeOwner
  2659. parameters:
  2660. - description: The Id or Name of config
  2661. in: path
  2662. name: id
  2663. required: true
  2664. type: string
  2665. x-go-name: Id
  2666. - in: body
  2667. name: body
  2668. schema:
  2669. properties:
  2670. config:
  2671. $ref: '#/definitions/PerformChangeDomainOwnerInput'
  2672. type: object
  2673. x-go-name: Body
  2674. responses:
  2675. "200":
  2676. $ref: '#/responses/config_PerformChangeOwnerOutput'
  2677. summary: 更改项目
  2678. tags:
  2679. - config
  2680. /configs/{id}/metadata:
  2681. get:
  2682. description: 获取指定信息Metadata
  2683. operationId: config_GetDetailsMetadata
  2684. parameters:
  2685. - description: |-
  2686. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  2687. 标签分为
  2688. 类型 | 说明 |
  2689. ----------|---------------------------------------------|
  2690. 系统标签 | 平台定义的标签 |
  2691. 用户标签 | key以user:为前缀,用户自定义标签 |
  2692. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  2693. in: query
  2694. items:
  2695. type: string
  2696. name: field
  2697. type: array
  2698. x-go-name: Field
  2699. - description: 按标签前缀过滤
  2700. in: query
  2701. name: prefix
  2702. type: string
  2703. x-go-name: Prefix
  2704. - description: The Id or Name of config
  2705. in: path
  2706. name: id
  2707. required: true
  2708. type: string
  2709. x-go-name: Id
  2710. responses:
  2711. "200":
  2712. $ref: '#/responses/config_GetDetailsMetadataOutput'
  2713. summary: 获取资源标签(元数据)
  2714. tags:
  2715. - config
  2716. /configs/capability:
  2717. get:
  2718. description: 获取指定资源类的信息Capability
  2719. operationId: config_GetPropertyCapability
  2720. responses:
  2721. "200":
  2722. $ref: '#/responses/config_GetPropertyCapabilityOutput'
  2723. summary: 获取指定资源类的信息Capability
  2724. tags:
  2725. - config
  2726. /configs/validate:
  2727. post:
  2728. description: 执行操作Validate
  2729. operationId: config_PerformValidate
  2730. parameters:
  2731. - in: body
  2732. name: body
  2733. schema:
  2734. properties:
  2735. config:
  2736. $ref: '#/definitions/ConfigValidateInput'
  2737. type: object
  2738. x-go-name: Body
  2739. responses:
  2740. "200":
  2741. $ref: '#/responses/config_PerformValidateOutput'
  2742. summary: 执行操作Validate
  2743. tags:
  2744. - config
  2745. /email_queue_statuses:
  2746. get:
  2747. description: 列表
  2748. operationId: email_queue_status_ListItemFilter
  2749. parameters:
  2750. - default: 20
  2751. description: 查询限制量
  2752. format: int64
  2753. in: query
  2754. name: limit
  2755. type: integer
  2756. x-go-name: Limit
  2757. - default: 0
  2758. description: 查询偏移量
  2759. format: int64
  2760. in: query
  2761. name: offset
  2762. type: integer
  2763. x-go-name: Offset
  2764. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  2765. in: query
  2766. items:
  2767. type: string
  2768. name: order_by
  2769. type: array
  2770. x-go-name: OrderBy
  2771. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  2772. example: desc|asc
  2773. in: query
  2774. name: order
  2775. type: string
  2776. x-go-name: Order
  2777. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  2778. in: query
  2779. name: details
  2780. type: boolean
  2781. x-go-name: Details
  2782. - description: 模糊搜索所有字段
  2783. in: query
  2784. name: search
  2785. type: string
  2786. x-go-name: Search
  2787. - description: |-
  2788. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  2789. 支持的操作符如下:
  2790. 操作符 | 参数个数 | 举例 | 说明 |
  2791. ---------------|----------|------------------------------------------------|-----------------------------|
  2792. in | > 0 | name.in("test", "good") | 在给定数组中 |
  2793. notin | > 0 | name.notin('test') | 不在给定数组中 |
  2794. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  2795. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  2796. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  2797. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  2798. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  2799. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  2800. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  2801. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  2802. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  2803. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  2804. notequals | 1 | name.notequals('test') | 不等于给定值 |
  2805. isnull | 0 | name.isnull() | 值为SQL的NULL |
  2806. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  2807. isempty | 0 | name.isempty('test') | 值为空字符串 |
  2808. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  2809. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  2810. in: query
  2811. items:
  2812. type: string
  2813. name: filter
  2814. type: array
  2815. x-go-name: Filter
  2816. - description: |-
  2817. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  2818. 和其他表关联的语法如下:
  2819. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  2820. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  2821. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  2822. 举例:
  2823. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  2824. in: query
  2825. items:
  2826. type: string
  2827. name: joint_filter
  2828. type: array
  2829. x-go-name: JointFilter
  2830. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  2831. in: query
  2832. name: filter_any
  2833. type: boolean
  2834. x-go-name: FilterAny
  2835. - description: 返回结果只包含指定的字段
  2836. in: query
  2837. items:
  2838. type: string
  2839. name: field
  2840. type: array
  2841. x-go-name: Field
  2842. - description: 用于数据导出,指定导出的数据字段
  2843. in: query
  2844. name: export_keys
  2845. type: string
  2846. x-go-name: ExportKeys
  2847. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  2848. in: query
  2849. name: show_fail_reason
  2850. type: boolean
  2851. x-go-name: ShowFailReason
  2852. - description: 是否返回状态统计信息,默认为False
  2853. in: query
  2854. name: summary_stats
  2855. type: boolean
  2856. x-go-name: SummaryStats
  2857. responses:
  2858. "200":
  2859. $ref: '#/responses/email_queue_status_ListItemFilterOutput'
  2860. summary: 列表
  2861. tags:
  2862. - email_queue_status
  2863. post:
  2864. description: 新建
  2865. operationId: email_queue_status_ValidateCreateData
  2866. parameters:
  2867. - in: body
  2868. name: body
  2869. schema:
  2870. properties:
  2871. count:
  2872. default: 1
  2873. format: int64
  2874. type: integer
  2875. x-go-name: Count
  2876. email_queue_status:
  2877. $ref: '#/definitions/ModelBaseCreateInput'
  2878. type: object
  2879. x-go-name: Body
  2880. responses:
  2881. "200":
  2882. $ref: '#/responses/email_queue_status_ValidateCreateDataOutput'
  2883. summary: 新建
  2884. tags:
  2885. - email_queue_status
  2886. /email_queue_statuses/{id}:
  2887. delete:
  2888. description: 删除
  2889. operationId: email_queue_status_CustomizeDelete
  2890. parameters:
  2891. - description: The Id or Name of email_queue_status
  2892. in: path
  2893. name: id
  2894. required: true
  2895. type: string
  2896. x-go-name: Id
  2897. responses:
  2898. "200":
  2899. $ref: '#/responses/email_queue_status_CustomizeDeleteOutput'
  2900. summary: 删除
  2901. tags:
  2902. - email_queue_status
  2903. get:
  2904. description: 获取详情
  2905. operationId: email_queue_status_FetchCustomizeColumns
  2906. parameters:
  2907. - description: The Id or Name of email_queue_status
  2908. in: path
  2909. name: id
  2910. required: true
  2911. type: string
  2912. x-go-name: Id
  2913. responses:
  2914. "200":
  2915. $ref: '#/responses/email_queue_status_FetchCustomizeColumnsOutput'
  2916. summary: 获取详情
  2917. tags:
  2918. - email_queue_status
  2919. put:
  2920. description: 更新
  2921. operationId: email_queue_status_ValidateUpdateData
  2922. parameters:
  2923. - description: The Id or Name of email_queue_status
  2924. in: path
  2925. name: id
  2926. required: true
  2927. type: string
  2928. x-go-name: Id
  2929. - in: body
  2930. name: body
  2931. schema:
  2932. properties:
  2933. email_queue_status:
  2934. $ref: '#/definitions/ModelBaseUpdateInput'
  2935. type: object
  2936. x-go-name: Body
  2937. responses:
  2938. "200":
  2939. $ref: '#/responses/email_queue_status_ValidateUpdateDataOutput'
  2940. summary: 更新
  2941. tags:
  2942. - email_queue_status
  2943. /email_queues:
  2944. get:
  2945. description: 列表
  2946. operationId: email_queue_ListItemFilter
  2947. parameters:
  2948. - default: 20
  2949. description: 查询限制量
  2950. format: int64
  2951. in: query
  2952. name: limit
  2953. type: integer
  2954. x-go-name: Limit
  2955. - default: 0
  2956. description: 查询偏移量
  2957. format: int64
  2958. in: query
  2959. name: offset
  2960. type: integer
  2961. x-go-name: Offset
  2962. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  2963. in: query
  2964. items:
  2965. type: string
  2966. name: order_by
  2967. type: array
  2968. x-go-name: OrderBy
  2969. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  2970. example: desc|asc
  2971. in: query
  2972. name: order
  2973. type: string
  2974. x-go-name: Order
  2975. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  2976. in: query
  2977. name: details
  2978. type: boolean
  2979. x-go-name: Details
  2980. - description: 模糊搜索所有字段
  2981. in: query
  2982. name: search
  2983. type: string
  2984. x-go-name: Search
  2985. - description: |-
  2986. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  2987. 支持的操作符如下:
  2988. 操作符 | 参数个数 | 举例 | 说明 |
  2989. ---------------|----------|------------------------------------------------|-----------------------------|
  2990. in | > 0 | name.in("test", "good") | 在给定数组中 |
  2991. notin | > 0 | name.notin('test') | 不在给定数组中 |
  2992. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  2993. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  2994. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  2995. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  2996. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  2997. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  2998. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  2999. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  3000. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  3001. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  3002. notequals | 1 | name.notequals('test') | 不等于给定值 |
  3003. isnull | 0 | name.isnull() | 值为SQL的NULL |
  3004. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  3005. isempty | 0 | name.isempty('test') | 值为空字符串 |
  3006. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  3007. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  3008. in: query
  3009. items:
  3010. type: string
  3011. name: filter
  3012. type: array
  3013. x-go-name: Filter
  3014. - description: |-
  3015. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  3016. 和其他表关联的语法如下:
  3017. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  3018. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  3019. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  3020. 举例:
  3021. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  3022. in: query
  3023. items:
  3024. type: string
  3025. name: joint_filter
  3026. type: array
  3027. x-go-name: JointFilter
  3028. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  3029. in: query
  3030. name: filter_any
  3031. type: boolean
  3032. x-go-name: FilterAny
  3033. - description: 返回结果只包含指定的字段
  3034. in: query
  3035. items:
  3036. type: string
  3037. name: field
  3038. type: array
  3039. x-go-name: Field
  3040. - description: 用于数据导出,指定导出的数据字段
  3041. in: query
  3042. name: export_keys
  3043. type: string
  3044. x-go-name: ExportKeys
  3045. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  3046. in: query
  3047. name: show_fail_reason
  3048. type: boolean
  3049. x-go-name: ShowFailReason
  3050. - description: 是否返回状态统计信息,默认为False
  3051. in: query
  3052. name: summary_stats
  3053. type: boolean
  3054. x-go-name: SummaryStats
  3055. - in: query
  3056. items:
  3057. type: string
  3058. name: id
  3059. type: array
  3060. x-go-name: Id
  3061. - description: Id []int `json:"id"`
  3062. in: query
  3063. items:
  3064. type: string
  3065. name: to
  3066. type: array
  3067. x-go-name: To
  3068. - in: query
  3069. name: subject
  3070. type: string
  3071. x-go-name: Subject
  3072. - in: query
  3073. items:
  3074. type: string
  3075. name: session_id
  3076. type: array
  3077. x-go-name: SessionId
  3078. responses:
  3079. "200":
  3080. $ref: '#/responses/email_queue_ListItemFilterOutput'
  3081. summary: 宿主机/物理机列表
  3082. tags:
  3083. - email_queue
  3084. post:
  3085. description: 新建
  3086. operationId: email_queue_ValidateCreateData
  3087. parameters:
  3088. - in: body
  3089. name: body
  3090. schema:
  3091. properties:
  3092. count:
  3093. default: 1
  3094. format: int64
  3095. type: integer
  3096. x-go-name: Count
  3097. email_queue:
  3098. $ref: '#/definitions/EmailQueueCreateInput'
  3099. type: object
  3100. x-go-name: Body
  3101. responses:
  3102. "200":
  3103. $ref: '#/responses/email_queue_ValidateCreateDataOutput'
  3104. summary: 新建
  3105. tags:
  3106. - email_queue
  3107. /email_queues/{id}:
  3108. delete:
  3109. description: 删除
  3110. operationId: email_queue_CustomizeDelete
  3111. parameters:
  3112. - description: The Id or Name of email_queue
  3113. in: path
  3114. name: id
  3115. required: true
  3116. type: string
  3117. x-go-name: Id
  3118. responses:
  3119. "200":
  3120. $ref: '#/responses/email_queue_CustomizeDeleteOutput'
  3121. summary: 删除
  3122. tags:
  3123. - email_queue
  3124. get:
  3125. description: 获取详情
  3126. operationId: email_queue_FetchCustomizeColumns
  3127. parameters:
  3128. - description: The Id or Name of email_queue
  3129. in: path
  3130. name: id
  3131. required: true
  3132. type: string
  3133. x-go-name: Id
  3134. responses:
  3135. "200":
  3136. $ref: '#/responses/email_queue_FetchCustomizeColumnsOutput'
  3137. summary: 获取详情
  3138. tags:
  3139. - email_queue
  3140. put:
  3141. description: 更新
  3142. operationId: email_queue_ValidateUpdateData
  3143. parameters:
  3144. - description: The Id or Name of email_queue
  3145. in: path
  3146. name: id
  3147. required: true
  3148. type: string
  3149. x-go-name: Id
  3150. responses:
  3151. "200":
  3152. $ref: '#/responses/email_queue_ValidateUpdateDataOutput'
  3153. summary: 更新
  3154. tags:
  3155. - email_queue
  3156. /email_queues/{id}/send:
  3157. post:
  3158. description: 执行操作Send
  3159. operationId: email_queue_PerformSend
  3160. parameters:
  3161. - description: The Id or Name of email_queue
  3162. in: path
  3163. name: id
  3164. required: true
  3165. type: string
  3166. x-go-name: Id
  3167. - in: body
  3168. name: body
  3169. schema:
  3170. properties:
  3171. email_queue:
  3172. $ref: '#/definitions/EmailQueueSendInput'
  3173. type: object
  3174. x-go-name: Body
  3175. responses:
  3176. "200":
  3177. $ref: '#/responses/email_queue_PerformSendOutput'
  3178. summary: 执行操作Send
  3179. tags:
  3180. - email_queue
  3181. /events:
  3182. get:
  3183. description: 列表
  3184. operationId: event_ListItemFilter
  3185. parameters:
  3186. - default: 20
  3187. description: 查询限制量
  3188. format: int64
  3189. in: query
  3190. name: limit
  3191. type: integer
  3192. x-go-name: Limit
  3193. - default: 0
  3194. description: 查询偏移量
  3195. format: int64
  3196. in: query
  3197. name: offset
  3198. type: integer
  3199. x-go-name: Offset
  3200. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  3201. in: query
  3202. items:
  3203. type: string
  3204. name: order_by
  3205. type: array
  3206. x-go-name: OrderBy
  3207. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  3208. example: desc|asc
  3209. in: query
  3210. name: order
  3211. type: string
  3212. x-go-name: Order
  3213. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  3214. in: query
  3215. name: details
  3216. type: boolean
  3217. x-go-name: Details
  3218. - description: 模糊搜索所有字段
  3219. in: query
  3220. name: search
  3221. type: string
  3222. x-go-name: Search
  3223. - description: |-
  3224. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  3225. 支持的操作符如下:
  3226. 操作符 | 参数个数 | 举例 | 说明 |
  3227. ---------------|----------|------------------------------------------------|-----------------------------|
  3228. in | > 0 | name.in("test", "good") | 在给定数组中 |
  3229. notin | > 0 | name.notin('test') | 不在给定数组中 |
  3230. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  3231. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  3232. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  3233. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  3234. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  3235. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  3236. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  3237. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  3238. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  3239. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  3240. notequals | 1 | name.notequals('test') | 不等于给定值 |
  3241. isnull | 0 | name.isnull() | 值为SQL的NULL |
  3242. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  3243. isempty | 0 | name.isempty('test') | 值为空字符串 |
  3244. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  3245. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  3246. in: query
  3247. items:
  3248. type: string
  3249. name: filter
  3250. type: array
  3251. x-go-name: Filter
  3252. - description: |-
  3253. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  3254. 和其他表关联的语法如下:
  3255. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  3256. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  3257. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  3258. 举例:
  3259. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  3260. in: query
  3261. items:
  3262. type: string
  3263. name: joint_filter
  3264. type: array
  3265. x-go-name: JointFilter
  3266. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  3267. in: query
  3268. name: filter_any
  3269. type: boolean
  3270. x-go-name: FilterAny
  3271. - description: 返回结果只包含指定的字段
  3272. in: query
  3273. items:
  3274. type: string
  3275. name: field
  3276. type: array
  3277. x-go-name: Field
  3278. - description: 用于数据导出,指定导出的数据字段
  3279. in: query
  3280. name: export_keys
  3281. type: string
  3282. x-go-name: ExportKeys
  3283. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  3284. in: query
  3285. name: show_fail_reason
  3286. type: boolean
  3287. x-go-name: ShowFailReason
  3288. - description: 是否返回状态统计信息,默认为False
  3289. in: query
  3290. name: summary_stats
  3291. type: boolean
  3292. x-go-name: SummaryStats
  3293. - in: query
  3294. items:
  3295. type: string
  3296. name: id
  3297. type: array
  3298. x-go-name: Id
  3299. responses:
  3300. "200":
  3301. $ref: '#/responses/event_ListItemFilterOutput'
  3302. summary: 操作日志列表
  3303. tags:
  3304. - event
  3305. post:
  3306. description: 新建
  3307. operationId: event_ValidateCreateData
  3308. parameters:
  3309. - in: body
  3310. name: body
  3311. schema:
  3312. properties:
  3313. count:
  3314. default: 1
  3315. format: int64
  3316. type: integer
  3317. x-go-name: Count
  3318. event:
  3319. $ref: '#/definitions/ModelBaseCreateInput'
  3320. type: object
  3321. x-go-name: Body
  3322. responses:
  3323. "200":
  3324. $ref: '#/responses/event_ValidateCreateDataOutput'
  3325. summary: 新建
  3326. tags:
  3327. - event
  3328. /events/{id}:
  3329. delete:
  3330. description: 删除
  3331. operationId: event_CustomizeDelete
  3332. parameters:
  3333. - description: The Id or Name of event
  3334. in: path
  3335. name: id
  3336. required: true
  3337. type: string
  3338. x-go-name: Id
  3339. responses:
  3340. "200":
  3341. $ref: '#/responses/event_CustomizeDeleteOutput'
  3342. summary: 删除
  3343. tags:
  3344. - event
  3345. get:
  3346. description: 获取详情
  3347. operationId: event_FetchCustomizeColumns
  3348. parameters:
  3349. - description: The Id or Name of event
  3350. in: path
  3351. name: id
  3352. required: true
  3353. type: string
  3354. x-go-name: Id
  3355. responses:
  3356. "200":
  3357. $ref: '#/responses/event_FetchCustomizeColumnsOutput'
  3358. summary: 获取详情
  3359. tags:
  3360. - event
  3361. put:
  3362. description: 更新
  3363. operationId: event_ValidateUpdateData
  3364. parameters:
  3365. - description: The Id or Name of event
  3366. in: path
  3367. name: id
  3368. required: true
  3369. type: string
  3370. x-go-name: Id
  3371. responses:
  3372. "200":
  3373. $ref: '#/responses/event_ValidateUpdateDataOutput'
  3374. summary: 更新
  3375. tags:
  3376. - event
  3377. /notification_groups:
  3378. get:
  3379. description: 列表
  3380. operationId: notification_group_ListItemFilter
  3381. parameters:
  3382. - default: 20
  3383. description: 查询限制量
  3384. format: int64
  3385. in: query
  3386. name: limit
  3387. type: integer
  3388. x-go-name: Limit
  3389. - default: 0
  3390. description: 查询偏移量
  3391. format: int64
  3392. in: query
  3393. name: offset
  3394. type: integer
  3395. x-go-name: Offset
  3396. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  3397. in: query
  3398. items:
  3399. type: string
  3400. name: order_by
  3401. type: array
  3402. x-go-name: OrderBy
  3403. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  3404. example: desc|asc
  3405. in: query
  3406. name: order
  3407. type: string
  3408. x-go-name: Order
  3409. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  3410. in: query
  3411. name: details
  3412. type: boolean
  3413. x-go-name: Details
  3414. - description: 模糊搜索所有字段
  3415. in: query
  3416. name: search
  3417. type: string
  3418. x-go-name: Search
  3419. - description: |-
  3420. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  3421. 支持的操作符如下:
  3422. 操作符 | 参数个数 | 举例 | 说明 |
  3423. ---------------|----------|------------------------------------------------|-----------------------------|
  3424. in | > 0 | name.in("test", "good") | 在给定数组中 |
  3425. notin | > 0 | name.notin('test') | 不在给定数组中 |
  3426. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  3427. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  3428. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  3429. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  3430. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  3431. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  3432. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  3433. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  3434. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  3435. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  3436. notequals | 1 | name.notequals('test') | 不等于给定值 |
  3437. isnull | 0 | name.isnull() | 值为SQL的NULL |
  3438. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  3439. isempty | 0 | name.isempty('test') | 值为空字符串 |
  3440. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  3441. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  3442. in: query
  3443. items:
  3444. type: string
  3445. name: filter
  3446. type: array
  3447. x-go-name: Filter
  3448. - description: |-
  3449. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  3450. 和其他表关联的语法如下:
  3451. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  3452. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  3453. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  3454. 举例:
  3455. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  3456. in: query
  3457. items:
  3458. type: string
  3459. name: joint_filter
  3460. type: array
  3461. x-go-name: JointFilter
  3462. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  3463. in: query
  3464. name: filter_any
  3465. type: boolean
  3466. x-go-name: FilterAny
  3467. - description: 返回结果只包含指定的字段
  3468. in: query
  3469. items:
  3470. type: string
  3471. name: field
  3472. type: array
  3473. x-go-name: Field
  3474. - description: 用于数据导出,指定导出的数据字段
  3475. in: query
  3476. name: export_keys
  3477. type: string
  3478. x-go-name: ExportKeys
  3479. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  3480. in: query
  3481. name: show_fail_reason
  3482. type: boolean
  3483. x-go-name: ShowFailReason
  3484. - description: 是否返回状态统计信息,默认为False
  3485. in: query
  3486. name: summary_stats
  3487. type: boolean
  3488. x-go-name: SummaryStats
  3489. responses:
  3490. "200":
  3491. $ref: '#/responses/notification_group_ListItemFilterOutput'
  3492. summary: 列表
  3493. tags:
  3494. - notification_group
  3495. post:
  3496. description: 新建
  3497. operationId: notification_group_ValidateCreateData
  3498. parameters:
  3499. - in: body
  3500. name: body
  3501. schema:
  3502. properties:
  3503. count:
  3504. default: 1
  3505. format: int64
  3506. type: integer
  3507. x-go-name: Count
  3508. notification_group:
  3509. $ref: '#/definitions/ModelBaseCreateInput'
  3510. type: object
  3511. x-go-name: Body
  3512. responses:
  3513. "200":
  3514. $ref: '#/responses/notification_group_ValidateCreateDataOutput'
  3515. summary: 新建
  3516. tags:
  3517. - notification_group
  3518. /notification_groups/{id}:
  3519. delete:
  3520. description: 删除
  3521. operationId: notification_group_CustomizeDelete
  3522. parameters:
  3523. - description: The Id or Name of notification_group
  3524. in: path
  3525. name: id
  3526. required: true
  3527. type: string
  3528. x-go-name: Id
  3529. responses:
  3530. "200":
  3531. $ref: '#/responses/notification_group_CustomizeDeleteOutput'
  3532. summary: 删除
  3533. tags:
  3534. - notification_group
  3535. get:
  3536. description: 获取详情
  3537. operationId: notification_group_FetchCustomizeColumns
  3538. parameters:
  3539. - description: The Id or Name of notification_group
  3540. in: path
  3541. name: id
  3542. required: true
  3543. type: string
  3544. x-go-name: Id
  3545. responses:
  3546. "200":
  3547. $ref: '#/responses/notification_group_FetchCustomizeColumnsOutput'
  3548. summary: 获取详情
  3549. tags:
  3550. - notification_group
  3551. put:
  3552. description: 更新
  3553. operationId: notification_group_ValidateUpdateData
  3554. parameters:
  3555. - description: The Id or Name of notification_group
  3556. in: path
  3557. name: id
  3558. required: true
  3559. type: string
  3560. x-go-name: Id
  3561. - in: body
  3562. name: body
  3563. schema:
  3564. properties:
  3565. notification_group:
  3566. $ref: '#/definitions/ModelBaseUpdateInput'
  3567. type: object
  3568. x-go-name: Body
  3569. responses:
  3570. "200":
  3571. $ref: '#/responses/notification_group_ValidateUpdateDataOutput'
  3572. summary: 更新
  3573. tags:
  3574. - notification_group
  3575. /notification_logs:
  3576. get:
  3577. description: 列表
  3578. operationId: notification_log_ListItemFilter
  3579. parameters:
  3580. - default: 20
  3581. description: 查询限制量
  3582. format: int64
  3583. in: query
  3584. name: limit
  3585. type: integer
  3586. x-go-name: Limit
  3587. - default: 0
  3588. description: 查询偏移量
  3589. format: int64
  3590. in: query
  3591. name: offset
  3592. type: integer
  3593. x-go-name: Offset
  3594. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  3595. in: query
  3596. items:
  3597. type: string
  3598. name: order_by
  3599. type: array
  3600. x-go-name: OrderBy
  3601. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  3602. example: desc|asc
  3603. in: query
  3604. name: order
  3605. type: string
  3606. x-go-name: Order
  3607. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  3608. in: query
  3609. name: details
  3610. type: boolean
  3611. x-go-name: Details
  3612. - description: 模糊搜索所有字段
  3613. in: query
  3614. name: search
  3615. type: string
  3616. x-go-name: Search
  3617. - description: |-
  3618. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  3619. 支持的操作符如下:
  3620. 操作符 | 参数个数 | 举例 | 说明 |
  3621. ---------------|----------|------------------------------------------------|-----------------------------|
  3622. in | > 0 | name.in("test", "good") | 在给定数组中 |
  3623. notin | > 0 | name.notin('test') | 不在给定数组中 |
  3624. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  3625. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  3626. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  3627. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  3628. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  3629. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  3630. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  3631. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  3632. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  3633. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  3634. notequals | 1 | name.notequals('test') | 不等于给定值 |
  3635. isnull | 0 | name.isnull() | 值为SQL的NULL |
  3636. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  3637. isempty | 0 | name.isempty('test') | 值为空字符串 |
  3638. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  3639. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  3640. in: query
  3641. items:
  3642. type: string
  3643. name: filter
  3644. type: array
  3645. x-go-name: Filter
  3646. - description: |-
  3647. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  3648. 和其他表关联的语法如下:
  3649. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  3650. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  3651. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  3652. 举例:
  3653. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  3654. in: query
  3655. items:
  3656. type: string
  3657. name: joint_filter
  3658. type: array
  3659. x-go-name: JointFilter
  3660. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  3661. in: query
  3662. name: filter_any
  3663. type: boolean
  3664. x-go-name: FilterAny
  3665. - description: 返回结果只包含指定的字段
  3666. in: query
  3667. items:
  3668. type: string
  3669. name: field
  3670. type: array
  3671. x-go-name: Field
  3672. - description: 用于数据导出,指定导出的数据字段
  3673. in: query
  3674. name: export_keys
  3675. type: string
  3676. x-go-name: ExportKeys
  3677. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  3678. in: query
  3679. name: show_fail_reason
  3680. type: boolean
  3681. x-go-name: ShowFailReason
  3682. - description: 是否返回状态统计信息,默认为False
  3683. in: query
  3684. name: summary_stats
  3685. type: boolean
  3686. x-go-name: SummaryStats
  3687. - in: query
  3688. items:
  3689. type: string
  3690. name: id
  3691. type: array
  3692. x-go-name: Id
  3693. responses:
  3694. "200":
  3695. $ref: '#/responses/notification_log_ListItemFilterOutput'
  3696. summary: 操作日志列表
  3697. tags:
  3698. - notification_log
  3699. post:
  3700. description: 新建
  3701. operationId: notification_log_ValidateCreateData
  3702. parameters:
  3703. - in: body
  3704. name: body
  3705. schema:
  3706. properties:
  3707. count:
  3708. default: 1
  3709. format: int64
  3710. type: integer
  3711. x-go-name: Count
  3712. notification_log:
  3713. $ref: '#/definitions/ModelBaseCreateInput'
  3714. type: object
  3715. x-go-name: Body
  3716. responses:
  3717. "200":
  3718. $ref: '#/responses/notification_log_ValidateCreateDataOutput'
  3719. summary: 新建
  3720. tags:
  3721. - notification_log
  3722. /notification_logs/{id}:
  3723. delete:
  3724. description: 删除
  3725. operationId: notification_log_CustomizeDelete
  3726. parameters:
  3727. - description: The Id or Name of notification_log
  3728. in: path
  3729. name: id
  3730. required: true
  3731. type: string
  3732. x-go-name: Id
  3733. responses:
  3734. "200":
  3735. $ref: '#/responses/notification_log_CustomizeDeleteOutput'
  3736. summary: 删除
  3737. tags:
  3738. - notification_log
  3739. get:
  3740. description: 获取详情
  3741. operationId: notification_log_FetchCustomizeColumns
  3742. parameters:
  3743. - description: The Id or Name of notification_log
  3744. in: path
  3745. name: id
  3746. required: true
  3747. type: string
  3748. x-go-name: Id
  3749. responses:
  3750. "200":
  3751. $ref: '#/responses/notification_log_FetchCustomizeColumnsOutput'
  3752. summary: 获取详情
  3753. tags:
  3754. - notification_log
  3755. put:
  3756. description: 更新
  3757. operationId: notification_log_ValidateUpdateData
  3758. parameters:
  3759. - description: The Id or Name of notification_log
  3760. in: path
  3761. name: id
  3762. required: true
  3763. type: string
  3764. x-go-name: Id
  3765. responses:
  3766. "200":
  3767. $ref: '#/responses/notification_log_ValidateUpdateDataOutput'
  3768. summary: 更新
  3769. tags:
  3770. - notification_log
  3771. /notifications:
  3772. get:
  3773. description: 列表
  3774. operationId: notification_ListItemFilter
  3775. parameters:
  3776. - default: 20
  3777. description: 查询限制量
  3778. format: int64
  3779. in: query
  3780. name: limit
  3781. type: integer
  3782. x-go-name: Limit
  3783. - default: 0
  3784. description: 查询偏移量
  3785. format: int64
  3786. in: query
  3787. name: offset
  3788. type: integer
  3789. x-go-name: Offset
  3790. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  3791. in: query
  3792. items:
  3793. type: string
  3794. name: order_by
  3795. type: array
  3796. x-go-name: OrderBy
  3797. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  3798. example: desc|asc
  3799. in: query
  3800. name: order
  3801. type: string
  3802. x-go-name: Order
  3803. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  3804. in: query
  3805. name: details
  3806. type: boolean
  3807. x-go-name: Details
  3808. - description: 模糊搜索所有字段
  3809. in: query
  3810. name: search
  3811. type: string
  3812. x-go-name: Search
  3813. - description: |-
  3814. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  3815. 支持的操作符如下:
  3816. 操作符 | 参数个数 | 举例 | 说明 |
  3817. ---------------|----------|------------------------------------------------|-----------------------------|
  3818. in | > 0 | name.in("test", "good") | 在给定数组中 |
  3819. notin | > 0 | name.notin('test') | 不在给定数组中 |
  3820. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  3821. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  3822. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  3823. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  3824. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  3825. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  3826. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  3827. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  3828. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  3829. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  3830. notequals | 1 | name.notequals('test') | 不等于给定值 |
  3831. isnull | 0 | name.isnull() | 值为SQL的NULL |
  3832. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  3833. isempty | 0 | name.isempty('test') | 值为空字符串 |
  3834. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  3835. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  3836. in: query
  3837. items:
  3838. type: string
  3839. name: filter
  3840. type: array
  3841. x-go-name: Filter
  3842. - description: |-
  3843. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  3844. 和其他表关联的语法如下:
  3845. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  3846. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  3847. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  3848. 举例:
  3849. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  3850. in: query
  3851. items:
  3852. type: string
  3853. name: joint_filter
  3854. type: array
  3855. x-go-name: JointFilter
  3856. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  3857. in: query
  3858. name: filter_any
  3859. type: boolean
  3860. x-go-name: FilterAny
  3861. - description: 返回结果只包含指定的字段
  3862. in: query
  3863. items:
  3864. type: string
  3865. name: field
  3866. type: array
  3867. x-go-name: Field
  3868. - description: 用于数据导出,指定导出的数据字段
  3869. in: query
  3870. name: export_keys
  3871. type: string
  3872. x-go-name: ExportKeys
  3873. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  3874. in: query
  3875. name: show_fail_reason
  3876. type: boolean
  3877. x-go-name: ShowFailReason
  3878. - description: 是否返回状态统计信息,默认为False
  3879. in: query
  3880. name: summary_stats
  3881. type: boolean
  3882. x-go-name: SummaryStats
  3883. - $ref: '#/definitions/TTagSet'
  3884. description: 通过标签过滤(包含这些标签)
  3885. in: query
  3886. name: tags
  3887. x-go-name: Tags
  3888. - $ref: '#/definitions/TTagSetList'
  3889. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  3890. in: query
  3891. name: obj_tags
  3892. x-go-name: ObjTags
  3893. - $ref: '#/definitions/TTagSet'
  3894. description: 通过标签过滤(不包含这些标签)
  3895. in: query
  3896. name: no_tags
  3897. x-go-name: NoTags
  3898. - $ref: '#/definitions/TTagSetList'
  3899. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  3900. in: query
  3901. name: no_obj_tags
  3902. x-go-name: NoObjTags
  3903. - description: 通过标签排序
  3904. in: query
  3905. name: order_by_tag
  3906. type: string
  3907. x-go-name: OrderByTag
  3908. - description: |-
  3909. deprecated
  3910. 返回资源的标签不包含用户标签
  3911. in: query
  3912. name: without_user_meta
  3913. type: boolean
  3914. x-go-name: WithoutUserMeta
  3915. - description: 返回包含用户标签的资源
  3916. in: query
  3917. name: with_user_meta
  3918. type: boolean
  3919. x-go-name: WithUserMeta
  3920. - description: 返回包含外部标签的资源
  3921. in: query
  3922. name: with_cloud_meta
  3923. type: boolean
  3924. x-go-name: WithCloudMeta
  3925. - description: 返回包含任意标签的资源
  3926. in: query
  3927. name: with_any_meta
  3928. type: boolean
  3929. x-go-name: WithAnyMeta
  3930. - description: 返回列表数据中包含资源的标签数据(Metadata)
  3931. in: query
  3932. name: with_meta
  3933. type: boolean
  3934. x-go-name: WithMeta
  3935. - description: 显示所有的资源,包括模拟的资源
  3936. in: query
  3937. name: show_emulated
  3938. type: boolean
  3939. x-go-name: ShowEmulated
  3940. - description: 以资源ID过滤列表
  3941. in: query
  3942. items:
  3943. type: string
  3944. name: id
  3945. type: array
  3946. x-go-name: Ids
  3947. - description: 以资源名称过滤列表
  3948. in: query
  3949. items:
  3950. type: string
  3951. name: name
  3952. type: array
  3953. x-go-name: Names
  3954. - description: 以资源的状态过滤列表
  3955. in: query
  3956. items:
  3957. type: string
  3958. name: status
  3959. type: array
  3960. x-go-name: Status
  3961. - in: query
  3962. name: contact_type
  3963. type: string
  3964. x-go-name: ContactType
  3965. - in: query
  3966. name: receiver_id
  3967. type: string
  3968. x-go-name: ReceiverId
  3969. - in: query
  3970. name: tag
  3971. type: string
  3972. x-go-name: Tag
  3973. - in: query
  3974. name: topic_type
  3975. type: string
  3976. x-go-name: TopicType
  3977. responses:
  3978. "200":
  3979. $ref: '#/responses/notification_ListItemFilterOutput'
  3980. summary: 通知消息列表
  3981. tags:
  3982. - notification
  3983. post:
  3984. description: 新建
  3985. operationId: notification_ValidateCreateData
  3986. parameters:
  3987. - in: body
  3988. name: body
  3989. schema:
  3990. properties:
  3991. count:
  3992. default: 1
  3993. format: int64
  3994. type: integer
  3995. x-go-name: Count
  3996. notification:
  3997. $ref: '#/definitions/NotificationCreateInput'
  3998. type: object
  3999. x-go-name: Body
  4000. responses:
  4001. "200":
  4002. $ref: '#/responses/notification_ValidateCreateDataOutput'
  4003. summary: 新建
  4004. tags:
  4005. - notification
  4006. /notifications/{id}:
  4007. delete:
  4008. description: 删除
  4009. operationId: notification_CustomizeDelete
  4010. parameters:
  4011. - description: The Id or Name of notification
  4012. in: path
  4013. name: id
  4014. required: true
  4015. type: string
  4016. x-go-name: Id
  4017. responses:
  4018. "200":
  4019. $ref: '#/responses/notification_CustomizeDeleteOutput'
  4020. summary: 删除
  4021. tags:
  4022. - notification
  4023. get:
  4024. description: 获取详情
  4025. operationId: notification_FetchCustomizeColumns
  4026. parameters:
  4027. - description: The Id or Name of notification
  4028. in: path
  4029. name: id
  4030. required: true
  4031. type: string
  4032. x-go-name: Id
  4033. responses:
  4034. "200":
  4035. $ref: '#/responses/notification_FetchCustomizeColumnsOutput'
  4036. summary: 获取详情
  4037. tags:
  4038. - notification
  4039. put:
  4040. description: 更新
  4041. operationId: notification_ValidateUpdateData
  4042. parameters:
  4043. - description: The Id or Name of notification
  4044. in: path
  4045. name: id
  4046. required: true
  4047. type: string
  4048. x-go-name: Id
  4049. - in: body
  4050. name: body
  4051. schema:
  4052. properties:
  4053. notification:
  4054. $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput'
  4055. type: object
  4056. x-go-name: Body
  4057. responses:
  4058. "200":
  4059. $ref: '#/responses/notification_ValidateUpdateDataOutput'
  4060. summary: 更新
  4061. tags:
  4062. - notification
  4063. /notifications/{id}/metadata:
  4064. get:
  4065. description: 获取指定信息Metadata
  4066. operationId: notification_GetDetailsMetadata
  4067. parameters:
  4068. - description: |-
  4069. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  4070. 标签分为
  4071. 类型 | 说明 |
  4072. ----------|---------------------------------------------|
  4073. 系统标签 | 平台定义的标签 |
  4074. 用户标签 | key以user:为前缀,用户自定义标签 |
  4075. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  4076. in: query
  4077. items:
  4078. type: string
  4079. name: field
  4080. type: array
  4081. x-go-name: Field
  4082. - description: 按标签前缀过滤
  4083. in: query
  4084. name: prefix
  4085. type: string
  4086. x-go-name: Prefix
  4087. - description: The Id or Name of notification
  4088. in: path
  4089. name: id
  4090. required: true
  4091. type: string
  4092. x-go-name: Id
  4093. responses:
  4094. "200":
  4095. $ref: '#/responses/notification_GetDetailsMetadataOutput'
  4096. summary: 获取资源标签(元数据)
  4097. tags:
  4098. - notification
  4099. /notifications/{id}/status:
  4100. get:
  4101. description: 获取指定信息Status
  4102. operationId: notification_GetDetailsStatus
  4103. parameters:
  4104. - description: The Id or Name of notification
  4105. in: path
  4106. name: id
  4107. required: true
  4108. type: string
  4109. x-go-name: Id
  4110. responses:
  4111. "200":
  4112. $ref: '#/responses/notification_GetDetailsStatusOutput'
  4113. summary: 获取资源状态
  4114. tags:
  4115. - notification
  4116. /notifications/contact-notify:
  4117. post:
  4118. description: 执行操作ContactNotify
  4119. operationId: notification_PerformContactNotify
  4120. parameters:
  4121. - in: body
  4122. name: body
  4123. schema:
  4124. properties:
  4125. notification:
  4126. $ref: '#/definitions/NotificationManagerContactNotifyInput'
  4127. type: object
  4128. x-go-name: Body
  4129. responses:
  4130. "200":
  4131. $ref: '#/responses/notification_PerformContactNotifyOutput'
  4132. summary: 执行操作ContactNotify
  4133. tags:
  4134. - notification
  4135. /notifications/event-notify:
  4136. post:
  4137. description: 执行操作EventNotify
  4138. operationId: notification_PerformEventNotify
  4139. parameters:
  4140. - in: body
  4141. name: body
  4142. schema:
  4143. properties:
  4144. notification:
  4145. $ref: '#/definitions/NotificationManagerEventNotifyInput'
  4146. type: object
  4147. x-go-name: Body
  4148. responses:
  4149. "200":
  4150. $ref: '#/responses/notification_PerformEventNotifyOutput'
  4151. summary: 'TODO: support project and domain'
  4152. tags:
  4153. - notification
  4154. /receivers:
  4155. get:
  4156. description: 列表
  4157. operationId: receiver_ListItemFilter
  4158. parameters:
  4159. - default: 20
  4160. description: 查询限制量
  4161. format: int64
  4162. in: query
  4163. name: limit
  4164. type: integer
  4165. x-go-name: Limit
  4166. - default: 0
  4167. description: 查询偏移量
  4168. format: int64
  4169. in: query
  4170. name: offset
  4171. type: integer
  4172. x-go-name: Offset
  4173. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  4174. in: query
  4175. items:
  4176. type: string
  4177. name: order_by
  4178. type: array
  4179. x-go-name: OrderBy
  4180. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  4181. example: desc|asc
  4182. in: query
  4183. name: order
  4184. type: string
  4185. x-go-name: Order
  4186. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  4187. in: query
  4188. name: details
  4189. type: boolean
  4190. x-go-name: Details
  4191. - description: 模糊搜索所有字段
  4192. in: query
  4193. name: search
  4194. type: string
  4195. x-go-name: Search
  4196. - description: |-
  4197. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4198. 支持的操作符如下:
  4199. 操作符 | 参数个数 | 举例 | 说明 |
  4200. ---------------|----------|------------------------------------------------|-----------------------------|
  4201. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4202. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4203. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4204. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4205. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4206. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4207. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4208. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4209. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4210. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4211. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4212. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4213. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4214. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4215. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4216. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4217. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4218. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4219. in: query
  4220. items:
  4221. type: string
  4222. name: filter
  4223. type: array
  4224. x-go-name: Filter
  4225. - description: |-
  4226. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4227. 和其他表关联的语法如下:
  4228. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4229. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4230. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4231. 举例:
  4232. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4233. in: query
  4234. items:
  4235. type: string
  4236. name: joint_filter
  4237. type: array
  4238. x-go-name: JointFilter
  4239. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4240. in: query
  4241. name: filter_any
  4242. type: boolean
  4243. x-go-name: FilterAny
  4244. - description: 返回结果只包含指定的字段
  4245. in: query
  4246. items:
  4247. type: string
  4248. name: field
  4249. type: array
  4250. x-go-name: Field
  4251. - description: 用于数据导出,指定导出的数据字段
  4252. in: query
  4253. name: export_keys
  4254. type: string
  4255. x-go-name: ExportKeys
  4256. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4257. in: query
  4258. name: show_fail_reason
  4259. type: boolean
  4260. x-go-name: ShowFailReason
  4261. - description: 是否返回状态统计信息,默认为False
  4262. in: query
  4263. name: summary_stats
  4264. type: boolean
  4265. x-go-name: SummaryStats
  4266. - $ref: '#/definitions/TTagSet'
  4267. description: 通过标签过滤(包含这些标签)
  4268. in: query
  4269. name: tags
  4270. x-go-name: Tags
  4271. - $ref: '#/definitions/TTagSetList'
  4272. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4273. in: query
  4274. name: obj_tags
  4275. x-go-name: ObjTags
  4276. - $ref: '#/definitions/TTagSet'
  4277. description: 通过标签过滤(不包含这些标签)
  4278. in: query
  4279. name: no_tags
  4280. x-go-name: NoTags
  4281. - $ref: '#/definitions/TTagSetList'
  4282. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4283. in: query
  4284. name: no_obj_tags
  4285. x-go-name: NoObjTags
  4286. - description: 通过标签排序
  4287. in: query
  4288. name: order_by_tag
  4289. type: string
  4290. x-go-name: OrderByTag
  4291. - description: |-
  4292. deprecated
  4293. 返回资源的标签不包含用户标签
  4294. in: query
  4295. name: without_user_meta
  4296. type: boolean
  4297. x-go-name: WithoutUserMeta
  4298. - description: 返回包含用户标签的资源
  4299. in: query
  4300. name: with_user_meta
  4301. type: boolean
  4302. x-go-name: WithUserMeta
  4303. - description: 返回包含外部标签的资源
  4304. in: query
  4305. name: with_cloud_meta
  4306. type: boolean
  4307. x-go-name: WithCloudMeta
  4308. - description: 返回包含任意标签的资源
  4309. in: query
  4310. name: with_any_meta
  4311. type: boolean
  4312. x-go-name: WithAnyMeta
  4313. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4314. in: query
  4315. name: with_meta
  4316. type: boolean
  4317. x-go-name: WithMeta
  4318. - description: 显示所有的资源,包括模拟的资源
  4319. in: query
  4320. name: show_emulated
  4321. type: boolean
  4322. x-go-name: ShowEmulated
  4323. - description: 以资源ID过滤列表
  4324. in: query
  4325. items:
  4326. type: string
  4327. name: id
  4328. type: array
  4329. x-go-name: Ids
  4330. - description: 以资源名称过滤列表
  4331. in: query
  4332. items:
  4333. type: string
  4334. name: name
  4335. type: array
  4336. x-go-name: Names
  4337. - description: 以资源的状态过滤列表
  4338. in: query
  4339. items:
  4340. type: string
  4341. name: status
  4342. type: array
  4343. x-go-name: Status
  4344. - description: 指定查询的权限范围,可能值为project, domain or system
  4345. in: query
  4346. name: scope
  4347. type: string
  4348. x-go-name: Scope
  4349. - description: 指定项目归属域名称或ID
  4350. in: query
  4351. name: project_domain_id
  4352. type: string
  4353. x-go-name: ProjectDomainId
  4354. - description: 对具有域属性的资源,严格匹配域ID
  4355. in: query
  4356. items:
  4357. type: string
  4358. name: project_domain_ids
  4359. type: array
  4360. x-go-name: ProjectDomainIds
  4361. - description: 按domain名称排序,可能值为asc|desc
  4362. in: query
  4363. name: order_by_domain
  4364. pattern: asc|desc
  4365. type: string
  4366. x-go-name: OrderByDomain
  4367. - $ref: '#/definitions/TTagSetList'
  4368. description: filter by domain tags
  4369. in: query
  4370. name: domain_tags
  4371. x-go-name: DomainTags
  4372. - $ref: '#/definitions/TTagSetList'
  4373. description: filter by domain tags
  4374. in: query
  4375. name: no_domain_tags
  4376. x-go-name: NoDomainTags
  4377. - description: 指定项目的名称或ID
  4378. in: query
  4379. name: project_id
  4380. type: string
  4381. x-go-name: ProjectId
  4382. - description: 对具有项目属性的资源,严格匹配项目ID
  4383. in: query
  4384. items:
  4385. type: string
  4386. name: project_ids
  4387. type: array
  4388. x-go-name: ProjectIds
  4389. - description: 按project名称排序,可能值为asc|desc
  4390. in: query
  4391. name: order_by_project
  4392. pattern: asc|desc
  4393. type: string
  4394. x-go-name: OrderByProject
  4395. - $ref: '#/definitions/TTagSetList'
  4396. description: filter by project tags
  4397. in: query
  4398. name: project_tags
  4399. x-go-name: ProjectTags
  4400. - $ref: '#/definitions/TTagSetList'
  4401. description: filter by no project tags
  4402. in: query
  4403. name: no_project_tags
  4404. x-go-name: NoProjectTags
  4405. - description: filter by project organizations
  4406. in: query
  4407. items:
  4408. type: string
  4409. name: project_organizations
  4410. type: array
  4411. x-go-name: ProjectOrganizations
  4412. - $ref: '#/definitions/TTagSetList'
  4413. description: |-
  4414. ignore
  4415. project tag fitlers imposed by policy
  4416. in: query
  4417. name: policy_project_tags
  4418. x-go-name: PolicyProjectTags
  4419. - description: 列表中包含标记为"系统资源"的资源
  4420. in: query
  4421. name: system
  4422. type: boolean
  4423. x-go-name: System
  4424. - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
  4425. in: query
  4426. name: pending_delete
  4427. type: boolean
  4428. x-go-name: PendingDelete
  4429. - description: 以资源是否启用/禁用过滤列表
  4430. in: query
  4431. name: enabled
  4432. type: boolean
  4433. x-go-name: Enabled
  4434. - in: query
  4435. name: uid
  4436. type: string
  4437. x-go-name: UID
  4438. - in: query
  4439. name: uname
  4440. type: string
  4441. x-go-name: UName
  4442. - in: query
  4443. name: enabled_contact_type
  4444. type: string
  4445. x-go-name: EnabledContactType
  4446. - in: query
  4447. name: verified_contact_type
  4448. type: string
  4449. x-go-name: VerifiedContactType
  4450. - in: query
  4451. name: project_domain_filter
  4452. type: boolean
  4453. x-go-name: ProjectDomainFilter
  4454. responses:
  4455. "200":
  4456. $ref: '#/responses/receiver_ListItemFilterOutput'
  4457. summary: 列表
  4458. tags:
  4459. - receiver
  4460. post:
  4461. description: 新建
  4462. operationId: receiver_ValidateCreateData
  4463. parameters:
  4464. - in: body
  4465. name: body
  4466. schema:
  4467. properties:
  4468. count:
  4469. default: 1
  4470. format: int64
  4471. type: integer
  4472. x-go-name: Count
  4473. receiver:
  4474. $ref: '#/definitions/ReceiverCreateInput'
  4475. type: object
  4476. x-go-name: Body
  4477. responses:
  4478. "200":
  4479. $ref: '#/responses/receiver_ValidateCreateDataOutput'
  4480. summary: 新建
  4481. tags:
  4482. - receiver
  4483. /receivers/{id}:
  4484. delete:
  4485. description: 删除
  4486. operationId: receiver_CustomizeDelete
  4487. parameters:
  4488. - description: The Id or Name of receiver
  4489. in: path
  4490. name: id
  4491. required: true
  4492. type: string
  4493. x-go-name: Id
  4494. responses:
  4495. "200":
  4496. $ref: '#/responses/receiver_CustomizeDeleteOutput'
  4497. summary: 删除
  4498. tags:
  4499. - receiver
  4500. get:
  4501. description: 获取详情
  4502. operationId: receiver_FetchCustomizeColumns
  4503. parameters:
  4504. - description: The Id or Name of receiver
  4505. in: path
  4506. name: id
  4507. required: true
  4508. type: string
  4509. x-go-name: Id
  4510. responses:
  4511. "200":
  4512. $ref: '#/responses/receiver_FetchCustomizeColumnsOutput'
  4513. summary: 获取详情
  4514. tags:
  4515. - receiver
  4516. put:
  4517. description: 更新
  4518. operationId: receiver_ValidateUpdateData
  4519. parameters:
  4520. - description: The Id or Name of receiver
  4521. in: path
  4522. name: id
  4523. required: true
  4524. type: string
  4525. x-go-name: Id
  4526. - in: body
  4527. name: body
  4528. schema:
  4529. properties:
  4530. receiver:
  4531. $ref: '#/definitions/ReceiverUpdateInput'
  4532. type: object
  4533. x-go-name: Body
  4534. responses:
  4535. "200":
  4536. $ref: '#/responses/receiver_ValidateUpdateDataOutput'
  4537. summary: 更新
  4538. tags:
  4539. - receiver
  4540. /receivers/{id}/change-owner:
  4541. post:
  4542. description: 执行操作ChangeOwner
  4543. operationId: receiver_PerformChangeOwner
  4544. parameters:
  4545. - description: The Id or Name of receiver
  4546. in: path
  4547. name: id
  4548. required: true
  4549. type: string
  4550. x-go-name: Id
  4551. - in: body
  4552. name: body
  4553. schema:
  4554. properties:
  4555. receiver:
  4556. $ref: '#/definitions/PerformChangeProjectOwnerInput'
  4557. type: object
  4558. x-go-name: Body
  4559. responses:
  4560. "200":
  4561. $ref: '#/responses/receiver_PerformChangeOwnerOutput'
  4562. summary: 更改项目
  4563. tags:
  4564. - receiver
  4565. /receivers/{id}/disable:
  4566. post:
  4567. description: 执行操作Disable
  4568. operationId: receiver_PerformDisable
  4569. parameters:
  4570. - description: The Id or Name of receiver
  4571. in: path
  4572. name: id
  4573. required: true
  4574. type: string
  4575. x-go-name: Id
  4576. - in: body
  4577. name: body
  4578. schema:
  4579. properties:
  4580. receiver:
  4581. $ref: '#/definitions/PerformDisableInput'
  4582. type: object
  4583. x-go-name: Body
  4584. responses:
  4585. "200":
  4586. $ref: '#/responses/receiver_PerformDisableOutput'
  4587. summary: 执行操作Disable
  4588. tags:
  4589. - receiver
  4590. /receivers/{id}/enable:
  4591. post:
  4592. description: 执行操作Enable
  4593. operationId: receiver_PerformEnable
  4594. parameters:
  4595. - description: The Id or Name of receiver
  4596. in: path
  4597. name: id
  4598. required: true
  4599. type: string
  4600. x-go-name: Id
  4601. - in: body
  4602. name: body
  4603. schema:
  4604. properties:
  4605. receiver:
  4606. $ref: '#/definitions/PerformEnableInput'
  4607. type: object
  4608. x-go-name: Body
  4609. responses:
  4610. "200":
  4611. $ref: '#/responses/receiver_PerformEnableOutput'
  4612. summary: 执行操作Enable
  4613. tags:
  4614. - receiver
  4615. /receivers/{id}/enable-contact-type:
  4616. post:
  4617. description: 执行操作EnableContactType
  4618. operationId: receiver_PerformEnableContactType
  4619. parameters:
  4620. - description: The Id or Name of receiver
  4621. in: path
  4622. name: id
  4623. required: true
  4624. type: string
  4625. x-go-name: Id
  4626. - in: body
  4627. name: body
  4628. schema:
  4629. properties:
  4630. receiver:
  4631. $ref: '#/definitions/ReceiverEnableContactTypeInput'
  4632. type: object
  4633. x-go-name: Body
  4634. responses:
  4635. "200":
  4636. $ref: '#/responses/receiver_PerformEnableContactTypeOutput'
  4637. summary: 执行操作EnableContactType
  4638. tags:
  4639. - receiver
  4640. /receivers/{id}/get-subscription:
  4641. post:
  4642. description: 执行操作GetSubscription
  4643. operationId: receiver_PerformGetSubscription
  4644. parameters:
  4645. - description: The Id or Name of receiver
  4646. in: path
  4647. name: id
  4648. required: true
  4649. type: string
  4650. x-go-name: Id
  4651. - in: body
  4652. name: body
  4653. schema:
  4654. properties:
  4655. receiver:
  4656. $ref: '#/definitions/ReceiverGetSubscriptionOptions'
  4657. type: object
  4658. x-go-name: Body
  4659. responses:
  4660. "200":
  4661. $ref: '#/responses/receiver_PerformGetSubscriptionOutput'
  4662. summary: 获取用户订阅
  4663. tags:
  4664. - receiver
  4665. /receivers/{id}/metadata:
  4666. get:
  4667. description: 获取指定信息Metadata
  4668. operationId: receiver_GetDetailsMetadata
  4669. parameters:
  4670. - description: |-
  4671. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  4672. 标签分为
  4673. 类型 | 说明 |
  4674. ----------|---------------------------------------------|
  4675. 系统标签 | 平台定义的标签 |
  4676. 用户标签 | key以user:为前缀,用户自定义标签 |
  4677. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  4678. in: query
  4679. items:
  4680. type: string
  4681. name: field
  4682. type: array
  4683. x-go-name: Field
  4684. - description: 按标签前缀过滤
  4685. in: query
  4686. name: prefix
  4687. type: string
  4688. x-go-name: Prefix
  4689. - description: The Id or Name of receiver
  4690. in: path
  4691. name: id
  4692. required: true
  4693. type: string
  4694. x-go-name: Id
  4695. responses:
  4696. "200":
  4697. $ref: '#/responses/receiver_GetDetailsMetadataOutput'
  4698. summary: 获取资源标签(元数据)
  4699. tags:
  4700. - receiver
  4701. /receivers/{id}/status:
  4702. get:
  4703. description: 获取指定信息Status
  4704. operationId: receiver_GetDetailsStatus
  4705. parameters:
  4706. - description: The Id or Name of receiver
  4707. in: path
  4708. name: id
  4709. required: true
  4710. type: string
  4711. x-go-name: Id
  4712. responses:
  4713. "200":
  4714. $ref: '#/responses/receiver_GetDetailsStatusOutput'
  4715. summary: 获取资源状态
  4716. tags:
  4717. - receiver
  4718. /receivers/{id}/trigger-verify:
  4719. post:
  4720. description: 执行操作TriggerVerify
  4721. operationId: receiver_PerformTriggerVerify
  4722. parameters:
  4723. - description: The Id or Name of receiver
  4724. in: path
  4725. name: id
  4726. required: true
  4727. type: string
  4728. x-go-name: Id
  4729. - in: body
  4730. name: body
  4731. schema:
  4732. properties:
  4733. receiver:
  4734. $ref: '#/definitions/ReceiverTriggerVerifyInput'
  4735. type: object
  4736. x-go-name: Body
  4737. responses:
  4738. "200":
  4739. $ref: '#/responses/receiver_PerformTriggerVerifyOutput'
  4740. summary: 执行操作TriggerVerify
  4741. tags:
  4742. - receiver
  4743. /receivers/{id}/verify:
  4744. post:
  4745. description: 执行操作Verify
  4746. operationId: receiver_PerformVerify
  4747. parameters:
  4748. - description: The Id or Name of receiver
  4749. in: path
  4750. name: id
  4751. required: true
  4752. type: string
  4753. x-go-name: Id
  4754. - in: body
  4755. name: body
  4756. schema:
  4757. properties:
  4758. receiver:
  4759. $ref: '#/definitions/ReceiverVerifyInput'
  4760. type: object
  4761. x-go-name: Body
  4762. responses:
  4763. "200":
  4764. $ref: '#/responses/receiver_PerformVerifyOutput'
  4765. summary: 执行操作Verify
  4766. tags:
  4767. - receiver
  4768. /receivers/get-types:
  4769. post:
  4770. description: 执行操作GetTypes
  4771. operationId: receiver_PerformGetTypes
  4772. parameters:
  4773. - in: body
  4774. name: body
  4775. schema:
  4776. properties:
  4777. receiver:
  4778. $ref: '#/definitions/ConfigManagerGetTypesInput'
  4779. type: object
  4780. x-go-name: Body
  4781. responses:
  4782. "200":
  4783. $ref: '#/responses/receiver_PerformGetTypesOutput'
  4784. summary: 执行操作GetTypes
  4785. tags:
  4786. - receiver
  4787. /receivers/intellij-get:
  4788. post:
  4789. description: 执行操作IntellijGet
  4790. operationId: receiver_PerformIntellijGet
  4791. parameters:
  4792. - in: body
  4793. name: body
  4794. schema:
  4795. properties:
  4796. receiver:
  4797. $ref: '#/definitions/ReceiverIntellijGetInput'
  4798. type: object
  4799. x-go-name: Body
  4800. responses:
  4801. "200":
  4802. $ref: '#/responses/receiver_PerformIntellijGetOutput'
  4803. summary: 执行操作IntellijGet
  4804. tags:
  4805. - receiver
  4806. /receivers/role-contact-type:
  4807. get:
  4808. description: 获取指定资源类的信息RoleContactType
  4809. operationId: receiver_GetPropertyRoleContactType
  4810. parameters:
  4811. - in: query
  4812. items:
  4813. type: string
  4814. name: role_ids
  4815. type: array
  4816. x-go-name: RoleIds
  4817. - in: query
  4818. name: scope
  4819. type: string
  4820. x-go-name: Scope
  4821. - in: query
  4822. name: project_domain_id
  4823. type: string
  4824. x-go-name: ProjectDomainId
  4825. - in: query
  4826. name: project_id
  4827. type: string
  4828. x-go-name: ProjectId
  4829. responses:
  4830. "200":
  4831. $ref: '#/responses/receiver_GetPropertyRoleContactTypeOutput'
  4832. summary: 获取指定资源类的信息RoleContactType
  4833. tags:
  4834. - receiver
  4835. /robots:
  4836. get:
  4837. description: 列表
  4838. operationId: robot_ListItemFilter
  4839. parameters:
  4840. - default: 20
  4841. description: 查询限制量
  4842. format: int64
  4843. in: query
  4844. name: limit
  4845. type: integer
  4846. x-go-name: Limit
  4847. - default: 0
  4848. description: 查询偏移量
  4849. format: int64
  4850. in: query
  4851. name: offset
  4852. type: integer
  4853. x-go-name: Offset
  4854. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  4855. in: query
  4856. items:
  4857. type: string
  4858. name: order_by
  4859. type: array
  4860. x-go-name: OrderBy
  4861. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  4862. example: desc|asc
  4863. in: query
  4864. name: order
  4865. type: string
  4866. x-go-name: Order
  4867. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  4868. in: query
  4869. name: details
  4870. type: boolean
  4871. x-go-name: Details
  4872. - description: 模糊搜索所有字段
  4873. in: query
  4874. name: search
  4875. type: string
  4876. x-go-name: Search
  4877. - description: |-
  4878. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4879. 支持的操作符如下:
  4880. 操作符 | 参数个数 | 举例 | 说明 |
  4881. ---------------|----------|------------------------------------------------|-----------------------------|
  4882. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4883. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4884. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4885. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4886. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4887. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4888. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4889. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4890. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4891. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4892. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4893. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4894. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4895. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4896. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4897. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4898. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4899. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4900. in: query
  4901. items:
  4902. type: string
  4903. name: filter
  4904. type: array
  4905. x-go-name: Filter
  4906. - description: |-
  4907. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4908. 和其他表关联的语法如下:
  4909. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4910. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4911. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4912. 举例:
  4913. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4914. in: query
  4915. items:
  4916. type: string
  4917. name: joint_filter
  4918. type: array
  4919. x-go-name: JointFilter
  4920. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4921. in: query
  4922. name: filter_any
  4923. type: boolean
  4924. x-go-name: FilterAny
  4925. - description: 返回结果只包含指定的字段
  4926. in: query
  4927. items:
  4928. type: string
  4929. name: field
  4930. type: array
  4931. x-go-name: Field
  4932. - description: 用于数据导出,指定导出的数据字段
  4933. in: query
  4934. name: export_keys
  4935. type: string
  4936. x-go-name: ExportKeys
  4937. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4938. in: query
  4939. name: show_fail_reason
  4940. type: boolean
  4941. x-go-name: ShowFailReason
  4942. - description: 是否返回状态统计信息,默认为False
  4943. in: query
  4944. name: summary_stats
  4945. type: boolean
  4946. x-go-name: SummaryStats
  4947. - $ref: '#/definitions/TTagSet'
  4948. description: 通过标签过滤(包含这些标签)
  4949. in: query
  4950. name: tags
  4951. x-go-name: Tags
  4952. - $ref: '#/definitions/TTagSetList'
  4953. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4954. in: query
  4955. name: obj_tags
  4956. x-go-name: ObjTags
  4957. - $ref: '#/definitions/TTagSet'
  4958. description: 通过标签过滤(不包含这些标签)
  4959. in: query
  4960. name: no_tags
  4961. x-go-name: NoTags
  4962. - $ref: '#/definitions/TTagSetList'
  4963. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4964. in: query
  4965. name: no_obj_tags
  4966. x-go-name: NoObjTags
  4967. - description: 通过标签排序
  4968. in: query
  4969. name: order_by_tag
  4970. type: string
  4971. x-go-name: OrderByTag
  4972. - description: |-
  4973. deprecated
  4974. 返回资源的标签不包含用户标签
  4975. in: query
  4976. name: without_user_meta
  4977. type: boolean
  4978. x-go-name: WithoutUserMeta
  4979. - description: 返回包含用户标签的资源
  4980. in: query
  4981. name: with_user_meta
  4982. type: boolean
  4983. x-go-name: WithUserMeta
  4984. - description: 返回包含外部标签的资源
  4985. in: query
  4986. name: with_cloud_meta
  4987. type: boolean
  4988. x-go-name: WithCloudMeta
  4989. - description: 返回包含任意标签的资源
  4990. in: query
  4991. name: with_any_meta
  4992. type: boolean
  4993. x-go-name: WithAnyMeta
  4994. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4995. in: query
  4996. name: with_meta
  4997. type: boolean
  4998. x-go-name: WithMeta
  4999. - description: 显示所有的资源,包括模拟的资源
  5000. in: query
  5001. name: show_emulated
  5002. type: boolean
  5003. x-go-name: ShowEmulated
  5004. - description: 以资源ID过滤列表
  5005. in: query
  5006. items:
  5007. type: string
  5008. name: id
  5009. type: array
  5010. x-go-name: Ids
  5011. - description: 以资源名称过滤列表
  5012. in: query
  5013. items:
  5014. type: string
  5015. name: name
  5016. type: array
  5017. x-go-name: Names
  5018. - description: 以资源的状态过滤列表
  5019. in: query
  5020. items:
  5021. type: string
  5022. name: status
  5023. type: array
  5024. x-go-name: Status
  5025. - description: 指定查询的权限范围,可能值为project, domain or system
  5026. in: query
  5027. name: scope
  5028. type: string
  5029. x-go-name: Scope
  5030. - description: 指定项目归属域名称或ID
  5031. in: query
  5032. name: project_domain_id
  5033. type: string
  5034. x-go-name: ProjectDomainId
  5035. - description: 对具有域属性的资源,严格匹配域ID
  5036. in: query
  5037. items:
  5038. type: string
  5039. name: project_domain_ids
  5040. type: array
  5041. x-go-name: ProjectDomainIds
  5042. - description: 按domain名称排序,可能值为asc|desc
  5043. in: query
  5044. name: order_by_domain
  5045. pattern: asc|desc
  5046. type: string
  5047. x-go-name: OrderByDomain
  5048. - $ref: '#/definitions/TTagSetList'
  5049. description: filter by domain tags
  5050. in: query
  5051. name: domain_tags
  5052. x-go-name: DomainTags
  5053. - $ref: '#/definitions/TTagSetList'
  5054. description: filter by domain tags
  5055. in: query
  5056. name: no_domain_tags
  5057. x-go-name: NoDomainTags
  5058. - description: 指定项目的名称或ID
  5059. in: query
  5060. name: project_id
  5061. type: string
  5062. x-go-name: ProjectId
  5063. - description: 对具有项目属性的资源,严格匹配项目ID
  5064. in: query
  5065. items:
  5066. type: string
  5067. name: project_ids
  5068. type: array
  5069. x-go-name: ProjectIds
  5070. - description: 按project名称排序,可能值为asc|desc
  5071. in: query
  5072. name: order_by_project
  5073. pattern: asc|desc
  5074. type: string
  5075. x-go-name: OrderByProject
  5076. - $ref: '#/definitions/TTagSetList'
  5077. description: filter by project tags
  5078. in: query
  5079. name: project_tags
  5080. x-go-name: ProjectTags
  5081. - $ref: '#/definitions/TTagSetList'
  5082. description: filter by no project tags
  5083. in: query
  5084. name: no_project_tags
  5085. x-go-name: NoProjectTags
  5086. - description: filter by project organizations
  5087. in: query
  5088. items:
  5089. type: string
  5090. name: project_organizations
  5091. type: array
  5092. x-go-name: ProjectOrganizations
  5093. - $ref: '#/definitions/TTagSetList'
  5094. description: |-
  5095. ignore
  5096. project tag fitlers imposed by policy
  5097. in: query
  5098. name: policy_project_tags
  5099. x-go-name: PolicyProjectTags
  5100. - description: 列表中包含标记为"系统资源"的资源
  5101. in: query
  5102. name: system
  5103. type: boolean
  5104. x-go-name: System
  5105. - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
  5106. in: query
  5107. name: pending_delete
  5108. type: boolean
  5109. x-go-name: PendingDelete
  5110. - description: 以资源是否共享过滤列表
  5111. in: query
  5112. name: is_public
  5113. type: boolean
  5114. x-go-name: IsPublic
  5115. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  5116. in: query
  5117. name: public_scope
  5118. type: string
  5119. x-go-name: PublicScope
  5120. - description: 以资源是否启用/禁用过滤列表
  5121. in: query
  5122. name: enabled
  5123. type: boolean
  5124. x-go-name: Enabled
  5125. - description: 'description: robot type'
  5126. enum:
  5127. - feishu
  5128. - dingtalk
  5129. - workwx
  5130. - webhook
  5131. example: webhook
  5132. in: query
  5133. name: type
  5134. type: string
  5135. x-go-name: Type
  5136. - description: 'description: Language preference'
  5137. example: en
  5138. in: query
  5139. name: lang
  5140. type: string
  5141. x-go-name: Lang
  5142. responses:
  5143. "200":
  5144. $ref: '#/responses/robot_ListItemFilterOutput'
  5145. summary: 列表
  5146. tags:
  5147. - robot
  5148. post:
  5149. description: 新建
  5150. operationId: robot_ValidateCreateData
  5151. parameters:
  5152. - in: body
  5153. name: body
  5154. schema:
  5155. properties:
  5156. count:
  5157. default: 1
  5158. format: int64
  5159. type: integer
  5160. x-go-name: Count
  5161. robot:
  5162. $ref: '#/definitions/RobotCreateInput'
  5163. type: object
  5164. x-go-name: Body
  5165. responses:
  5166. "200":
  5167. $ref: '#/responses/robot_ValidateCreateDataOutput'
  5168. summary: 新建
  5169. tags:
  5170. - robot
  5171. /robots/{id}:
  5172. delete:
  5173. description: 删除
  5174. operationId: robot_CustomizeDelete
  5175. parameters:
  5176. - description: The Id or Name of robot
  5177. in: path
  5178. name: id
  5179. required: true
  5180. type: string
  5181. x-go-name: Id
  5182. responses:
  5183. "200":
  5184. $ref: '#/responses/robot_CustomizeDeleteOutput'
  5185. summary: 删除
  5186. tags:
  5187. - robot
  5188. get:
  5189. description: 获取详情
  5190. operationId: robot_FetchCustomizeColumns
  5191. parameters:
  5192. - description: The Id or Name of robot
  5193. in: path
  5194. name: id
  5195. required: true
  5196. type: string
  5197. x-go-name: Id
  5198. responses:
  5199. "200":
  5200. $ref: '#/responses/robot_FetchCustomizeColumnsOutput'
  5201. summary: 获取详情
  5202. tags:
  5203. - robot
  5204. put:
  5205. description: 更新
  5206. operationId: robot_ValidateUpdateData
  5207. parameters:
  5208. - description: The Id or Name of robot
  5209. in: path
  5210. name: id
  5211. required: true
  5212. type: string
  5213. x-go-name: Id
  5214. - in: body
  5215. name: body
  5216. schema:
  5217. properties:
  5218. robot:
  5219. $ref: '#/definitions/RobotUpdateInput'
  5220. type: object
  5221. x-go-name: Body
  5222. responses:
  5223. "200":
  5224. $ref: '#/responses/robot_ValidateUpdateDataOutput'
  5225. summary: 更新
  5226. tags:
  5227. - robot
  5228. /robots/{id}/change-owner:
  5229. post:
  5230. description: 执行操作ChangeOwner
  5231. operationId: robot_PerformChangeOwner
  5232. parameters:
  5233. - description: The Id or Name of robot
  5234. in: path
  5235. name: id
  5236. required: true
  5237. type: string
  5238. x-go-name: Id
  5239. - in: body
  5240. name: body
  5241. schema:
  5242. properties:
  5243. robot:
  5244. $ref: '#/definitions/PerformChangeProjectOwnerInput'
  5245. type: object
  5246. x-go-name: Body
  5247. responses:
  5248. "200":
  5249. $ref: '#/responses/robot_PerformChangeOwnerOutput'
  5250. summary: 更改项目
  5251. tags:
  5252. - robot
  5253. /robots/{id}/disable:
  5254. post:
  5255. description: 执行操作Disable
  5256. operationId: robot_PerformDisable
  5257. parameters:
  5258. - description: The Id or Name of robot
  5259. in: path
  5260. name: id
  5261. required: true
  5262. type: string
  5263. x-go-name: Id
  5264. - in: body
  5265. name: body
  5266. schema:
  5267. properties:
  5268. robot:
  5269. $ref: '#/definitions/PerformDisableInput'
  5270. type: object
  5271. x-go-name: Body
  5272. responses:
  5273. "200":
  5274. $ref: '#/responses/robot_PerformDisableOutput'
  5275. summary: 执行操作Disable
  5276. tags:
  5277. - robot
  5278. /robots/{id}/enable:
  5279. post:
  5280. description: 执行操作Enable
  5281. operationId: robot_PerformEnable
  5282. parameters:
  5283. - description: The Id or Name of robot
  5284. in: path
  5285. name: id
  5286. required: true
  5287. type: string
  5288. x-go-name: Id
  5289. - in: body
  5290. name: body
  5291. schema:
  5292. properties:
  5293. robot:
  5294. $ref: '#/definitions/PerformEnableInput'
  5295. type: object
  5296. x-go-name: Body
  5297. responses:
  5298. "200":
  5299. $ref: '#/responses/robot_PerformEnableOutput'
  5300. summary: 执行操作Enable
  5301. tags:
  5302. - robot
  5303. /robots/{id}/metadata:
  5304. get:
  5305. description: 获取指定信息Metadata
  5306. operationId: robot_GetDetailsMetadata
  5307. parameters:
  5308. - description: |-
  5309. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  5310. 标签分为
  5311. 类型 | 说明 |
  5312. ----------|---------------------------------------------|
  5313. 系统标签 | 平台定义的标签 |
  5314. 用户标签 | key以user:为前缀,用户自定义标签 |
  5315. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  5316. in: query
  5317. items:
  5318. type: string
  5319. name: field
  5320. type: array
  5321. x-go-name: Field
  5322. - description: 按标签前缀过滤
  5323. in: query
  5324. name: prefix
  5325. type: string
  5326. x-go-name: Prefix
  5327. - description: The Id or Name of robot
  5328. in: path
  5329. name: id
  5330. required: true
  5331. type: string
  5332. x-go-name: Id
  5333. responses:
  5334. "200":
  5335. $ref: '#/responses/robot_GetDetailsMetadataOutput'
  5336. summary: 获取资源标签(元数据)
  5337. tags:
  5338. - robot
  5339. /robots/{id}/private:
  5340. post:
  5341. description: 执行操作Private
  5342. operationId: robot_PerformPrivate
  5343. parameters:
  5344. - description: The Id or Name of robot
  5345. in: path
  5346. name: id
  5347. required: true
  5348. type: string
  5349. x-go-name: Id
  5350. - in: body
  5351. name: body
  5352. schema:
  5353. properties:
  5354. robot:
  5355. $ref: '#/definitions/PerformPrivateInput'
  5356. type: object
  5357. x-go-name: Body
  5358. responses:
  5359. "200":
  5360. $ref: '#/responses/robot_PerformPrivateOutput'
  5361. summary: 执行操作Private
  5362. tags:
  5363. - robot
  5364. /robots/{id}/public:
  5365. post:
  5366. description: 执行操作Public
  5367. operationId: robot_PerformPublic
  5368. parameters:
  5369. - description: The Id or Name of robot
  5370. in: path
  5371. name: id
  5372. required: true
  5373. type: string
  5374. x-go-name: Id
  5375. - in: body
  5376. name: body
  5377. schema:
  5378. properties:
  5379. robot:
  5380. $ref: '#/definitions/PerformPublicProjectInput'
  5381. type: object
  5382. x-go-name: Body
  5383. responses:
  5384. "200":
  5385. $ref: '#/responses/robot_PerformPublicOutput'
  5386. summary: 执行操作Public
  5387. tags:
  5388. - robot
  5389. /robots/{id}/status:
  5390. get:
  5391. description: 获取指定信息Status
  5392. operationId: robot_GetDetailsStatus
  5393. parameters:
  5394. - description: The Id or Name of robot
  5395. in: path
  5396. name: id
  5397. required: true
  5398. type: string
  5399. x-go-name: Id
  5400. responses:
  5401. "200":
  5402. $ref: '#/responses/robot_GetDetailsStatusOutput'
  5403. summary: 获取资源状态
  5404. tags:
  5405. - robot
  5406. /subscriber_receivers:
  5407. get:
  5408. description: 列表
  5409. operationId: subscriber_receiver_ListItemFilter
  5410. parameters:
  5411. - default: 20
  5412. description: 查询限制量
  5413. format: int64
  5414. in: query
  5415. name: limit
  5416. type: integer
  5417. x-go-name: Limit
  5418. - default: 0
  5419. description: 查询偏移量
  5420. format: int64
  5421. in: query
  5422. name: offset
  5423. type: integer
  5424. x-go-name: Offset
  5425. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  5426. in: query
  5427. items:
  5428. type: string
  5429. name: order_by
  5430. type: array
  5431. x-go-name: OrderBy
  5432. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  5433. example: desc|asc
  5434. in: query
  5435. name: order
  5436. type: string
  5437. x-go-name: Order
  5438. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  5439. in: query
  5440. name: details
  5441. type: boolean
  5442. x-go-name: Details
  5443. - description: 模糊搜索所有字段
  5444. in: query
  5445. name: search
  5446. type: string
  5447. x-go-name: Search
  5448. - description: |-
  5449. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  5450. 支持的操作符如下:
  5451. 操作符 | 参数个数 | 举例 | 说明 |
  5452. ---------------|----------|------------------------------------------------|-----------------------------|
  5453. in | > 0 | name.in("test", "good") | 在给定数组中 |
  5454. notin | > 0 | name.notin('test') | 不在给定数组中 |
  5455. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  5456. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  5457. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  5458. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  5459. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  5460. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  5461. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  5462. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  5463. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  5464. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  5465. notequals | 1 | name.notequals('test') | 不等于给定值 |
  5466. isnull | 0 | name.isnull() | 值为SQL的NULL |
  5467. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  5468. isempty | 0 | name.isempty('test') | 值为空字符串 |
  5469. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  5470. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  5471. in: query
  5472. items:
  5473. type: string
  5474. name: filter
  5475. type: array
  5476. x-go-name: Filter
  5477. - description: |-
  5478. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  5479. 和其他表关联的语法如下:
  5480. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  5481. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  5482. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  5483. 举例:
  5484. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  5485. in: query
  5486. items:
  5487. type: string
  5488. name: joint_filter
  5489. type: array
  5490. x-go-name: JointFilter
  5491. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  5492. in: query
  5493. name: filter_any
  5494. type: boolean
  5495. x-go-name: FilterAny
  5496. - description: 返回结果只包含指定的字段
  5497. in: query
  5498. items:
  5499. type: string
  5500. name: field
  5501. type: array
  5502. x-go-name: Field
  5503. - description: 用于数据导出,指定导出的数据字段
  5504. in: query
  5505. name: export_keys
  5506. type: string
  5507. x-go-name: ExportKeys
  5508. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  5509. in: query
  5510. name: show_fail_reason
  5511. type: boolean
  5512. x-go-name: ShowFailReason
  5513. - description: 是否返回状态统计信息,默认为False
  5514. in: query
  5515. name: summary_stats
  5516. type: boolean
  5517. x-go-name: SummaryStats
  5518. responses:
  5519. "200":
  5520. $ref: '#/responses/subscriber_receiver_ListItemFilterOutput'
  5521. summary: 列表
  5522. tags:
  5523. - subscriber_receiver
  5524. post:
  5525. description: 新建
  5526. operationId: subscriber_receiver_ValidateCreateData
  5527. parameters:
  5528. - in: body
  5529. name: body
  5530. schema:
  5531. properties:
  5532. count:
  5533. default: 1
  5534. format: int64
  5535. type: integer
  5536. x-go-name: Count
  5537. subscriber_receiver:
  5538. $ref: '#/definitions/JoinResourceBaseCreateInput'
  5539. type: object
  5540. x-go-name: Body
  5541. responses:
  5542. "200":
  5543. $ref: '#/responses/subscriber_receiver_ValidateCreateDataOutput'
  5544. summary: 新建
  5545. tags:
  5546. - subscriber_receiver
  5547. /subscriber_receivers/{id}:
  5548. delete:
  5549. description: 删除
  5550. operationId: subscriber_receiver_CustomizeDelete
  5551. parameters:
  5552. - description: The Id or Name of subscriber_receiver
  5553. in: path
  5554. name: id
  5555. required: true
  5556. type: string
  5557. x-go-name: Id
  5558. responses:
  5559. "200":
  5560. $ref: '#/responses/subscriber_receiver_CustomizeDeleteOutput'
  5561. summary: 删除
  5562. tags:
  5563. - subscriber_receiver
  5564. get:
  5565. description: 获取详情
  5566. operationId: subscriber_receiver_FetchCustomizeColumns
  5567. parameters:
  5568. - description: The Id or Name of subscriber_receiver
  5569. in: path
  5570. name: id
  5571. required: true
  5572. type: string
  5573. x-go-name: Id
  5574. responses:
  5575. "200":
  5576. $ref: '#/responses/subscriber_receiver_FetchCustomizeColumnsOutput'
  5577. summary: 获取详情
  5578. tags:
  5579. - subscriber_receiver
  5580. put:
  5581. description: 更新
  5582. operationId: subscriber_receiver_ValidateUpdateData
  5583. parameters:
  5584. - description: The Id or Name of subscriber_receiver
  5585. in: path
  5586. name: id
  5587. required: true
  5588. type: string
  5589. x-go-name: Id
  5590. - in: body
  5591. name: body
  5592. schema:
  5593. properties:
  5594. subscriber_receiver:
  5595. $ref: '#/definitions/JointResourceBaseUpdateInput'
  5596. type: object
  5597. x-go-name: Body
  5598. responses:
  5599. "200":
  5600. $ref: '#/responses/subscriber_receiver_ValidateUpdateDataOutput'
  5601. summary: 更新
  5602. tags:
  5603. - subscriber_receiver
  5604. /subscribers:
  5605. get:
  5606. description: 列表
  5607. operationId: subscriber_ListItemFilter
  5608. parameters:
  5609. - default: 20
  5610. description: 查询限制量
  5611. format: int64
  5612. in: query
  5613. name: limit
  5614. type: integer
  5615. x-go-name: Limit
  5616. - default: 0
  5617. description: 查询偏移量
  5618. format: int64
  5619. in: query
  5620. name: offset
  5621. type: integer
  5622. x-go-name: Offset
  5623. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  5624. in: query
  5625. items:
  5626. type: string
  5627. name: order_by
  5628. type: array
  5629. x-go-name: OrderBy
  5630. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  5631. example: desc|asc
  5632. in: query
  5633. name: order
  5634. type: string
  5635. x-go-name: Order
  5636. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  5637. in: query
  5638. name: details
  5639. type: boolean
  5640. x-go-name: Details
  5641. - description: 模糊搜索所有字段
  5642. in: query
  5643. name: search
  5644. type: string
  5645. x-go-name: Search
  5646. - description: |-
  5647. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  5648. 支持的操作符如下:
  5649. 操作符 | 参数个数 | 举例 | 说明 |
  5650. ---------------|----------|------------------------------------------------|-----------------------------|
  5651. in | > 0 | name.in("test", "good") | 在给定数组中 |
  5652. notin | > 0 | name.notin('test') | 不在给定数组中 |
  5653. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  5654. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  5655. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  5656. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  5657. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  5658. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  5659. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  5660. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  5661. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  5662. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  5663. notequals | 1 | name.notequals('test') | 不等于给定值 |
  5664. isnull | 0 | name.isnull() | 值为SQL的NULL |
  5665. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  5666. isempty | 0 | name.isempty('test') | 值为空字符串 |
  5667. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  5668. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  5669. in: query
  5670. items:
  5671. type: string
  5672. name: filter
  5673. type: array
  5674. x-go-name: Filter
  5675. - description: |-
  5676. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  5677. 和其他表关联的语法如下:
  5678. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  5679. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  5680. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  5681. 举例:
  5682. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  5683. in: query
  5684. items:
  5685. type: string
  5686. name: joint_filter
  5687. type: array
  5688. x-go-name: JointFilter
  5689. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  5690. in: query
  5691. name: filter_any
  5692. type: boolean
  5693. x-go-name: FilterAny
  5694. - description: 返回结果只包含指定的字段
  5695. in: query
  5696. items:
  5697. type: string
  5698. name: field
  5699. type: array
  5700. x-go-name: Field
  5701. - description: 用于数据导出,指定导出的数据字段
  5702. in: query
  5703. name: export_keys
  5704. type: string
  5705. x-go-name: ExportKeys
  5706. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  5707. in: query
  5708. name: show_fail_reason
  5709. type: boolean
  5710. x-go-name: ShowFailReason
  5711. - description: 是否返回状态统计信息,默认为False
  5712. in: query
  5713. name: summary_stats
  5714. type: boolean
  5715. x-go-name: SummaryStats
  5716. - $ref: '#/definitions/TTagSet'
  5717. description: 通过标签过滤(包含这些标签)
  5718. in: query
  5719. name: tags
  5720. x-go-name: Tags
  5721. - $ref: '#/definitions/TTagSetList'
  5722. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  5723. in: query
  5724. name: obj_tags
  5725. x-go-name: ObjTags
  5726. - $ref: '#/definitions/TTagSet'
  5727. description: 通过标签过滤(不包含这些标签)
  5728. in: query
  5729. name: no_tags
  5730. x-go-name: NoTags
  5731. - $ref: '#/definitions/TTagSetList'
  5732. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  5733. in: query
  5734. name: no_obj_tags
  5735. x-go-name: NoObjTags
  5736. - description: 通过标签排序
  5737. in: query
  5738. name: order_by_tag
  5739. type: string
  5740. x-go-name: OrderByTag
  5741. - description: |-
  5742. deprecated
  5743. 返回资源的标签不包含用户标签
  5744. in: query
  5745. name: without_user_meta
  5746. type: boolean
  5747. x-go-name: WithoutUserMeta
  5748. - description: 返回包含用户标签的资源
  5749. in: query
  5750. name: with_user_meta
  5751. type: boolean
  5752. x-go-name: WithUserMeta
  5753. - description: 返回包含外部标签的资源
  5754. in: query
  5755. name: with_cloud_meta
  5756. type: boolean
  5757. x-go-name: WithCloudMeta
  5758. - description: 返回包含任意标签的资源
  5759. in: query
  5760. name: with_any_meta
  5761. type: boolean
  5762. x-go-name: WithAnyMeta
  5763. - description: 返回列表数据中包含资源的标签数据(Metadata)
  5764. in: query
  5765. name: with_meta
  5766. type: boolean
  5767. x-go-name: WithMeta
  5768. - description: 显示所有的资源,包括模拟的资源
  5769. in: query
  5770. name: show_emulated
  5771. type: boolean
  5772. x-go-name: ShowEmulated
  5773. - description: 以资源ID过滤列表
  5774. in: query
  5775. items:
  5776. type: string
  5777. name: id
  5778. type: array
  5779. x-go-name: Ids
  5780. - description: 以资源是否启用/禁用过滤列表
  5781. in: query
  5782. name: enabled
  5783. type: boolean
  5784. x-go-name: Enabled
  5785. - description: 'description: topic id'
  5786. in: query
  5787. name: topic_id
  5788. type: string
  5789. x-go-name: TopicID
  5790. - description: 'description: scope of resource'
  5791. enum:
  5792. - system
  5793. - domain
  5794. - project
  5795. in: query
  5796. name: resource_scope
  5797. type: string
  5798. x-go-name: ResourceScope
  5799. - description: 'description: type'
  5800. enum:
  5801. - receiver
  5802. - robot
  5803. - role
  5804. in: query
  5805. name: type
  5806. type: string
  5807. x-go-name: Type
  5808. - description: 'description: scope'
  5809. enum:
  5810. - system
  5811. - domain
  5812. in: query
  5813. name: scope
  5814. type: string
  5815. x-go-name: Scope
  5816. responses:
  5817. "200":
  5818. $ref: '#/responses/subscriber_ListItemFilterOutput'
  5819. summary: 列表
  5820. tags:
  5821. - subscriber
  5822. post:
  5823. description: 新建
  5824. operationId: subscriber_ValidateCreateData
  5825. parameters:
  5826. - in: body
  5827. name: body
  5828. schema:
  5829. properties:
  5830. count:
  5831. default: 1
  5832. format: int64
  5833. type: integer
  5834. x-go-name: Count
  5835. subscriber:
  5836. $ref: '#/definitions/SubscriberCreateInput'
  5837. type: object
  5838. x-go-name: Body
  5839. responses:
  5840. "200":
  5841. $ref: '#/responses/subscriber_ValidateCreateDataOutput'
  5842. summary: 新建
  5843. tags:
  5844. - subscriber
  5845. /subscribers/{id}:
  5846. delete:
  5847. description: 删除
  5848. operationId: subscriber_CustomizeDelete
  5849. parameters:
  5850. - description: The Id or Name of subscriber
  5851. in: path
  5852. name: id
  5853. required: true
  5854. type: string
  5855. x-go-name: Id
  5856. responses:
  5857. "200":
  5858. $ref: '#/responses/subscriber_CustomizeDeleteOutput'
  5859. summary: 删除
  5860. tags:
  5861. - subscriber
  5862. get:
  5863. description: 获取详情
  5864. operationId: subscriber_FetchCustomizeColumns
  5865. parameters:
  5866. - description: The Id or Name of subscriber
  5867. in: path
  5868. name: id
  5869. required: true
  5870. type: string
  5871. x-go-name: Id
  5872. responses:
  5873. "200":
  5874. $ref: '#/responses/subscriber_FetchCustomizeColumnsOutput'
  5875. summary: 获取详情
  5876. tags:
  5877. - subscriber
  5878. put:
  5879. description: 更新
  5880. operationId: subscriber_ValidateUpdateData
  5881. parameters:
  5882. - description: The Id or Name of subscriber
  5883. in: path
  5884. name: id
  5885. required: true
  5886. type: string
  5887. x-go-name: Id
  5888. - in: body
  5889. name: body
  5890. schema:
  5891. properties:
  5892. subscriber:
  5893. $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput'
  5894. type: object
  5895. x-go-name: Body
  5896. responses:
  5897. "200":
  5898. $ref: '#/responses/subscriber_ValidateUpdateDataOutput'
  5899. summary: 更新
  5900. tags:
  5901. - subscriber
  5902. /subscribers/{id}/change:
  5903. post:
  5904. description: 执行操作Change
  5905. operationId: subscriber_PerformChange
  5906. parameters:
  5907. - description: The Id or Name of subscriber
  5908. in: path
  5909. name: id
  5910. required: true
  5911. type: string
  5912. x-go-name: Id
  5913. - in: body
  5914. name: body
  5915. schema:
  5916. properties:
  5917. subscriber:
  5918. $ref: '#/definitions/SubscriberChangeInput'
  5919. type: object
  5920. x-go-name: Body
  5921. responses:
  5922. "200":
  5923. $ref: '#/responses/subscriber_PerformChangeOutput'
  5924. summary: 执行操作Change
  5925. tags:
  5926. - subscriber
  5927. /subscribers/{id}/disable:
  5928. post:
  5929. description: 执行操作Disable
  5930. operationId: subscriber_PerformDisable
  5931. parameters:
  5932. - description: The Id or Name of subscriber
  5933. in: path
  5934. name: id
  5935. required: true
  5936. type: string
  5937. x-go-name: Id
  5938. responses:
  5939. "200":
  5940. $ref: '#/responses/subscriber_PerformDisableOutput'
  5941. summary: 执行操作Disable
  5942. tags:
  5943. - subscriber
  5944. /subscribers/{id}/enable:
  5945. post:
  5946. description: 执行操作Enable
  5947. operationId: subscriber_PerformEnable
  5948. parameters:
  5949. - description: The Id or Name of subscriber
  5950. in: path
  5951. name: id
  5952. required: true
  5953. type: string
  5954. x-go-name: Id
  5955. responses:
  5956. "200":
  5957. $ref: '#/responses/subscriber_PerformEnableOutput'
  5958. summary: 执行操作Enable
  5959. tags:
  5960. - subscriber
  5961. /subscribers/{id}/metadata:
  5962. get:
  5963. description: 获取指定信息Metadata
  5964. operationId: subscriber_GetDetailsMetadata
  5965. parameters:
  5966. - description: |-
  5967. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  5968. 标签分为
  5969. 类型 | 说明 |
  5970. ----------|---------------------------------------------|
  5971. 系统标签 | 平台定义的标签 |
  5972. 用户标签 | key以user:为前缀,用户自定义标签 |
  5973. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  5974. in: query
  5975. items:
  5976. type: string
  5977. name: field
  5978. type: array
  5979. x-go-name: Field
  5980. - description: 按标签前缀过滤
  5981. in: query
  5982. name: prefix
  5983. type: string
  5984. x-go-name: Prefix
  5985. - description: The Id or Name of subscriber
  5986. in: path
  5987. name: id
  5988. required: true
  5989. type: string
  5990. x-go-name: Id
  5991. responses:
  5992. "200":
  5993. $ref: '#/responses/subscriber_GetDetailsMetadataOutput'
  5994. summary: 获取资源标签(元数据)
  5995. tags:
  5996. - subscriber
  5997. /subscribers/{id}/set-receiver:
  5998. post:
  5999. description: 执行操作SetReceiver
  6000. operationId: subscriber_PerformSetReceiver
  6001. parameters:
  6002. - description: The Id or Name of subscriber
  6003. in: path
  6004. name: id
  6005. required: true
  6006. type: string
  6007. x-go-name: Id
  6008. - in: body
  6009. name: body
  6010. schema:
  6011. properties:
  6012. subscriber:
  6013. $ref: '#/definitions/SubscriberSetReceiverInput'
  6014. type: object
  6015. x-go-name: Body
  6016. responses:
  6017. "200":
  6018. $ref: '#/responses/subscriber_PerformSetReceiverOutput'
  6019. summary: 执行操作SetReceiver
  6020. tags:
  6021. - subscriber
  6022. /templates:
  6023. get:
  6024. description: 列表
  6025. operationId: template_ListItemFilter
  6026. parameters:
  6027. - default: 20
  6028. description: 查询限制量
  6029. format: int64
  6030. in: query
  6031. name: limit
  6032. type: integer
  6033. x-go-name: Limit
  6034. - default: 0
  6035. description: 查询偏移量
  6036. format: int64
  6037. in: query
  6038. name: offset
  6039. type: integer
  6040. x-go-name: Offset
  6041. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6042. in: query
  6043. items:
  6044. type: string
  6045. name: order_by
  6046. type: array
  6047. x-go-name: OrderBy
  6048. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6049. example: desc|asc
  6050. in: query
  6051. name: order
  6052. type: string
  6053. x-go-name: Order
  6054. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6055. in: query
  6056. name: details
  6057. type: boolean
  6058. x-go-name: Details
  6059. - description: 模糊搜索所有字段
  6060. in: query
  6061. name: search
  6062. type: string
  6063. x-go-name: Search
  6064. - description: |-
  6065. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6066. 支持的操作符如下:
  6067. 操作符 | 参数个数 | 举例 | 说明 |
  6068. ---------------|----------|------------------------------------------------|-----------------------------|
  6069. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6070. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6071. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6072. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6073. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6074. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6075. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6076. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6077. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6078. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6079. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6080. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6081. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6082. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6083. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6084. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6085. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6086. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6087. in: query
  6088. items:
  6089. type: string
  6090. name: filter
  6091. type: array
  6092. x-go-name: Filter
  6093. - description: |-
  6094. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6095. 和其他表关联的语法如下:
  6096. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6097. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6098. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  6099. 举例:
  6100. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  6101. in: query
  6102. items:
  6103. type: string
  6104. name: joint_filter
  6105. type: array
  6106. x-go-name: JointFilter
  6107. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  6108. in: query
  6109. name: filter_any
  6110. type: boolean
  6111. x-go-name: FilterAny
  6112. - description: 返回结果只包含指定的字段
  6113. in: query
  6114. items:
  6115. type: string
  6116. name: field
  6117. type: array
  6118. x-go-name: Field
  6119. - description: 用于数据导出,指定导出的数据字段
  6120. in: query
  6121. name: export_keys
  6122. type: string
  6123. x-go-name: ExportKeys
  6124. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  6125. in: query
  6126. name: show_fail_reason
  6127. type: boolean
  6128. x-go-name: ShowFailReason
  6129. - description: 是否返回状态统计信息,默认为False
  6130. in: query
  6131. name: summary_stats
  6132. type: boolean
  6133. x-go-name: SummaryStats
  6134. - $ref: '#/definitions/TTagSet'
  6135. description: 通过标签过滤(包含这些标签)
  6136. in: query
  6137. name: tags
  6138. x-go-name: Tags
  6139. - $ref: '#/definitions/TTagSetList'
  6140. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  6141. in: query
  6142. name: obj_tags
  6143. x-go-name: ObjTags
  6144. - $ref: '#/definitions/TTagSet'
  6145. description: 通过标签过滤(不包含这些标签)
  6146. in: query
  6147. name: no_tags
  6148. x-go-name: NoTags
  6149. - $ref: '#/definitions/TTagSetList'
  6150. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  6151. in: query
  6152. name: no_obj_tags
  6153. x-go-name: NoObjTags
  6154. - description: 通过标签排序
  6155. in: query
  6156. name: order_by_tag
  6157. type: string
  6158. x-go-name: OrderByTag
  6159. - description: |-
  6160. deprecated
  6161. 返回资源的标签不包含用户标签
  6162. in: query
  6163. name: without_user_meta
  6164. type: boolean
  6165. x-go-name: WithoutUserMeta
  6166. - description: 返回包含用户标签的资源
  6167. in: query
  6168. name: with_user_meta
  6169. type: boolean
  6170. x-go-name: WithUserMeta
  6171. - description: 返回包含外部标签的资源
  6172. in: query
  6173. name: with_cloud_meta
  6174. type: boolean
  6175. x-go-name: WithCloudMeta
  6176. - description: 返回包含任意标签的资源
  6177. in: query
  6178. name: with_any_meta
  6179. type: boolean
  6180. x-go-name: WithAnyMeta
  6181. - description: 返回列表数据中包含资源的标签数据(Metadata)
  6182. in: query
  6183. name: with_meta
  6184. type: boolean
  6185. x-go-name: WithMeta
  6186. - description: 显示所有的资源,包括模拟的资源
  6187. in: query
  6188. name: show_emulated
  6189. type: boolean
  6190. x-go-name: ShowEmulated
  6191. - description: 以资源ID过滤列表
  6192. in: query
  6193. items:
  6194. type: string
  6195. name: id
  6196. type: array
  6197. x-go-name: Ids
  6198. - description: |-
  6199. description: Contact type, specifically, setting it to all means all contact type
  6200. require: true
  6201. example: email
  6202. in: query
  6203. name: contact_type
  6204. type: string
  6205. x-go-name: ContactType
  6206. - description: 'description: Template type'
  6207. enum:
  6208. - title
  6209. - content
  6210. - remote
  6211. example: title
  6212. in: query
  6213. name: template_type
  6214. type: string
  6215. x-go-name: TemplateType
  6216. - description: 'description: template topic'
  6217. example: IMAGE_ACTIVE
  6218. in: query
  6219. name: topic
  6220. required: true
  6221. type: string
  6222. x-go-name: Topic
  6223. - description: 'description: Language'
  6224. enum:
  6225. - cn
  6226. - en
  6227. in: query
  6228. name: lang
  6229. type: string
  6230. x-go-name: Lang
  6231. responses:
  6232. "200":
  6233. $ref: '#/responses/template_ListItemFilterOutput'
  6234. summary: 列表
  6235. tags:
  6236. - template
  6237. post:
  6238. description: 新建
  6239. operationId: template_ValidateCreateData
  6240. parameters:
  6241. - in: body
  6242. name: body
  6243. schema:
  6244. properties:
  6245. count:
  6246. default: 1
  6247. format: int64
  6248. type: integer
  6249. x-go-name: Count
  6250. template:
  6251. $ref: '#/definitions/TemplateCreateInput'
  6252. type: object
  6253. x-go-name: Body
  6254. responses:
  6255. "200":
  6256. $ref: '#/responses/template_ValidateCreateDataOutput'
  6257. summary: 新建
  6258. tags:
  6259. - template
  6260. /templates/{id}:
  6261. delete:
  6262. description: 删除
  6263. operationId: template_CustomizeDelete
  6264. parameters:
  6265. - description: The Id or Name of template
  6266. in: path
  6267. name: id
  6268. required: true
  6269. type: string
  6270. x-go-name: Id
  6271. responses:
  6272. "200":
  6273. $ref: '#/responses/template_CustomizeDeleteOutput'
  6274. summary: 删除
  6275. tags:
  6276. - template
  6277. get:
  6278. description: 获取详情
  6279. operationId: template_FetchCustomizeColumns
  6280. parameters:
  6281. - description: The Id or Name of template
  6282. in: path
  6283. name: id
  6284. required: true
  6285. type: string
  6286. x-go-name: Id
  6287. responses:
  6288. "200":
  6289. $ref: '#/responses/template_FetchCustomizeColumnsOutput'
  6290. summary: 获取详情
  6291. tags:
  6292. - template
  6293. put:
  6294. description: 更新
  6295. operationId: template_ValidateUpdateData
  6296. parameters:
  6297. - description: The Id or Name of template
  6298. in: path
  6299. name: id
  6300. required: true
  6301. type: string
  6302. x-go-name: Id
  6303. - in: body
  6304. name: body
  6305. schema:
  6306. properties:
  6307. template:
  6308. $ref: '#/definitions/TemplateUpdateInput'
  6309. type: object
  6310. x-go-name: Body
  6311. responses:
  6312. "200":
  6313. $ref: '#/responses/template_ValidateUpdateDataOutput'
  6314. summary: 更新
  6315. tags:
  6316. - template
  6317. /templates/{id}/metadata:
  6318. get:
  6319. description: 获取指定信息Metadata
  6320. operationId: template_GetDetailsMetadata
  6321. parameters:
  6322. - description: |-
  6323. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  6324. 标签分为
  6325. 类型 | 说明 |
  6326. ----------|---------------------------------------------|
  6327. 系统标签 | 平台定义的标签 |
  6328. 用户标签 | key以user:为前缀,用户自定义标签 |
  6329. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  6330. in: query
  6331. items:
  6332. type: string
  6333. name: field
  6334. type: array
  6335. x-go-name: Field
  6336. - description: 按标签前缀过滤
  6337. in: query
  6338. name: prefix
  6339. type: string
  6340. x-go-name: Prefix
  6341. - description: The Id or Name of template
  6342. in: path
  6343. name: id
  6344. required: true
  6345. type: string
  6346. x-go-name: Id
  6347. responses:
  6348. "200":
  6349. $ref: '#/responses/template_GetDetailsMetadataOutput'
  6350. summary: 获取资源标签(元数据)
  6351. tags:
  6352. - template
  6353. /templates/save:
  6354. post:
  6355. description: 执行操作Save
  6356. operationId: template_PerformSave
  6357. parameters:
  6358. - in: body
  6359. name: body
  6360. schema:
  6361. properties:
  6362. template:
  6363. $ref: '#/definitions/TemplateManagerSaveInput'
  6364. type: object
  6365. x-go-name: Body
  6366. responses:
  6367. "200":
  6368. $ref: '#/responses/template_PerformSaveOutput'
  6369. summary: 执行操作Save
  6370. tags:
  6371. - template
  6372. /topic_actions:
  6373. get:
  6374. description: 列表
  6375. operationId: topic_action_ListItemFilter
  6376. parameters:
  6377. - default: 20
  6378. description: 查询限制量
  6379. format: int64
  6380. in: query
  6381. name: limit
  6382. type: integer
  6383. x-go-name: Limit
  6384. - default: 0
  6385. description: 查询偏移量
  6386. format: int64
  6387. in: query
  6388. name: offset
  6389. type: integer
  6390. x-go-name: Offset
  6391. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6392. in: query
  6393. items:
  6394. type: string
  6395. name: order_by
  6396. type: array
  6397. x-go-name: OrderBy
  6398. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6399. example: desc|asc
  6400. in: query
  6401. name: order
  6402. type: string
  6403. x-go-name: Order
  6404. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6405. in: query
  6406. name: details
  6407. type: boolean
  6408. x-go-name: Details
  6409. - description: 模糊搜索所有字段
  6410. in: query
  6411. name: search
  6412. type: string
  6413. x-go-name: Search
  6414. - description: |-
  6415. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6416. 支持的操作符如下:
  6417. 操作符 | 参数个数 | 举例 | 说明 |
  6418. ---------------|----------|------------------------------------------------|-----------------------------|
  6419. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6420. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6421. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6422. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6423. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6424. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6425. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6426. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6427. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6428. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6429. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6430. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6431. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6432. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6433. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6434. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6435. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6436. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6437. in: query
  6438. items:
  6439. type: string
  6440. name: filter
  6441. type: array
  6442. x-go-name: Filter
  6443. - description: |-
  6444. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6445. 和其他表关联的语法如下:
  6446. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6447. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6448. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  6449. 举例:
  6450. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  6451. in: query
  6452. items:
  6453. type: string
  6454. name: joint_filter
  6455. type: array
  6456. x-go-name: JointFilter
  6457. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  6458. in: query
  6459. name: filter_any
  6460. type: boolean
  6461. x-go-name: FilterAny
  6462. - description: 返回结果只包含指定的字段
  6463. in: query
  6464. items:
  6465. type: string
  6466. name: field
  6467. type: array
  6468. x-go-name: Field
  6469. - description: 用于数据导出,指定导出的数据字段
  6470. in: query
  6471. name: export_keys
  6472. type: string
  6473. x-go-name: ExportKeys
  6474. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  6475. in: query
  6476. name: show_fail_reason
  6477. type: boolean
  6478. x-go-name: ShowFailReason
  6479. - description: 是否返回状态统计信息,默认为False
  6480. in: query
  6481. name: summary_stats
  6482. type: boolean
  6483. x-go-name: SummaryStats
  6484. responses:
  6485. "200":
  6486. $ref: '#/responses/topic_action_ListItemFilterOutput'
  6487. summary: 列表
  6488. tags:
  6489. - topic_action
  6490. post:
  6491. description: 新建
  6492. operationId: topic_action_ValidateCreateData
  6493. parameters:
  6494. - in: body
  6495. name: body
  6496. schema:
  6497. properties:
  6498. count:
  6499. default: 1
  6500. format: int64
  6501. type: integer
  6502. x-go-name: Count
  6503. topic_action:
  6504. $ref: '#/definitions/ResourceBaseCreateInput'
  6505. type: object
  6506. x-go-name: Body
  6507. responses:
  6508. "200":
  6509. $ref: '#/responses/topic_action_ValidateCreateDataOutput'
  6510. summary: 新建
  6511. tags:
  6512. - topic_action
  6513. /topic_actions/{id}:
  6514. delete:
  6515. description: 删除
  6516. operationId: topic_action_CustomizeDelete
  6517. parameters:
  6518. - description: The Id or Name of topic_action
  6519. in: path
  6520. name: id
  6521. required: true
  6522. type: string
  6523. x-go-name: Id
  6524. responses:
  6525. "200":
  6526. $ref: '#/responses/topic_action_CustomizeDeleteOutput'
  6527. summary: 删除
  6528. tags:
  6529. - topic_action
  6530. get:
  6531. description: 获取详情
  6532. operationId: topic_action_FetchCustomizeColumns
  6533. parameters:
  6534. - description: The Id or Name of topic_action
  6535. in: path
  6536. name: id
  6537. required: true
  6538. type: string
  6539. x-go-name: Id
  6540. responses:
  6541. "200":
  6542. $ref: '#/responses/topic_action_FetchCustomizeColumnsOutput'
  6543. summary: 获取详情
  6544. tags:
  6545. - topic_action
  6546. put:
  6547. description: 更新
  6548. operationId: topic_action_ValidateUpdateData
  6549. parameters:
  6550. - description: The Id or Name of topic_action
  6551. in: path
  6552. name: id
  6553. required: true
  6554. type: string
  6555. x-go-name: Id
  6556. - in: body
  6557. name: body
  6558. schema:
  6559. properties:
  6560. topic_action:
  6561. $ref: '#/definitions/ResourceBaseUpdateInput'
  6562. type: object
  6563. x-go-name: Body
  6564. responses:
  6565. "200":
  6566. $ref: '#/responses/topic_action_ValidateUpdateDataOutput'
  6567. summary: 更新
  6568. tags:
  6569. - topic_action
  6570. /topic_resources:
  6571. get:
  6572. description: 列表
  6573. operationId: topic_resource_ListItemFilter
  6574. parameters:
  6575. - default: 20
  6576. description: 查询限制量
  6577. format: int64
  6578. in: query
  6579. name: limit
  6580. type: integer
  6581. x-go-name: Limit
  6582. - default: 0
  6583. description: 查询偏移量
  6584. format: int64
  6585. in: query
  6586. name: offset
  6587. type: integer
  6588. x-go-name: Offset
  6589. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6590. in: query
  6591. items:
  6592. type: string
  6593. name: order_by
  6594. type: array
  6595. x-go-name: OrderBy
  6596. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6597. example: desc|asc
  6598. in: query
  6599. name: order
  6600. type: string
  6601. x-go-name: Order
  6602. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6603. in: query
  6604. name: details
  6605. type: boolean
  6606. x-go-name: Details
  6607. - description: 模糊搜索所有字段
  6608. in: query
  6609. name: search
  6610. type: string
  6611. x-go-name: Search
  6612. - description: |-
  6613. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6614. 支持的操作符如下:
  6615. 操作符 | 参数个数 | 举例 | 说明 |
  6616. ---------------|----------|------------------------------------------------|-----------------------------|
  6617. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6618. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6619. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6620. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6621. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6622. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6623. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6624. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6625. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6626. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6627. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6628. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6629. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6630. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6631. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6632. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6633. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6634. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6635. in: query
  6636. items:
  6637. type: string
  6638. name: filter
  6639. type: array
  6640. x-go-name: Filter
  6641. - description: |-
  6642. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6643. 和其他表关联的语法如下:
  6644. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6645. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6646. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  6647. 举例:
  6648. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  6649. in: query
  6650. items:
  6651. type: string
  6652. name: joint_filter
  6653. type: array
  6654. x-go-name: JointFilter
  6655. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  6656. in: query
  6657. name: filter_any
  6658. type: boolean
  6659. x-go-name: FilterAny
  6660. - description: 返回结果只包含指定的字段
  6661. in: query
  6662. items:
  6663. type: string
  6664. name: field
  6665. type: array
  6666. x-go-name: Field
  6667. - description: 用于数据导出,指定导出的数据字段
  6668. in: query
  6669. name: export_keys
  6670. type: string
  6671. x-go-name: ExportKeys
  6672. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  6673. in: query
  6674. name: show_fail_reason
  6675. type: boolean
  6676. x-go-name: ShowFailReason
  6677. - description: 是否返回状态统计信息,默认为False
  6678. in: query
  6679. name: summary_stats
  6680. type: boolean
  6681. x-go-name: SummaryStats
  6682. responses:
  6683. "200":
  6684. $ref: '#/responses/topic_resource_ListItemFilterOutput'
  6685. summary: 列表
  6686. tags:
  6687. - topic_resource
  6688. post:
  6689. description: 新建
  6690. operationId: topic_resource_ValidateCreateData
  6691. parameters:
  6692. - in: body
  6693. name: body
  6694. schema:
  6695. properties:
  6696. count:
  6697. default: 1
  6698. format: int64
  6699. type: integer
  6700. x-go-name: Count
  6701. topic_resource:
  6702. $ref: '#/definitions/ResourceBaseCreateInput'
  6703. type: object
  6704. x-go-name: Body
  6705. responses:
  6706. "200":
  6707. $ref: '#/responses/topic_resource_ValidateCreateDataOutput'
  6708. summary: 新建
  6709. tags:
  6710. - topic_resource
  6711. /topic_resources/{id}:
  6712. delete:
  6713. description: 删除
  6714. operationId: topic_resource_CustomizeDelete
  6715. parameters:
  6716. - description: The Id or Name of topic_resource
  6717. in: path
  6718. name: id
  6719. required: true
  6720. type: string
  6721. x-go-name: Id
  6722. responses:
  6723. "200":
  6724. $ref: '#/responses/topic_resource_CustomizeDeleteOutput'
  6725. summary: 删除
  6726. tags:
  6727. - topic_resource
  6728. get:
  6729. description: 获取详情
  6730. operationId: topic_resource_FetchCustomizeColumns
  6731. parameters:
  6732. - description: The Id or Name of topic_resource
  6733. in: path
  6734. name: id
  6735. required: true
  6736. type: string
  6737. x-go-name: Id
  6738. responses:
  6739. "200":
  6740. $ref: '#/responses/topic_resource_FetchCustomizeColumnsOutput'
  6741. summary: 获取详情
  6742. tags:
  6743. - topic_resource
  6744. put:
  6745. description: 更新
  6746. operationId: topic_resource_ValidateUpdateData
  6747. parameters:
  6748. - description: The Id or Name of topic_resource
  6749. in: path
  6750. name: id
  6751. required: true
  6752. type: string
  6753. x-go-name: Id
  6754. - in: body
  6755. name: body
  6756. schema:
  6757. properties:
  6758. topic_resource:
  6759. $ref: '#/definitions/ResourceBaseUpdateInput'
  6760. type: object
  6761. x-go-name: Body
  6762. responses:
  6763. "200":
  6764. $ref: '#/responses/topic_resource_ValidateUpdateDataOutput'
  6765. summary: 更新
  6766. tags:
  6767. - topic_resource
  6768. /topics:
  6769. get:
  6770. description: 列表
  6771. operationId: topic_ListItemFilter
  6772. parameters:
  6773. - default: 20
  6774. description: 查询限制量
  6775. format: int64
  6776. in: query
  6777. name: limit
  6778. type: integer
  6779. x-go-name: Limit
  6780. - default: 0
  6781. description: 查询偏移量
  6782. format: int64
  6783. in: query
  6784. name: offset
  6785. type: integer
  6786. x-go-name: Offset
  6787. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6788. in: query
  6789. items:
  6790. type: string
  6791. name: order_by
  6792. type: array
  6793. x-go-name: OrderBy
  6794. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6795. example: desc|asc
  6796. in: query
  6797. name: order
  6798. type: string
  6799. x-go-name: Order
  6800. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6801. in: query
  6802. name: details
  6803. type: boolean
  6804. x-go-name: Details
  6805. - description: 模糊搜索所有字段
  6806. in: query
  6807. name: search
  6808. type: string
  6809. x-go-name: Search
  6810. - description: |-
  6811. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6812. 支持的操作符如下:
  6813. 操作符 | 参数个数 | 举例 | 说明 |
  6814. ---------------|----------|------------------------------------------------|-----------------------------|
  6815. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6816. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6817. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6818. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6819. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6820. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6821. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6822. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6823. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6824. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6825. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6826. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6827. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6828. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6829. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6830. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6831. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6832. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6833. in: query
  6834. items:
  6835. type: string
  6836. name: filter
  6837. type: array
  6838. x-go-name: Filter
  6839. - description: |-
  6840. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6841. 和其他表关联的语法如下:
  6842. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6843. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6844. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  6845. 举例:
  6846. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  6847. in: query
  6848. items:
  6849. type: string
  6850. name: joint_filter
  6851. type: array
  6852. x-go-name: JointFilter
  6853. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  6854. in: query
  6855. name: filter_any
  6856. type: boolean
  6857. x-go-name: FilterAny
  6858. - description: 返回结果只包含指定的字段
  6859. in: query
  6860. items:
  6861. type: string
  6862. name: field
  6863. type: array
  6864. x-go-name: Field
  6865. - description: 用于数据导出,指定导出的数据字段
  6866. in: query
  6867. name: export_keys
  6868. type: string
  6869. x-go-name: ExportKeys
  6870. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  6871. in: query
  6872. name: show_fail_reason
  6873. type: boolean
  6874. x-go-name: ShowFailReason
  6875. - description: 是否返回状态统计信息,默认为False
  6876. in: query
  6877. name: summary_stats
  6878. type: boolean
  6879. x-go-name: SummaryStats
  6880. - $ref: '#/definitions/TTagSet'
  6881. description: 通过标签过滤(包含这些标签)
  6882. in: query
  6883. name: tags
  6884. x-go-name: Tags
  6885. - $ref: '#/definitions/TTagSetList'
  6886. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  6887. in: query
  6888. name: obj_tags
  6889. x-go-name: ObjTags
  6890. - $ref: '#/definitions/TTagSet'
  6891. description: 通过标签过滤(不包含这些标签)
  6892. in: query
  6893. name: no_tags
  6894. x-go-name: NoTags
  6895. - $ref: '#/definitions/TTagSetList'
  6896. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  6897. in: query
  6898. name: no_obj_tags
  6899. x-go-name: NoObjTags
  6900. - description: 通过标签排序
  6901. in: query
  6902. name: order_by_tag
  6903. type: string
  6904. x-go-name: OrderByTag
  6905. - description: |-
  6906. deprecated
  6907. 返回资源的标签不包含用户标签
  6908. in: query
  6909. name: without_user_meta
  6910. type: boolean
  6911. x-go-name: WithoutUserMeta
  6912. - description: 返回包含用户标签的资源
  6913. in: query
  6914. name: with_user_meta
  6915. type: boolean
  6916. x-go-name: WithUserMeta
  6917. - description: 返回包含外部标签的资源
  6918. in: query
  6919. name: with_cloud_meta
  6920. type: boolean
  6921. x-go-name: WithCloudMeta
  6922. - description: 返回包含任意标签的资源
  6923. in: query
  6924. name: with_any_meta
  6925. type: boolean
  6926. x-go-name: WithAnyMeta
  6927. - description: 返回列表数据中包含资源的标签数据(Metadata)
  6928. in: query
  6929. name: with_meta
  6930. type: boolean
  6931. x-go-name: WithMeta
  6932. - description: 显示所有的资源,包括模拟的资源
  6933. in: query
  6934. name: show_emulated
  6935. type: boolean
  6936. x-go-name: ShowEmulated
  6937. - description: 以资源ID过滤列表
  6938. in: query
  6939. items:
  6940. type: string
  6941. name: id
  6942. type: array
  6943. x-go-name: Ids
  6944. - description: 以资源名称过滤列表
  6945. in: query
  6946. items:
  6947. type: string
  6948. name: name
  6949. type: array
  6950. x-go-name: Names
  6951. - description: 以资源是否启用/禁用过滤列表
  6952. in: query
  6953. name: enabled
  6954. type: boolean
  6955. x-go-name: Enabled
  6956. responses:
  6957. "200":
  6958. $ref: '#/responses/topic_ListItemFilterOutput'
  6959. summary: 列表
  6960. tags:
  6961. - topic
  6962. post:
  6963. description: 新建
  6964. operationId: topic_ValidateCreateData
  6965. parameters:
  6966. - in: body
  6967. name: body
  6968. schema:
  6969. properties:
  6970. count:
  6971. default: 1
  6972. format: int64
  6973. type: integer
  6974. x-go-name: Count
  6975. topic:
  6976. $ref: '#/definitions/STopicCreateInput'
  6977. type: object
  6978. x-go-name: Body
  6979. responses:
  6980. "200":
  6981. $ref: '#/responses/topic_ValidateCreateDataOutput'
  6982. summary: 新建
  6983. tags:
  6984. - topic
  6985. /topics/{id}:
  6986. delete:
  6987. description: 删除
  6988. operationId: topic_CustomizeDelete
  6989. parameters:
  6990. - description: The Id or Name of topic
  6991. in: path
  6992. name: id
  6993. required: true
  6994. type: string
  6995. x-go-name: Id
  6996. responses:
  6997. "200":
  6998. $ref: '#/responses/topic_CustomizeDeleteOutput'
  6999. summary: 删除
  7000. tags:
  7001. - topic
  7002. get:
  7003. description: 获取详情
  7004. operationId: topic_FetchCustomizeColumns
  7005. parameters:
  7006. - description: The Id or Name of topic
  7007. in: path
  7008. name: id
  7009. required: true
  7010. type: string
  7011. x-go-name: Id
  7012. responses:
  7013. "200":
  7014. $ref: '#/responses/topic_FetchCustomizeColumnsOutput'
  7015. summary: 获取详情
  7016. tags:
  7017. - topic
  7018. put:
  7019. description: 更新
  7020. operationId: topic_ValidateUpdateData
  7021. parameters:
  7022. - description: The Id or Name of topic
  7023. in: path
  7024. name: id
  7025. required: true
  7026. type: string
  7027. x-go-name: Id
  7028. - in: body
  7029. name: body
  7030. schema:
  7031. properties:
  7032. topic:
  7033. $ref: '#/definitions/TopicUpdateInput'
  7034. type: object
  7035. x-go-name: Body
  7036. responses:
  7037. "200":
  7038. $ref: '#/responses/topic_ValidateUpdateDataOutput'
  7039. summary: 更新
  7040. tags:
  7041. - topic
  7042. /topics/{id}/disable:
  7043. post:
  7044. description: 执行操作Disable
  7045. operationId: topic_PerformDisable
  7046. parameters:
  7047. - description: The Id or Name of topic
  7048. in: path
  7049. name: id
  7050. required: true
  7051. type: string
  7052. x-go-name: Id
  7053. - in: body
  7054. name: body
  7055. schema:
  7056. properties:
  7057. topic:
  7058. $ref: '#/definitions/PerformDisableInput'
  7059. type: object
  7060. x-go-name: Body
  7061. responses:
  7062. "200":
  7063. $ref: '#/responses/topic_PerformDisableOutput'
  7064. summary: 禁用资源
  7065. tags:
  7066. - topic
  7067. /topics/{id}/enable:
  7068. post:
  7069. description: 执行操作Enable
  7070. operationId: topic_PerformEnable
  7071. parameters:
  7072. - description: The Id or Name of topic
  7073. in: path
  7074. name: id
  7075. required: true
  7076. type: string
  7077. x-go-name: Id
  7078. - in: body
  7079. name: body
  7080. schema:
  7081. properties:
  7082. topic:
  7083. $ref: '#/definitions/PerformEnableInput'
  7084. type: object
  7085. x-go-name: Body
  7086. responses:
  7087. "200":
  7088. $ref: '#/responses/topic_PerformEnableOutput'
  7089. summary: 启用资源
  7090. tags:
  7091. - topic
  7092. /topics/{id}/metadata:
  7093. get:
  7094. description: 获取指定信息Metadata
  7095. operationId: topic_GetDetailsMetadata
  7096. parameters:
  7097. - description: |-
  7098. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  7099. 标签分为
  7100. 类型 | 说明 |
  7101. ----------|---------------------------------------------|
  7102. 系统标签 | 平台定义的标签 |
  7103. 用户标签 | key以user:为前缀,用户自定义标签 |
  7104. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  7105. in: query
  7106. items:
  7107. type: string
  7108. name: field
  7109. type: array
  7110. x-go-name: Field
  7111. - description: 按标签前缀过滤
  7112. in: query
  7113. name: prefix
  7114. type: string
  7115. x-go-name: Prefix
  7116. - description: The Id or Name of topic
  7117. in: path
  7118. name: id
  7119. required: true
  7120. type: string
  7121. x-go-name: Id
  7122. responses:
  7123. "200":
  7124. $ref: '#/responses/topic_GetDetailsMetadataOutput'
  7125. summary: 获取资源标签(元数据)
  7126. tags:
  7127. - topic
  7128. /topics/{id}/status:
  7129. get:
  7130. description: 获取指定信息Status
  7131. operationId: topic_GetDetailsStatus
  7132. parameters:
  7133. - description: The Id or Name of topic
  7134. in: path
  7135. name: id
  7136. required: true
  7137. type: string
  7138. x-go-name: Id
  7139. responses:
  7140. "200":
  7141. $ref: '#/responses/topic_GetDetailsStatusOutput'
  7142. summary: 获取资源状态
  7143. tags:
  7144. - topic
  7145. produces:
  7146. - application/json
  7147. responses:
  7148. config_CustomizeDeleteOutput:
  7149. description: ""
  7150. schema:
  7151. properties:
  7152. config:
  7153. $ref: '#/definitions/ConfigDetails'
  7154. type: object
  7155. config_FetchCustomizeColumnsOutput:
  7156. description: ""
  7157. schema:
  7158. properties:
  7159. config:
  7160. $ref: '#/definitions/ConfigDetails'
  7161. type: object
  7162. config_GetDetailsMetadataOutput:
  7163. description: ""
  7164. schema:
  7165. properties:
  7166. config:
  7167. additionalProperties:
  7168. type: string
  7169. type: object
  7170. x-go-name: Output
  7171. type: object
  7172. config_GetPropertyCapabilityOutput:
  7173. description: ""
  7174. config_ListItemFilterOutput:
  7175. description: ""
  7176. schema:
  7177. properties:
  7178. configs:
  7179. items:
  7180. $ref: '#/definitions/ConfigDetails'
  7181. type: array
  7182. x-go-name: Output
  7183. limit:
  7184. format: int64
  7185. type: integer
  7186. x-go-name: Limit
  7187. offset:
  7188. format: int64
  7189. type: integer
  7190. x-go-name: Offset
  7191. total:
  7192. format: int64
  7193. type: integer
  7194. x-go-name: Total
  7195. type: object
  7196. config_PerformChangeOwnerOutput:
  7197. description: ""
  7198. config_PerformValidateOutput:
  7199. description: ""
  7200. schema:
  7201. properties:
  7202. config:
  7203. $ref: '#/definitions/ConfigValidateOutput'
  7204. type: object
  7205. config_ValidateCreateDataOutput:
  7206. description: ""
  7207. schema:
  7208. properties:
  7209. config:
  7210. $ref: '#/definitions/ConfigDetails'
  7211. type: object
  7212. config_ValidateUpdateDataOutput:
  7213. description: ""
  7214. schema:
  7215. properties:
  7216. config:
  7217. $ref: '#/definitions/ConfigDetails'
  7218. type: object
  7219. email_queue_CustomizeDeleteOutput:
  7220. description: ""
  7221. schema:
  7222. properties:
  7223. email_queue:
  7224. $ref: '#/definitions/EmailQueueDetails'
  7225. type: object
  7226. email_queue_FetchCustomizeColumnsOutput:
  7227. description: ""
  7228. schema:
  7229. properties:
  7230. email_queue:
  7231. $ref: '#/definitions/EmailQueueDetails'
  7232. type: object
  7233. email_queue_ListItemFilterOutput:
  7234. description: ""
  7235. schema:
  7236. properties:
  7237. email_queues:
  7238. items:
  7239. $ref: '#/definitions/EmailQueueDetails'
  7240. type: array
  7241. x-go-name: Output
  7242. limit:
  7243. format: int64
  7244. type: integer
  7245. x-go-name: Limit
  7246. offset:
  7247. format: int64
  7248. type: integer
  7249. x-go-name: Offset
  7250. total:
  7251. format: int64
  7252. type: integer
  7253. x-go-name: Total
  7254. type: object
  7255. email_queue_PerformSendOutput:
  7256. description: ""
  7257. email_queue_ValidateCreateDataOutput:
  7258. description: ""
  7259. schema:
  7260. properties:
  7261. email_queue:
  7262. $ref: '#/definitions/EmailQueueDetails'
  7263. type: object
  7264. email_queue_ValidateUpdateDataOutput:
  7265. description: ""
  7266. schema:
  7267. properties:
  7268. email_queue:
  7269. $ref: '#/definitions/EmailQueueDetails'
  7270. type: object
  7271. email_queue_status_CustomizeDeleteOutput:
  7272. description: ""
  7273. schema:
  7274. properties:
  7275. email_queue_status:
  7276. $ref: '#/definitions/ModelBaseDetails'
  7277. type: object
  7278. email_queue_status_FetchCustomizeColumnsOutput:
  7279. description: ""
  7280. schema:
  7281. properties:
  7282. email_queue_status:
  7283. $ref: '#/definitions/ModelBaseDetails'
  7284. type: object
  7285. email_queue_status_ListItemFilterOutput:
  7286. description: ""
  7287. schema:
  7288. properties:
  7289. email_queue_statuses:
  7290. items:
  7291. $ref: '#/definitions/ModelBaseDetails'
  7292. type: array
  7293. x-go-name: Output
  7294. limit:
  7295. format: int64
  7296. type: integer
  7297. x-go-name: Limit
  7298. offset:
  7299. format: int64
  7300. type: integer
  7301. x-go-name: Offset
  7302. total:
  7303. format: int64
  7304. type: integer
  7305. x-go-name: Total
  7306. type: object
  7307. email_queue_status_ValidateCreateDataOutput:
  7308. description: ""
  7309. schema:
  7310. properties:
  7311. email_queue_status:
  7312. $ref: '#/definitions/ModelBaseDetails'
  7313. type: object
  7314. email_queue_status_ValidateUpdateDataOutput:
  7315. description: ""
  7316. schema:
  7317. properties:
  7318. email_queue_status:
  7319. $ref: '#/definitions/ModelBaseDetails'
  7320. type: object
  7321. event_CustomizeDeleteOutput:
  7322. description: ""
  7323. schema:
  7324. properties:
  7325. event:
  7326. $ref: '#/definitions/ModelBaseDetails'
  7327. type: object
  7328. event_FetchCustomizeColumnsOutput:
  7329. description: ""
  7330. schema:
  7331. properties:
  7332. event:
  7333. $ref: '#/definitions/ModelBaseDetails'
  7334. type: object
  7335. event_ListItemFilterOutput:
  7336. description: ""
  7337. schema:
  7338. properties:
  7339. events:
  7340. items:
  7341. $ref: '#/definitions/ModelBaseDetails'
  7342. type: array
  7343. x-go-name: Output
  7344. limit:
  7345. format: int64
  7346. type: integer
  7347. x-go-name: Limit
  7348. offset:
  7349. format: int64
  7350. type: integer
  7351. x-go-name: Offset
  7352. total:
  7353. format: int64
  7354. type: integer
  7355. x-go-name: Total
  7356. type: object
  7357. event_ValidateCreateDataOutput:
  7358. description: ""
  7359. schema:
  7360. properties:
  7361. event:
  7362. $ref: '#/definitions/ModelBaseDetails'
  7363. type: object
  7364. event_ValidateUpdateDataOutput:
  7365. description: ""
  7366. schema:
  7367. properties:
  7368. event:
  7369. $ref: '#/definitions/ModelBaseDetails'
  7370. type: object
  7371. notification_CustomizeDeleteOutput:
  7372. description: ""
  7373. schema:
  7374. properties:
  7375. notification:
  7376. $ref: '#/definitions/NotificationDetails'
  7377. type: object
  7378. notification_FetchCustomizeColumnsOutput:
  7379. description: ""
  7380. schema:
  7381. properties:
  7382. notification:
  7383. $ref: '#/definitions/NotificationDetails'
  7384. type: object
  7385. notification_GetDetailsMetadataOutput:
  7386. description: ""
  7387. schema:
  7388. properties:
  7389. notification:
  7390. additionalProperties:
  7391. type: string
  7392. type: object
  7393. x-go-name: Output
  7394. type: object
  7395. notification_GetDetailsStatusOutput:
  7396. description: ""
  7397. schema:
  7398. properties:
  7399. notification:
  7400. $ref: '#/definitions/GetDetailsStatusOutput'
  7401. type: object
  7402. notification_ListItemFilterOutput:
  7403. description: ""
  7404. schema:
  7405. properties:
  7406. limit:
  7407. format: int64
  7408. type: integer
  7409. x-go-name: Limit
  7410. notifications:
  7411. items:
  7412. $ref: '#/definitions/NotificationDetails'
  7413. type: array
  7414. x-go-name: Output
  7415. offset:
  7416. format: int64
  7417. type: integer
  7418. x-go-name: Offset
  7419. total:
  7420. format: int64
  7421. type: integer
  7422. x-go-name: Total
  7423. type: object
  7424. notification_PerformContactNotifyOutput:
  7425. description: ""
  7426. schema:
  7427. properties:
  7428. notification:
  7429. $ref: '#/definitions/NotificationManagerEventNotifyOutput'
  7430. type: object
  7431. notification_PerformEventNotifyOutput:
  7432. description: ""
  7433. schema:
  7434. properties:
  7435. notification:
  7436. $ref: '#/definitions/NotificationManagerEventNotifyOutput'
  7437. type: object
  7438. notification_ValidateCreateDataOutput:
  7439. description: ""
  7440. schema:
  7441. properties:
  7442. notification:
  7443. $ref: '#/definitions/NotificationDetails'
  7444. type: object
  7445. notification_ValidateUpdateDataOutput:
  7446. description: ""
  7447. schema:
  7448. properties:
  7449. notification:
  7450. $ref: '#/definitions/NotificationDetails'
  7451. type: object
  7452. notification_group_CustomizeDeleteOutput:
  7453. description: ""
  7454. schema:
  7455. properties:
  7456. notification_group:
  7457. $ref: '#/definitions/ModelBaseDetails'
  7458. type: object
  7459. notification_group_FetchCustomizeColumnsOutput:
  7460. description: ""
  7461. schema:
  7462. properties:
  7463. notification_group:
  7464. $ref: '#/definitions/ModelBaseDetails'
  7465. type: object
  7466. notification_group_ListItemFilterOutput:
  7467. description: ""
  7468. schema:
  7469. properties:
  7470. limit:
  7471. format: int64
  7472. type: integer
  7473. x-go-name: Limit
  7474. notification_groups:
  7475. items:
  7476. $ref: '#/definitions/ModelBaseDetails'
  7477. type: array
  7478. x-go-name: Output
  7479. offset:
  7480. format: int64
  7481. type: integer
  7482. x-go-name: Offset
  7483. total:
  7484. format: int64
  7485. type: integer
  7486. x-go-name: Total
  7487. type: object
  7488. notification_group_ValidateCreateDataOutput:
  7489. description: ""
  7490. schema:
  7491. properties:
  7492. notification_group:
  7493. $ref: '#/definitions/ModelBaseDetails'
  7494. type: object
  7495. notification_group_ValidateUpdateDataOutput:
  7496. description: ""
  7497. schema:
  7498. properties:
  7499. notification_group:
  7500. $ref: '#/definitions/ModelBaseDetails'
  7501. type: object
  7502. notification_log_CustomizeDeleteOutput:
  7503. description: ""
  7504. schema:
  7505. properties:
  7506. notification_log:
  7507. $ref: '#/definitions/ModelBaseDetails'
  7508. type: object
  7509. notification_log_FetchCustomizeColumnsOutput:
  7510. description: ""
  7511. schema:
  7512. properties:
  7513. notification_log:
  7514. $ref: '#/definitions/ModelBaseDetails'
  7515. type: object
  7516. notification_log_ListItemFilterOutput:
  7517. description: ""
  7518. schema:
  7519. properties:
  7520. limit:
  7521. format: int64
  7522. type: integer
  7523. x-go-name: Limit
  7524. notification_logs:
  7525. items:
  7526. $ref: '#/definitions/ModelBaseDetails'
  7527. type: array
  7528. x-go-name: Output
  7529. offset:
  7530. format: int64
  7531. type: integer
  7532. x-go-name: Offset
  7533. total:
  7534. format: int64
  7535. type: integer
  7536. x-go-name: Total
  7537. type: object
  7538. notification_log_ValidateCreateDataOutput:
  7539. description: ""
  7540. schema:
  7541. properties:
  7542. notification_log:
  7543. $ref: '#/definitions/ModelBaseDetails'
  7544. type: object
  7545. notification_log_ValidateUpdateDataOutput:
  7546. description: ""
  7547. schema:
  7548. properties:
  7549. notification_log:
  7550. $ref: '#/definitions/ModelBaseDetails'
  7551. type: object
  7552. receiver_CustomizeDeleteOutput:
  7553. description: ""
  7554. schema:
  7555. properties:
  7556. receiver:
  7557. $ref: '#/definitions/ReceiverDetails'
  7558. type: object
  7559. receiver_FetchCustomizeColumnsOutput:
  7560. description: ""
  7561. schema:
  7562. properties:
  7563. receiver:
  7564. $ref: '#/definitions/ReceiverDetails'
  7565. type: object
  7566. receiver_GetDetailsMetadataOutput:
  7567. description: ""
  7568. schema:
  7569. properties:
  7570. receiver:
  7571. additionalProperties:
  7572. type: string
  7573. type: object
  7574. x-go-name: Output
  7575. type: object
  7576. receiver_GetDetailsStatusOutput:
  7577. description: ""
  7578. schema:
  7579. properties:
  7580. receiver:
  7581. $ref: '#/definitions/GetDetailsStatusOutput'
  7582. type: object
  7583. receiver_GetPropertyRoleContactTypeOutput:
  7584. description: ""
  7585. receiver_ListItemFilterOutput:
  7586. description: ""
  7587. schema:
  7588. properties:
  7589. limit:
  7590. format: int64
  7591. type: integer
  7592. x-go-name: Limit
  7593. offset:
  7594. format: int64
  7595. type: integer
  7596. x-go-name: Offset
  7597. receivers:
  7598. items:
  7599. $ref: '#/definitions/ReceiverDetails'
  7600. type: array
  7601. x-go-name: Output
  7602. total:
  7603. format: int64
  7604. type: integer
  7605. x-go-name: Total
  7606. type: object
  7607. receiver_PerformChangeOwnerOutput:
  7608. description: ""
  7609. receiver_PerformDisableOutput:
  7610. description: ""
  7611. receiver_PerformEnableContactTypeOutput:
  7612. description: ""
  7613. receiver_PerformEnableOutput:
  7614. description: ""
  7615. receiver_PerformGetSubscriptionOutput:
  7616. description: ""
  7617. receiver_PerformGetTypesOutput:
  7618. description: ""
  7619. schema:
  7620. properties:
  7621. receiver:
  7622. $ref: '#/definitions/ConfigManagerGetTypesOutput'
  7623. type: object
  7624. receiver_PerformIntellijGetOutput:
  7625. description: ""
  7626. receiver_PerformTriggerVerifyOutput:
  7627. description: ""
  7628. receiver_PerformVerifyOutput:
  7629. description: ""
  7630. receiver_ValidateCreateDataOutput:
  7631. description: ""
  7632. schema:
  7633. properties:
  7634. receiver:
  7635. $ref: '#/definitions/ReceiverDetails'
  7636. type: object
  7637. receiver_ValidateUpdateDataOutput:
  7638. description: ""
  7639. schema:
  7640. properties:
  7641. receiver:
  7642. $ref: '#/definitions/ReceiverDetails'
  7643. type: object
  7644. robot_CustomizeDeleteOutput:
  7645. description: ""
  7646. schema:
  7647. properties:
  7648. robot:
  7649. $ref: '#/definitions/RobotDetails'
  7650. type: object
  7651. robot_FetchCustomizeColumnsOutput:
  7652. description: ""
  7653. schema:
  7654. properties:
  7655. robot:
  7656. $ref: '#/definitions/RobotDetails'
  7657. type: object
  7658. robot_GetDetailsMetadataOutput:
  7659. description: ""
  7660. schema:
  7661. properties:
  7662. robot:
  7663. additionalProperties:
  7664. type: string
  7665. type: object
  7666. x-go-name: Output
  7667. type: object
  7668. robot_GetDetailsStatusOutput:
  7669. description: ""
  7670. schema:
  7671. properties:
  7672. robot:
  7673. $ref: '#/definitions/GetDetailsStatusOutput'
  7674. type: object
  7675. robot_ListItemFilterOutput:
  7676. description: ""
  7677. schema:
  7678. properties:
  7679. limit:
  7680. format: int64
  7681. type: integer
  7682. x-go-name: Limit
  7683. offset:
  7684. format: int64
  7685. type: integer
  7686. x-go-name: Offset
  7687. robots:
  7688. items:
  7689. $ref: '#/definitions/RobotDetails'
  7690. type: array
  7691. x-go-name: Output
  7692. total:
  7693. format: int64
  7694. type: integer
  7695. x-go-name: Total
  7696. type: object
  7697. robot_PerformChangeOwnerOutput:
  7698. description: ""
  7699. robot_PerformDisableOutput:
  7700. description: ""
  7701. robot_PerformEnableOutput:
  7702. description: ""
  7703. robot_PerformPrivateOutput:
  7704. description: ""
  7705. robot_PerformPublicOutput:
  7706. description: ""
  7707. robot_ValidateCreateDataOutput:
  7708. description: ""
  7709. schema:
  7710. properties:
  7711. robot:
  7712. $ref: '#/definitions/RobotDetails'
  7713. type: object
  7714. robot_ValidateUpdateDataOutput:
  7715. description: ""
  7716. schema:
  7717. properties:
  7718. robot:
  7719. $ref: '#/definitions/RobotDetails'
  7720. type: object
  7721. subscriber_CustomizeDeleteOutput:
  7722. description: ""
  7723. schema:
  7724. properties:
  7725. subscriber:
  7726. $ref: '#/definitions/SubscriberDetails'
  7727. type: object
  7728. subscriber_FetchCustomizeColumnsOutput:
  7729. description: ""
  7730. schema:
  7731. properties:
  7732. subscriber:
  7733. $ref: '#/definitions/SubscriberDetails'
  7734. type: object
  7735. subscriber_GetDetailsMetadataOutput:
  7736. description: ""
  7737. schema:
  7738. properties:
  7739. subscriber:
  7740. additionalProperties:
  7741. type: string
  7742. type: object
  7743. x-go-name: Output
  7744. type: object
  7745. subscriber_ListItemFilterOutput:
  7746. description: ""
  7747. schema:
  7748. properties:
  7749. limit:
  7750. format: int64
  7751. type: integer
  7752. x-go-name: Limit
  7753. offset:
  7754. format: int64
  7755. type: integer
  7756. x-go-name: Offset
  7757. subscribers:
  7758. items:
  7759. $ref: '#/definitions/SubscriberDetails'
  7760. type: array
  7761. x-go-name: Output
  7762. total:
  7763. format: int64
  7764. type: integer
  7765. x-go-name: Total
  7766. type: object
  7767. subscriber_PerformChangeOutput:
  7768. description: ""
  7769. subscriber_PerformDisableOutput:
  7770. description: ""
  7771. subscriber_PerformEnableOutput:
  7772. description: ""
  7773. subscriber_PerformSetReceiverOutput:
  7774. description: ""
  7775. subscriber_ValidateCreateDataOutput:
  7776. description: ""
  7777. schema:
  7778. properties:
  7779. subscriber:
  7780. $ref: '#/definitions/SubscriberDetails'
  7781. type: object
  7782. subscriber_ValidateUpdateDataOutput:
  7783. description: ""
  7784. schema:
  7785. properties:
  7786. subscriber:
  7787. $ref: '#/definitions/SubscriberDetails'
  7788. type: object
  7789. subscriber_receiver_CustomizeDeleteOutput:
  7790. description: ""
  7791. schema:
  7792. properties:
  7793. subscriber_receiver:
  7794. $ref: '#/definitions/JointResourceBaseDetails'
  7795. type: object
  7796. subscriber_receiver_FetchCustomizeColumnsOutput:
  7797. description: ""
  7798. schema:
  7799. properties:
  7800. subscriber_receiver:
  7801. $ref: '#/definitions/JointResourceBaseDetails'
  7802. type: object
  7803. subscriber_receiver_ListItemFilterOutput:
  7804. description: ""
  7805. schema:
  7806. properties:
  7807. limit:
  7808. format: int64
  7809. type: integer
  7810. x-go-name: Limit
  7811. offset:
  7812. format: int64
  7813. type: integer
  7814. x-go-name: Offset
  7815. subscriber_receivers:
  7816. items:
  7817. $ref: '#/definitions/JointResourceBaseDetails'
  7818. type: array
  7819. x-go-name: Output
  7820. total:
  7821. format: int64
  7822. type: integer
  7823. x-go-name: Total
  7824. type: object
  7825. subscriber_receiver_ValidateCreateDataOutput:
  7826. description: ""
  7827. schema:
  7828. properties:
  7829. subscriber_receiver:
  7830. $ref: '#/definitions/JointResourceBaseDetails'
  7831. type: object
  7832. subscriber_receiver_ValidateUpdateDataOutput:
  7833. description: ""
  7834. schema:
  7835. properties:
  7836. subscriber_receiver:
  7837. $ref: '#/definitions/JointResourceBaseDetails'
  7838. type: object
  7839. template_CustomizeDeleteOutput:
  7840. description: ""
  7841. schema:
  7842. properties:
  7843. template:
  7844. $ref: '#/definitions/StandaloneAnonResourceDetails'
  7845. type: object
  7846. template_FetchCustomizeColumnsOutput:
  7847. description: ""
  7848. schema:
  7849. properties:
  7850. template:
  7851. $ref: '#/definitions/StandaloneAnonResourceDetails'
  7852. type: object
  7853. template_GetDetailsMetadataOutput:
  7854. description: ""
  7855. schema:
  7856. properties:
  7857. template:
  7858. additionalProperties:
  7859. type: string
  7860. type: object
  7861. x-go-name: Output
  7862. type: object
  7863. template_ListItemFilterOutput:
  7864. description: ""
  7865. schema:
  7866. properties:
  7867. limit:
  7868. format: int64
  7869. type: integer
  7870. x-go-name: Limit
  7871. offset:
  7872. format: int64
  7873. type: integer
  7874. x-go-name: Offset
  7875. templates:
  7876. items:
  7877. $ref: '#/definitions/StandaloneAnonResourceDetails'
  7878. type: array
  7879. x-go-name: Output
  7880. total:
  7881. format: int64
  7882. type: integer
  7883. x-go-name: Total
  7884. type: object
  7885. template_PerformSaveOutput:
  7886. description: ""
  7887. template_ValidateCreateDataOutput:
  7888. description: ""
  7889. schema:
  7890. properties:
  7891. template:
  7892. $ref: '#/definitions/StandaloneAnonResourceDetails'
  7893. type: object
  7894. template_ValidateUpdateDataOutput:
  7895. description: ""
  7896. schema:
  7897. properties:
  7898. template:
  7899. $ref: '#/definitions/StandaloneAnonResourceDetails'
  7900. type: object
  7901. topic_CustomizeDeleteOutput:
  7902. description: ""
  7903. schema:
  7904. properties:
  7905. topic:
  7906. $ref: '#/definitions/TopicDetails'
  7907. type: object
  7908. topic_FetchCustomizeColumnsOutput:
  7909. description: ""
  7910. schema:
  7911. properties:
  7912. topic:
  7913. $ref: '#/definitions/TopicDetails'
  7914. type: object
  7915. topic_GetDetailsMetadataOutput:
  7916. description: ""
  7917. schema:
  7918. properties:
  7919. topic:
  7920. additionalProperties:
  7921. type: string
  7922. type: object
  7923. x-go-name: Output
  7924. type: object
  7925. topic_GetDetailsStatusOutput:
  7926. description: ""
  7927. schema:
  7928. properties:
  7929. topic:
  7930. $ref: '#/definitions/GetDetailsStatusOutput'
  7931. type: object
  7932. topic_ListItemFilterOutput:
  7933. description: ""
  7934. schema:
  7935. properties:
  7936. limit:
  7937. format: int64
  7938. type: integer
  7939. x-go-name: Limit
  7940. offset:
  7941. format: int64
  7942. type: integer
  7943. x-go-name: Offset
  7944. topics:
  7945. items:
  7946. $ref: '#/definitions/TopicDetails'
  7947. type: array
  7948. x-go-name: Output
  7949. total:
  7950. format: int64
  7951. type: integer
  7952. x-go-name: Total
  7953. type: object
  7954. topic_PerformDisableOutput:
  7955. description: ""
  7956. topic_PerformEnableOutput:
  7957. description: ""
  7958. topic_ValidateCreateDataOutput:
  7959. description: ""
  7960. schema:
  7961. properties:
  7962. topic:
  7963. $ref: '#/definitions/TopicDetails'
  7964. type: object
  7965. topic_ValidateUpdateDataOutput:
  7966. description: ""
  7967. schema:
  7968. properties:
  7969. topic:
  7970. $ref: '#/definitions/TopicDetails'
  7971. type: object
  7972. topic_action_CustomizeDeleteOutput:
  7973. description: ""
  7974. schema:
  7975. properties:
  7976. topic_action:
  7977. $ref: '#/definitions/ResourceBaseDetails'
  7978. type: object
  7979. topic_action_FetchCustomizeColumnsOutput:
  7980. description: ""
  7981. schema:
  7982. properties:
  7983. topic_action:
  7984. $ref: '#/definitions/ResourceBaseDetails'
  7985. type: object
  7986. topic_action_ListItemFilterOutput:
  7987. description: ""
  7988. schema:
  7989. properties:
  7990. limit:
  7991. format: int64
  7992. type: integer
  7993. x-go-name: Limit
  7994. offset:
  7995. format: int64
  7996. type: integer
  7997. x-go-name: Offset
  7998. topic_actions:
  7999. items:
  8000. $ref: '#/definitions/ResourceBaseDetails'
  8001. type: array
  8002. x-go-name: Output
  8003. total:
  8004. format: int64
  8005. type: integer
  8006. x-go-name: Total
  8007. type: object
  8008. topic_action_ValidateCreateDataOutput:
  8009. description: ""
  8010. schema:
  8011. properties:
  8012. topic_action:
  8013. $ref: '#/definitions/ResourceBaseDetails'
  8014. type: object
  8015. topic_action_ValidateUpdateDataOutput:
  8016. description: ""
  8017. schema:
  8018. properties:
  8019. topic_action:
  8020. $ref: '#/definitions/ResourceBaseDetails'
  8021. type: object
  8022. topic_resource_CustomizeDeleteOutput:
  8023. description: ""
  8024. schema:
  8025. properties:
  8026. topic_resource:
  8027. $ref: '#/definitions/ResourceBaseDetails'
  8028. type: object
  8029. topic_resource_FetchCustomizeColumnsOutput:
  8030. description: ""
  8031. schema:
  8032. properties:
  8033. topic_resource:
  8034. $ref: '#/definitions/ResourceBaseDetails'
  8035. type: object
  8036. topic_resource_ListItemFilterOutput:
  8037. description: ""
  8038. schema:
  8039. properties:
  8040. limit:
  8041. format: int64
  8042. type: integer
  8043. x-go-name: Limit
  8044. offset:
  8045. format: int64
  8046. type: integer
  8047. x-go-name: Offset
  8048. topic_resources:
  8049. items:
  8050. $ref: '#/definitions/ResourceBaseDetails'
  8051. type: array
  8052. x-go-name: Output
  8053. total:
  8054. format: int64
  8055. type: integer
  8056. x-go-name: Total
  8057. type: object
  8058. topic_resource_ValidateCreateDataOutput:
  8059. description: ""
  8060. schema:
  8061. properties:
  8062. topic_resource:
  8063. $ref: '#/definitions/ResourceBaseDetails'
  8064. type: object
  8065. topic_resource_ValidateUpdateDataOutput:
  8066. description: ""
  8067. schema:
  8068. properties:
  8069. topic_resource:
  8070. $ref: '#/definitions/ResourceBaseDetails'
  8071. type: object
  8072. schemes:
  8073. - https
  8074. - http
  8075. securityDefinitions:
  8076. keystone:
  8077. in: header
  8078. name: X-Auth-Token
  8079. type: apiKey
  8080. swagger: "2.0"