swagger_monitor.yaml 490 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426
  1. basePath: /
  2. consumes:
  3. - application/json
  4. definitions:
  5. AlertCloneDashboardInput:
  6. properties:
  7. clone_name:
  8. type: string
  9. x-go-name: CloneName
  10. type: object
  11. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  12. AlertClonePanelInput:
  13. properties:
  14. clone_panel_name:
  15. type: string
  16. x-go-name: ClonePanelName
  17. panel_id:
  18. type: string
  19. x-go-name: PanelId
  20. type: object
  21. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  22. AlertCondition:
  23. properties:
  24. evaluator:
  25. $ref: '#/definitions/Condition'
  26. operator:
  27. type: string
  28. x-go-name: Operator
  29. query:
  30. $ref: '#/definitions/AlertQuery'
  31. reducer:
  32. $ref: '#/definitions/Condition'
  33. reducer_order:
  34. $ref: '#/definitions/ResultReducerOrder'
  35. type:
  36. type: string
  37. x-go-name: Type
  38. type: object
  39. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  40. AlertCreateInput:
  41. properties:
  42. customize_config:
  43. description: customize info
  44. type: object
  45. x-go-name: CustomizeConfig
  46. enabled:
  47. description: 启用报警
  48. type: boolean
  49. x-go-name: Enabled
  50. execution_error_state:
  51. description: 报警执行错误将当前报警状态设置为对应的状态
  52. type: string
  53. x-go-name: ExecutionErrorState
  54. for:
  55. description: 报警持续时间
  56. format: int64
  57. type: integer
  58. x-go-name: For
  59. frequency:
  60. description: 报警执行频率
  61. format: int64
  62. type: integer
  63. x-go-name: Frequency
  64. level:
  65. description: 报警级别
  66. type: string
  67. x-go-name: Level
  68. name:
  69. description: 报警名称
  70. type: string
  71. x-go-name: Name
  72. no_data_state:
  73. description: 没有收到监控指标时将当前报警状态设置为对应的状态
  74. type: string
  75. x-go-name: NoDataState
  76. reason:
  77. type: string
  78. x-go-name: Reason
  79. settings:
  80. $ref: '#/definitions/AlertSetting'
  81. used_by:
  82. type: string
  83. x-go-name: UsedBy
  84. type: object
  85. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  86. AlertDashBoardCreateInput:
  87. properties:
  88. __meta__:
  89. additionalProperties:
  90. type: string
  91. description: 标签列表,最多支持20个
  92. example:
  93. user:rd: op
  94. type: object
  95. x-go-name: Metadata
  96. description:
  97. description: 资源描述
  98. example: test create network
  99. type: string
  100. x-go-name: Description
  101. dry_run:
  102. default: false
  103. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  104. type: boolean
  105. x-go-name: DryRun
  106. generate_name:
  107. description: |-
  108. 生成资源名称的模板,如果name为空,则为必填项
  109. description: generated resource name, given a pattern to generate name, required if name is not given
  110. example: test###
  111. type: string
  112. x-go-name: GenerateName
  113. is_emulated:
  114. description: |-
  115. 资源是否为模拟资源
  116. description: the resource is an emulated resource
  117. type: boolean
  118. x-go-name: IsEmulated
  119. name:
  120. description: |-
  121. 资源名称,如果generate_name为空,则为必填项
  122. description: resource name, required if generated_name is not given
  123. example: test-network
  124. type: string
  125. uniqueItems: true
  126. x-go-name: Name
  127. project_domain_id:
  128. description: 指定项目归属域名称或ID
  129. type: string
  130. x-go-name: ProjectDomainId
  131. project_id:
  132. description: 指定项目的名称或ID
  133. type: string
  134. x-go-name: ProjectId
  135. refresh:
  136. type: string
  137. x-go-name: Refresh
  138. scope:
  139. type: string
  140. x-go-name: Scope
  141. required:
  142. - name
  143. type: object
  144. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  145. AlertDashBoardDetails:
  146. properties:
  147. alert_panel_details:
  148. items:
  149. $ref: '#/definitions/AlertPanelDetail'
  150. type: array
  151. x-go-name: AlertPanelDetails
  152. can_delete:
  153. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  154. example: true
  155. type: boolean
  156. x-go-name: CanDelete
  157. can_update:
  158. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  159. example: true
  160. type: boolean
  161. x-go-name: CanUpdate
  162. created_at:
  163. description: 资源创建时间
  164. format: date-time
  165. type: string
  166. x-go-name: CreatedAt
  167. customize_config:
  168. type: object
  169. x-go-name: CustomizeConfig
  170. delete_fail_reason:
  171. $ref: '#/definitions/Error'
  172. deleted:
  173. description: 资源是否被删除
  174. type: boolean
  175. x-go-name: Deleted
  176. deleted_at:
  177. description: 资源删除时间
  178. format: date-time
  179. type: string
  180. x-go-name: DeletedAt
  181. description:
  182. description: 资源描述信息
  183. type: string
  184. x-go-name: Description
  185. domain_id:
  186. description: 域Id
  187. type: string
  188. x-go-name: DomainId
  189. enabled:
  190. description: 资源是否启用
  191. type: boolean
  192. x-go-name: Enabled
  193. eval_data:
  194. type: object
  195. x-go-name: EvalData
  196. execution_error:
  197. description: Silenced bool
  198. type: string
  199. x-go-name: ExecutionError
  200. execution_error_state:
  201. type: string
  202. x-go-name: ExecutionErrorState
  203. for:
  204. description: |-
  205. If an alert rule has a configured `For` and the query violates the configured threshold
  206. it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
  207. notifications. Once the alert rule has been firing for more than `For` duration, it will
  208. change to `Alerting` and send alert notifications.
  209. format: int64
  210. type: integer
  211. x-go-name: For
  212. frequency:
  213. description: Frequency is evaluate period
  214. format: int64
  215. type: integer
  216. x-go-name: Frequency
  217. id:
  218. description: 资源UUID
  219. type: string
  220. x-go-name: Id
  221. is_emulated:
  222. description: |-
  223. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  224. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  225. type: boolean
  226. x-go-name: IsEmulated
  227. last_state_change:
  228. format: date-time
  229. type: string
  230. x-go-name: LastStateChange
  231. level:
  232. type: string
  233. x-go-name: Level
  234. message:
  235. type: string
  236. x-go-name: Message
  237. metadata:
  238. additionalProperties:
  239. type: string
  240. description: 标签
  241. type: object
  242. x-go-name: Metadata
  243. name:
  244. description: 资源名称
  245. type: string
  246. x-go-name: Name
  247. no_data_state:
  248. type: string
  249. x-go-name: NoDataState
  250. org_node_md5:
  251. description: 用以组织架构变更通知其他服务权限变更
  252. type: string
  253. x-go-name: OrgNodeMd5
  254. progress:
  255. description: 操作进度0-100
  256. format: float
  257. type: number
  258. x-go-name: Progress
  259. project:
  260. description: |-
  261. 资源归属项目的名称(向后兼容别名)
  262. Deprecated
  263. type: string
  264. x-go-name: Tenant
  265. project_domain:
  266. description: 资源归属项目的域名称
  267. type: string
  268. x-go-name: ProjectDomain
  269. project_id:
  270. description: |-
  271. 资源归属项目的ID(向后兼容别名)
  272. Deprecated
  273. type: string
  274. x-go-name: TenantId
  275. project_metadata:
  276. additionalProperties:
  277. type: string
  278. type: object
  279. x-go-name: ProjectMetadata
  280. res_type:
  281. type: string
  282. x-go-name: ResType
  283. scope:
  284. type: string
  285. x-go-name: Scope
  286. settings:
  287. $ref: '#/definitions/AlertSetting'
  288. state:
  289. type: string
  290. x-go-name: State
  291. state_changes:
  292. format: int64
  293. type: integer
  294. x-go-name: StateChanges
  295. status:
  296. description: 资源状态
  297. type: string
  298. x-go-name: Status
  299. tenant:
  300. description: |-
  301. 资源归属项目的名称
  302. alias:project
  303. type: string
  304. x-go-name: Project
  305. tenant_id:
  306. description: 项目Id
  307. type: string
  308. x-go-name: ProjectId
  309. update_fail_reason:
  310. $ref: '#/definitions/Error'
  311. update_version:
  312. description: 资源被更新次数
  313. format: int64
  314. type: integer
  315. x-go-name: UpdateVersion
  316. updated_at:
  317. description: 资源更新时间
  318. format: date-time
  319. type: string
  320. x-go-name: UpdatedAt
  321. used_by:
  322. type: string
  323. x-go-name: UsedBy
  324. type: object
  325. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  326. AlertDetails:
  327. properties:
  328. can_delete:
  329. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  330. example: true
  331. type: boolean
  332. x-go-name: CanDelete
  333. can_update:
  334. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  335. example: true
  336. type: boolean
  337. x-go-name: CanUpdate
  338. created_at:
  339. description: 资源创建时间
  340. format: date-time
  341. type: string
  342. x-go-name: CreatedAt
  343. customize_config:
  344. type: object
  345. x-go-name: CustomizeConfig
  346. delete_fail_reason:
  347. $ref: '#/definitions/Error'
  348. deleted:
  349. description: 资源是否被删除
  350. type: boolean
  351. x-go-name: Deleted
  352. deleted_at:
  353. description: 资源删除时间
  354. format: date-time
  355. type: string
  356. x-go-name: DeletedAt
  357. description:
  358. description: 资源描述信息
  359. type: string
  360. x-go-name: Description
  361. domain_id:
  362. description: 域Id
  363. type: string
  364. x-go-name: DomainId
  365. enabled:
  366. description: 资源是否启用
  367. type: boolean
  368. x-go-name: Enabled
  369. eval_data:
  370. type: object
  371. x-go-name: EvalData
  372. execution_error:
  373. description: Silenced bool
  374. type: string
  375. x-go-name: ExecutionError
  376. execution_error_state:
  377. type: string
  378. x-go-name: ExecutionErrorState
  379. for:
  380. description: |-
  381. If an alert rule has a configured `For` and the query violates the configured threshold
  382. it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
  383. notifications. Once the alert rule has been firing for more than `For` duration, it will
  384. change to `Alerting` and send alert notifications.
  385. format: int64
  386. type: integer
  387. x-go-name: For
  388. frequency:
  389. description: Frequency is evaluate period
  390. format: int64
  391. type: integer
  392. x-go-name: Frequency
  393. id:
  394. description: 资源UUID
  395. type: string
  396. x-go-name: Id
  397. is_emulated:
  398. description: |-
  399. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  400. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  401. type: boolean
  402. x-go-name: IsEmulated
  403. last_state_change:
  404. format: date-time
  405. type: string
  406. x-go-name: LastStateChange
  407. level:
  408. type: string
  409. x-go-name: Level
  410. message:
  411. type: string
  412. x-go-name: Message
  413. metadata:
  414. additionalProperties:
  415. type: string
  416. description: 标签
  417. type: object
  418. x-go-name: Metadata
  419. name:
  420. description: 资源名称
  421. type: string
  422. x-go-name: Name
  423. no_data_state:
  424. type: string
  425. x-go-name: NoDataState
  426. org_node_md5:
  427. description: 用以组织架构变更通知其他服务权限变更
  428. type: string
  429. x-go-name: OrgNodeMd5
  430. progress:
  431. description: 操作进度0-100
  432. format: float
  433. type: number
  434. x-go-name: Progress
  435. project:
  436. description: |-
  437. 资源归属项目的名称(向后兼容别名)
  438. Deprecated
  439. type: string
  440. x-go-name: Tenant
  441. project_domain:
  442. description: 资源归属项目的域名称
  443. type: string
  444. x-go-name: ProjectDomain
  445. project_id:
  446. description: |-
  447. 资源归属项目的ID(向后兼容别名)
  448. Deprecated
  449. type: string
  450. x-go-name: TenantId
  451. project_metadata:
  452. additionalProperties:
  453. type: string
  454. type: object
  455. x-go-name: ProjectMetadata
  456. res_type:
  457. type: string
  458. x-go-name: ResType
  459. scope:
  460. type: string
  461. x-go-name: Scope
  462. settings:
  463. $ref: '#/definitions/AlertSetting'
  464. state:
  465. type: string
  466. x-go-name: State
  467. state_changes:
  468. format: int64
  469. type: integer
  470. x-go-name: StateChanges
  471. status:
  472. description: 资源状态
  473. type: string
  474. x-go-name: Status
  475. tenant:
  476. description: |-
  477. 资源归属项目的名称
  478. alias:project
  479. type: string
  480. x-go-name: Project
  481. tenant_id:
  482. description: 项目Id
  483. type: string
  484. x-go-name: ProjectId
  485. update_fail_reason:
  486. $ref: '#/definitions/Error'
  487. update_version:
  488. description: 资源被更新次数
  489. format: int64
  490. type: integer
  491. x-go-name: UpdateVersion
  492. updated_at:
  493. description: 资源更新时间
  494. format: date-time
  495. type: string
  496. x-go-name: UpdatedAt
  497. used_by:
  498. type: string
  499. x-go-name: UsedBy
  500. type: object
  501. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  502. AlertPanelCreateInput:
  503. properties:
  504. customize_config:
  505. description: customize info
  506. type: object
  507. x-go-name: CustomizeConfig
  508. dashboard_id:
  509. type: string
  510. x-go-name: DashboardId
  511. domain_tags:
  512. $ref: '#/definitions/TTagSetList'
  513. enabled:
  514. description: 启用报警
  515. type: boolean
  516. x-go-name: Enabled
  517. execution_error_state:
  518. description: 报警执行错误将当前报警状态设置为对应的状态
  519. type: string
  520. x-go-name: ExecutionErrorState
  521. for:
  522. description: 报警持续时间
  523. format: int64
  524. type: integer
  525. x-go-name: For
  526. frequency:
  527. description: 报警执行频率
  528. format: int64
  529. type: integer
  530. x-go-name: Frequency
  531. from:
  532. type: string
  533. x-go-name: From
  534. interval:
  535. type: string
  536. x-go-name: Interval
  537. level:
  538. description: 报警级别
  539. type: string
  540. x-go-name: Level
  541. metric_query:
  542. items:
  543. $ref: '#/definitions/CommonAlertQuery'
  544. type: array
  545. x-go-name: MetricQuery
  546. name:
  547. description: 报警名称
  548. type: string
  549. x-go-name: Name
  550. no_data_state:
  551. description: 没有收到监控指标时将当前报警状态设置为对应的状态
  552. type: string
  553. x-go-name: NoDataState
  554. no_domain_tags:
  555. $ref: '#/definitions/TTagSetList'
  556. no_project_tags:
  557. $ref: '#/definitions/TTagSetList'
  558. order_by_domain:
  559. description: 按domain名称排序,可能值为asc|desc
  560. pattern: asc|desc
  561. type: string
  562. x-go-name: OrderByDomain
  563. order_by_project:
  564. description: 按project名称排序,可能值为asc|desc
  565. pattern: asc|desc
  566. type: string
  567. x-go-name: OrderByProject
  568. policy_project_tags:
  569. $ref: '#/definitions/TTagSetList'
  570. project_domain_id:
  571. description: 指定项目归属域名称或ID
  572. type: string
  573. x-go-name: ProjectDomainId
  574. project_domain_ids:
  575. description: 对具有域属性的资源,严格匹配域ID
  576. items:
  577. type: string
  578. type: array
  579. x-go-name: ProjectDomainIds
  580. project_id:
  581. description: 指定项目的名称或ID
  582. type: string
  583. x-go-name: ProjectId
  584. project_ids:
  585. description: 对具有项目属性的资源,严格匹配项目ID
  586. items:
  587. type: string
  588. type: array
  589. x-go-name: ProjectIds
  590. project_organizations:
  591. description: filter by project organizations
  592. items:
  593. type: string
  594. type: array
  595. x-go-name: ProjectOrganizations
  596. project_tags:
  597. $ref: '#/definitions/TTagSetList'
  598. reason:
  599. type: string
  600. x-go-name: Reason
  601. refresh:
  602. type: string
  603. x-go-name: Refresh
  604. scope:
  605. description: 指定查询的权限范围,可能值为project, domain or system
  606. type: string
  607. x-go-name: Scope
  608. settings:
  609. $ref: '#/definitions/AlertSetting'
  610. to:
  611. type: string
  612. x-go-name: To
  613. used_by:
  614. type: string
  615. x-go-name: UsedBy
  616. type: object
  617. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  618. AlertPanelDetail:
  619. properties:
  620. Setting:
  621. $ref: '#/definitions/AlertSetting'
  622. can_delete:
  623. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  624. example: true
  625. type: boolean
  626. x-go-name: CanDelete
  627. can_update:
  628. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  629. example: true
  630. type: boolean
  631. x-go-name: CanUpdate
  632. common_alert_metric_details:
  633. items:
  634. $ref: '#/definitions/CommonAlertMetricDetails'
  635. type: array
  636. x-go-name: CommonAlertMetricDetails
  637. created_at:
  638. description: 资源创建时间
  639. format: date-time
  640. type: string
  641. x-go-name: CreatedAt
  642. customize_config:
  643. type: object
  644. x-go-name: CustomizeConfig
  645. delete_fail_reason:
  646. $ref: '#/definitions/Error'
  647. deleted:
  648. description: 资源是否被删除
  649. type: boolean
  650. x-go-name: Deleted
  651. deleted_at:
  652. description: 资源删除时间
  653. format: date-time
  654. type: string
  655. x-go-name: DeletedAt
  656. description:
  657. description: 资源描述信息
  658. type: string
  659. x-go-name: Description
  660. domain_id:
  661. description: 域Id
  662. type: string
  663. x-go-name: DomainId
  664. enabled:
  665. description: 资源是否启用
  666. type: boolean
  667. x-go-name: Enabled
  668. eval_data:
  669. type: object
  670. x-go-name: EvalData
  671. execution_error:
  672. description: Silenced bool
  673. type: string
  674. x-go-name: ExecutionError
  675. execution_error_state:
  676. type: string
  677. x-go-name: ExecutionErrorState
  678. for:
  679. description: |-
  680. If an alert rule has a configured `For` and the query violates the configured threshold
  681. it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
  682. notifications. Once the alert rule has been firing for more than `For` duration, it will
  683. change to `Alerting` and send alert notifications.
  684. format: int64
  685. type: integer
  686. x-go-name: For
  687. frequency:
  688. description: Frequency is evaluate period
  689. format: int64
  690. type: integer
  691. x-go-name: Frequency
  692. id:
  693. description: 资源UUID
  694. type: string
  695. x-go-name: Id
  696. is_emulated:
  697. description: |-
  698. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  699. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  700. type: boolean
  701. x-go-name: IsEmulated
  702. last_state_change:
  703. format: date-time
  704. type: string
  705. x-go-name: LastStateChange
  706. level:
  707. type: string
  708. x-go-name: Level
  709. message:
  710. type: string
  711. x-go-name: Message
  712. metadata:
  713. additionalProperties:
  714. type: string
  715. description: 标签
  716. type: object
  717. x-go-name: Metadata
  718. name:
  719. description: 资源名称
  720. type: string
  721. x-go-name: Name
  722. no_data_state:
  723. type: string
  724. x-go-name: NoDataState
  725. org_node_md5:
  726. description: 用以组织架构变更通知其他服务权限变更
  727. type: string
  728. x-go-name: OrgNodeMd5
  729. panel_id:
  730. type: string
  731. x-go-name: PanelId
  732. panel_name:
  733. type: string
  734. x-go-name: PanelName
  735. progress:
  736. description: 操作进度0-100
  737. format: float
  738. type: number
  739. x-go-name: Progress
  740. project:
  741. description: |-
  742. 资源归属项目的名称(向后兼容别名)
  743. Deprecated
  744. type: string
  745. x-go-name: Tenant
  746. project_domain:
  747. description: 资源归属项目的域名称
  748. type: string
  749. x-go-name: ProjectDomain
  750. project_id:
  751. description: |-
  752. 资源归属项目的ID(向后兼容别名)
  753. Deprecated
  754. type: string
  755. x-go-name: TenantId
  756. project_metadata:
  757. additionalProperties:
  758. type: string
  759. type: object
  760. x-go-name: ProjectMetadata
  761. refresh:
  762. type: string
  763. x-go-name: Refresh
  764. res_type:
  765. type: string
  766. x-go-name: ResType
  767. scope:
  768. type: string
  769. x-go-name: Scope
  770. settings:
  771. $ref: '#/definitions/AlertSetting'
  772. state:
  773. type: string
  774. x-go-name: State
  775. state_changes:
  776. format: int64
  777. type: integer
  778. x-go-name: StateChanges
  779. status:
  780. description: 资源状态
  781. type: string
  782. x-go-name: Status
  783. tenant:
  784. description: |-
  785. 资源归属项目的名称
  786. alias:project
  787. type: string
  788. x-go-name: Project
  789. tenant_id:
  790. description: 项目Id
  791. type: string
  792. x-go-name: ProjectId
  793. update_fail_reason:
  794. $ref: '#/definitions/Error'
  795. update_version:
  796. description: 资源被更新次数
  797. format: int64
  798. type: integer
  799. x-go-name: UpdateVersion
  800. updated_at:
  801. description: 资源更新时间
  802. format: date-time
  803. type: string
  804. x-go-name: UpdatedAt
  805. used_by:
  806. type: string
  807. x-go-name: UsedBy
  808. type: object
  809. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  810. AlertPanelSetOrderInput:
  811. properties:
  812. order:
  813. items:
  814. properties:
  815. index:
  816. format: int64
  817. type: integer
  818. x-go-name: Index
  819. panel_id:
  820. type: string
  821. x-go-name: PanelId
  822. type: object
  823. type: array
  824. x-go-name: Order
  825. type: object
  826. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  827. AlertPauseInput:
  828. properties:
  829. paused:
  830. type: boolean
  831. x-go-name: Paused
  832. type: object
  833. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  834. AlertQuery:
  835. properties:
  836. from:
  837. type: string
  838. x-go-name: From
  839. model:
  840. $ref: '#/definitions/MetricQuery'
  841. result_reducer:
  842. $ref: '#/definitions/Condition'
  843. result_reducer_order:
  844. $ref: '#/definitions/ResultReducerOrder'
  845. to:
  846. type: string
  847. x-go-name: To
  848. type: object
  849. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  850. AlertRecordCreateInput:
  851. properties:
  852. __meta__:
  853. additionalProperties:
  854. type: string
  855. description: 标签列表,最多支持20个
  856. example:
  857. user:rd: op
  858. type: object
  859. x-go-name: Metadata
  860. alert_id:
  861. type: string
  862. x-go-name: AlertId
  863. alert_rule:
  864. items:
  865. $ref: '#/definitions/AlertRecordRule'
  866. type: array
  867. x-go-name: AlertRule
  868. description:
  869. description: 资源描述
  870. example: test create network
  871. type: string
  872. x-go-name: Description
  873. dry_run:
  874. default: false
  875. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  876. type: boolean
  877. x-go-name: DryRun
  878. eval_data:
  879. items:
  880. $ref: '#/definitions/EvalMatch'
  881. type: array
  882. x-go-name: EvalData
  883. generate_name:
  884. description: |-
  885. 生成资源名称的模板,如果name为空,则为必填项
  886. description: generated resource name, given a pattern to generate name, required if name is not given
  887. example: test###
  888. type: string
  889. x-go-name: GenerateName
  890. is_emulated:
  891. description: |-
  892. 资源是否为模拟资源
  893. description: the resource is an emulated resource
  894. type: boolean
  895. x-go-name: IsEmulated
  896. level:
  897. description: 报警级别
  898. type: string
  899. x-go-name: Level
  900. name:
  901. description: |-
  902. 资源名称,如果generate_name为空,则为必填项
  903. description: resource name, required if generated_name is not given
  904. example: test-network
  905. type: string
  906. uniqueItems: true
  907. x-go-name: Name
  908. res_type:
  909. type: string
  910. x-go-name: ResType
  911. send_state:
  912. type: string
  913. x-go-name: SendState
  914. state:
  915. type: string
  916. x-go-name: State
  917. required:
  918. - name
  919. type: object
  920. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  921. AlertRecordDetails:
  922. properties:
  923. alert_id:
  924. type: string
  925. x-go-name: AlertId
  926. alert_name:
  927. type: string
  928. x-go-name: AlertName
  929. alert_rule:
  930. type: object
  931. x-go-name: AlertRule
  932. can_delete:
  933. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  934. example: true
  935. type: boolean
  936. x-go-name: CanDelete
  937. can_update:
  938. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  939. example: true
  940. type: boolean
  941. x-go-name: CanUpdate
  942. created_at:
  943. description: 资源创建时间
  944. format: date-time
  945. type: string
  946. x-go-name: CreatedAt
  947. delete_fail_reason:
  948. $ref: '#/definitions/Error'
  949. deleted:
  950. description: 资源是否被删除
  951. type: boolean
  952. x-go-name: Deleted
  953. deleted_at:
  954. description: 资源删除时间
  955. format: date-time
  956. type: string
  957. x-go-name: DeletedAt
  958. description:
  959. description: 资源描述信息
  960. type: string
  961. x-go-name: Description
  962. domain_id:
  963. description: 域Id
  964. type: string
  965. x-go-name: DomainId
  966. enabled:
  967. description: 资源是否启用
  968. type: boolean
  969. x-go-name: Enabled
  970. eval_data:
  971. type: object
  972. x-go-name: EvalData
  973. id:
  974. description: 资源UUID
  975. type: string
  976. x-go-name: Id
  977. is_emulated:
  978. description: |-
  979. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  980. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  981. type: boolean
  982. x-go-name: IsEmulated
  983. level:
  984. type: string
  985. x-go-name: Level
  986. metadata:
  987. additionalProperties:
  988. type: string
  989. description: 标签
  990. type: object
  991. x-go-name: Metadata
  992. org_node_md5:
  993. description: 用以组织架构变更通知其他服务权限变更
  994. type: string
  995. x-go-name: OrgNodeMd5
  996. project:
  997. description: |-
  998. 资源归属项目的名称(向后兼容别名)
  999. Deprecated
  1000. type: string
  1001. x-go-name: Tenant
  1002. project_domain:
  1003. description: 资源归属项目的域名称
  1004. type: string
  1005. x-go-name: ProjectDomain
  1006. project_id:
  1007. description: |-
  1008. 资源归属项目的ID(向后兼容别名)
  1009. Deprecated
  1010. type: string
  1011. x-go-name: TenantId
  1012. project_metadata:
  1013. additionalProperties:
  1014. type: string
  1015. type: object
  1016. x-go-name: ProjectMetadata
  1017. res_ids:
  1018. type: string
  1019. x-go-name: ResIds
  1020. res_num:
  1021. format: int64
  1022. type: integer
  1023. x-go-name: ResNum
  1024. res_type:
  1025. type: string
  1026. x-go-name: ResType
  1027. scope:
  1028. type: string
  1029. x-go-name: Scope
  1030. send_state:
  1031. type: string
  1032. x-go-name: SendState
  1033. state:
  1034. type: string
  1035. x-go-name: State
  1036. tenant:
  1037. description: |-
  1038. 资源归属项目的名称
  1039. alias:project
  1040. type: string
  1041. x-go-name: Project
  1042. tenant_id:
  1043. description: 项目Id
  1044. type: string
  1045. x-go-name: ProjectId
  1046. trigger_time:
  1047. format: date-time
  1048. type: string
  1049. x-go-name: TriggerTime
  1050. update_fail_reason:
  1051. $ref: '#/definitions/Error'
  1052. update_version:
  1053. description: 资源被更新次数
  1054. format: int64
  1055. type: integer
  1056. x-go-name: UpdateVersion
  1057. updated_at:
  1058. description: 资源更新时间
  1059. format: date-time
  1060. type: string
  1061. x-go-name: UpdatedAt
  1062. type: object
  1063. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1064. AlertRecordHistoryAlert:
  1065. properties:
  1066. data:
  1067. items:
  1068. $ref: '#/definitions/AlertRecordHistoryAlertData'
  1069. type: array
  1070. x-go-name: Data
  1071. type: object
  1072. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1073. AlertRecordHistoryAlertData:
  1074. properties:
  1075. domain:
  1076. type: string
  1077. x-go-name: Domain
  1078. domain_id:
  1079. type: string
  1080. x-go-name: DomainId
  1081. project:
  1082. type: string
  1083. x-go-name: Project
  1084. project_id:
  1085. type: string
  1086. x-go-name: ProjectId
  1087. res_num:
  1088. format: int64
  1089. type: integer
  1090. x-go-name: ResNum
  1091. res_type:
  1092. type: string
  1093. x-go-name: ResType
  1094. type: object
  1095. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1096. AlertRecordRule:
  1097. properties:
  1098. alert_duration:
  1099. format: int64
  1100. type: integer
  1101. x-go-name: AlertDuration
  1102. comparator:
  1103. description: '比较运算符, 比如: >, <, >=, <='
  1104. type: string
  1105. x-go-name: Comparator
  1106. condition_type:
  1107. type: string
  1108. x-go-name: ConditionType
  1109. database:
  1110. type: string
  1111. x-go-name: Database
  1112. field:
  1113. type: string
  1114. x-go-name: Field
  1115. field_desc:
  1116. type: string
  1117. x-go-name: FieldDesc
  1118. measurement:
  1119. type: string
  1120. x-go-name: Measurement
  1121. measurement_desc:
  1122. type: string
  1123. x-go-name: MeasurementDesc
  1124. metric:
  1125. type: string
  1126. x-go-name: Metric
  1127. period:
  1128. type: string
  1129. x-go-name: Period
  1130. reducer:
  1131. type: string
  1132. x-go-name: Reducer
  1133. res_type:
  1134. type: string
  1135. x-go-name: ResType
  1136. silent_period:
  1137. description: 静默期
  1138. type: string
  1139. x-go-name: SilentPeriod
  1140. threshold:
  1141. description: 报警阀值
  1142. type: string
  1143. x-go-name: Threshold
  1144. threshold_range:
  1145. items:
  1146. format: double
  1147. type: number
  1148. type: array
  1149. x-go-name: ThresholdRange
  1150. unit:
  1151. type: string
  1152. x-go-name: Unit
  1153. type: object
  1154. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1155. AlertRecordShieldCreateInput:
  1156. properties:
  1157. __meta__:
  1158. additionalProperties:
  1159. type: string
  1160. description: 标签列表,最多支持20个
  1161. example:
  1162. user:rd: op
  1163. type: object
  1164. x-go-name: Metadata
  1165. alert_id:
  1166. type: string
  1167. x-go-name: AlertId
  1168. description:
  1169. description: 资源描述
  1170. example: test create network
  1171. type: string
  1172. x-go-name: Description
  1173. dry_run:
  1174. default: false
  1175. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1176. type: boolean
  1177. x-go-name: DryRun
  1178. end_time:
  1179. type: string
  1180. x-go-name: EndTime
  1181. generate_name:
  1182. description: |-
  1183. 生成资源名称的模板,如果name为空,则为必填项
  1184. description: generated resource name, given a pattern to generate name, required if name is not given
  1185. example: test###
  1186. type: string
  1187. x-go-name: GenerateName
  1188. is_emulated:
  1189. description: |-
  1190. 资源是否为模拟资源
  1191. description: the resource is an emulated resource
  1192. type: boolean
  1193. x-go-name: IsEmulated
  1194. name:
  1195. description: |-
  1196. 资源名称,如果generate_name为空,则为必填项
  1197. description: resource name, required if generated_name is not given
  1198. example: test-network
  1199. type: string
  1200. uniqueItems: true
  1201. x-go-name: Name
  1202. res_id:
  1203. type: string
  1204. x-go-name: ResId
  1205. res_name:
  1206. type: string
  1207. x-go-name: ResName
  1208. res_type:
  1209. type: string
  1210. x-go-name: ResType
  1211. start_time:
  1212. type: string
  1213. x-go-name: StartTime
  1214. required:
  1215. - name
  1216. type: object
  1217. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1218. AlertRecordShieldDetails:
  1219. properties:
  1220. alert_duration:
  1221. description: 报警连续持续周期数
  1222. format: int64
  1223. type: integer
  1224. x-go-name: AlertDuration
  1225. alert_name:
  1226. type: string
  1227. x-go-name: AlertName
  1228. alert_type:
  1229. description: 报警类型
  1230. type: string
  1231. x-go-name: AlertType
  1232. can_delete:
  1233. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1234. example: true
  1235. type: boolean
  1236. x-go-name: CanDelete
  1237. can_update:
  1238. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1239. example: true
  1240. type: boolean
  1241. x-go-name: CanUpdate
  1242. channel:
  1243. items:
  1244. type: string
  1245. type: array
  1246. x-go-name: Channel
  1247. common_alert_metric_details:
  1248. items:
  1249. $ref: '#/definitions/CommonAlertMetricDetails'
  1250. type: array
  1251. x-go-name: CommonAlertMetricDetails
  1252. created_at:
  1253. description: 资源创建时间
  1254. format: date-time
  1255. type: string
  1256. x-go-name: CreatedAt
  1257. customize_config:
  1258. type: object
  1259. x-go-name: CustomizeConfig
  1260. delete_fail_reason:
  1261. $ref: '#/definitions/Error'
  1262. deleted:
  1263. description: 资源是否被删除
  1264. type: boolean
  1265. x-go-name: Deleted
  1266. deleted_at:
  1267. description: 资源删除时间
  1268. format: date-time
  1269. type: string
  1270. x-go-name: DeletedAt
  1271. description:
  1272. description: 资源描述信息
  1273. type: string
  1274. x-go-name: Description
  1275. disable_notify_recovery:
  1276. type: boolean
  1277. x-go-name: DisableNotifyRecovery
  1278. domain_id:
  1279. description: 域Id
  1280. type: string
  1281. x-go-name: DomainId
  1282. enabled:
  1283. description: 资源是否启用
  1284. type: boolean
  1285. x-go-name: Enabled
  1286. eval_data:
  1287. type: object
  1288. x-go-name: EvalData
  1289. execution_error:
  1290. description: Silenced bool
  1291. type: string
  1292. x-go-name: ExecutionError
  1293. execution_error_state:
  1294. type: string
  1295. x-go-name: ExecutionErrorState
  1296. expired:
  1297. type: boolean
  1298. x-go-name: Expired
  1299. for:
  1300. description: |-
  1301. If an alert rule has a configured `For` and the query violates the configured threshold
  1302. it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
  1303. notifications. Once the alert rule has been firing for more than `For` duration, it will
  1304. change to `Alerting` and send alert notifications.
  1305. format: int64
  1306. type: integer
  1307. x-go-name: For
  1308. frequency:
  1309. description: Frequency is evaluate period
  1310. format: int64
  1311. type: integer
  1312. x-go-name: Frequency
  1313. id:
  1314. description: 资源UUID
  1315. type: string
  1316. x-go-name: Id
  1317. is_emulated:
  1318. description: |-
  1319. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1320. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1321. type: boolean
  1322. x-go-name: IsEmulated
  1323. last_state_change:
  1324. format: date-time
  1325. type: string
  1326. x-go-name: LastStateChange
  1327. level:
  1328. type: string
  1329. x-go-name: Level
  1330. message:
  1331. type: string
  1332. x-go-name: Message
  1333. metadata:
  1334. additionalProperties:
  1335. type: string
  1336. description: 标签
  1337. type: object
  1338. x-go-name: Metadata
  1339. name:
  1340. description: 资源名称
  1341. type: string
  1342. x-go-name: Name
  1343. no_data_state:
  1344. type: string
  1345. x-go-name: NoDataState
  1346. notifier_id:
  1347. type: string
  1348. x-go-name: NotifierId
  1349. org_node_md5:
  1350. description: 用以组织架构变更通知其他服务权限变更
  1351. type: string
  1352. x-go-name: OrgNodeMd5
  1353. period:
  1354. type: string
  1355. x-go-name: Period
  1356. progress:
  1357. description: 操作进度0-100
  1358. format: float
  1359. type: number
  1360. x-go-name: Progress
  1361. project:
  1362. description: |-
  1363. 资源归属项目的名称(向后兼容别名)
  1364. Deprecated
  1365. type: string
  1366. x-go-name: Tenant
  1367. project_domain:
  1368. description: 资源归属项目的域名称
  1369. type: string
  1370. x-go-name: ProjectDomain
  1371. project_id:
  1372. description: |-
  1373. 资源归属项目的ID(向后兼容别名)
  1374. Deprecated
  1375. type: string
  1376. x-go-name: TenantId
  1377. project_metadata:
  1378. additionalProperties:
  1379. type: string
  1380. type: object
  1381. x-go-name: ProjectMetadata
  1382. recipients:
  1383. items:
  1384. type: string
  1385. type: array
  1386. x-go-name: Recipients
  1387. res_name:
  1388. type: string
  1389. x-go-name: ResName
  1390. res_type:
  1391. type: string
  1392. x-go-name: ResType
  1393. robot_ids:
  1394. items:
  1395. type: string
  1396. type: array
  1397. x-go-name: RobotIds
  1398. role_ids:
  1399. items:
  1400. type: string
  1401. type: array
  1402. x-go-name: RoleIds
  1403. scope:
  1404. type: string
  1405. x-go-name: Scope
  1406. settings:
  1407. $ref: '#/definitions/AlertSetting'
  1408. silent_period:
  1409. description: 静默期
  1410. type: string
  1411. x-go-name: SilentPeriod
  1412. state:
  1413. type: string
  1414. x-go-name: State
  1415. state_changes:
  1416. format: int64
  1417. type: integer
  1418. x-go-name: StateChanges
  1419. status:
  1420. description: 资源状态
  1421. type: string
  1422. x-go-name: Status
  1423. tenant:
  1424. description: |-
  1425. 资源归属项目的名称
  1426. alias:project
  1427. type: string
  1428. x-go-name: Project
  1429. tenant_id:
  1430. description: 项目Id
  1431. type: string
  1432. x-go-name: ProjectId
  1433. update_fail_reason:
  1434. $ref: '#/definitions/Error'
  1435. update_version:
  1436. description: 资源被更新次数
  1437. format: int64
  1438. type: integer
  1439. x-go-name: UpdateVersion
  1440. updated_at:
  1441. description: 资源更新时间
  1442. format: date-time
  1443. type: string
  1444. x-go-name: UpdatedAt
  1445. used_by:
  1446. type: string
  1447. x-go-name: UsedBy
  1448. type: object
  1449. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1450. AlertResourceDetails:
  1451. properties:
  1452. can_delete:
  1453. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1454. example: true
  1455. type: boolean
  1456. x-go-name: CanDelete
  1457. can_update:
  1458. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1459. example: true
  1460. type: boolean
  1461. x-go-name: CanUpdate
  1462. count:
  1463. format: int64
  1464. type: integer
  1465. x-go-name: Count
  1466. delete_fail_reason:
  1467. $ref: '#/definitions/Error'
  1468. metadata:
  1469. additionalProperties:
  1470. type: string
  1471. description: 标签
  1472. type: object
  1473. x-go-name: Metadata
  1474. tags:
  1475. additionalProperties:
  1476. type: string
  1477. type: object
  1478. x-go-name: Tags
  1479. update_fail_reason:
  1480. $ref: '#/definitions/Error'
  1481. type: object
  1482. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1483. AlertSetting:
  1484. description: AlertSettings contains alert conditions
  1485. properties:
  1486. conditions:
  1487. items:
  1488. $ref: '#/definitions/AlertCondition'
  1489. type: array
  1490. x-go-name: Conditions
  1491. type: object
  1492. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1493. AlertTestRunInput:
  1494. properties:
  1495. is_debug:
  1496. type: boolean
  1497. x-go-name: IsDebug
  1498. type: object
  1499. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1500. AlertTestRunOutput:
  1501. properties:
  1502. alert_ok_eval_matches:
  1503. items:
  1504. $ref: '#/definitions/EvalMatch'
  1505. type: array
  1506. x-go-name: AlertOKEvalMatches
  1507. condition_evals:
  1508. type: string
  1509. x-go-name: ConditionEvals
  1510. end_time:
  1511. format: date-time
  1512. type: string
  1513. x-go-name: EndTime
  1514. error:
  1515. type: string
  1516. x-go-name: Error
  1517. x-go-type: error
  1518. eval_matches:
  1519. items:
  1520. $ref: '#/definitions/EvalMatch'
  1521. type: array
  1522. x-go-name: EvalMatches
  1523. firing:
  1524. type: boolean
  1525. x-go-name: Firing
  1526. is_debug:
  1527. type: boolean
  1528. x-go-name: IsDebug
  1529. is_test_run:
  1530. type: boolean
  1531. x-go-name: IsTestRun
  1532. logs:
  1533. items:
  1534. $ref: '#/definitions/ResultLogEntry'
  1535. type: array
  1536. x-go-name: Logs
  1537. no_data_found:
  1538. type: boolean
  1539. x-go-name: NoDataFound
  1540. prev_alert_state:
  1541. type: string
  1542. x-go-name: PrevAlertState
  1543. start_time:
  1544. format: date-time
  1545. type: string
  1546. x-go-name: StartTime
  1547. type: object
  1548. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1549. AlertUpdateInput:
  1550. properties:
  1551. description:
  1552. description: 资源描述
  1553. type: string
  1554. x-go-name: Description
  1555. enabled:
  1556. description: 启用报警
  1557. type: boolean
  1558. x-go-name: Enabled
  1559. execution_error_state:
  1560. description: 报警执行错误将当前报警状态设置为对应的状态
  1561. type: string
  1562. x-go-name: ExecutionErrorState
  1563. for:
  1564. description: 报警持续时间
  1565. format: int64
  1566. type: integer
  1567. x-go-name: For
  1568. frequency:
  1569. description: 报警执行频率
  1570. format: int64
  1571. type: integer
  1572. x-go-name: Frequency
  1573. level:
  1574. description: 报警级别
  1575. type: string
  1576. x-go-name: Level
  1577. message:
  1578. type: string
  1579. x-go-name: Message
  1580. name:
  1581. description: 资源名称
  1582. type: string
  1583. x-go-name: Name
  1584. no_data_state:
  1585. description: 没有收到监控指标时将当前报警状态设置为对应的状态
  1586. type: string
  1587. x-go-name: NoDataState
  1588. reason:
  1589. description: 报警原因
  1590. type: string
  1591. x-go-name: Reason
  1592. settings:
  1593. $ref: '#/definitions/AlertSetting'
  1594. type: object
  1595. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1596. CommonAlertCreateInput:
  1597. properties:
  1598. alert_duration:
  1599. description: 报警连续持续周期数
  1600. format: int64
  1601. type: integer
  1602. x-go-name: AlertDuration
  1603. alert_type:
  1604. description: 报警类型
  1605. type: string
  1606. x-go-name: AlertType
  1607. channel:
  1608. description: '通知方式, 比如: email, mobile'
  1609. items:
  1610. type: string
  1611. type: array
  1612. x-go-name: Channel
  1613. customize_config:
  1614. description: customize info
  1615. type: object
  1616. x-go-name: CustomizeConfig
  1617. description:
  1618. type: string
  1619. x-go-name: Description
  1620. disable_notify_recovery:
  1621. description: 为 true 时不发送恢复通知(OK)
  1622. type: boolean
  1623. x-go-name: DisableNotifyRecovery
  1624. domain_id:
  1625. type: string
  1626. x-go-name: DomainId
  1627. enabled:
  1628. description: 启用报警
  1629. type: boolean
  1630. x-go-name: Enabled
  1631. execution_error_state:
  1632. description: 报警执行错误将当前报警状态设置为对应的状态
  1633. type: string
  1634. x-go-name: ExecutionErrorState
  1635. for:
  1636. description: 报警持续时间
  1637. format: int64
  1638. type: integer
  1639. x-go-name: For
  1640. frequency:
  1641. description: 报警执行频率
  1642. format: int64
  1643. type: integer
  1644. x-go-name: Frequency
  1645. from:
  1646. type: string
  1647. x-go-name: From
  1648. get_point_str:
  1649. type: boolean
  1650. x-go-name: GetPointStr
  1651. interval:
  1652. type: string
  1653. x-go-name: Interval
  1654. level:
  1655. description: 报警级别
  1656. type: string
  1657. x-go-name: Level
  1658. meta_name:
  1659. type: string
  1660. x-go-name: MetaName
  1661. metric_query:
  1662. items:
  1663. $ref: '#/definitions/CommonAlertQuery'
  1664. type: array
  1665. x-go-name: MetricQuery
  1666. name:
  1667. description: 报警名称
  1668. type: string
  1669. x-go-name: Name
  1670. no_data_state:
  1671. description: 没有收到监控指标时将当前报警状态设置为对应的状态
  1672. type: string
  1673. x-go-name: NoDataState
  1674. period:
  1675. description: 查询指标周期
  1676. type: string
  1677. x-go-name: Period
  1678. project_id:
  1679. type: string
  1680. x-go-name: ProjectId
  1681. reason:
  1682. type: string
  1683. x-go-name: Reason
  1684. recipients:
  1685. description: 通知接受者
  1686. items:
  1687. type: string
  1688. type: array
  1689. x-go-name: Recipients
  1690. robot_ids:
  1691. items:
  1692. type: string
  1693. type: array
  1694. x-go-name: RobotIds
  1695. roles:
  1696. description: 角色 id 或者 name
  1697. items:
  1698. type: string
  1699. type: array
  1700. x-go-name: Roles
  1701. scope:
  1702. description: Scope Resource
  1703. type: string
  1704. x-go-name: Scope
  1705. settings:
  1706. $ref: '#/definitions/AlertSetting'
  1707. silent_period:
  1708. description: 静默期
  1709. type: string
  1710. x-go-name: SilentPeriod
  1711. to:
  1712. type: string
  1713. x-go-name: To
  1714. used_by:
  1715. type: string
  1716. x-go-name: UsedBy
  1717. type: object
  1718. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1719. CommonAlertDetails:
  1720. properties:
  1721. alert_duration:
  1722. description: 报警连续持续周期数
  1723. format: int64
  1724. type: integer
  1725. x-go-name: AlertDuration
  1726. alert_type:
  1727. description: 报警类型
  1728. type: string
  1729. x-go-name: AlertType
  1730. can_delete:
  1731. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1732. example: true
  1733. type: boolean
  1734. x-go-name: CanDelete
  1735. can_update:
  1736. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1737. example: true
  1738. type: boolean
  1739. x-go-name: CanUpdate
  1740. channel:
  1741. items:
  1742. type: string
  1743. type: array
  1744. x-go-name: Channel
  1745. common_alert_metric_details:
  1746. items:
  1747. $ref: '#/definitions/CommonAlertMetricDetails'
  1748. type: array
  1749. x-go-name: CommonAlertMetricDetails
  1750. created_at:
  1751. description: 资源创建时间
  1752. format: date-time
  1753. type: string
  1754. x-go-name: CreatedAt
  1755. customize_config:
  1756. type: object
  1757. x-go-name: CustomizeConfig
  1758. delete_fail_reason:
  1759. $ref: '#/definitions/Error'
  1760. deleted:
  1761. description: 资源是否被删除
  1762. type: boolean
  1763. x-go-name: Deleted
  1764. deleted_at:
  1765. description: 资源删除时间
  1766. format: date-time
  1767. type: string
  1768. x-go-name: DeletedAt
  1769. description:
  1770. description: 资源描述信息
  1771. type: string
  1772. x-go-name: Description
  1773. disable_notify_recovery:
  1774. type: boolean
  1775. x-go-name: DisableNotifyRecovery
  1776. domain_id:
  1777. description: 域Id
  1778. type: string
  1779. x-go-name: DomainId
  1780. enabled:
  1781. description: 资源是否启用
  1782. type: boolean
  1783. x-go-name: Enabled
  1784. eval_data:
  1785. type: object
  1786. x-go-name: EvalData
  1787. execution_error:
  1788. description: Silenced bool
  1789. type: string
  1790. x-go-name: ExecutionError
  1791. execution_error_state:
  1792. type: string
  1793. x-go-name: ExecutionErrorState
  1794. for:
  1795. description: |-
  1796. If an alert rule has a configured `For` and the query violates the configured threshold
  1797. it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
  1798. notifications. Once the alert rule has been firing for more than `For` duration, it will
  1799. change to `Alerting` and send alert notifications.
  1800. format: int64
  1801. type: integer
  1802. x-go-name: For
  1803. frequency:
  1804. description: Frequency is evaluate period
  1805. format: int64
  1806. type: integer
  1807. x-go-name: Frequency
  1808. id:
  1809. description: 资源UUID
  1810. type: string
  1811. x-go-name: Id
  1812. is_emulated:
  1813. description: |-
  1814. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1815. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1816. type: boolean
  1817. x-go-name: IsEmulated
  1818. last_state_change:
  1819. format: date-time
  1820. type: string
  1821. x-go-name: LastStateChange
  1822. level:
  1823. type: string
  1824. x-go-name: Level
  1825. message:
  1826. type: string
  1827. x-go-name: Message
  1828. metadata:
  1829. additionalProperties:
  1830. type: string
  1831. description: 标签
  1832. type: object
  1833. x-go-name: Metadata
  1834. name:
  1835. description: 资源名称
  1836. type: string
  1837. x-go-name: Name
  1838. no_data_state:
  1839. type: string
  1840. x-go-name: NoDataState
  1841. notifier_id:
  1842. type: string
  1843. x-go-name: NotifierId
  1844. org_node_md5:
  1845. description: 用以组织架构变更通知其他服务权限变更
  1846. type: string
  1847. x-go-name: OrgNodeMd5
  1848. period:
  1849. type: string
  1850. x-go-name: Period
  1851. progress:
  1852. description: 操作进度0-100
  1853. format: float
  1854. type: number
  1855. x-go-name: Progress
  1856. project:
  1857. description: |-
  1858. 资源归属项目的名称(向后兼容别名)
  1859. Deprecated
  1860. type: string
  1861. x-go-name: Tenant
  1862. project_domain:
  1863. description: 资源归属项目的域名称
  1864. type: string
  1865. x-go-name: ProjectDomain
  1866. project_id:
  1867. description: |-
  1868. 资源归属项目的ID(向后兼容别名)
  1869. Deprecated
  1870. type: string
  1871. x-go-name: TenantId
  1872. project_metadata:
  1873. additionalProperties:
  1874. type: string
  1875. type: object
  1876. x-go-name: ProjectMetadata
  1877. recipients:
  1878. items:
  1879. type: string
  1880. type: array
  1881. x-go-name: Recipients
  1882. res_type:
  1883. type: string
  1884. x-go-name: ResType
  1885. robot_ids:
  1886. items:
  1887. type: string
  1888. type: array
  1889. x-go-name: RobotIds
  1890. role_ids:
  1891. items:
  1892. type: string
  1893. type: array
  1894. x-go-name: RoleIds
  1895. scope:
  1896. type: string
  1897. x-go-name: Scope
  1898. settings:
  1899. $ref: '#/definitions/AlertSetting'
  1900. silent_period:
  1901. description: 静默期
  1902. type: string
  1903. x-go-name: SilentPeriod
  1904. state:
  1905. type: string
  1906. x-go-name: State
  1907. state_changes:
  1908. format: int64
  1909. type: integer
  1910. x-go-name: StateChanges
  1911. status:
  1912. description: 资源状态
  1913. type: string
  1914. x-go-name: Status
  1915. tenant:
  1916. description: |-
  1917. 资源归属项目的名称
  1918. alias:project
  1919. type: string
  1920. x-go-name: Project
  1921. tenant_id:
  1922. description: 项目Id
  1923. type: string
  1924. x-go-name: ProjectId
  1925. update_fail_reason:
  1926. $ref: '#/definitions/Error'
  1927. update_version:
  1928. description: 资源被更新次数
  1929. format: int64
  1930. type: integer
  1931. x-go-name: UpdateVersion
  1932. updated_at:
  1933. description: 资源更新时间
  1934. format: date-time
  1935. type: string
  1936. x-go-name: UpdatedAt
  1937. used_by:
  1938. type: string
  1939. x-go-name: UsedBy
  1940. type: object
  1941. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1942. CommonAlertFieldOpt:
  1943. type: string
  1944. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  1945. CommonAlertMetricDetails:
  1946. properties:
  1947. FieldDescription:
  1948. $ref: '#/definitions/MetricFieldDetail'
  1949. comparator:
  1950. type: string
  1951. x-go-name: Comparator
  1952. condition_type:
  1953. type: string
  1954. x-go-name: ConditionType
  1955. db:
  1956. type: string
  1957. x-go-name: DB
  1958. field:
  1959. type: string
  1960. x-go-name: Field
  1961. field_opt:
  1962. type: string
  1963. x-go-name: FieldOpt
  1964. filters:
  1965. items:
  1966. $ref: '#/definitions/MetricQueryTag'
  1967. type: array
  1968. x-go-name: Filters
  1969. get_point_str:
  1970. type: boolean
  1971. x-go-name: GetPointStr
  1972. groupby:
  1973. type: string
  1974. x-go-name: Groupby
  1975. measurement:
  1976. type: string
  1977. x-go-name: Measurement
  1978. measurement_display_name:
  1979. type: string
  1980. x-go-name: MeasurementDisplayName
  1981. operator:
  1982. type: string
  1983. x-go-name: Operator
  1984. reduce:
  1985. description: metric points'value的运算方式
  1986. type: string
  1987. x-go-name: Reduce
  1988. res_type:
  1989. type: string
  1990. x-go-name: ResType
  1991. threshold:
  1992. format: double
  1993. type: number
  1994. x-go-name: Threshold
  1995. threshold_range:
  1996. items:
  1997. format: double
  1998. type: number
  1999. type: array
  2000. x-go-name: ThresholdRange
  2001. threshold_str:
  2002. type: string
  2003. x-go-name: ThresholdStr
  2004. type: object
  2005. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2006. CommonAlertQuery:
  2007. properties:
  2008. comparator:
  2009. description: '比较运算符, 比如: >, <, >=, <=, within_range, outside_range'
  2010. type: string
  2011. x-go-name: Comparator
  2012. condition_type:
  2013. type: string
  2014. x-go-name: ConditionType
  2015. field_opt:
  2016. $ref: '#/definitions/CommonAlertFieldOpt'
  2017. from:
  2018. type: string
  2019. x-go-name: From
  2020. model:
  2021. $ref: '#/definitions/MetricQuery'
  2022. operator:
  2023. description: Operator should be chosen from 'and | or'
  2024. type: string
  2025. x-go-name: Operator
  2026. reduce:
  2027. description: metric points'value的运算方式
  2028. type: string
  2029. x-go-name: Reduce
  2030. result_reducer:
  2031. $ref: '#/definitions/Condition'
  2032. result_reducer_order:
  2033. $ref: '#/definitions/ResultReducerOrder'
  2034. threshold:
  2035. description: 报警阀值 (用于 gt, lt, eq)
  2036. format: double
  2037. type: number
  2038. x-go-name: Threshold
  2039. threshold_range:
  2040. description: 范围参数 (用于 within_range, outside_range)
  2041. items:
  2042. format: double
  2043. type: number
  2044. type: array
  2045. x-go-name: ThresholdRange
  2046. to:
  2047. type: string
  2048. x-go-name: To
  2049. type: object
  2050. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2051. Condition:
  2052. properties:
  2053. operators:
  2054. items:
  2055. type: string
  2056. type: array
  2057. x-go-name: Operators
  2058. params:
  2059. items:
  2060. format: double
  2061. type: number
  2062. type: array
  2063. x-go-name: Params
  2064. type:
  2065. type: string
  2066. x-go-name: Type
  2067. type: object
  2068. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2069. Duration:
  2070. description: |-
  2071. A Duration represents the elapsed time between two instants
  2072. as an int64 nanosecond count. The representation limits the
  2073. largest representable duration to approximately 290 years.
  2074. format: int64
  2075. type: integer
  2076. x-go-package: time
  2077. Error:
  2078. properties:
  2079. class:
  2080. type: string
  2081. x-go-name: Class
  2082. code:
  2083. format: int64
  2084. type: integer
  2085. x-go-name: Code
  2086. details:
  2087. type: string
  2088. x-go-name: Details
  2089. type: object
  2090. x-go-package: yunion.io/x/onecloud/pkg/httperrors
  2091. EvalMatch:
  2092. properties:
  2093. alert_details:
  2094. type: object
  2095. x-go-name: AlertDetails
  2096. condition:
  2097. type: string
  2098. x-go-name: Condition
  2099. is_recovery:
  2100. type: boolean
  2101. x-go-name: IsRecovery
  2102. metric:
  2103. type: string
  2104. x-go-name: Metric
  2105. tags:
  2106. additionalProperties:
  2107. type: string
  2108. type: object
  2109. x-go-name: Tags
  2110. unit:
  2111. type: string
  2112. x-go-name: Unit
  2113. value:
  2114. format: double
  2115. type: number
  2116. x-go-name: Value
  2117. value_str:
  2118. type: string
  2119. x-go-name: ValueStr
  2120. title: EvalMatch represents the series violating the threshold.
  2121. type: object
  2122. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2123. GetDetailsStatusOutput:
  2124. properties:
  2125. status:
  2126. description: 状态
  2127. type: string
  2128. x-go-name: Status
  2129. type: object
  2130. x-go-package: yunion.io/x/onecloud/pkg/apis
  2131. JoinResourceBaseCreateInput:
  2132. type: object
  2133. x-go-package: yunion.io/x/onecloud/pkg/apis
  2134. JointResourceBaseDetails:
  2135. properties:
  2136. can_delete:
  2137. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  2138. example: true
  2139. type: boolean
  2140. x-go-name: CanDelete
  2141. can_update:
  2142. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  2143. example: true
  2144. type: boolean
  2145. x-go-name: CanUpdate
  2146. delete_fail_reason:
  2147. $ref: '#/definitions/Error'
  2148. update_fail_reason:
  2149. $ref: '#/definitions/Error'
  2150. type: object
  2151. x-go-package: yunion.io/x/onecloud/pkg/apis
  2152. JointResourceBaseUpdateInput:
  2153. type: object
  2154. x-go-package: yunion.io/x/onecloud/pkg/apis
  2155. MetricCreateInput:
  2156. properties:
  2157. measurement:
  2158. $ref: '#/definitions/MetricMeasurementCreateInput'
  2159. metric_fields:
  2160. items:
  2161. $ref: '#/definitions/MetricFieldCreateInput'
  2162. type: array
  2163. x-go-name: MetricFields
  2164. scope:
  2165. type: string
  2166. x-go-name: Scope
  2167. type: object
  2168. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2169. MetricDetails:
  2170. properties:
  2171. can_delete:
  2172. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  2173. example: true
  2174. type: boolean
  2175. x-go-name: CanDelete
  2176. can_update:
  2177. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  2178. example: true
  2179. type: boolean
  2180. x-go-name: CanUpdate
  2181. delete_fail_reason:
  2182. $ref: '#/definitions/Error'
  2183. metadata:
  2184. additionalProperties:
  2185. type: string
  2186. description: 标签
  2187. type: object
  2188. x-go-name: Metadata
  2189. metric_fields:
  2190. items:
  2191. $ref: '#/definitions/MetricFieldDetail'
  2192. type: array
  2193. x-go-name: MetricFields
  2194. project:
  2195. description: |-
  2196. 资源归属项目的名称(向后兼容别名)
  2197. Deprecated
  2198. type: string
  2199. x-go-name: Tenant
  2200. project_domain:
  2201. description: 资源归属项目的域名称
  2202. type: string
  2203. x-go-name: ProjectDomain
  2204. project_id:
  2205. description: |-
  2206. 资源归属项目的ID(向后兼容别名)
  2207. Deprecated
  2208. type: string
  2209. x-go-name: TenantId
  2210. project_metadata:
  2211. additionalProperties:
  2212. type: string
  2213. type: object
  2214. x-go-name: ProjectMetadata
  2215. scope:
  2216. type: string
  2217. x-go-name: Scope
  2218. tenant:
  2219. description: |-
  2220. 资源归属项目的名称
  2221. alias:project
  2222. type: string
  2223. x-go-name: Project
  2224. update_fail_reason:
  2225. $ref: '#/definitions/Error'
  2226. type: object
  2227. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2228. MetricFieldCreateInput:
  2229. properties:
  2230. __meta__:
  2231. additionalProperties:
  2232. type: string
  2233. description: 标签列表,最多支持20个
  2234. example:
  2235. user:rd: op
  2236. type: object
  2237. x-go-name: Metadata
  2238. description:
  2239. description: 资源描述
  2240. example: test create network
  2241. type: string
  2242. x-go-name: Description
  2243. display_name:
  2244. type: string
  2245. x-go-name: DisplayName
  2246. dry_run:
  2247. default: false
  2248. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  2249. type: boolean
  2250. x-go-name: DryRun
  2251. generate_name:
  2252. description: |-
  2253. 生成资源名称的模板,如果name为空,则为必填项
  2254. description: generated resource name, given a pattern to generate name, required if name is not given
  2255. example: test###
  2256. type: string
  2257. x-go-name: GenerateName
  2258. is_emulated:
  2259. description: |-
  2260. 资源是否为模拟资源
  2261. description: the resource is an emulated resource
  2262. type: boolean
  2263. x-go-name: IsEmulated
  2264. name:
  2265. description: |-
  2266. 资源名称,如果generate_name为空,则为必填项
  2267. description: resource name, required if generated_name is not given
  2268. example: test-network
  2269. type: string
  2270. uniqueItems: true
  2271. x-go-name: Name
  2272. score:
  2273. format: int64
  2274. type: integer
  2275. x-go-name: Score
  2276. unit:
  2277. type: string
  2278. x-go-name: Unit
  2279. value_type:
  2280. type: string
  2281. x-go-name: ValueType
  2282. required:
  2283. - name
  2284. type: object
  2285. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2286. MetricFieldDetail:
  2287. properties:
  2288. display_name:
  2289. type: string
  2290. x-go-name: DisplayName
  2291. id:
  2292. type: string
  2293. x-go-name: Id
  2294. name:
  2295. type: string
  2296. x-go-name: Name
  2297. unit:
  2298. type: string
  2299. x-go-name: Unit
  2300. type: object
  2301. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2302. MetricFieldListInput:
  2303. properties:
  2304. belong_scope:
  2305. description: 指定匹配的范围,可能值为project, domain or system
  2306. type: string
  2307. x-go-name: BelongScope
  2308. details:
  2309. description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  2310. type: boolean
  2311. x-go-name: Details
  2312. display_name:
  2313. type: string
  2314. x-go-name: DisplayName
  2315. domain_tags:
  2316. $ref: '#/definitions/TTagSetList'
  2317. enabled:
  2318. description: 以资源是否启用/禁用过滤列表
  2319. type: boolean
  2320. x-go-name: Enabled
  2321. export_keys:
  2322. description: 用于数据导出,指定导出的数据字段
  2323. type: string
  2324. x-go-name: ExportKeys
  2325. field:
  2326. description: 返回结果只包含指定的字段
  2327. items:
  2328. type: string
  2329. type: array
  2330. x-go-name: Field
  2331. filter:
  2332. description: |-
  2333. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  2334. 支持的操作符如下:
  2335. 操作符 | 参数个数 | 举例 | 说明 |
  2336. ---------------|----------|------------------------------------------------|-----------------------------|
  2337. in | > 0 | name.in("test", "good") | 在给定数组中 |
  2338. notin | > 0 | name.notin('test') | 不在给定数组中 |
  2339. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  2340. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  2341. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  2342. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  2343. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  2344. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  2345. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  2346. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  2347. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  2348. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  2349. notequals | 1 | name.notequals('test') | 不等于给定值 |
  2350. isnull | 0 | name.isnull() | 值为SQL的NULL |
  2351. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  2352. isempty | 0 | name.isempty('test') | 值为空字符串 |
  2353. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  2354. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  2355. items:
  2356. type: string
  2357. type: array
  2358. x-go-name: Filter
  2359. filter_any:
  2360. description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  2361. type: boolean
  2362. x-go-name: FilterAny
  2363. id:
  2364. description: 以资源ID过滤列表
  2365. items:
  2366. type: string
  2367. type: array
  2368. x-go-name: Ids
  2369. joint_filter:
  2370. description: |-
  2371. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  2372. 和其他表关联的语法如下:
  2373. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  2374. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  2375. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  2376. 举例:
  2377. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  2378. items:
  2379. type: string
  2380. type: array
  2381. x-go-name: JointFilter
  2382. limit:
  2383. default: 20
  2384. description: 查询限制量
  2385. format: int64
  2386. type: integer
  2387. x-go-name: Limit
  2388. name:
  2389. description: 以资源名称过滤列表
  2390. items:
  2391. type: string
  2392. type: array
  2393. x-go-name: Names
  2394. no_domain_tags:
  2395. $ref: '#/definitions/TTagSetList'
  2396. no_obj_tags:
  2397. $ref: '#/definitions/TTagSetList'
  2398. no_project_tags:
  2399. $ref: '#/definitions/TTagSetList'
  2400. no_tags:
  2401. $ref: '#/definitions/TTagSet'
  2402. obj_tags:
  2403. $ref: '#/definitions/TTagSetList'
  2404. offset:
  2405. default: 0
  2406. description: 查询偏移量
  2407. format: int64
  2408. type: integer
  2409. x-go-name: Offset
  2410. order:
  2411. description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  2412. example: desc|asc
  2413. type: string
  2414. x-go-name: Order
  2415. order_by:
  2416. description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  2417. items:
  2418. type: string
  2419. type: array
  2420. x-go-name: OrderBy
  2421. order_by_domain:
  2422. description: 按domain名称排序,可能值为asc|desc
  2423. pattern: asc|desc
  2424. type: string
  2425. x-go-name: OrderByDomain
  2426. order_by_project:
  2427. description: 按project名称排序,可能值为asc|desc
  2428. pattern: asc|desc
  2429. type: string
  2430. x-go-name: OrderByProject
  2431. order_by_tag:
  2432. description: 通过标签排序
  2433. type: string
  2434. x-go-name: OrderByTag
  2435. policy_project_tags:
  2436. $ref: '#/definitions/TTagSetList'
  2437. project_domain_id:
  2438. description: 指定项目归属域名称或ID
  2439. type: string
  2440. x-go-name: ProjectDomainId
  2441. project_domain_ids:
  2442. description: 对具有域属性的资源,严格匹配域ID
  2443. items:
  2444. type: string
  2445. type: array
  2446. x-go-name: ProjectDomainIds
  2447. project_id:
  2448. description: 指定项目的名称或ID
  2449. type: string
  2450. x-go-name: ProjectId
  2451. project_ids:
  2452. description: 对具有项目属性的资源,严格匹配项目ID
  2453. items:
  2454. type: string
  2455. type: array
  2456. x-go-name: ProjectIds
  2457. project_organizations:
  2458. description: filter by project organizations
  2459. items:
  2460. type: string
  2461. type: array
  2462. x-go-name: ProjectOrganizations
  2463. project_tags:
  2464. $ref: '#/definitions/TTagSetList'
  2465. scope:
  2466. description: 指定查询的权限范围,可能值为project, domain or system
  2467. type: string
  2468. x-go-name: Scope
  2469. search:
  2470. description: 模糊搜索所有字段
  2471. type: string
  2472. x-go-name: Search
  2473. show_emulated:
  2474. description: 显示所有的资源,包括模拟的资源
  2475. type: boolean
  2476. x-go-name: ShowEmulated
  2477. show_fail_reason:
  2478. description: 返回结果携带delete_fail_reason和update_fail_reason字段
  2479. type: boolean
  2480. x-go-name: ShowFailReason
  2481. status:
  2482. description: 以资源的状态过滤列表
  2483. items:
  2484. type: string
  2485. type: array
  2486. x-go-name: Status
  2487. summary_stats:
  2488. description: 是否返回状态统计信息,默认为False
  2489. type: boolean
  2490. x-go-name: SummaryStats
  2491. tags:
  2492. $ref: '#/definitions/TTagSet'
  2493. unit:
  2494. type: string
  2495. x-go-name: Unit
  2496. with_any_meta:
  2497. description: 返回包含任意标签的资源
  2498. type: boolean
  2499. x-go-name: WithAnyMeta
  2500. with_cloud_meta:
  2501. description: 返回包含外部标签的资源
  2502. type: boolean
  2503. x-go-name: WithCloudMeta
  2504. with_meta:
  2505. description: 返回列表数据中包含资源的标签数据(Metadata)
  2506. type: boolean
  2507. x-go-name: WithMeta
  2508. with_user_meta:
  2509. description: 返回包含用户标签的资源
  2510. type: boolean
  2511. x-go-name: WithUserMeta
  2512. without_user_meta:
  2513. description: |-
  2514. deprecated
  2515. 返回资源的标签不包含用户标签
  2516. type: boolean
  2517. x-go-name: WithoutUserMeta
  2518. type: object
  2519. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2520. MetricFieldUpdateInput:
  2521. properties:
  2522. description:
  2523. description: 资源描述
  2524. type: string
  2525. x-go-name: Description
  2526. display_name:
  2527. type: string
  2528. x-go-name: DisplayName
  2529. id:
  2530. type: string
  2531. x-go-name: Id
  2532. name:
  2533. description: 资源名称
  2534. type: string
  2535. x-go-name: Name
  2536. score:
  2537. format: int64
  2538. type: integer
  2539. x-go-name: Score
  2540. unit:
  2541. type: string
  2542. x-go-name: Unit
  2543. value_type:
  2544. type: string
  2545. x-go-name: ValueType
  2546. type: object
  2547. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2548. MetricMeasurementCreateInput:
  2549. properties:
  2550. __meta__:
  2551. additionalProperties:
  2552. type: string
  2553. description: 标签列表,最多支持20个
  2554. example:
  2555. user:rd: op
  2556. type: object
  2557. x-go-name: Metadata
  2558. database:
  2559. type: string
  2560. x-go-name: Database
  2561. description:
  2562. description: 资源描述
  2563. example: test create network
  2564. type: string
  2565. x-go-name: Description
  2566. disabled:
  2567. description: 该资源是否被管理员*人为*禁用, 和enabled互斥
  2568. type: boolean
  2569. x-go-name: Disabled
  2570. display_name:
  2571. type: string
  2572. x-go-name: DisplayName
  2573. dry_run:
  2574. default: false
  2575. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  2576. type: boolean
  2577. x-go-name: DryRun
  2578. enabled:
  2579. description: 该资源是否被管理员*人为*启用或者禁用
  2580. type: boolean
  2581. x-go-name: Enabled
  2582. generate_name:
  2583. description: |-
  2584. 生成资源名称的模板,如果name为空,则为必填项
  2585. description: generated resource name, given a pattern to generate name, required if name is not given
  2586. example: test###
  2587. type: string
  2588. x-go-name: GenerateName
  2589. is_emulated:
  2590. description: |-
  2591. 资源是否为模拟资源
  2592. description: the resource is an emulated resource
  2593. type: boolean
  2594. x-go-name: IsEmulated
  2595. name:
  2596. description: |-
  2597. 资源名称,如果generate_name为空,则为必填项
  2598. description: resource name, required if generated_name is not given
  2599. example: test-network
  2600. type: string
  2601. uniqueItems: true
  2602. x-go-name: Name
  2603. res_type:
  2604. type: string
  2605. x-go-name: ResType
  2606. score:
  2607. format: int64
  2608. type: integer
  2609. x-go-name: Score
  2610. required:
  2611. - name
  2612. type: object
  2613. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2614. MetricMeasurementListInput:
  2615. properties:
  2616. belong_scope:
  2617. description: 指定匹配的范围,可能值为project, domain or system
  2618. type: string
  2619. x-go-name: BelongScope
  2620. details:
  2621. description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  2622. type: boolean
  2623. x-go-name: Details
  2624. display_name:
  2625. type: string
  2626. x-go-name: DisplayName
  2627. domain_tags:
  2628. $ref: '#/definitions/TTagSetList'
  2629. enabled:
  2630. description: 以资源是否启用/禁用过滤列表
  2631. type: boolean
  2632. x-go-name: Enabled
  2633. export_keys:
  2634. description: 用于数据导出,指定导出的数据字段
  2635. type: string
  2636. x-go-name: ExportKeys
  2637. field:
  2638. description: 返回结果只包含指定的字段
  2639. items:
  2640. type: string
  2641. type: array
  2642. x-go-name: Field
  2643. filter:
  2644. description: |-
  2645. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  2646. 支持的操作符如下:
  2647. 操作符 | 参数个数 | 举例 | 说明 |
  2648. ---------------|----------|------------------------------------------------|-----------------------------|
  2649. in | > 0 | name.in("test", "good") | 在给定数组中 |
  2650. notin | > 0 | name.notin('test') | 不在给定数组中 |
  2651. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  2652. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  2653. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  2654. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  2655. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  2656. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  2657. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  2658. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  2659. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  2660. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  2661. notequals | 1 | name.notequals('test') | 不等于给定值 |
  2662. isnull | 0 | name.isnull() | 值为SQL的NULL |
  2663. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  2664. isempty | 0 | name.isempty('test') | 值为空字符串 |
  2665. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  2666. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  2667. items:
  2668. type: string
  2669. type: array
  2670. x-go-name: Filter
  2671. filter_any:
  2672. description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  2673. type: boolean
  2674. x-go-name: FilterAny
  2675. id:
  2676. description: 以资源ID过滤列表
  2677. items:
  2678. type: string
  2679. type: array
  2680. x-go-name: Ids
  2681. joint_filter:
  2682. description: |-
  2683. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  2684. 和其他表关联的语法如下:
  2685. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  2686. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  2687. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  2688. 举例:
  2689. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  2690. items:
  2691. type: string
  2692. type: array
  2693. x-go-name: JointFilter
  2694. limit:
  2695. default: 20
  2696. description: 查询限制量
  2697. format: int64
  2698. type: integer
  2699. x-go-name: Limit
  2700. name:
  2701. description: 以资源名称过滤列表
  2702. items:
  2703. type: string
  2704. type: array
  2705. x-go-name: Names
  2706. no_domain_tags:
  2707. $ref: '#/definitions/TTagSetList'
  2708. no_obj_tags:
  2709. $ref: '#/definitions/TTagSetList'
  2710. no_project_tags:
  2711. $ref: '#/definitions/TTagSetList'
  2712. no_tags:
  2713. $ref: '#/definitions/TTagSet'
  2714. obj_tags:
  2715. $ref: '#/definitions/TTagSetList'
  2716. offset:
  2717. default: 0
  2718. description: 查询偏移量
  2719. format: int64
  2720. type: integer
  2721. x-go-name: Offset
  2722. order:
  2723. description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  2724. example: desc|asc
  2725. type: string
  2726. x-go-name: Order
  2727. order_by:
  2728. description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  2729. items:
  2730. type: string
  2731. type: array
  2732. x-go-name: OrderBy
  2733. order_by_domain:
  2734. description: 按domain名称排序,可能值为asc|desc
  2735. pattern: asc|desc
  2736. type: string
  2737. x-go-name: OrderByDomain
  2738. order_by_project:
  2739. description: 按project名称排序,可能值为asc|desc
  2740. pattern: asc|desc
  2741. type: string
  2742. x-go-name: OrderByProject
  2743. order_by_tag:
  2744. description: 通过标签排序
  2745. type: string
  2746. x-go-name: OrderByTag
  2747. policy_project_tags:
  2748. $ref: '#/definitions/TTagSetList'
  2749. project_domain_id:
  2750. description: 指定项目归属域名称或ID
  2751. type: string
  2752. x-go-name: ProjectDomainId
  2753. project_domain_ids:
  2754. description: 对具有域属性的资源,严格匹配域ID
  2755. items:
  2756. type: string
  2757. type: array
  2758. x-go-name: ProjectDomainIds
  2759. project_id:
  2760. description: 指定项目的名称或ID
  2761. type: string
  2762. x-go-name: ProjectId
  2763. project_ids:
  2764. description: 对具有项目属性的资源,严格匹配项目ID
  2765. items:
  2766. type: string
  2767. type: array
  2768. x-go-name: ProjectIds
  2769. project_organizations:
  2770. description: filter by project organizations
  2771. items:
  2772. type: string
  2773. type: array
  2774. x-go-name: ProjectOrganizations
  2775. project_tags:
  2776. $ref: '#/definitions/TTagSetList'
  2777. res_type:
  2778. type: string
  2779. x-go-name: ResType
  2780. scope:
  2781. description: 指定查询的权限范围,可能值为project, domain or system
  2782. type: string
  2783. x-go-name: Scope
  2784. search:
  2785. description: 模糊搜索所有字段
  2786. type: string
  2787. x-go-name: Search
  2788. show_emulated:
  2789. description: 显示所有的资源,包括模拟的资源
  2790. type: boolean
  2791. x-go-name: ShowEmulated
  2792. show_fail_reason:
  2793. description: 返回结果携带delete_fail_reason和update_fail_reason字段
  2794. type: boolean
  2795. x-go-name: ShowFailReason
  2796. status:
  2797. description: 以资源的状态过滤列表
  2798. items:
  2799. type: string
  2800. type: array
  2801. x-go-name: Status
  2802. summary_stats:
  2803. description: 是否返回状态统计信息,默认为False
  2804. type: boolean
  2805. x-go-name: SummaryStats
  2806. tags:
  2807. $ref: '#/definitions/TTagSet'
  2808. with_any_meta:
  2809. description: 返回包含任意标签的资源
  2810. type: boolean
  2811. x-go-name: WithAnyMeta
  2812. with_cloud_meta:
  2813. description: 返回包含外部标签的资源
  2814. type: boolean
  2815. x-go-name: WithCloudMeta
  2816. with_meta:
  2817. description: 返回列表数据中包含资源的标签数据(Metadata)
  2818. type: boolean
  2819. x-go-name: WithMeta
  2820. with_user_meta:
  2821. description: 返回包含用户标签的资源
  2822. type: boolean
  2823. x-go-name: WithUserMeta
  2824. without_user_meta:
  2825. description: |-
  2826. deprecated
  2827. 返回资源的标签不包含用户标签
  2828. type: boolean
  2829. x-go-name: WithoutUserMeta
  2830. type: object
  2831. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2832. MetricMeasurementUpdateInput:
  2833. properties:
  2834. description:
  2835. description: 资源描述
  2836. type: string
  2837. x-go-name: Description
  2838. display_name:
  2839. type: string
  2840. x-go-name: DisplayName
  2841. name:
  2842. description: 资源名称
  2843. type: string
  2844. x-go-name: Name
  2845. res_type:
  2846. type: string
  2847. x-go-name: ResType
  2848. type: object
  2849. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2850. MetricQuery:
  2851. properties:
  2852. alias:
  2853. type: string
  2854. x-go-name: Alias
  2855. database:
  2856. type: string
  2857. x-go-name: Database
  2858. group_by:
  2859. items:
  2860. $ref: '#/definitions/MetricQueryPart'
  2861. type: array
  2862. x-go-name: GroupBy
  2863. interval:
  2864. type: string
  2865. x-go-name: Interval
  2866. measurement:
  2867. type: string
  2868. x-go-name: Measurement
  2869. policy:
  2870. type: string
  2871. x-go-name: Policy
  2872. result_format:
  2873. type: string
  2874. x-go-name: ResultFormat
  2875. select:
  2876. items:
  2877. $ref: '#/definitions/MetricQuerySelect'
  2878. type: array
  2879. x-go-name: Selects
  2880. tags:
  2881. items:
  2882. $ref: '#/definitions/MetricQueryTag'
  2883. type: array
  2884. x-go-name: Tags
  2885. tz:
  2886. type: string
  2887. x-go-name: Tz
  2888. type: object
  2889. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2890. MetricQueryInput:
  2891. properties:
  2892. domain_id:
  2893. type: string
  2894. x-go-name: DomainId
  2895. from:
  2896. type: string
  2897. x-go-name: From
  2898. interval:
  2899. type: string
  2900. x-go-name: Interval
  2901. metric_query:
  2902. items:
  2903. $ref: '#/definitions/AlertQuery'
  2904. type: array
  2905. x-go-name: MetricQuery
  2906. project_id:
  2907. type: string
  2908. x-go-name: ProjectId
  2909. scope:
  2910. type: string
  2911. x-go-name: Scope
  2912. show_meta:
  2913. type: boolean
  2914. x-go-name: ShowMeta
  2915. signature:
  2916. type: string
  2917. x-go-name: Signature
  2918. skip_check_series:
  2919. type: boolean
  2920. x-go-name: SkipCheckSeries
  2921. slimit:
  2922. type: string
  2923. x-go-name: Slimit
  2924. soffset:
  2925. type: string
  2926. x-go-name: Soffset
  2927. to:
  2928. type: string
  2929. x-go-name: To
  2930. unit:
  2931. type: boolean
  2932. x-go-name: Unit
  2933. type: object
  2934. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2935. MetricQueryPart:
  2936. properties:
  2937. params:
  2938. items:
  2939. type: string
  2940. type: array
  2941. x-go-name: Params
  2942. type:
  2943. type: string
  2944. x-go-name: Type
  2945. type: object
  2946. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2947. MetricQuerySelect:
  2948. items:
  2949. $ref: '#/definitions/MetricQueryPart'
  2950. type: array
  2951. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2952. MetricQueryTag:
  2953. properties:
  2954. condition:
  2955. type: string
  2956. x-go-name: Condition
  2957. key:
  2958. type: string
  2959. x-go-name: Key
  2960. operator:
  2961. type: string
  2962. x-go-name: Operator
  2963. value:
  2964. type: string
  2965. x-go-name: Value
  2966. type: object
  2967. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2968. MetricUpdateInput:
  2969. properties:
  2970. measurement:
  2971. $ref: '#/definitions/MetricMeasurementUpdateInput'
  2972. metric_fields:
  2973. items:
  2974. $ref: '#/definitions/MetricFieldUpdateInput'
  2975. type: array
  2976. x-go-name: MetricFields
  2977. scope:
  2978. type: string
  2979. x-go-name: Scope
  2980. type: object
  2981. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2982. MetricsQueryResult:
  2983. properties:
  2984. metas:
  2985. items:
  2986. $ref: '#/definitions/QueryResultMeta'
  2987. type: array
  2988. x-go-name: Metas
  2989. reduced_result:
  2990. $ref: '#/definitions/ReducedResult'
  2991. series:
  2992. $ref: '#/definitions/TimeSeriesSlice'
  2993. series_total:
  2994. format: int64
  2995. type: integer
  2996. x-go-name: SeriesTotal
  2997. type: object
  2998. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  2999. MigrationAlertCreateInput:
  3000. properties:
  3001. customize_config:
  3002. description: customize info
  3003. type: object
  3004. x-go-name: CustomizeConfig
  3005. enabled:
  3006. description: 启用报警
  3007. type: boolean
  3008. x-go-name: Enabled
  3009. execution_error_state:
  3010. description: 报警执行错误将当前报警状态设置为对应的状态
  3011. type: string
  3012. x-go-name: ExecutionErrorState
  3013. for:
  3014. description: 报警持续时间
  3015. format: int64
  3016. type: integer
  3017. x-go-name: For
  3018. frequency:
  3019. description: 报警执行频率
  3020. format: int64
  3021. type: integer
  3022. x-go-name: Frequency
  3023. level:
  3024. description: 报警级别
  3025. type: string
  3026. x-go-name: Level
  3027. metric_type:
  3028. $ref: '#/definitions/MigrationAlertMetricType'
  3029. migration_settings:
  3030. $ref: '#/definitions/MigrationAlertSettings'
  3031. name:
  3032. description: 报警名称
  3033. type: string
  3034. x-go-name: Name
  3035. no_data_state:
  3036. description: 没有收到监控指标时将当前报警状态设置为对应的状态
  3037. type: string
  3038. x-go-name: NoDataState
  3039. period:
  3040. description: Period of querying metrics
  3041. type: string
  3042. x-go-name: Period
  3043. reason:
  3044. type: string
  3045. x-go-name: Reason
  3046. settings:
  3047. $ref: '#/definitions/AlertSetting'
  3048. threshold:
  3049. description: Threshold is the value to trigger migration
  3050. format: double
  3051. type: number
  3052. x-go-name: Threshold
  3053. used_by:
  3054. type: string
  3055. x-go-name: UsedBy
  3056. type: object
  3057. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3058. MigrationAlertMetricType:
  3059. type: string
  3060. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3061. MigrationAlertSettings:
  3062. properties:
  3063. source:
  3064. $ref: '#/definitions/MigrationAlertSettingsSource'
  3065. target:
  3066. $ref: '#/definitions/MigrationAlertSettingsTarget'
  3067. type: object
  3068. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3069. MigrationAlertSettingsSource:
  3070. properties:
  3071. guest_ids:
  3072. items:
  3073. type: string
  3074. type: array
  3075. x-go-name: GuestIds
  3076. host_ids:
  3077. items:
  3078. type: string
  3079. type: array
  3080. x-go-name: HostIds
  3081. type: object
  3082. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3083. MigrationAlertSettingsTarget:
  3084. properties:
  3085. host_ids:
  3086. items:
  3087. type: string
  3088. type: array
  3089. x-go-name: HostIds
  3090. type: object
  3091. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3092. MonitorResourceCreateInput:
  3093. properties:
  3094. __meta__:
  3095. additionalProperties:
  3096. type: string
  3097. description: 标签列表,最多支持20个
  3098. example:
  3099. user:rd: op
  3100. type: object
  3101. x-go-name: Metadata
  3102. alert_status:
  3103. type: string
  3104. x-go-name: AlertStatus
  3105. description:
  3106. description: 资源描述
  3107. example: test create network
  3108. type: string
  3109. x-go-name: Description
  3110. disabled:
  3111. description: 该资源是否被管理员*人为*禁用, 和enabled互斥
  3112. type: boolean
  3113. x-go-name: Disabled
  3114. dry_run:
  3115. default: false
  3116. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  3117. type: boolean
  3118. x-go-name: DryRun
  3119. enabled:
  3120. description: 该资源是否被管理员*人为*启用或者禁用
  3121. type: boolean
  3122. x-go-name: Enabled
  3123. generate_name:
  3124. description: |-
  3125. 生成资源名称的模板,如果name为空,则为必填项
  3126. description: generated resource name, given a pattern to generate name, required if name is not given
  3127. example: test###
  3128. type: string
  3129. x-go-name: GenerateName
  3130. is_emulated:
  3131. description: |-
  3132. 资源是否为模拟资源
  3133. description: the resource is an emulated resource
  3134. type: boolean
  3135. x-go-name: IsEmulated
  3136. is_system:
  3137. description: 'description: indicate the resource is a system resource, which is not visible to user'
  3138. type: boolean
  3139. x-go-name: IsSystem
  3140. name:
  3141. description: |-
  3142. 资源名称,如果generate_name为空,则为必填项
  3143. description: resource name, required if generated_name is not given
  3144. example: test-network
  3145. type: string
  3146. uniqueItems: true
  3147. x-go-name: Name
  3148. project_domain_id:
  3149. description: 指定项目归属域名称或ID
  3150. type: string
  3151. x-go-name: ProjectDomainId
  3152. project_id:
  3153. description: 指定项目的名称或ID
  3154. type: string
  3155. x-go-name: ProjectId
  3156. res_id:
  3157. type: string
  3158. x-go-name: ResId
  3159. res_type:
  3160. type: string
  3161. x-go-name: ResType
  3162. status:
  3163. description: 用来存储资源的状态
  3164. type: string
  3165. x-go-name: Status
  3166. required:
  3167. - name
  3168. type: object
  3169. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3170. MonitorResourceDetails:
  3171. properties:
  3172. access_ip:
  3173. type: string
  3174. x-go-name: AccessIp
  3175. account:
  3176. description: 云账号名称
  3177. example: google-account
  3178. type: string
  3179. x-go-name: Account
  3180. account_health_status:
  3181. description: 云账号监控状态
  3182. type: string
  3183. x-go-name: AccountHealthStatus
  3184. account_read_only:
  3185. type: boolean
  3186. x-go-name: AccountReadOnly
  3187. account_status:
  3188. description: 云账号状态
  3189. type: string
  3190. x-go-name: AccountStatus
  3191. attach_alert_count:
  3192. format: int64
  3193. type: integer
  3194. x-go-name: AttachAlertCount
  3195. brand:
  3196. description: 云平台品牌
  3197. example: Google
  3198. type: string
  3199. x-go-name: Brand
  3200. can_delete:
  3201. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3202. example: true
  3203. type: boolean
  3204. x-go-name: CanDelete
  3205. can_update:
  3206. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3207. example: true
  3208. type: boolean
  3209. x-go-name: CanUpdate
  3210. cloud_env:
  3211. description: 云环境
  3212. example: public
  3213. type: string
  3214. x-go-name: CloudEnv
  3215. cloudregion:
  3216. description: 区域的名称
  3217. type: string
  3218. x-go-name: Cloudregion
  3219. delete_fail_reason:
  3220. $ref: '#/definitions/Error'
  3221. environment:
  3222. description: Environment
  3223. type: string
  3224. x-go-name: Environment
  3225. hypervisor:
  3226. type: string
  3227. x-go-name: Hypervisor
  3228. ips:
  3229. type: string
  3230. x-go-name: Ips
  3231. metadata:
  3232. additionalProperties:
  3233. type: string
  3234. description: 标签
  3235. type: object
  3236. x-go-name: Metadata
  3237. project:
  3238. description: |-
  3239. 资源归属项目的名称(向后兼容别名)
  3240. Deprecated
  3241. type: string
  3242. x-go-name: Tenant
  3243. project_domain:
  3244. description: 资源归属项目的域名称
  3245. type: string
  3246. x-go-name: ProjectDomain
  3247. project_id:
  3248. description: |-
  3249. 资源归属项目的ID(向后兼容别名)
  3250. Deprecated
  3251. type: string
  3252. x-go-name: TenantId
  3253. project_metadata:
  3254. additionalProperties:
  3255. type: string
  3256. type: object
  3257. x-go-name: ProjectMetadata
  3258. provider:
  3259. description: 云平台名称
  3260. example: Google
  3261. type: string
  3262. x-go-name: Provider
  3263. region:
  3264. description: 区域的名称
  3265. example: Default
  3266. type: string
  3267. x-go-name: Region
  3268. region_ext_id:
  3269. description: 纳管云区域的Id
  3270. example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4
  3271. type: string
  3272. x-go-name: RegionExtId
  3273. region_external_id:
  3274. description: 纳管云区域的组合Id(平台+Id)
  3275. example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4
  3276. type: string
  3277. x-go-name: RegionExternalId
  3278. region_id:
  3279. description: 区域的Id
  3280. example: default
  3281. type: string
  3282. x-go-name: RegionId
  3283. tenant:
  3284. description: |-
  3285. 资源归属项目的名称
  3286. alias:project
  3287. type: string
  3288. x-go-name: Project
  3289. update_fail_reason:
  3290. $ref: '#/definitions/Error'
  3291. type: object
  3292. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3293. MonitorResourceDoActionInput:
  3294. properties:
  3295. action:
  3296. type: string
  3297. x-go-name: Action
  3298. data:
  3299. type: object
  3300. x-go-name: Data
  3301. type: object
  3302. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3303. MonitorResourceJointDetails:
  3304. properties:
  3305. alert_count:
  3306. format: int64
  3307. type: integer
  3308. x-go-name: AlertCount
  3309. alert_name:
  3310. type: string
  3311. x-go-name: AlertName
  3312. alert_rule:
  3313. type: object
  3314. x-go-name: AlertRule
  3315. is_set_shield:
  3316. type: boolean
  3317. x-go-name: IsSetShield
  3318. level:
  3319. type: string
  3320. x-go-name: Level
  3321. monitor_resource_object_id:
  3322. type: string
  3323. x-go-name: MonitorResourceObjectId
  3324. res_id:
  3325. type: string
  3326. x-go-name: ResId
  3327. res_name:
  3328. type: string
  3329. x-go-name: ResName
  3330. res_type:
  3331. type: string
  3332. x-go-name: ResType
  3333. send_state:
  3334. type: string
  3335. x-go-name: SendState
  3336. state:
  3337. type: string
  3338. x-go-name: State
  3339. type: object
  3340. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3341. NodeAlertCreateInput:
  3342. properties:
  3343. channel:
  3344. description: '通知方式, 比如: email, mobile'
  3345. type: string
  3346. x-go-name: Channel
  3347. common_alert_create_input:
  3348. $ref: '#/definitions/CommonAlertCreateInput'
  3349. comparator:
  3350. description: '比较运算符, 比如: >, <, >=, <='
  3351. type: string
  3352. x-go-name: Comparator
  3353. customize_config:
  3354. description: customize info
  3355. type: object
  3356. x-go-name: CustomizeConfig
  3357. enabled:
  3358. description: 启用报警
  3359. type: boolean
  3360. x-go-name: Enabled
  3361. execution_error_state:
  3362. description: 报警执行错误将当前报警状态设置为对应的状态
  3363. type: string
  3364. x-go-name: ExecutionErrorState
  3365. for:
  3366. description: 报警持续时间
  3367. format: int64
  3368. type: integer
  3369. x-go-name: For
  3370. frequency:
  3371. description: 报警执行频率
  3372. format: int64
  3373. type: integer
  3374. x-go-name: Frequency
  3375. level:
  3376. description: 报警级别
  3377. type: string
  3378. x-go-name: Level
  3379. metric:
  3380. description: 监控指标名称
  3381. type: string
  3382. x-go-name: Metric
  3383. name:
  3384. description: 报警名称
  3385. type: string
  3386. x-go-name: Name
  3387. no_data_state:
  3388. description: 没有收到监控指标时将当前报警状态设置为对应的状态
  3389. type: string
  3390. x-go-name: NoDataState
  3391. node_id:
  3392. description: 监控资源 Id
  3393. type: string
  3394. x-go-name: NodeId
  3395. node_name:
  3396. description: 监控资源名称
  3397. type: string
  3398. x-go-name: NodeName
  3399. period:
  3400. description: 查询指标周期
  3401. type: string
  3402. x-go-name: Period
  3403. reason:
  3404. type: string
  3405. x-go-name: Reason
  3406. recipients:
  3407. description: 通知接受者
  3408. type: string
  3409. x-go-name: Recipients
  3410. settings:
  3411. $ref: '#/definitions/AlertSetting'
  3412. threshold:
  3413. description: 报警阀值
  3414. format: double
  3415. type: number
  3416. x-go-name: Threshold
  3417. type:
  3418. description: '监控资源类型, 比如: guest, host'
  3419. type: string
  3420. x-go-name: Type
  3421. used_by:
  3422. type: string
  3423. x-go-name: UsedBy
  3424. window:
  3425. description: 每隔多久查询一次
  3426. type: string
  3427. x-go-name: Window
  3428. type: object
  3429. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3430. NodeAlertDetails:
  3431. properties:
  3432. can_delete:
  3433. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3434. example: true
  3435. type: boolean
  3436. x-go-name: CanDelete
  3437. can_update:
  3438. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3439. example: true
  3440. type: boolean
  3441. x-go-name: CanUpdate
  3442. channel:
  3443. type: string
  3444. x-go-name: Channel
  3445. comparator:
  3446. type: string
  3447. x-go-name: Comparator
  3448. created_at:
  3449. description: 资源创建时间
  3450. format: date-time
  3451. type: string
  3452. x-go-name: CreatedAt
  3453. customize_config:
  3454. type: object
  3455. x-go-name: CustomizeConfig
  3456. db:
  3457. type: string
  3458. x-go-name: DB
  3459. delete_fail_reason:
  3460. $ref: '#/definitions/Error'
  3461. deleted:
  3462. description: 资源是否被删除
  3463. type: boolean
  3464. x-go-name: Deleted
  3465. deleted_at:
  3466. description: 资源删除时间
  3467. format: date-time
  3468. type: string
  3469. x-go-name: DeletedAt
  3470. description:
  3471. description: 资源描述信息
  3472. type: string
  3473. x-go-name: Description
  3474. domain_id:
  3475. description: 域Id
  3476. type: string
  3477. x-go-name: DomainId
  3478. enabled:
  3479. description: 资源是否启用
  3480. type: boolean
  3481. x-go-name: Enabled
  3482. eval_data:
  3483. type: object
  3484. x-go-name: EvalData
  3485. execution_error:
  3486. description: Silenced bool
  3487. type: string
  3488. x-go-name: ExecutionError
  3489. execution_error_state:
  3490. type: string
  3491. x-go-name: ExecutionErrorState
  3492. field:
  3493. type: string
  3494. x-go-name: Field
  3495. for:
  3496. description: |-
  3497. If an alert rule has a configured `For` and the query violates the configured threshold
  3498. it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
  3499. notifications. Once the alert rule has been firing for more than `For` duration, it will
  3500. change to `Alerting` and send alert notifications.
  3501. format: int64
  3502. type: integer
  3503. x-go-name: For
  3504. frequency:
  3505. description: Frequency is evaluate period
  3506. format: int64
  3507. type: integer
  3508. x-go-name: Frequency
  3509. id:
  3510. description: 资源UUID
  3511. type: string
  3512. x-go-name: Id
  3513. is_emulated:
  3514. description: |-
  3515. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  3516. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  3517. type: boolean
  3518. x-go-name: IsEmulated
  3519. last_state_change:
  3520. format: date-time
  3521. type: string
  3522. x-go-name: LastStateChange
  3523. level:
  3524. type: string
  3525. x-go-name: Level
  3526. measurement:
  3527. type: string
  3528. x-go-name: Measurement
  3529. message:
  3530. type: string
  3531. x-go-name: Message
  3532. metadata:
  3533. additionalProperties:
  3534. type: string
  3535. description: 标签
  3536. type: object
  3537. x-go-name: Metadata
  3538. metric:
  3539. type: string
  3540. x-go-name: Metric
  3541. name:
  3542. description: 资源名称
  3543. type: string
  3544. x-go-name: Name
  3545. no_data_state:
  3546. type: string
  3547. x-go-name: NoDataState
  3548. node_id:
  3549. type: string
  3550. x-go-name: NodeId
  3551. node_name:
  3552. type: string
  3553. x-go-name: NodeName
  3554. notifier_id:
  3555. type: string
  3556. x-go-name: NotifierId
  3557. org_node_md5:
  3558. description: 用以组织架构变更通知其他服务权限变更
  3559. type: string
  3560. x-go-name: OrgNodeMd5
  3561. period:
  3562. type: string
  3563. x-go-name: Period
  3564. progress:
  3565. description: 操作进度0-100
  3566. format: float
  3567. type: number
  3568. x-go-name: Progress
  3569. project:
  3570. description: |-
  3571. 资源归属项目的名称(向后兼容别名)
  3572. Deprecated
  3573. type: string
  3574. x-go-name: Tenant
  3575. project_domain:
  3576. description: 资源归属项目的域名称
  3577. type: string
  3578. x-go-name: ProjectDomain
  3579. project_id:
  3580. description: |-
  3581. 资源归属项目的ID(向后兼容别名)
  3582. Deprecated
  3583. type: string
  3584. x-go-name: TenantId
  3585. project_metadata:
  3586. additionalProperties:
  3587. type: string
  3588. type: object
  3589. x-go-name: ProjectMetadata
  3590. recipients:
  3591. type: string
  3592. x-go-name: Recipients
  3593. res_type:
  3594. type: string
  3595. x-go-name: ResType
  3596. scope:
  3597. type: string
  3598. x-go-name: Scope
  3599. settings:
  3600. $ref: '#/definitions/AlertSetting'
  3601. state:
  3602. type: string
  3603. x-go-name: State
  3604. state_changes:
  3605. format: int64
  3606. type: integer
  3607. x-go-name: StateChanges
  3608. status:
  3609. description: 资源状态
  3610. type: string
  3611. x-go-name: Status
  3612. tenant:
  3613. description: |-
  3614. 资源归属项目的名称
  3615. alias:project
  3616. type: string
  3617. x-go-name: Project
  3618. tenant_id:
  3619. description: 项目Id
  3620. type: string
  3621. x-go-name: ProjectId
  3622. threshold:
  3623. format: double
  3624. type: number
  3625. x-go-name: Threshold
  3626. type:
  3627. type: string
  3628. x-go-name: Type
  3629. update_fail_reason:
  3630. $ref: '#/definitions/Error'
  3631. update_version:
  3632. description: 资源被更新次数
  3633. format: int64
  3634. type: integer
  3635. x-go-name: UpdateVersion
  3636. updated_at:
  3637. description: 资源更新时间
  3638. format: date-time
  3639. type: string
  3640. x-go-name: UpdatedAt
  3641. used_by:
  3642. type: string
  3643. x-go-name: UsedBy
  3644. window:
  3645. type: string
  3646. x-go-name: Window
  3647. type: object
  3648. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3649. NodeAlertUpdateInput:
  3650. properties:
  3651. channel:
  3652. description: '通知方式, 比如: email, mobile'
  3653. type: string
  3654. x-go-name: Channel
  3655. comparator:
  3656. description: '比较运算符, 比如: >, <, >=, <='
  3657. type: string
  3658. x-go-name: Comparator
  3659. description:
  3660. description: 资源描述
  3661. type: string
  3662. x-go-name: Description
  3663. enabled:
  3664. description: 启用报警
  3665. type: boolean
  3666. x-go-name: Enabled
  3667. execution_error_state:
  3668. description: 报警执行错误将当前报警状态设置为对应的状态
  3669. type: string
  3670. x-go-name: ExecutionErrorState
  3671. for:
  3672. description: 报警持续时间
  3673. format: int64
  3674. type: integer
  3675. x-go-name: For
  3676. frequency:
  3677. description: 报警执行频率
  3678. format: int64
  3679. type: integer
  3680. x-go-name: Frequency
  3681. level:
  3682. description: 报警级别
  3683. type: string
  3684. x-go-name: Level
  3685. message:
  3686. type: string
  3687. x-go-name: Message
  3688. metric:
  3689. description: 监控指标名称
  3690. type: string
  3691. x-go-name: Metric
  3692. name:
  3693. description: 资源名称
  3694. type: string
  3695. x-go-name: Name
  3696. no_data_state:
  3697. description: 没有收到监控指标时将当前报警状态设置为对应的状态
  3698. type: string
  3699. x-go-name: NoDataState
  3700. node_id:
  3701. description: 监控资源 Id
  3702. type: string
  3703. x-go-name: NodeId
  3704. node_name:
  3705. description: 监控资源名称
  3706. type: string
  3707. x-go-name: NodeName
  3708. period:
  3709. description: 查询指标周期
  3710. type: string
  3711. x-go-name: Period
  3712. reason:
  3713. description: 报警原因
  3714. type: string
  3715. x-go-name: Reason
  3716. recipients:
  3717. description: 通知接受者
  3718. type: string
  3719. x-go-name: Recipients
  3720. settings:
  3721. $ref: '#/definitions/AlertSetting'
  3722. threshold:
  3723. description: 报警阀值
  3724. format: double
  3725. type: number
  3726. x-go-name: Threshold
  3727. type:
  3728. description: '监控资源类型, 比如: guest, host'
  3729. type: string
  3730. x-go-name: Type
  3731. window:
  3732. description: 每隔多久查询一次
  3733. type: string
  3734. x-go-name: Window
  3735. type: object
  3736. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3737. NotificationCreateInput:
  3738. properties:
  3739. disable_resolve_message:
  3740. description: 是否禁用报警恢复提醒
  3741. type: boolean
  3742. x-go-name: DisableResolveMessage
  3743. frequency:
  3744. $ref: '#/definitions/Duration'
  3745. is_default:
  3746. description: 是否为默认通知配置
  3747. type: boolean
  3748. x-go-name: IsDefault
  3749. name:
  3750. description: 报警通知名称
  3751. type: string
  3752. x-go-name: Name
  3753. send_reminder:
  3754. description: 是否一直提醒
  3755. type: boolean
  3756. x-go-name: SendReminder
  3757. settings:
  3758. description: 通知配置
  3759. type: object
  3760. x-go-name: Settings
  3761. type:
  3762. description: 类型
  3763. type: string
  3764. x-go-name: Type
  3765. type: object
  3766. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3767. PanelDetails:
  3768. properties:
  3769. can_delete:
  3770. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3771. example: true
  3772. type: boolean
  3773. x-go-name: CanDelete
  3774. can_update:
  3775. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3776. example: true
  3777. type: boolean
  3778. x-go-name: CanUpdate
  3779. common_alert_metric_details:
  3780. items:
  3781. $ref: '#/definitions/CommonAlertMetricDetails'
  3782. type: array
  3783. x-go-name: CommonAlertMetricDetails
  3784. created_at:
  3785. description: 资源创建时间
  3786. format: date-time
  3787. type: string
  3788. x-go-name: CreatedAt
  3789. customize_config:
  3790. type: object
  3791. x-go-name: CustomizeConfig
  3792. delete_fail_reason:
  3793. $ref: '#/definitions/Error'
  3794. deleted:
  3795. description: 资源是否被删除
  3796. type: boolean
  3797. x-go-name: Deleted
  3798. deleted_at:
  3799. description: 资源删除时间
  3800. format: date-time
  3801. type: string
  3802. x-go-name: DeletedAt
  3803. description:
  3804. description: 资源描述信息
  3805. type: string
  3806. x-go-name: Description
  3807. domain_id:
  3808. description: 域Id
  3809. type: string
  3810. x-go-name: DomainId
  3811. enabled:
  3812. description: 资源是否启用
  3813. type: boolean
  3814. x-go-name: Enabled
  3815. eval_data:
  3816. type: object
  3817. x-go-name: EvalData
  3818. execution_error:
  3819. description: Silenced bool
  3820. type: string
  3821. x-go-name: ExecutionError
  3822. execution_error_state:
  3823. type: string
  3824. x-go-name: ExecutionErrorState
  3825. for:
  3826. description: |-
  3827. If an alert rule has a configured `For` and the query violates the configured threshold
  3828. it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
  3829. notifications. Once the alert rule has been firing for more than `For` duration, it will
  3830. change to `Alerting` and send alert notifications.
  3831. format: int64
  3832. type: integer
  3833. x-go-name: For
  3834. frequency:
  3835. description: Frequency is evaluate period
  3836. format: int64
  3837. type: integer
  3838. x-go-name: Frequency
  3839. id:
  3840. description: 资源UUID
  3841. type: string
  3842. x-go-name: Id
  3843. is_emulated:
  3844. description: |-
  3845. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  3846. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  3847. type: boolean
  3848. x-go-name: IsEmulated
  3849. last_state_change:
  3850. format: date-time
  3851. type: string
  3852. x-go-name: LastStateChange
  3853. level:
  3854. type: string
  3855. x-go-name: Level
  3856. message:
  3857. type: string
  3858. x-go-name: Message
  3859. metadata:
  3860. additionalProperties:
  3861. type: string
  3862. description: 标签
  3863. type: object
  3864. x-go-name: Metadata
  3865. name:
  3866. description: 资源名称
  3867. type: string
  3868. x-go-name: Name
  3869. no_data_state:
  3870. type: string
  3871. x-go-name: NoDataState
  3872. org_node_md5:
  3873. description: 用以组织架构变更通知其他服务权限变更
  3874. type: string
  3875. x-go-name: OrgNodeMd5
  3876. progress:
  3877. description: 操作进度0-100
  3878. format: float
  3879. type: number
  3880. x-go-name: Progress
  3881. project:
  3882. description: |-
  3883. 资源归属项目的名称(向后兼容别名)
  3884. Deprecated
  3885. type: string
  3886. x-go-name: Tenant
  3887. project_domain:
  3888. description: 资源归属项目的域名称
  3889. type: string
  3890. x-go-name: ProjectDomain
  3891. project_id:
  3892. description: |-
  3893. 资源归属项目的ID(向后兼容别名)
  3894. Deprecated
  3895. type: string
  3896. x-go-name: TenantId
  3897. project_metadata:
  3898. additionalProperties:
  3899. type: string
  3900. type: object
  3901. x-go-name: ProjectMetadata
  3902. res_type:
  3903. type: string
  3904. x-go-name: ResType
  3905. scope:
  3906. type: string
  3907. x-go-name: Scope
  3908. settings:
  3909. $ref: '#/definitions/AlertSetting'
  3910. state:
  3911. type: string
  3912. x-go-name: State
  3913. state_changes:
  3914. format: int64
  3915. type: integer
  3916. x-go-name: StateChanges
  3917. status:
  3918. description: 资源状态
  3919. type: string
  3920. x-go-name: Status
  3921. tenant:
  3922. description: |-
  3923. 资源归属项目的名称
  3924. alias:project
  3925. type: string
  3926. x-go-name: Project
  3927. tenant_id:
  3928. description: 项目Id
  3929. type: string
  3930. x-go-name: ProjectId
  3931. update_fail_reason:
  3932. $ref: '#/definitions/Error'
  3933. update_version:
  3934. description: 资源被更新次数
  3935. format: int64
  3936. type: integer
  3937. x-go-name: UpdateVersion
  3938. updated_at:
  3939. description: 资源更新时间
  3940. format: date-time
  3941. type: string
  3942. x-go-name: UpdatedAt
  3943. used_by:
  3944. type: string
  3945. x-go-name: UsedBy
  3946. type: object
  3947. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3948. PerformChangeProjectOwnerInput:
  3949. properties:
  3950. project_domain_id:
  3951. description: 指定项目归属域名称或ID
  3952. type: string
  3953. x-go-name: ProjectDomainId
  3954. project_id:
  3955. description: 指定项目的名称或ID
  3956. type: string
  3957. x-go-name: ProjectId
  3958. type: object
  3959. x-go-package: yunion.io/x/onecloud/pkg/apis
  3960. PerformDisableInput:
  3961. type: object
  3962. x-go-package: yunion.io/x/onecloud/pkg/apis
  3963. PerformEnableInput:
  3964. type: object
  3965. x-go-package: yunion.io/x/onecloud/pkg/apis
  3966. ProjectAlertResourceCount:
  3967. description: ProjectAlertResourceCount 报警资源统计结果
  3968. properties:
  3969. data:
  3970. items:
  3971. $ref: '#/definitions/ProjectAlertResourceCountData'
  3972. type: array
  3973. x-go-name: Data
  3974. type: object
  3975. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  3976. ProjectAlertResourceCountData:
  3977. description: ProjectAlertResourceCountData 报警资源统计数据(按 scope 分类)
  3978. properties:
  3979. domain:
  3980. type: string
  3981. x-go-name: Domain
  3982. domain_id:
  3983. type: string
  3984. x-go-name: DomainId
  3985. project:
  3986. type: string
  3987. x-go-name: Project
  3988. project_id:
  3989. type: string
  3990. x-go-name: ProjectId
  3991. res_count:
  3992. format: int64
  3993. type: integer
  3994. x-go-name: ResCount
  3995. scope:
  3996. type: string
  3997. x-go-name: Scope
  3998. type: object
  3999. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4000. QueryResultMeta:
  4001. properties:
  4002. raw_query:
  4003. type: string
  4004. x-go-name: RawQuery
  4005. result_reducer_value:
  4006. format: double
  4007. type: number
  4008. x-go-name: ResultReducerValue
  4009. type: object
  4010. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4011. ReducedResult:
  4012. properties:
  4013. reducer:
  4014. $ref: '#/definitions/Condition'
  4015. result:
  4016. items:
  4017. format: double
  4018. type: number
  4019. type: array
  4020. x-go-name: Result
  4021. type: object
  4022. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4023. ResultLogEntry:
  4024. properties:
  4025. data:
  4026. x-go-name: Data
  4027. message:
  4028. type: string
  4029. x-go-name: Message
  4030. title: ResultLogEntry represents log data for the alert evaluation.
  4031. type: object
  4032. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4033. ResultReducerOrder:
  4034. type: string
  4035. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4036. STag:
  4037. properties:
  4038. key:
  4039. description: 标签Kye
  4040. type: string
  4041. x-go-name: Key
  4042. value:
  4043. description: 标签Value
  4044. type: string
  4045. x-go-name: Value
  4046. type: object
  4047. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  4048. StandaloneAnonResourceBaseUpdateInput:
  4049. properties:
  4050. description:
  4051. description: 资源描述
  4052. type: string
  4053. x-go-name: Description
  4054. type: object
  4055. x-go-package: yunion.io/x/onecloud/pkg/apis
  4056. StandaloneResourceBaseUpdateInput:
  4057. properties:
  4058. description:
  4059. description: 资源描述
  4060. type: string
  4061. x-go-name: Description
  4062. name:
  4063. description: 资源名称
  4064. type: string
  4065. x-go-name: Name
  4066. type: object
  4067. x-go-package: yunion.io/x/onecloud/pkg/apis
  4068. StandaloneResourceCreateInput:
  4069. properties:
  4070. __meta__:
  4071. additionalProperties:
  4072. type: string
  4073. description: 标签列表,最多支持20个
  4074. example:
  4075. user:rd: op
  4076. type: object
  4077. x-go-name: Metadata
  4078. description:
  4079. description: 资源描述
  4080. example: test create network
  4081. type: string
  4082. x-go-name: Description
  4083. dry_run:
  4084. default: false
  4085. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  4086. type: boolean
  4087. x-go-name: DryRun
  4088. generate_name:
  4089. description: |-
  4090. 生成资源名称的模板,如果name为空,则为必填项
  4091. description: generated resource name, given a pattern to generate name, required if name is not given
  4092. example: test###
  4093. type: string
  4094. x-go-name: GenerateName
  4095. is_emulated:
  4096. description: |-
  4097. 资源是否为模拟资源
  4098. description: the resource is an emulated resource
  4099. type: boolean
  4100. x-go-name: IsEmulated
  4101. name:
  4102. description: |-
  4103. 资源名称,如果generate_name为空,则为必填项
  4104. description: resource name, required if generated_name is not given
  4105. example: test-network
  4106. type: string
  4107. uniqueItems: true
  4108. x-go-name: Name
  4109. required:
  4110. - name
  4111. type: object
  4112. x-go-package: yunion.io/x/onecloud/pkg/apis
  4113. StandaloneResourceDetails:
  4114. properties:
  4115. can_delete:
  4116. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  4117. example: true
  4118. type: boolean
  4119. x-go-name: CanDelete
  4120. can_update:
  4121. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  4122. example: true
  4123. type: boolean
  4124. x-go-name: CanUpdate
  4125. delete_fail_reason:
  4126. $ref: '#/definitions/Error'
  4127. metadata:
  4128. additionalProperties:
  4129. type: string
  4130. description: 标签
  4131. type: object
  4132. x-go-name: Metadata
  4133. update_fail_reason:
  4134. $ref: '#/definitions/Error'
  4135. type: object
  4136. x-go-package: yunion.io/x/onecloud/pkg/apis
  4137. StatusStandaloneResourceBaseUpdateInput:
  4138. properties:
  4139. description:
  4140. description: 资源描述
  4141. type: string
  4142. x-go-name: Description
  4143. name:
  4144. description: 资源名称
  4145. type: string
  4146. x-go-name: Name
  4147. progress:
  4148. format: float
  4149. type: number
  4150. x-go-name: Progress
  4151. type: object
  4152. x-go-package: yunion.io/x/onecloud/pkg/apis
  4153. TTagSet:
  4154. items:
  4155. $ref: '#/definitions/STag'
  4156. type: array
  4157. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  4158. TTagSetList:
  4159. items:
  4160. $ref: '#/definitions/TTagSet'
  4161. type: array
  4162. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  4163. TimePoint:
  4164. items: {}
  4165. type: array
  4166. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4167. TimeSeries:
  4168. properties:
  4169. cloud_tags:
  4170. additionalProperties:
  4171. type: string
  4172. type: object
  4173. x-go-name: CloudTags
  4174. columns:
  4175. items:
  4176. type: string
  4177. type: array
  4178. x-go-name: Columns
  4179. name:
  4180. type: string
  4181. x-go-name: Name
  4182. points:
  4183. $ref: '#/definitions/TimeSeriesPoints'
  4184. raw_name:
  4185. description: RawName is used to frontend displaying the curve name
  4186. type: string
  4187. x-go-name: RawName
  4188. tags:
  4189. additionalProperties:
  4190. type: string
  4191. type: object
  4192. x-go-name: Tags
  4193. type: object
  4194. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4195. TimeSeriesPoints:
  4196. items:
  4197. $ref: '#/definitions/TimePoint'
  4198. type: array
  4199. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4200. TimeSeriesSlice:
  4201. items:
  4202. $ref: '#/definitions/TimeSeries'
  4203. type: array
  4204. x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
  4205. VirtualJointResourceBaseUpdateInput:
  4206. type: object
  4207. x-go-package: yunion.io/x/onecloud/pkg/apis
  4208. VirtualResourceBaseUpdateInput:
  4209. properties:
  4210. description:
  4211. description: 资源描述
  4212. type: string
  4213. x-go-name: Description
  4214. name:
  4215. description: 资源名称
  4216. type: string
  4217. x-go-name: Name
  4218. progress:
  4219. format: float
  4220. type: number
  4221. x-go-name: Progress
  4222. type: object
  4223. x-go-package: yunion.io/x/onecloud/pkg/apis
  4224. VirtualResourceDetails:
  4225. properties:
  4226. can_delete:
  4227. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  4228. example: true
  4229. type: boolean
  4230. x-go-name: CanDelete
  4231. can_update:
  4232. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  4233. example: true
  4234. type: boolean
  4235. x-go-name: CanUpdate
  4236. delete_fail_reason:
  4237. $ref: '#/definitions/Error'
  4238. metadata:
  4239. additionalProperties:
  4240. type: string
  4241. description: 标签
  4242. type: object
  4243. x-go-name: Metadata
  4244. project:
  4245. description: |-
  4246. 资源归属项目的名称(向后兼容别名)
  4247. Deprecated
  4248. type: string
  4249. x-go-name: Tenant
  4250. project_domain:
  4251. description: 资源归属项目的域名称
  4252. type: string
  4253. x-go-name: ProjectDomain
  4254. project_id:
  4255. description: |-
  4256. 资源归属项目的ID(向后兼容别名)
  4257. Deprecated
  4258. type: string
  4259. x-go-name: TenantId
  4260. project_metadata:
  4261. additionalProperties:
  4262. type: string
  4263. type: object
  4264. x-go-name: ProjectMetadata
  4265. tenant:
  4266. description: |-
  4267. 资源归属项目的名称
  4268. alias:project
  4269. type: string
  4270. x-go-name: Project
  4271. update_fail_reason:
  4272. $ref: '#/definitions/Error'
  4273. type: object
  4274. x-go-package: yunion.io/x/onecloud/pkg/apis
  4275. host: '"127.0.0.1:8889"'
  4276. info:
  4277. contact:
  4278. email: lizexi@yunion.cn
  4279. name: Zexi Li
  4280. description: Cloudprovider API
  4281. license:
  4282. name: Apache 2.0
  4283. url: http://www.apache.org/licenses/LICENSE-2.0.html
  4284. version: "1.0"
  4285. paths:
  4286. /alert_notifications:
  4287. get:
  4288. description: 列表
  4289. operationId: alert_notification_ListItemFilter
  4290. parameters:
  4291. - default: 20
  4292. description: 查询限制量
  4293. format: int64
  4294. in: query
  4295. name: limit
  4296. type: integer
  4297. x-go-name: Limit
  4298. - default: 0
  4299. description: 查询偏移量
  4300. format: int64
  4301. in: query
  4302. name: offset
  4303. type: integer
  4304. x-go-name: Offset
  4305. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  4306. in: query
  4307. items:
  4308. type: string
  4309. name: order_by
  4310. type: array
  4311. x-go-name: OrderBy
  4312. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  4313. example: desc|asc
  4314. in: query
  4315. name: order
  4316. type: string
  4317. x-go-name: Order
  4318. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  4319. in: query
  4320. name: details
  4321. type: boolean
  4322. x-go-name: Details
  4323. - description: 模糊搜索所有字段
  4324. in: query
  4325. name: search
  4326. type: string
  4327. x-go-name: Search
  4328. - description: |-
  4329. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4330. 支持的操作符如下:
  4331. 操作符 | 参数个数 | 举例 | 说明 |
  4332. ---------------|----------|------------------------------------------------|-----------------------------|
  4333. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4334. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4335. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4336. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4337. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4338. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4339. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4340. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4341. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4342. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4343. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4344. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4345. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4346. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4347. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4348. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4349. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4350. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4351. in: query
  4352. items:
  4353. type: string
  4354. name: filter
  4355. type: array
  4356. x-go-name: Filter
  4357. - description: |-
  4358. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4359. 和其他表关联的语法如下:
  4360. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4361. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4362. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4363. 举例:
  4364. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4365. in: query
  4366. items:
  4367. type: string
  4368. name: joint_filter
  4369. type: array
  4370. x-go-name: JointFilter
  4371. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4372. in: query
  4373. name: filter_any
  4374. type: boolean
  4375. x-go-name: FilterAny
  4376. - description: 返回结果只包含指定的字段
  4377. in: query
  4378. items:
  4379. type: string
  4380. name: field
  4381. type: array
  4382. x-go-name: Field
  4383. - description: 用于数据导出,指定导出的数据字段
  4384. in: query
  4385. name: export_keys
  4386. type: string
  4387. x-go-name: ExportKeys
  4388. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4389. in: query
  4390. name: show_fail_reason
  4391. type: boolean
  4392. x-go-name: ShowFailReason
  4393. - description: 是否返回状态统计信息,默认为False
  4394. in: query
  4395. name: summary_stats
  4396. type: boolean
  4397. x-go-name: SummaryStats
  4398. - $ref: '#/definitions/TTagSet'
  4399. description: 通过标签过滤(包含这些标签)
  4400. in: query
  4401. name: tags
  4402. x-go-name: Tags
  4403. - $ref: '#/definitions/TTagSetList'
  4404. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4405. in: query
  4406. name: obj_tags
  4407. x-go-name: ObjTags
  4408. - $ref: '#/definitions/TTagSet'
  4409. description: 通过标签过滤(不包含这些标签)
  4410. in: query
  4411. name: no_tags
  4412. x-go-name: NoTags
  4413. - $ref: '#/definitions/TTagSetList'
  4414. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4415. in: query
  4416. name: no_obj_tags
  4417. x-go-name: NoObjTags
  4418. - description: 通过标签排序
  4419. in: query
  4420. name: order_by_tag
  4421. type: string
  4422. x-go-name: OrderByTag
  4423. - description: |-
  4424. deprecated
  4425. 返回资源的标签不包含用户标签
  4426. in: query
  4427. name: without_user_meta
  4428. type: boolean
  4429. x-go-name: WithoutUserMeta
  4430. - description: 返回包含用户标签的资源
  4431. in: query
  4432. name: with_user_meta
  4433. type: boolean
  4434. x-go-name: WithUserMeta
  4435. - description: 返回包含外部标签的资源
  4436. in: query
  4437. name: with_cloud_meta
  4438. type: boolean
  4439. x-go-name: WithCloudMeta
  4440. - description: 返回包含任意标签的资源
  4441. in: query
  4442. name: with_any_meta
  4443. type: boolean
  4444. x-go-name: WithAnyMeta
  4445. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4446. in: query
  4447. name: with_meta
  4448. type: boolean
  4449. x-go-name: WithMeta
  4450. - description: 显示所有的资源,包括模拟的资源
  4451. in: query
  4452. name: show_emulated
  4453. type: boolean
  4454. x-go-name: ShowEmulated
  4455. - description: 以资源ID过滤列表
  4456. in: query
  4457. items:
  4458. type: string
  4459. name: id
  4460. type: array
  4461. x-go-name: Ids
  4462. - description: 以资源名称过滤列表
  4463. in: query
  4464. items:
  4465. type: string
  4466. name: name
  4467. type: array
  4468. x-go-name: Names
  4469. - description: 以资源的状态过滤列表
  4470. in: query
  4471. items:
  4472. type: string
  4473. name: status
  4474. type: array
  4475. x-go-name: Status
  4476. - description: 指定查询的权限范围,可能值为project, domain or system
  4477. in: query
  4478. name: scope
  4479. type: string
  4480. x-go-name: Scope
  4481. - description: 指定项目归属域名称或ID
  4482. in: query
  4483. name: project_domain_id
  4484. type: string
  4485. x-go-name: ProjectDomainId
  4486. - description: 对具有域属性的资源,严格匹配域ID
  4487. in: query
  4488. items:
  4489. type: string
  4490. name: project_domain_ids
  4491. type: array
  4492. x-go-name: ProjectDomainIds
  4493. - description: 按domain名称排序,可能值为asc|desc
  4494. in: query
  4495. name: order_by_domain
  4496. pattern: asc|desc
  4497. type: string
  4498. x-go-name: OrderByDomain
  4499. - $ref: '#/definitions/TTagSetList'
  4500. description: filter by domain tags
  4501. in: query
  4502. name: domain_tags
  4503. x-go-name: DomainTags
  4504. - $ref: '#/definitions/TTagSetList'
  4505. description: filter by domain tags
  4506. in: query
  4507. name: no_domain_tags
  4508. x-go-name: NoDomainTags
  4509. - description: 指定项目的名称或ID
  4510. in: query
  4511. name: project_id
  4512. type: string
  4513. x-go-name: ProjectId
  4514. - description: 对具有项目属性的资源,严格匹配项目ID
  4515. in: query
  4516. items:
  4517. type: string
  4518. name: project_ids
  4519. type: array
  4520. x-go-name: ProjectIds
  4521. - description: 按project名称排序,可能值为asc|desc
  4522. in: query
  4523. name: order_by_project
  4524. pattern: asc|desc
  4525. type: string
  4526. x-go-name: OrderByProject
  4527. - $ref: '#/definitions/TTagSetList'
  4528. description: filter by project tags
  4529. in: query
  4530. name: project_tags
  4531. x-go-name: ProjectTags
  4532. - $ref: '#/definitions/TTagSetList'
  4533. description: filter by no project tags
  4534. in: query
  4535. name: no_project_tags
  4536. x-go-name: NoProjectTags
  4537. - description: filter by project organizations
  4538. in: query
  4539. items:
  4540. type: string
  4541. name: project_organizations
  4542. type: array
  4543. x-go-name: ProjectOrganizations
  4544. - $ref: '#/definitions/TTagSetList'
  4545. description: |-
  4546. ignore
  4547. project tag fitlers imposed by policy
  4548. in: query
  4549. name: policy_project_tags
  4550. x-go-name: PolicyProjectTags
  4551. - description: 列表中包含标记为"系统资源"的资源
  4552. in: query
  4553. name: system
  4554. type: boolean
  4555. x-go-name: System
  4556. - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
  4557. in: query
  4558. name: pending_delete
  4559. type: boolean
  4560. x-go-name: PendingDelete
  4561. - description: 类型
  4562. in: query
  4563. name: type
  4564. type: string
  4565. x-go-name: Type
  4566. responses:
  4567. "200":
  4568. $ref: '#/responses/alert_notification_ListItemFilterOutput'
  4569. summary: 列表
  4570. tags:
  4571. - alert_notification
  4572. post:
  4573. description: 新建
  4574. operationId: alert_notification_ValidateCreateData
  4575. parameters:
  4576. - in: body
  4577. name: body
  4578. schema:
  4579. properties:
  4580. alert_notification:
  4581. $ref: '#/definitions/NotificationCreateInput'
  4582. count:
  4583. default: 1
  4584. format: int64
  4585. type: integer
  4586. x-go-name: Count
  4587. type: object
  4588. x-go-name: Body
  4589. responses:
  4590. "200":
  4591. $ref: '#/responses/alert_notification_ValidateCreateDataOutput'
  4592. summary: 新建
  4593. tags:
  4594. - alert_notification
  4595. /alert_notifications/{id}:
  4596. delete:
  4597. description: 删除
  4598. operationId: alert_notification_CustomizeDelete
  4599. parameters:
  4600. - description: The Id or Name of alert_notification
  4601. in: path
  4602. name: id
  4603. required: true
  4604. type: string
  4605. x-go-name: Id
  4606. responses:
  4607. "200":
  4608. $ref: '#/responses/alert_notification_CustomizeDeleteOutput'
  4609. summary: 删除
  4610. tags:
  4611. - alert_notification
  4612. get:
  4613. description: 获取详情
  4614. operationId: alert_notification_FetchCustomizeColumns
  4615. parameters:
  4616. - description: The Id or Name of alert_notification
  4617. in: path
  4618. name: id
  4619. required: true
  4620. type: string
  4621. x-go-name: Id
  4622. responses:
  4623. "200":
  4624. $ref: '#/responses/alert_notification_FetchCustomizeColumnsOutput'
  4625. summary: 获取详情
  4626. tags:
  4627. - alert_notification
  4628. put:
  4629. description: 更新
  4630. operationId: alert_notification_ValidateUpdateData
  4631. parameters:
  4632. - description: The Id or Name of alert_notification
  4633. in: path
  4634. name: id
  4635. required: true
  4636. type: string
  4637. x-go-name: Id
  4638. - in: body
  4639. name: body
  4640. schema:
  4641. properties:
  4642. alert_notification:
  4643. $ref: '#/definitions/VirtualResourceBaseUpdateInput'
  4644. type: object
  4645. x-go-name: Body
  4646. responses:
  4647. "200":
  4648. $ref: '#/responses/alert_notification_ValidateUpdateDataOutput'
  4649. summary: 更新
  4650. tags:
  4651. - alert_notification
  4652. /alert_notifications/{id}/change-owner:
  4653. post:
  4654. description: 执行操作ChangeOwner
  4655. operationId: alert_notification_PerformChangeOwner
  4656. parameters:
  4657. - description: The Id or Name of alert_notification
  4658. in: path
  4659. name: id
  4660. required: true
  4661. type: string
  4662. x-go-name: Id
  4663. - in: body
  4664. name: body
  4665. schema:
  4666. properties:
  4667. alert_notification:
  4668. $ref: '#/definitions/PerformChangeProjectOwnerInput'
  4669. type: object
  4670. x-go-name: Body
  4671. responses:
  4672. "200":
  4673. $ref: '#/responses/alert_notification_PerformChangeOwnerOutput'
  4674. summary: 更改项目
  4675. tags:
  4676. - alert_notification
  4677. /alert_notifications/{id}/metadata:
  4678. get:
  4679. description: 获取指定信息Metadata
  4680. operationId: alert_notification_GetDetailsMetadata
  4681. parameters:
  4682. - description: |-
  4683. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  4684. 标签分为
  4685. 类型 | 说明 |
  4686. ----------|---------------------------------------------|
  4687. 系统标签 | 平台定义的标签 |
  4688. 用户标签 | key以user:为前缀,用户自定义标签 |
  4689. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  4690. in: query
  4691. items:
  4692. type: string
  4693. name: field
  4694. type: array
  4695. x-go-name: Field
  4696. - description: 按标签前缀过滤
  4697. in: query
  4698. name: prefix
  4699. type: string
  4700. x-go-name: Prefix
  4701. - description: The Id or Name of alert_notification
  4702. in: path
  4703. name: id
  4704. required: true
  4705. type: string
  4706. x-go-name: Id
  4707. responses:
  4708. "200":
  4709. $ref: '#/responses/alert_notification_GetDetailsMetadataOutput'
  4710. summary: 获取资源标签(元数据)
  4711. tags:
  4712. - alert_notification
  4713. /alert_notifications/{id}/status:
  4714. get:
  4715. description: 获取指定信息Status
  4716. operationId: alert_notification_GetDetailsStatus
  4717. parameters:
  4718. - description: The Id or Name of alert_notification
  4719. in: path
  4720. name: id
  4721. required: true
  4722. type: string
  4723. x-go-name: Id
  4724. responses:
  4725. "200":
  4726. $ref: '#/responses/alert_notification_GetDetailsStatusOutput'
  4727. summary: 获取资源状态
  4728. tags:
  4729. - alert_notification
  4730. /alertdashboards:
  4731. get:
  4732. description: 列表
  4733. operationId: alertdashboard_ListItemFilter
  4734. parameters:
  4735. - description: 指定查询的权限范围,可能值为project, domain or system
  4736. in: query
  4737. name: scope
  4738. type: string
  4739. x-go-name: Scope
  4740. - description: 指定项目归属域名称或ID
  4741. in: query
  4742. name: project_domain_id
  4743. type: string
  4744. x-go-name: ProjectDomainId
  4745. - description: 对具有域属性的资源,严格匹配域ID
  4746. in: query
  4747. items:
  4748. type: string
  4749. name: project_domain_ids
  4750. type: array
  4751. x-go-name: ProjectDomainIds
  4752. - description: 按domain名称排序,可能值为asc|desc
  4753. in: query
  4754. name: order_by_domain
  4755. pattern: asc|desc
  4756. type: string
  4757. x-go-name: OrderByDomain
  4758. - $ref: '#/definitions/TTagSetList'
  4759. description: filter by domain tags
  4760. in: query
  4761. name: domain_tags
  4762. x-go-name: DomainTags
  4763. - $ref: '#/definitions/TTagSetList'
  4764. description: filter by domain tags
  4765. in: query
  4766. name: no_domain_tags
  4767. x-go-name: NoDomainTags
  4768. - description: 指定项目的名称或ID
  4769. in: query
  4770. name: project_id
  4771. type: string
  4772. x-go-name: ProjectId
  4773. - description: 对具有项目属性的资源,严格匹配项目ID
  4774. in: query
  4775. items:
  4776. type: string
  4777. name: project_ids
  4778. type: array
  4779. x-go-name: ProjectIds
  4780. - description: 按project名称排序,可能值为asc|desc
  4781. in: query
  4782. name: order_by_project
  4783. pattern: asc|desc
  4784. type: string
  4785. x-go-name: OrderByProject
  4786. - $ref: '#/definitions/TTagSetList'
  4787. description: filter by project tags
  4788. in: query
  4789. name: project_tags
  4790. x-go-name: ProjectTags
  4791. - $ref: '#/definitions/TTagSetList'
  4792. description: filter by no project tags
  4793. in: query
  4794. name: no_project_tags
  4795. x-go-name: NoProjectTags
  4796. - description: filter by project organizations
  4797. in: query
  4798. items:
  4799. type: string
  4800. name: project_organizations
  4801. type: array
  4802. x-go-name: ProjectOrganizations
  4803. - $ref: '#/definitions/TTagSetList'
  4804. description: |-
  4805. ignore
  4806. project tag fitlers imposed by policy
  4807. in: query
  4808. name: policy_project_tags
  4809. x-go-name: PolicyProjectTags
  4810. - description: 指定匹配的范围,可能值为project, domain or system
  4811. in: query
  4812. name: belong_scope
  4813. type: string
  4814. x-go-name: BelongScope
  4815. - description: 以资源是否启用/禁用过滤列表
  4816. in: query
  4817. name: enabled
  4818. type: boolean
  4819. x-go-name: Enabled
  4820. - default: 20
  4821. description: 查询限制量
  4822. format: int64
  4823. in: query
  4824. name: limit
  4825. type: integer
  4826. x-go-name: Limit
  4827. - default: 0
  4828. description: 查询偏移量
  4829. format: int64
  4830. in: query
  4831. name: offset
  4832. type: integer
  4833. x-go-name: Offset
  4834. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  4835. in: query
  4836. items:
  4837. type: string
  4838. name: order_by
  4839. type: array
  4840. x-go-name: OrderBy
  4841. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  4842. example: desc|asc
  4843. in: query
  4844. name: order
  4845. type: string
  4846. x-go-name: Order
  4847. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  4848. in: query
  4849. name: details
  4850. type: boolean
  4851. x-go-name: Details
  4852. - description: 模糊搜索所有字段
  4853. in: query
  4854. name: search
  4855. type: string
  4856. x-go-name: Search
  4857. - description: |-
  4858. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4859. 支持的操作符如下:
  4860. 操作符 | 参数个数 | 举例 | 说明 |
  4861. ---------------|----------|------------------------------------------------|-----------------------------|
  4862. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4863. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4864. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4865. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4866. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4867. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4868. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4869. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4870. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4871. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4872. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4873. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4874. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4875. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4876. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4877. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4878. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4879. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4880. in: query
  4881. items:
  4882. type: string
  4883. name: filter
  4884. type: array
  4885. x-go-name: Filter
  4886. - description: |-
  4887. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4888. 和其他表关联的语法如下:
  4889. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4890. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4891. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4892. 举例:
  4893. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4894. in: query
  4895. items:
  4896. type: string
  4897. name: joint_filter
  4898. type: array
  4899. x-go-name: JointFilter
  4900. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4901. in: query
  4902. name: filter_any
  4903. type: boolean
  4904. x-go-name: FilterAny
  4905. - description: 返回结果只包含指定的字段
  4906. in: query
  4907. items:
  4908. type: string
  4909. name: field
  4910. type: array
  4911. x-go-name: Field
  4912. - description: 用于数据导出,指定导出的数据字段
  4913. in: query
  4914. name: export_keys
  4915. type: string
  4916. x-go-name: ExportKeys
  4917. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4918. in: query
  4919. name: show_fail_reason
  4920. type: boolean
  4921. x-go-name: ShowFailReason
  4922. - description: 是否返回状态统计信息,默认为False
  4923. in: query
  4924. name: summary_stats
  4925. type: boolean
  4926. x-go-name: SummaryStats
  4927. - $ref: '#/definitions/TTagSet'
  4928. description: 通过标签过滤(包含这些标签)
  4929. in: query
  4930. name: tags
  4931. x-go-name: Tags
  4932. - $ref: '#/definitions/TTagSetList'
  4933. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4934. in: query
  4935. name: obj_tags
  4936. x-go-name: ObjTags
  4937. - $ref: '#/definitions/TTagSet'
  4938. description: 通过标签过滤(不包含这些标签)
  4939. in: query
  4940. name: no_tags
  4941. x-go-name: NoTags
  4942. - $ref: '#/definitions/TTagSetList'
  4943. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4944. in: query
  4945. name: no_obj_tags
  4946. x-go-name: NoObjTags
  4947. - description: 通过标签排序
  4948. in: query
  4949. name: order_by_tag
  4950. type: string
  4951. x-go-name: OrderByTag
  4952. - description: |-
  4953. deprecated
  4954. 返回资源的标签不包含用户标签
  4955. in: query
  4956. name: without_user_meta
  4957. type: boolean
  4958. x-go-name: WithoutUserMeta
  4959. - description: 返回包含用户标签的资源
  4960. in: query
  4961. name: with_user_meta
  4962. type: boolean
  4963. x-go-name: WithUserMeta
  4964. - description: 返回包含外部标签的资源
  4965. in: query
  4966. name: with_cloud_meta
  4967. type: boolean
  4968. x-go-name: WithCloudMeta
  4969. - description: 返回包含任意标签的资源
  4970. in: query
  4971. name: with_any_meta
  4972. type: boolean
  4973. x-go-name: WithAnyMeta
  4974. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4975. in: query
  4976. name: with_meta
  4977. type: boolean
  4978. x-go-name: WithMeta
  4979. - description: 显示所有的资源,包括模拟的资源
  4980. in: query
  4981. name: show_emulated
  4982. type: boolean
  4983. x-go-name: ShowEmulated
  4984. - description: 以资源ID过滤列表
  4985. in: query
  4986. items:
  4987. type: string
  4988. name: id
  4989. type: array
  4990. x-go-name: Ids
  4991. - description: 以资源名称过滤列表
  4992. in: query
  4993. items:
  4994. type: string
  4995. name: name
  4996. type: array
  4997. x-go-name: Names
  4998. - description: 以资源的状态过滤列表
  4999. in: query
  5000. items:
  5001. type: string
  5002. name: status
  5003. type: array
  5004. x-go-name: Status
  5005. - description: |-
  5006. 以报警是否启用/禁用过滤列表
  5007. Enabled *bool `json:"enabled"`
  5008. in: query
  5009. items:
  5010. type: string
  5011. name: monitor_resource_id
  5012. type: array
  5013. x-go-name: MonitorResourceId
  5014. responses:
  5015. "200":
  5016. $ref: '#/responses/alertdashboard_ListItemFilterOutput'
  5017. summary: 列表
  5018. tags:
  5019. - alertdashboard
  5020. post:
  5021. description: 新建
  5022. operationId: alertdashboard_ValidateCreateData
  5023. parameters:
  5024. - in: body
  5025. name: body
  5026. schema:
  5027. properties:
  5028. alertdashboard:
  5029. $ref: '#/definitions/AlertDashBoardCreateInput'
  5030. count:
  5031. default: 1
  5032. format: int64
  5033. type: integer
  5034. x-go-name: Count
  5035. type: object
  5036. x-go-name: Body
  5037. responses:
  5038. "200":
  5039. $ref: '#/responses/alertdashboard_ValidateCreateDataOutput'
  5040. summary: 新建
  5041. tags:
  5042. - alertdashboard
  5043. /alertdashboards/{id}:
  5044. delete:
  5045. description: 删除
  5046. operationId: alertdashboard_CustomizeDelete
  5047. parameters:
  5048. - description: The Id or Name of alertdashboard
  5049. in: path
  5050. name: id
  5051. required: true
  5052. type: string
  5053. x-go-name: Id
  5054. responses:
  5055. "200":
  5056. $ref: '#/responses/alertdashboard_CustomizeDeleteOutput'
  5057. summary: 删除
  5058. tags:
  5059. - alertdashboard
  5060. get:
  5061. description: 获取详情
  5062. operationId: alertdashboard_FetchCustomizeColumns
  5063. parameters:
  5064. - description: The Id or Name of alertdashboard
  5065. in: path
  5066. name: id
  5067. required: true
  5068. type: string
  5069. x-go-name: Id
  5070. responses:
  5071. "200":
  5072. $ref: '#/responses/alertdashboard_FetchCustomizeColumnsOutput'
  5073. summary: 获取详情
  5074. tags:
  5075. - alertdashboard
  5076. put:
  5077. description: 更新
  5078. operationId: alertdashboard_ValidateUpdateData
  5079. parameters:
  5080. - description: The Id or Name of alertdashboard
  5081. in: path
  5082. name: id
  5083. required: true
  5084. type: string
  5085. x-go-name: Id
  5086. responses:
  5087. "200":
  5088. $ref: '#/responses/alertdashboard_ValidateUpdateDataOutput'
  5089. summary: 更新
  5090. tags:
  5091. - alertdashboard
  5092. /alertdashboards/{id}/clone-dashboard:
  5093. post:
  5094. description: 执行操作CloneDashboard
  5095. operationId: alertdashboard_PerformCloneDashboard
  5096. parameters:
  5097. - description: The Id or Name of alertdashboard
  5098. in: path
  5099. name: id
  5100. required: true
  5101. type: string
  5102. x-go-name: Id
  5103. - in: body
  5104. name: body
  5105. schema:
  5106. properties:
  5107. alertdashboard:
  5108. $ref: '#/definitions/AlertCloneDashboardInput'
  5109. type: object
  5110. x-go-name: Body
  5111. responses:
  5112. "200":
  5113. $ref: '#/responses/alertdashboard_PerformCloneDashboardOutput'
  5114. summary: 执行操作CloneDashboard
  5115. tags:
  5116. - alertdashboard
  5117. /alertdashboards/{id}/clone-panel:
  5118. post:
  5119. description: 执行操作ClonePanel
  5120. operationId: alertdashboard_PerformClonePanel
  5121. parameters:
  5122. - description: The Id or Name of alertdashboard
  5123. in: path
  5124. name: id
  5125. required: true
  5126. type: string
  5127. x-go-name: Id
  5128. - in: body
  5129. name: body
  5130. schema:
  5131. properties:
  5132. alertdashboard:
  5133. $ref: '#/definitions/AlertClonePanelInput'
  5134. type: object
  5135. x-go-name: Body
  5136. responses:
  5137. "200":
  5138. $ref: '#/responses/alertdashboard_PerformClonePanelOutput'
  5139. summary: 执行操作ClonePanel
  5140. tags:
  5141. - alertdashboard
  5142. /alertdashboards/{id}/metadata:
  5143. get:
  5144. description: 获取指定信息Metadata
  5145. operationId: alertdashboard_GetDetailsMetadata
  5146. parameters:
  5147. - description: |-
  5148. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  5149. 标签分为
  5150. 类型 | 说明 |
  5151. ----------|---------------------------------------------|
  5152. 系统标签 | 平台定义的标签 |
  5153. 用户标签 | key以user:为前缀,用户自定义标签 |
  5154. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  5155. in: query
  5156. items:
  5157. type: string
  5158. name: field
  5159. type: array
  5160. x-go-name: Field
  5161. - description: 按标签前缀过滤
  5162. in: query
  5163. name: prefix
  5164. type: string
  5165. x-go-name: Prefix
  5166. - description: The Id or Name of alertdashboard
  5167. in: path
  5168. name: id
  5169. required: true
  5170. type: string
  5171. x-go-name: Id
  5172. responses:
  5173. "200":
  5174. $ref: '#/responses/alertdashboard_GetDetailsMetadataOutput'
  5175. summary: 获取资源标签(元数据)
  5176. tags:
  5177. - alertdashboard
  5178. /alertdashboards/{id}/set-panel-order:
  5179. post:
  5180. description: 执行操作SetPanelOrder
  5181. operationId: alertdashboard_PerformSetPanelOrder
  5182. parameters:
  5183. - description: The Id or Name of alertdashboard
  5184. in: path
  5185. name: id
  5186. required: true
  5187. type: string
  5188. x-go-name: Id
  5189. - in: body
  5190. name: body
  5191. schema:
  5192. properties:
  5193. alertdashboard:
  5194. $ref: '#/definitions/AlertPanelSetOrderInput'
  5195. type: object
  5196. x-go-name: Body
  5197. responses:
  5198. "200":
  5199. $ref: '#/responses/alertdashboard_PerformSetPanelOrderOutput'
  5200. summary: 执行操作SetPanelOrder
  5201. tags:
  5202. - alertdashboard
  5203. /alertdashboards/{id}/set-scope:
  5204. post:
  5205. description: 执行操作SetScope
  5206. operationId: alertdashboard_PerformSetScope
  5207. parameters:
  5208. - description: The Id or Name of alertdashboard
  5209. in: path
  5210. name: id
  5211. required: true
  5212. type: string
  5213. x-go-name: Id
  5214. responses:
  5215. "200":
  5216. $ref: '#/responses/alertdashboard_PerformSetScopeOutput'
  5217. summary: 执行操作SetScope
  5218. tags:
  5219. - alertdashboard
  5220. /alertdashboards/{id}/status:
  5221. get:
  5222. description: 获取指定信息Status
  5223. operationId: alertdashboard_GetDetailsStatus
  5224. parameters:
  5225. - description: The Id or Name of alertdashboard
  5226. in: path
  5227. name: id
  5228. required: true
  5229. type: string
  5230. x-go-name: Id
  5231. responses:
  5232. "200":
  5233. $ref: '#/responses/alertdashboard_GetDetailsStatusOutput'
  5234. summary: 获取资源状态
  5235. tags:
  5236. - alertdashboard
  5237. /alertpanels:
  5238. get:
  5239. description: 列表
  5240. operationId: alertpanel_ListItemFilter
  5241. parameters:
  5242. - description: 指定查询的权限范围,可能值为project, domain or system
  5243. in: query
  5244. name: scope
  5245. type: string
  5246. x-go-name: Scope
  5247. - description: 指定项目归属域名称或ID
  5248. in: query
  5249. name: project_domain_id
  5250. type: string
  5251. x-go-name: ProjectDomainId
  5252. - description: 对具有域属性的资源,严格匹配域ID
  5253. in: query
  5254. items:
  5255. type: string
  5256. name: project_domain_ids
  5257. type: array
  5258. x-go-name: ProjectDomainIds
  5259. - description: 按domain名称排序,可能值为asc|desc
  5260. in: query
  5261. name: order_by_domain
  5262. pattern: asc|desc
  5263. type: string
  5264. x-go-name: OrderByDomain
  5265. - $ref: '#/definitions/TTagSetList'
  5266. description: filter by domain tags
  5267. in: query
  5268. name: domain_tags
  5269. x-go-name: DomainTags
  5270. - $ref: '#/definitions/TTagSetList'
  5271. description: filter by domain tags
  5272. in: query
  5273. name: no_domain_tags
  5274. x-go-name: NoDomainTags
  5275. - description: 指定项目的名称或ID
  5276. in: query
  5277. name: project_id
  5278. type: string
  5279. x-go-name: ProjectId
  5280. - description: 对具有项目属性的资源,严格匹配项目ID
  5281. in: query
  5282. items:
  5283. type: string
  5284. name: project_ids
  5285. type: array
  5286. x-go-name: ProjectIds
  5287. - description: 按project名称排序,可能值为asc|desc
  5288. in: query
  5289. name: order_by_project
  5290. pattern: asc|desc
  5291. type: string
  5292. x-go-name: OrderByProject
  5293. - $ref: '#/definitions/TTagSetList'
  5294. description: filter by project tags
  5295. in: query
  5296. name: project_tags
  5297. x-go-name: ProjectTags
  5298. - $ref: '#/definitions/TTagSetList'
  5299. description: filter by no project tags
  5300. in: query
  5301. name: no_project_tags
  5302. x-go-name: NoProjectTags
  5303. - description: filter by project organizations
  5304. in: query
  5305. items:
  5306. type: string
  5307. name: project_organizations
  5308. type: array
  5309. x-go-name: ProjectOrganizations
  5310. - $ref: '#/definitions/TTagSetList'
  5311. description: |-
  5312. ignore
  5313. project tag fitlers imposed by policy
  5314. in: query
  5315. name: policy_project_tags
  5316. x-go-name: PolicyProjectTags
  5317. - description: 指定匹配的范围,可能值为project, domain or system
  5318. in: query
  5319. name: belong_scope
  5320. type: string
  5321. x-go-name: BelongScope
  5322. - description: 以资源是否启用/禁用过滤列表
  5323. in: query
  5324. name: enabled
  5325. type: boolean
  5326. x-go-name: Enabled
  5327. - default: 20
  5328. description: 查询限制量
  5329. format: int64
  5330. in: query
  5331. name: limit
  5332. type: integer
  5333. x-go-name: Limit
  5334. - default: 0
  5335. description: 查询偏移量
  5336. format: int64
  5337. in: query
  5338. name: offset
  5339. type: integer
  5340. x-go-name: Offset
  5341. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  5342. in: query
  5343. items:
  5344. type: string
  5345. name: order_by
  5346. type: array
  5347. x-go-name: OrderBy
  5348. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  5349. example: desc|asc
  5350. in: query
  5351. name: order
  5352. type: string
  5353. x-go-name: Order
  5354. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  5355. in: query
  5356. name: details
  5357. type: boolean
  5358. x-go-name: Details
  5359. - description: 模糊搜索所有字段
  5360. in: query
  5361. name: search
  5362. type: string
  5363. x-go-name: Search
  5364. - description: |-
  5365. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  5366. 支持的操作符如下:
  5367. 操作符 | 参数个数 | 举例 | 说明 |
  5368. ---------------|----------|------------------------------------------------|-----------------------------|
  5369. in | > 0 | name.in("test", "good") | 在给定数组中 |
  5370. notin | > 0 | name.notin('test') | 不在给定数组中 |
  5371. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  5372. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  5373. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  5374. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  5375. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  5376. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  5377. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  5378. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  5379. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  5380. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  5381. notequals | 1 | name.notequals('test') | 不等于给定值 |
  5382. isnull | 0 | name.isnull() | 值为SQL的NULL |
  5383. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  5384. isempty | 0 | name.isempty('test') | 值为空字符串 |
  5385. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  5386. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  5387. in: query
  5388. items:
  5389. type: string
  5390. name: filter
  5391. type: array
  5392. x-go-name: Filter
  5393. - description: |-
  5394. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  5395. 和其他表关联的语法如下:
  5396. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  5397. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  5398. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  5399. 举例:
  5400. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  5401. in: query
  5402. items:
  5403. type: string
  5404. name: joint_filter
  5405. type: array
  5406. x-go-name: JointFilter
  5407. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  5408. in: query
  5409. name: filter_any
  5410. type: boolean
  5411. x-go-name: FilterAny
  5412. - description: 返回结果只包含指定的字段
  5413. in: query
  5414. items:
  5415. type: string
  5416. name: field
  5417. type: array
  5418. x-go-name: Field
  5419. - description: 用于数据导出,指定导出的数据字段
  5420. in: query
  5421. name: export_keys
  5422. type: string
  5423. x-go-name: ExportKeys
  5424. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  5425. in: query
  5426. name: show_fail_reason
  5427. type: boolean
  5428. x-go-name: ShowFailReason
  5429. - description: 是否返回状态统计信息,默认为False
  5430. in: query
  5431. name: summary_stats
  5432. type: boolean
  5433. x-go-name: SummaryStats
  5434. - $ref: '#/definitions/TTagSet'
  5435. description: 通过标签过滤(包含这些标签)
  5436. in: query
  5437. name: tags
  5438. x-go-name: Tags
  5439. - $ref: '#/definitions/TTagSetList'
  5440. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  5441. in: query
  5442. name: obj_tags
  5443. x-go-name: ObjTags
  5444. - $ref: '#/definitions/TTagSet'
  5445. description: 通过标签过滤(不包含这些标签)
  5446. in: query
  5447. name: no_tags
  5448. x-go-name: NoTags
  5449. - $ref: '#/definitions/TTagSetList'
  5450. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  5451. in: query
  5452. name: no_obj_tags
  5453. x-go-name: NoObjTags
  5454. - description: 通过标签排序
  5455. in: query
  5456. name: order_by_tag
  5457. type: string
  5458. x-go-name: OrderByTag
  5459. - description: |-
  5460. deprecated
  5461. 返回资源的标签不包含用户标签
  5462. in: query
  5463. name: without_user_meta
  5464. type: boolean
  5465. x-go-name: WithoutUserMeta
  5466. - description: 返回包含用户标签的资源
  5467. in: query
  5468. name: with_user_meta
  5469. type: boolean
  5470. x-go-name: WithUserMeta
  5471. - description: 返回包含外部标签的资源
  5472. in: query
  5473. name: with_cloud_meta
  5474. type: boolean
  5475. x-go-name: WithCloudMeta
  5476. - description: 返回包含任意标签的资源
  5477. in: query
  5478. name: with_any_meta
  5479. type: boolean
  5480. x-go-name: WithAnyMeta
  5481. - description: 返回列表数据中包含资源的标签数据(Metadata)
  5482. in: query
  5483. name: with_meta
  5484. type: boolean
  5485. x-go-name: WithMeta
  5486. - description: 显示所有的资源,包括模拟的资源
  5487. in: query
  5488. name: show_emulated
  5489. type: boolean
  5490. x-go-name: ShowEmulated
  5491. - description: 以资源ID过滤列表
  5492. in: query
  5493. items:
  5494. type: string
  5495. name: id
  5496. type: array
  5497. x-go-name: Ids
  5498. - description: 以资源名称过滤列表
  5499. in: query
  5500. items:
  5501. type: string
  5502. name: name
  5503. type: array
  5504. x-go-name: Names
  5505. - description: 以资源的状态过滤列表
  5506. in: query
  5507. items:
  5508. type: string
  5509. name: status
  5510. type: array
  5511. x-go-name: Status
  5512. - description: |-
  5513. 以报警是否启用/禁用过滤列表
  5514. Enabled *bool `json:"enabled"`
  5515. in: query
  5516. items:
  5517. type: string
  5518. name: monitor_resource_id
  5519. type: array
  5520. x-go-name: MonitorResourceId
  5521. - in: query
  5522. name: dashboard_id
  5523. type: string
  5524. x-go-name: DashboardId
  5525. responses:
  5526. "200":
  5527. $ref: '#/responses/alertpanel_ListItemFilterOutput'
  5528. summary: 列表
  5529. tags:
  5530. - alertpanel
  5531. post:
  5532. description: 新建
  5533. operationId: alertpanel_ValidateCreateData
  5534. parameters:
  5535. - in: body
  5536. name: body
  5537. schema:
  5538. properties:
  5539. alertpanel:
  5540. $ref: '#/definitions/AlertPanelCreateInput'
  5541. count:
  5542. default: 1
  5543. format: int64
  5544. type: integer
  5545. x-go-name: Count
  5546. type: object
  5547. x-go-name: Body
  5548. responses:
  5549. "200":
  5550. $ref: '#/responses/alertpanel_ValidateCreateDataOutput'
  5551. summary: 新建
  5552. tags:
  5553. - alertpanel
  5554. /alertpanels/{id}:
  5555. delete:
  5556. description: 删除
  5557. operationId: alertpanel_CustomizeDelete
  5558. parameters:
  5559. - description: The Id or Name of alertpanel
  5560. in: path
  5561. name: id
  5562. required: true
  5563. type: string
  5564. x-go-name: Id
  5565. responses:
  5566. "200":
  5567. $ref: '#/responses/alertpanel_CustomizeDeleteOutput'
  5568. summary: 删除
  5569. tags:
  5570. - alertpanel
  5571. get:
  5572. description: 获取详情
  5573. operationId: alertpanel_FetchCustomizeColumns
  5574. parameters:
  5575. - description: The Id or Name of alertpanel
  5576. in: path
  5577. name: id
  5578. required: true
  5579. type: string
  5580. x-go-name: Id
  5581. responses:
  5582. "200":
  5583. $ref: '#/responses/alertpanel_FetchCustomizeColumnsOutput'
  5584. summary: 获取详情
  5585. tags:
  5586. - alertpanel
  5587. put:
  5588. description: 更新
  5589. operationId: alertpanel_ValidateUpdateData
  5590. parameters:
  5591. - description: The Id or Name of alertpanel
  5592. in: path
  5593. name: id
  5594. required: true
  5595. type: string
  5596. x-go-name: Id
  5597. responses:
  5598. "200":
  5599. $ref: '#/responses/alertpanel_ValidateUpdateDataOutput'
  5600. summary: 更新
  5601. tags:
  5602. - alertpanel
  5603. /alertpanels/{id}/metadata:
  5604. get:
  5605. description: 获取指定信息Metadata
  5606. operationId: alertpanel_GetDetailsMetadata
  5607. parameters:
  5608. - description: |-
  5609. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  5610. 标签分为
  5611. 类型 | 说明 |
  5612. ----------|---------------------------------------------|
  5613. 系统标签 | 平台定义的标签 |
  5614. 用户标签 | key以user:为前缀,用户自定义标签 |
  5615. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  5616. in: query
  5617. items:
  5618. type: string
  5619. name: field
  5620. type: array
  5621. x-go-name: Field
  5622. - description: 按标签前缀过滤
  5623. in: query
  5624. name: prefix
  5625. type: string
  5626. x-go-name: Prefix
  5627. - description: The Id or Name of alertpanel
  5628. in: path
  5629. name: id
  5630. required: true
  5631. type: string
  5632. x-go-name: Id
  5633. responses:
  5634. "200":
  5635. $ref: '#/responses/alertpanel_GetDetailsMetadataOutput'
  5636. summary: 获取资源标签(元数据)
  5637. tags:
  5638. - alertpanel
  5639. /alertpanels/{id}/status:
  5640. get:
  5641. description: 获取指定信息Status
  5642. operationId: alertpanel_GetDetailsStatus
  5643. parameters:
  5644. - description: The Id or Name of alertpanel
  5645. in: path
  5646. name: id
  5647. required: true
  5648. type: string
  5649. x-go-name: Id
  5650. responses:
  5651. "200":
  5652. $ref: '#/responses/alertpanel_GetDetailsStatusOutput'
  5653. summary: 获取资源状态
  5654. tags:
  5655. - alertpanel
  5656. /alertrecords:
  5657. get:
  5658. description: 列表
  5659. operationId: alertrecord_ListItemFilter
  5660. parameters:
  5661. - description: 指定查询的权限范围,可能值为project, domain or system
  5662. in: query
  5663. name: scope
  5664. type: string
  5665. x-go-name: Scope
  5666. - description: 指定项目归属域名称或ID
  5667. in: query
  5668. name: project_domain_id
  5669. type: string
  5670. x-go-name: ProjectDomainId
  5671. - description: 对具有域属性的资源,严格匹配域ID
  5672. in: query
  5673. items:
  5674. type: string
  5675. name: project_domain_ids
  5676. type: array
  5677. x-go-name: ProjectDomainIds
  5678. - description: 按domain名称排序,可能值为asc|desc
  5679. in: query
  5680. name: order_by_domain
  5681. pattern: asc|desc
  5682. type: string
  5683. x-go-name: OrderByDomain
  5684. - $ref: '#/definitions/TTagSetList'
  5685. description: filter by domain tags
  5686. in: query
  5687. name: domain_tags
  5688. x-go-name: DomainTags
  5689. - $ref: '#/definitions/TTagSetList'
  5690. description: filter by domain tags
  5691. in: query
  5692. name: no_domain_tags
  5693. x-go-name: NoDomainTags
  5694. - description: 指定项目的名称或ID
  5695. in: query
  5696. name: project_id
  5697. type: string
  5698. x-go-name: ProjectId
  5699. - description: 对具有项目属性的资源,严格匹配项目ID
  5700. in: query
  5701. items:
  5702. type: string
  5703. name: project_ids
  5704. type: array
  5705. x-go-name: ProjectIds
  5706. - description: 按project名称排序,可能值为asc|desc
  5707. in: query
  5708. name: order_by_project
  5709. pattern: asc|desc
  5710. type: string
  5711. x-go-name: OrderByProject
  5712. - $ref: '#/definitions/TTagSetList'
  5713. description: filter by project tags
  5714. in: query
  5715. name: project_tags
  5716. x-go-name: ProjectTags
  5717. - $ref: '#/definitions/TTagSetList'
  5718. description: filter by no project tags
  5719. in: query
  5720. name: no_project_tags
  5721. x-go-name: NoProjectTags
  5722. - description: filter by project organizations
  5723. in: query
  5724. items:
  5725. type: string
  5726. name: project_organizations
  5727. type: array
  5728. x-go-name: ProjectOrganizations
  5729. - $ref: '#/definitions/TTagSetList'
  5730. description: |-
  5731. ignore
  5732. project tag fitlers imposed by policy
  5733. in: query
  5734. name: policy_project_tags
  5735. x-go-name: PolicyProjectTags
  5736. - description: 指定匹配的范围,可能值为project, domain or system
  5737. in: query
  5738. name: belong_scope
  5739. type: string
  5740. x-go-name: BelongScope
  5741. - description: 以资源是否启用/禁用过滤列表
  5742. in: query
  5743. name: enabled
  5744. type: boolean
  5745. x-go-name: Enabled
  5746. - default: 20
  5747. description: 查询限制量
  5748. format: int64
  5749. in: query
  5750. name: limit
  5751. type: integer
  5752. x-go-name: Limit
  5753. - default: 0
  5754. description: 查询偏移量
  5755. format: int64
  5756. in: query
  5757. name: offset
  5758. type: integer
  5759. x-go-name: Offset
  5760. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  5761. in: query
  5762. items:
  5763. type: string
  5764. name: order_by
  5765. type: array
  5766. x-go-name: OrderBy
  5767. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  5768. example: desc|asc
  5769. in: query
  5770. name: order
  5771. type: string
  5772. x-go-name: Order
  5773. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  5774. in: query
  5775. name: details
  5776. type: boolean
  5777. x-go-name: Details
  5778. - description: 模糊搜索所有字段
  5779. in: query
  5780. name: search
  5781. type: string
  5782. x-go-name: Search
  5783. - description: |-
  5784. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  5785. 支持的操作符如下:
  5786. 操作符 | 参数个数 | 举例 | 说明 |
  5787. ---------------|----------|------------------------------------------------|-----------------------------|
  5788. in | > 0 | name.in("test", "good") | 在给定数组中 |
  5789. notin | > 0 | name.notin('test') | 不在给定数组中 |
  5790. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  5791. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  5792. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  5793. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  5794. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  5795. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  5796. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  5797. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  5798. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  5799. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  5800. notequals | 1 | name.notequals('test') | 不等于给定值 |
  5801. isnull | 0 | name.isnull() | 值为SQL的NULL |
  5802. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  5803. isempty | 0 | name.isempty('test') | 值为空字符串 |
  5804. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  5805. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  5806. in: query
  5807. items:
  5808. type: string
  5809. name: filter
  5810. type: array
  5811. x-go-name: Filter
  5812. - description: |-
  5813. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  5814. 和其他表关联的语法如下:
  5815. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  5816. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  5817. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  5818. 举例:
  5819. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  5820. in: query
  5821. items:
  5822. type: string
  5823. name: joint_filter
  5824. type: array
  5825. x-go-name: JointFilter
  5826. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  5827. in: query
  5828. name: filter_any
  5829. type: boolean
  5830. x-go-name: FilterAny
  5831. - description: 返回结果只包含指定的字段
  5832. in: query
  5833. items:
  5834. type: string
  5835. name: field
  5836. type: array
  5837. x-go-name: Field
  5838. - description: 用于数据导出,指定导出的数据字段
  5839. in: query
  5840. name: export_keys
  5841. type: string
  5842. x-go-name: ExportKeys
  5843. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  5844. in: query
  5845. name: show_fail_reason
  5846. type: boolean
  5847. x-go-name: ShowFailReason
  5848. - description: 是否返回状态统计信息,默认为False
  5849. in: query
  5850. name: summary_stats
  5851. type: boolean
  5852. x-go-name: SummaryStats
  5853. - $ref: '#/definitions/TTagSet'
  5854. description: 通过标签过滤(包含这些标签)
  5855. in: query
  5856. name: tags
  5857. x-go-name: Tags
  5858. - $ref: '#/definitions/TTagSetList'
  5859. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  5860. in: query
  5861. name: obj_tags
  5862. x-go-name: ObjTags
  5863. - $ref: '#/definitions/TTagSet'
  5864. description: 通过标签过滤(不包含这些标签)
  5865. in: query
  5866. name: no_tags
  5867. x-go-name: NoTags
  5868. - $ref: '#/definitions/TTagSetList'
  5869. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  5870. in: query
  5871. name: no_obj_tags
  5872. x-go-name: NoObjTags
  5873. - description: 通过标签排序
  5874. in: query
  5875. name: order_by_tag
  5876. type: string
  5877. x-go-name: OrderByTag
  5878. - description: |-
  5879. deprecated
  5880. 返回资源的标签不包含用户标签
  5881. in: query
  5882. name: without_user_meta
  5883. type: boolean
  5884. x-go-name: WithoutUserMeta
  5885. - description: 返回包含用户标签的资源
  5886. in: query
  5887. name: with_user_meta
  5888. type: boolean
  5889. x-go-name: WithUserMeta
  5890. - description: 返回包含外部标签的资源
  5891. in: query
  5892. name: with_cloud_meta
  5893. type: boolean
  5894. x-go-name: WithCloudMeta
  5895. - description: 返回包含任意标签的资源
  5896. in: query
  5897. name: with_any_meta
  5898. type: boolean
  5899. x-go-name: WithAnyMeta
  5900. - description: 返回列表数据中包含资源的标签数据(Metadata)
  5901. in: query
  5902. name: with_meta
  5903. type: boolean
  5904. x-go-name: WithMeta
  5905. - description: 显示所有的资源,包括模拟的资源
  5906. in: query
  5907. name: show_emulated
  5908. type: boolean
  5909. x-go-name: ShowEmulated
  5910. - description: 以资源ID过滤列表
  5911. in: query
  5912. items:
  5913. type: string
  5914. name: id
  5915. type: array
  5916. x-go-name: Ids
  5917. - description: 以资源名称过滤列表
  5918. in: query
  5919. items:
  5920. type: string
  5921. name: name
  5922. type: array
  5923. x-go-name: Names
  5924. - description: 以资源的状态过滤列表
  5925. in: query
  5926. items:
  5927. type: string
  5928. name: status
  5929. type: array
  5930. x-go-name: Status
  5931. - in: query
  5932. name: alert_id
  5933. type: string
  5934. x-go-name: AlertId
  5935. - in: query
  5936. name: alert_name
  5937. type: string
  5938. x-go-name: AlertName
  5939. - in: query
  5940. name: level
  5941. type: string
  5942. x-go-name: Level
  5943. - in: query
  5944. name: state
  5945. type: string
  5946. x-go-name: State
  5947. - in: query
  5948. name: res_type
  5949. type: string
  5950. x-go-name: ResType
  5951. - in: query
  5952. name: alerting
  5953. type: boolean
  5954. x-go-name: Alerting
  5955. - in: query
  5956. name: res_name
  5957. type: string
  5958. x-go-name: ResName
  5959. - in: query
  5960. name: res_id
  5961. type: string
  5962. x-go-name: ResId
  5963. responses:
  5964. "200":
  5965. $ref: '#/responses/alertrecord_ListItemFilterOutput'
  5966. summary: 列表
  5967. tags:
  5968. - alertrecord
  5969. post:
  5970. description: 新建
  5971. operationId: alertrecord_ValidateCreateData
  5972. parameters:
  5973. - in: body
  5974. name: body
  5975. schema:
  5976. properties:
  5977. alertrecord:
  5978. $ref: '#/definitions/AlertRecordCreateInput'
  5979. count:
  5980. default: 1
  5981. format: int64
  5982. type: integer
  5983. x-go-name: Count
  5984. type: object
  5985. x-go-name: Body
  5986. responses:
  5987. "200":
  5988. $ref: '#/responses/alertrecord_ValidateCreateDataOutput'
  5989. summary: 新建
  5990. tags:
  5991. - alertrecord
  5992. /alertrecords/{id}:
  5993. delete:
  5994. description: 删除
  5995. operationId: alertrecord_CustomizeDelete
  5996. parameters:
  5997. - description: The Id or Name of alertrecord
  5998. in: path
  5999. name: id
  6000. required: true
  6001. type: string
  6002. x-go-name: Id
  6003. responses:
  6004. "200":
  6005. $ref: '#/responses/alertrecord_CustomizeDeleteOutput'
  6006. summary: 删除
  6007. tags:
  6008. - alertrecord
  6009. get:
  6010. description: 获取详情
  6011. operationId: alertrecord_FetchCustomizeColumns
  6012. parameters:
  6013. - description: The Id or Name of alertrecord
  6014. in: path
  6015. name: id
  6016. required: true
  6017. type: string
  6018. x-go-name: Id
  6019. responses:
  6020. "200":
  6021. $ref: '#/responses/alertrecord_FetchCustomizeColumnsOutput'
  6022. summary: 获取详情
  6023. tags:
  6024. - alertrecord
  6025. put:
  6026. description: 更新
  6027. operationId: alertrecord_ValidateUpdateData
  6028. parameters:
  6029. - description: The Id or Name of alertrecord
  6030. in: path
  6031. name: id
  6032. required: true
  6033. type: string
  6034. x-go-name: Id
  6035. - in: body
  6036. name: body
  6037. schema:
  6038. properties:
  6039. alertrecord:
  6040. $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput'
  6041. type: object
  6042. x-go-name: Body
  6043. responses:
  6044. "200":
  6045. $ref: '#/responses/alertrecord_ValidateUpdateDataOutput'
  6046. summary: 更新
  6047. tags:
  6048. - alertrecord
  6049. /alertrecords/{id}/metadata:
  6050. get:
  6051. description: 获取指定信息Metadata
  6052. operationId: alertrecord_GetDetailsMetadata
  6053. parameters:
  6054. - description: |-
  6055. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  6056. 标签分为
  6057. 类型 | 说明 |
  6058. ----------|---------------------------------------------|
  6059. 系统标签 | 平台定义的标签 |
  6060. 用户标签 | key以user:为前缀,用户自定义标签 |
  6061. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  6062. in: query
  6063. items:
  6064. type: string
  6065. name: field
  6066. type: array
  6067. x-go-name: Field
  6068. - description: 按标签前缀过滤
  6069. in: query
  6070. name: prefix
  6071. type: string
  6072. x-go-name: Prefix
  6073. - description: The Id or Name of alertrecord
  6074. in: path
  6075. name: id
  6076. required: true
  6077. type: string
  6078. x-go-name: Id
  6079. responses:
  6080. "200":
  6081. $ref: '#/responses/alertrecord_GetDetailsMetadataOutput'
  6082. summary: 获取资源标签(元数据)
  6083. tags:
  6084. - alertrecord
  6085. /alertrecords/history-alert:
  6086. get:
  6087. description: 获取指定资源类的信息HistoryAlert
  6088. operationId: alertrecord_GetPropertyHistoryAlert
  6089. responses:
  6090. "200":
  6091. $ref: '#/responses/alertrecord_GetPropertyHistoryAlertOutput'
  6092. summary: 获取过去一天的报警历史分布
  6093. tags:
  6094. - alertrecord
  6095. /alertrecords/project-alert-resource-count:
  6096. get:
  6097. description: 获取指定资源类的信息ProjectAlertResourceCount
  6098. operationId: alertrecord_GetPropertyProjectAlertResourceCount
  6099. parameters:
  6100. - format: date-time
  6101. in: query
  6102. name: start_time
  6103. type: string
  6104. x-go-name: StartTime
  6105. - format: date-time
  6106. in: query
  6107. name: end_time
  6108. type: string
  6109. x-go-name: EndTime
  6110. - in: query
  6111. name: res_type
  6112. type: string
  6113. x-go-name: ResType
  6114. - in: query
  6115. name: alert_id
  6116. type: string
  6117. x-go-name: AlertId
  6118. - in: query
  6119. name: scope
  6120. type: string
  6121. x-go-name: Scope
  6122. responses:
  6123. "200":
  6124. $ref: '#/responses/alertrecord_GetPropertyProjectAlertResourceCountOutput'
  6125. summary: GetPropertyProjectAlertResourceCount 获取指定时间段内各项目下的报警资源数量
  6126. tags:
  6127. - alertrecord
  6128. /alertrecords/total-alert:
  6129. get:
  6130. description: 获取指定资源类的信息TotalAlert
  6131. operationId: alertrecord_GetPropertyTotalAlert
  6132. responses:
  6133. "200":
  6134. $ref: '#/responses/alertrecord_GetPropertyTotalAlertOutput'
  6135. summary: 获取指定资源类的信息TotalAlert
  6136. tags:
  6137. - alertrecord
  6138. /alertrecordshields:
  6139. get:
  6140. description: 列表
  6141. operationId: alertrecordshield_ListItemFilter
  6142. parameters:
  6143. - description: 指定查询的权限范围,可能值为project, domain or system
  6144. in: query
  6145. name: scope
  6146. type: string
  6147. x-go-name: Scope
  6148. - description: 指定项目归属域名称或ID
  6149. in: query
  6150. name: project_domain_id
  6151. type: string
  6152. x-go-name: ProjectDomainId
  6153. - description: 对具有域属性的资源,严格匹配域ID
  6154. in: query
  6155. items:
  6156. type: string
  6157. name: project_domain_ids
  6158. type: array
  6159. x-go-name: ProjectDomainIds
  6160. - description: 按domain名称排序,可能值为asc|desc
  6161. in: query
  6162. name: order_by_domain
  6163. pattern: asc|desc
  6164. type: string
  6165. x-go-name: OrderByDomain
  6166. - $ref: '#/definitions/TTagSetList'
  6167. description: filter by domain tags
  6168. in: query
  6169. name: domain_tags
  6170. x-go-name: DomainTags
  6171. - $ref: '#/definitions/TTagSetList'
  6172. description: filter by domain tags
  6173. in: query
  6174. name: no_domain_tags
  6175. x-go-name: NoDomainTags
  6176. - description: 指定项目的名称或ID
  6177. in: query
  6178. name: project_id
  6179. type: string
  6180. x-go-name: ProjectId
  6181. - description: 对具有项目属性的资源,严格匹配项目ID
  6182. in: query
  6183. items:
  6184. type: string
  6185. name: project_ids
  6186. type: array
  6187. x-go-name: ProjectIds
  6188. - description: 按project名称排序,可能值为asc|desc
  6189. in: query
  6190. name: order_by_project
  6191. pattern: asc|desc
  6192. type: string
  6193. x-go-name: OrderByProject
  6194. - $ref: '#/definitions/TTagSetList'
  6195. description: filter by project tags
  6196. in: query
  6197. name: project_tags
  6198. x-go-name: ProjectTags
  6199. - $ref: '#/definitions/TTagSetList'
  6200. description: filter by no project tags
  6201. in: query
  6202. name: no_project_tags
  6203. x-go-name: NoProjectTags
  6204. - description: filter by project organizations
  6205. in: query
  6206. items:
  6207. type: string
  6208. name: project_organizations
  6209. type: array
  6210. x-go-name: ProjectOrganizations
  6211. - $ref: '#/definitions/TTagSetList'
  6212. description: |-
  6213. ignore
  6214. project tag fitlers imposed by policy
  6215. in: query
  6216. name: policy_project_tags
  6217. x-go-name: PolicyProjectTags
  6218. - description: 指定匹配的范围,可能值为project, domain or system
  6219. in: query
  6220. name: belong_scope
  6221. type: string
  6222. x-go-name: BelongScope
  6223. - description: 以资源是否启用/禁用过滤列表
  6224. in: query
  6225. name: enabled
  6226. type: boolean
  6227. x-go-name: Enabled
  6228. - default: 20
  6229. description: 查询限制量
  6230. format: int64
  6231. in: query
  6232. name: limit
  6233. type: integer
  6234. x-go-name: Limit
  6235. - default: 0
  6236. description: 查询偏移量
  6237. format: int64
  6238. in: query
  6239. name: offset
  6240. type: integer
  6241. x-go-name: Offset
  6242. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6243. in: query
  6244. items:
  6245. type: string
  6246. name: order_by
  6247. type: array
  6248. x-go-name: OrderBy
  6249. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6250. example: desc|asc
  6251. in: query
  6252. name: order
  6253. type: string
  6254. x-go-name: Order
  6255. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6256. in: query
  6257. name: details
  6258. type: boolean
  6259. x-go-name: Details
  6260. - description: 模糊搜索所有字段
  6261. in: query
  6262. name: search
  6263. type: string
  6264. x-go-name: Search
  6265. - description: |-
  6266. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6267. 支持的操作符如下:
  6268. 操作符 | 参数个数 | 举例 | 说明 |
  6269. ---------------|----------|------------------------------------------------|-----------------------------|
  6270. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6271. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6272. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6273. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6274. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6275. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6276. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6277. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6278. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6279. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6280. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6281. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6282. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6283. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6284. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6285. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6286. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6287. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6288. in: query
  6289. items:
  6290. type: string
  6291. name: filter
  6292. type: array
  6293. x-go-name: Filter
  6294. - description: |-
  6295. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6296. 和其他表关联的语法如下:
  6297. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6298. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6299. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  6300. 举例:
  6301. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  6302. in: query
  6303. items:
  6304. type: string
  6305. name: joint_filter
  6306. type: array
  6307. x-go-name: JointFilter
  6308. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  6309. in: query
  6310. name: filter_any
  6311. type: boolean
  6312. x-go-name: FilterAny
  6313. - description: 返回结果只包含指定的字段
  6314. in: query
  6315. items:
  6316. type: string
  6317. name: field
  6318. type: array
  6319. x-go-name: Field
  6320. - description: 用于数据导出,指定导出的数据字段
  6321. in: query
  6322. name: export_keys
  6323. type: string
  6324. x-go-name: ExportKeys
  6325. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  6326. in: query
  6327. name: show_fail_reason
  6328. type: boolean
  6329. x-go-name: ShowFailReason
  6330. - description: 是否返回状态统计信息,默认为False
  6331. in: query
  6332. name: summary_stats
  6333. type: boolean
  6334. x-go-name: SummaryStats
  6335. - $ref: '#/definitions/TTagSet'
  6336. description: 通过标签过滤(包含这些标签)
  6337. in: query
  6338. name: tags
  6339. x-go-name: Tags
  6340. - $ref: '#/definitions/TTagSetList'
  6341. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  6342. in: query
  6343. name: obj_tags
  6344. x-go-name: ObjTags
  6345. - $ref: '#/definitions/TTagSet'
  6346. description: 通过标签过滤(不包含这些标签)
  6347. in: query
  6348. name: no_tags
  6349. x-go-name: NoTags
  6350. - $ref: '#/definitions/TTagSetList'
  6351. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  6352. in: query
  6353. name: no_obj_tags
  6354. x-go-name: NoObjTags
  6355. - description: 通过标签排序
  6356. in: query
  6357. name: order_by_tag
  6358. type: string
  6359. x-go-name: OrderByTag
  6360. - description: |-
  6361. deprecated
  6362. 返回资源的标签不包含用户标签
  6363. in: query
  6364. name: without_user_meta
  6365. type: boolean
  6366. x-go-name: WithoutUserMeta
  6367. - description: 返回包含用户标签的资源
  6368. in: query
  6369. name: with_user_meta
  6370. type: boolean
  6371. x-go-name: WithUserMeta
  6372. - description: 返回包含外部标签的资源
  6373. in: query
  6374. name: with_cloud_meta
  6375. type: boolean
  6376. x-go-name: WithCloudMeta
  6377. - description: 返回包含任意标签的资源
  6378. in: query
  6379. name: with_any_meta
  6380. type: boolean
  6381. x-go-name: WithAnyMeta
  6382. - description: 返回列表数据中包含资源的标签数据(Metadata)
  6383. in: query
  6384. name: with_meta
  6385. type: boolean
  6386. x-go-name: WithMeta
  6387. - description: 显示所有的资源,包括模拟的资源
  6388. in: query
  6389. name: show_emulated
  6390. type: boolean
  6391. x-go-name: ShowEmulated
  6392. - description: 以资源ID过滤列表
  6393. in: query
  6394. items:
  6395. type: string
  6396. name: id
  6397. type: array
  6398. x-go-name: Ids
  6399. - description: 以资源名称过滤列表
  6400. in: query
  6401. items:
  6402. type: string
  6403. name: name
  6404. type: array
  6405. x-go-name: Names
  6406. - description: 以资源的状态过滤列表
  6407. in: query
  6408. items:
  6409. type: string
  6410. name: status
  6411. type: array
  6412. x-go-name: Status
  6413. - in: query
  6414. name: alert_name
  6415. type: string
  6416. x-go-name: AlertName
  6417. - in: query
  6418. name: res_type
  6419. type: string
  6420. x-go-name: ResType
  6421. - in: query
  6422. name: res_name
  6423. type: string
  6424. x-go-name: ResName
  6425. - in: query
  6426. name: res_id
  6427. type: string
  6428. x-go-name: ResId
  6429. - in: query
  6430. name: alert_id
  6431. type: string
  6432. x-go-name: AlertId
  6433. - format: date-time
  6434. in: query
  6435. name: start_time
  6436. type: string
  6437. x-go-name: StartTime
  6438. - format: date-time
  6439. in: query
  6440. name: end_time
  6441. type: string
  6442. x-go-name: EndTime
  6443. responses:
  6444. "200":
  6445. $ref: '#/responses/alertrecordshield_ListItemFilterOutput'
  6446. summary: 列表
  6447. tags:
  6448. - alertrecordshield
  6449. post:
  6450. description: 新建
  6451. operationId: alertrecordshield_ValidateCreateData
  6452. parameters:
  6453. - in: body
  6454. name: body
  6455. schema:
  6456. properties:
  6457. alertrecordshield:
  6458. $ref: '#/definitions/AlertRecordShieldCreateInput'
  6459. count:
  6460. default: 1
  6461. format: int64
  6462. type: integer
  6463. x-go-name: Count
  6464. type: object
  6465. x-go-name: Body
  6466. responses:
  6467. "200":
  6468. $ref: '#/responses/alertrecordshield_ValidateCreateDataOutput'
  6469. summary: 新建
  6470. tags:
  6471. - alertrecordshield
  6472. /alertrecordshields/{id}:
  6473. delete:
  6474. description: 删除
  6475. operationId: alertrecordshield_CustomizeDelete
  6476. parameters:
  6477. - description: The Id or Name of alertrecordshield
  6478. in: path
  6479. name: id
  6480. required: true
  6481. type: string
  6482. x-go-name: Id
  6483. responses:
  6484. "200":
  6485. $ref: '#/responses/alertrecordshield_CustomizeDeleteOutput'
  6486. summary: 删除
  6487. tags:
  6488. - alertrecordshield
  6489. get:
  6490. description: 获取详情
  6491. operationId: alertrecordshield_FetchCustomizeColumns
  6492. parameters:
  6493. - description: The Id or Name of alertrecordshield
  6494. in: path
  6495. name: id
  6496. required: true
  6497. type: string
  6498. x-go-name: Id
  6499. responses:
  6500. "200":
  6501. $ref: '#/responses/alertrecordshield_FetchCustomizeColumnsOutput'
  6502. summary: 获取详情
  6503. tags:
  6504. - alertrecordshield
  6505. put:
  6506. description: 更新
  6507. operationId: alertrecordshield_ValidateUpdateData
  6508. parameters:
  6509. - description: The Id or Name of alertrecordshield
  6510. in: path
  6511. name: id
  6512. required: true
  6513. type: string
  6514. x-go-name: Id
  6515. - in: body
  6516. name: body
  6517. schema:
  6518. properties:
  6519. alertrecordshield:
  6520. $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput'
  6521. type: object
  6522. x-go-name: Body
  6523. responses:
  6524. "200":
  6525. $ref: '#/responses/alertrecordshield_ValidateUpdateDataOutput'
  6526. summary: 更新
  6527. tags:
  6528. - alertrecordshield
  6529. /alertrecordshields/{id}/metadata:
  6530. get:
  6531. description: 获取指定信息Metadata
  6532. operationId: alertrecordshield_GetDetailsMetadata
  6533. parameters:
  6534. - description: |-
  6535. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  6536. 标签分为
  6537. 类型 | 说明 |
  6538. ----------|---------------------------------------------|
  6539. 系统标签 | 平台定义的标签 |
  6540. 用户标签 | key以user:为前缀,用户自定义标签 |
  6541. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  6542. in: query
  6543. items:
  6544. type: string
  6545. name: field
  6546. type: array
  6547. x-go-name: Field
  6548. - description: 按标签前缀过滤
  6549. in: query
  6550. name: prefix
  6551. type: string
  6552. x-go-name: Prefix
  6553. - description: The Id or Name of alertrecordshield
  6554. in: path
  6555. name: id
  6556. required: true
  6557. type: string
  6558. x-go-name: Id
  6559. responses:
  6560. "200":
  6561. $ref: '#/responses/alertrecordshield_GetDetailsMetadataOutput'
  6562. summary: 获取资源标签(元数据)
  6563. tags:
  6564. - alertrecordshield
  6565. /alertrecordshields/{id}/status:
  6566. get:
  6567. description: 获取指定信息Status
  6568. operationId: alertrecordshield_GetDetailsStatus
  6569. parameters:
  6570. - description: The Id or Name of alertrecordshield
  6571. in: path
  6572. name: id
  6573. required: true
  6574. type: string
  6575. x-go-name: Id
  6576. responses:
  6577. "200":
  6578. $ref: '#/responses/alertrecordshield_GetDetailsStatusOutput'
  6579. summary: 获取资源状态
  6580. tags:
  6581. - alertrecordshield
  6582. /alertresources:
  6583. get:
  6584. description: 列表
  6585. operationId: alertresource_ListItemFilter
  6586. parameters:
  6587. - default: 20
  6588. description: 查询限制量
  6589. format: int64
  6590. in: query
  6591. name: limit
  6592. type: integer
  6593. x-go-name: Limit
  6594. - default: 0
  6595. description: 查询偏移量
  6596. format: int64
  6597. in: query
  6598. name: offset
  6599. type: integer
  6600. x-go-name: Offset
  6601. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6602. in: query
  6603. items:
  6604. type: string
  6605. name: order_by
  6606. type: array
  6607. x-go-name: OrderBy
  6608. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6609. example: desc|asc
  6610. in: query
  6611. name: order
  6612. type: string
  6613. x-go-name: Order
  6614. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6615. in: query
  6616. name: details
  6617. type: boolean
  6618. x-go-name: Details
  6619. - description: 模糊搜索所有字段
  6620. in: query
  6621. name: search
  6622. type: string
  6623. x-go-name: Search
  6624. - description: |-
  6625. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6626. 支持的操作符如下:
  6627. 操作符 | 参数个数 | 举例 | 说明 |
  6628. ---------------|----------|------------------------------------------------|-----------------------------|
  6629. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6630. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6631. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6632. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6633. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6634. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6635. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6636. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6637. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6638. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6639. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6640. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6641. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6642. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6643. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6644. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6645. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6646. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6647. in: query
  6648. items:
  6649. type: string
  6650. name: filter
  6651. type: array
  6652. x-go-name: Filter
  6653. - description: |-
  6654. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6655. 和其他表关联的语法如下:
  6656. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6657. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6658. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  6659. 举例:
  6660. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  6661. in: query
  6662. items:
  6663. type: string
  6664. name: joint_filter
  6665. type: array
  6666. x-go-name: JointFilter
  6667. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  6668. in: query
  6669. name: filter_any
  6670. type: boolean
  6671. x-go-name: FilterAny
  6672. - description: 返回结果只包含指定的字段
  6673. in: query
  6674. items:
  6675. type: string
  6676. name: field
  6677. type: array
  6678. x-go-name: Field
  6679. - description: 用于数据导出,指定导出的数据字段
  6680. in: query
  6681. name: export_keys
  6682. type: string
  6683. x-go-name: ExportKeys
  6684. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  6685. in: query
  6686. name: show_fail_reason
  6687. type: boolean
  6688. x-go-name: ShowFailReason
  6689. - description: 是否返回状态统计信息,默认为False
  6690. in: query
  6691. name: summary_stats
  6692. type: boolean
  6693. x-go-name: SummaryStats
  6694. - $ref: '#/definitions/TTagSet'
  6695. description: 通过标签过滤(包含这些标签)
  6696. in: query
  6697. name: tags
  6698. x-go-name: Tags
  6699. - $ref: '#/definitions/TTagSetList'
  6700. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  6701. in: query
  6702. name: obj_tags
  6703. x-go-name: ObjTags
  6704. - $ref: '#/definitions/TTagSet'
  6705. description: 通过标签过滤(不包含这些标签)
  6706. in: query
  6707. name: no_tags
  6708. x-go-name: NoTags
  6709. - $ref: '#/definitions/TTagSetList'
  6710. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  6711. in: query
  6712. name: no_obj_tags
  6713. x-go-name: NoObjTags
  6714. - description: 通过标签排序
  6715. in: query
  6716. name: order_by_tag
  6717. type: string
  6718. x-go-name: OrderByTag
  6719. - description: |-
  6720. deprecated
  6721. 返回资源的标签不包含用户标签
  6722. in: query
  6723. name: without_user_meta
  6724. type: boolean
  6725. x-go-name: WithoutUserMeta
  6726. - description: 返回包含用户标签的资源
  6727. in: query
  6728. name: with_user_meta
  6729. type: boolean
  6730. x-go-name: WithUserMeta
  6731. - description: 返回包含外部标签的资源
  6732. in: query
  6733. name: with_cloud_meta
  6734. type: boolean
  6735. x-go-name: WithCloudMeta
  6736. - description: 返回包含任意标签的资源
  6737. in: query
  6738. name: with_any_meta
  6739. type: boolean
  6740. x-go-name: WithAnyMeta
  6741. - description: 返回列表数据中包含资源的标签数据(Metadata)
  6742. in: query
  6743. name: with_meta
  6744. type: boolean
  6745. x-go-name: WithMeta
  6746. - description: 显示所有的资源,包括模拟的资源
  6747. in: query
  6748. name: show_emulated
  6749. type: boolean
  6750. x-go-name: ShowEmulated
  6751. - description: 以资源ID过滤列表
  6752. in: query
  6753. items:
  6754. type: string
  6755. name: id
  6756. type: array
  6757. x-go-name: Ids
  6758. - description: 以资源名称过滤列表
  6759. in: query
  6760. items:
  6761. type: string
  6762. name: name
  6763. type: array
  6764. x-go-name: Names
  6765. - in: query
  6766. name: type
  6767. type: string
  6768. x-go-name: Type
  6769. responses:
  6770. "200":
  6771. $ref: '#/responses/alertresource_ListItemFilterOutput'
  6772. summary: 列表
  6773. tags:
  6774. - alertresource
  6775. post:
  6776. description: 新建
  6777. operationId: alertresource_ValidateCreateData
  6778. parameters:
  6779. - in: body
  6780. name: body
  6781. schema:
  6782. properties:
  6783. alertresource:
  6784. $ref: '#/definitions/StandaloneResourceCreateInput'
  6785. count:
  6786. default: 1
  6787. format: int64
  6788. type: integer
  6789. x-go-name: Count
  6790. type: object
  6791. x-go-name: Body
  6792. responses:
  6793. "200":
  6794. $ref: '#/responses/alertresource_ValidateCreateDataOutput'
  6795. summary: 新建
  6796. tags:
  6797. - alertresource
  6798. /alertresources/{id}:
  6799. delete:
  6800. description: 删除
  6801. operationId: alertresource_CustomizeDelete
  6802. parameters:
  6803. - description: The Id or Name of alertresource
  6804. in: path
  6805. name: id
  6806. required: true
  6807. type: string
  6808. x-go-name: Id
  6809. responses:
  6810. "200":
  6811. $ref: '#/responses/alertresource_CustomizeDeleteOutput'
  6812. summary: 删除
  6813. tags:
  6814. - alertresource
  6815. get:
  6816. description: 获取详情
  6817. operationId: alertresource_FetchCustomizeColumns
  6818. parameters:
  6819. - description: The Id or Name of alertresource
  6820. in: path
  6821. name: id
  6822. required: true
  6823. type: string
  6824. x-go-name: Id
  6825. responses:
  6826. "200":
  6827. $ref: '#/responses/alertresource_FetchCustomizeColumnsOutput'
  6828. summary: 获取详情
  6829. tags:
  6830. - alertresource
  6831. put:
  6832. description: 更新
  6833. operationId: alertresource_ValidateUpdateData
  6834. parameters:
  6835. - description: The Id or Name of alertresource
  6836. in: path
  6837. name: id
  6838. required: true
  6839. type: string
  6840. x-go-name: Id
  6841. - in: body
  6842. name: body
  6843. schema:
  6844. properties:
  6845. alertresource:
  6846. $ref: '#/definitions/StandaloneResourceBaseUpdateInput'
  6847. type: object
  6848. x-go-name: Body
  6849. responses:
  6850. "200":
  6851. $ref: '#/responses/alertresource_ValidateUpdateDataOutput'
  6852. summary: 更新
  6853. tags:
  6854. - alertresource
  6855. /alertresources/{id}/metadata:
  6856. get:
  6857. description: 获取指定信息Metadata
  6858. operationId: alertresource_GetDetailsMetadata
  6859. parameters:
  6860. - description: |-
  6861. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  6862. 标签分为
  6863. 类型 | 说明 |
  6864. ----------|---------------------------------------------|
  6865. 系统标签 | 平台定义的标签 |
  6866. 用户标签 | key以user:为前缀,用户自定义标签 |
  6867. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  6868. in: query
  6869. items:
  6870. type: string
  6871. name: field
  6872. type: array
  6873. x-go-name: Field
  6874. - description: 按标签前缀过滤
  6875. in: query
  6876. name: prefix
  6877. type: string
  6878. x-go-name: Prefix
  6879. - description: The Id or Name of alertresource
  6880. in: path
  6881. name: id
  6882. required: true
  6883. type: string
  6884. x-go-name: Id
  6885. responses:
  6886. "200":
  6887. $ref: '#/responses/alertresource_GetDetailsMetadataOutput'
  6888. summary: 获取资源标签(元数据)
  6889. tags:
  6890. - alertresource
  6891. /alerts:
  6892. get:
  6893. description: 列表
  6894. operationId: alert_ListItemFilter
  6895. parameters:
  6896. - description: 指定查询的权限范围,可能值为project, domain or system
  6897. in: query
  6898. name: scope
  6899. type: string
  6900. x-go-name: Scope
  6901. - description: 指定项目归属域名称或ID
  6902. in: query
  6903. name: project_domain_id
  6904. type: string
  6905. x-go-name: ProjectDomainId
  6906. - description: 对具有域属性的资源,严格匹配域ID
  6907. in: query
  6908. items:
  6909. type: string
  6910. name: project_domain_ids
  6911. type: array
  6912. x-go-name: ProjectDomainIds
  6913. - description: 按domain名称排序,可能值为asc|desc
  6914. in: query
  6915. name: order_by_domain
  6916. pattern: asc|desc
  6917. type: string
  6918. x-go-name: OrderByDomain
  6919. - $ref: '#/definitions/TTagSetList'
  6920. description: filter by domain tags
  6921. in: query
  6922. name: domain_tags
  6923. x-go-name: DomainTags
  6924. - $ref: '#/definitions/TTagSetList'
  6925. description: filter by domain tags
  6926. in: query
  6927. name: no_domain_tags
  6928. x-go-name: NoDomainTags
  6929. - description: 指定项目的名称或ID
  6930. in: query
  6931. name: project_id
  6932. type: string
  6933. x-go-name: ProjectId
  6934. - description: 对具有项目属性的资源,严格匹配项目ID
  6935. in: query
  6936. items:
  6937. type: string
  6938. name: project_ids
  6939. type: array
  6940. x-go-name: ProjectIds
  6941. - description: 按project名称排序,可能值为asc|desc
  6942. in: query
  6943. name: order_by_project
  6944. pattern: asc|desc
  6945. type: string
  6946. x-go-name: OrderByProject
  6947. - $ref: '#/definitions/TTagSetList'
  6948. description: filter by project tags
  6949. in: query
  6950. name: project_tags
  6951. x-go-name: ProjectTags
  6952. - $ref: '#/definitions/TTagSetList'
  6953. description: filter by no project tags
  6954. in: query
  6955. name: no_project_tags
  6956. x-go-name: NoProjectTags
  6957. - description: filter by project organizations
  6958. in: query
  6959. items:
  6960. type: string
  6961. name: project_organizations
  6962. type: array
  6963. x-go-name: ProjectOrganizations
  6964. - $ref: '#/definitions/TTagSetList'
  6965. description: |-
  6966. ignore
  6967. project tag fitlers imposed by policy
  6968. in: query
  6969. name: policy_project_tags
  6970. x-go-name: PolicyProjectTags
  6971. - description: 指定匹配的范围,可能值为project, domain or system
  6972. in: query
  6973. name: belong_scope
  6974. type: string
  6975. x-go-name: BelongScope
  6976. - description: 以资源是否启用/禁用过滤列表
  6977. in: query
  6978. name: enabled
  6979. type: boolean
  6980. x-go-name: Enabled
  6981. - default: 20
  6982. description: 查询限制量
  6983. format: int64
  6984. in: query
  6985. name: limit
  6986. type: integer
  6987. x-go-name: Limit
  6988. - default: 0
  6989. description: 查询偏移量
  6990. format: int64
  6991. in: query
  6992. name: offset
  6993. type: integer
  6994. x-go-name: Offset
  6995. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6996. in: query
  6997. items:
  6998. type: string
  6999. name: order_by
  7000. type: array
  7001. x-go-name: OrderBy
  7002. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  7003. example: desc|asc
  7004. in: query
  7005. name: order
  7006. type: string
  7007. x-go-name: Order
  7008. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  7009. in: query
  7010. name: details
  7011. type: boolean
  7012. x-go-name: Details
  7013. - description: 模糊搜索所有字段
  7014. in: query
  7015. name: search
  7016. type: string
  7017. x-go-name: Search
  7018. - description: |-
  7019. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  7020. 支持的操作符如下:
  7021. 操作符 | 参数个数 | 举例 | 说明 |
  7022. ---------------|----------|------------------------------------------------|-----------------------------|
  7023. in | > 0 | name.in("test", "good") | 在给定数组中 |
  7024. notin | > 0 | name.notin('test') | 不在给定数组中 |
  7025. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  7026. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  7027. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  7028. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  7029. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  7030. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  7031. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  7032. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  7033. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  7034. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  7035. notequals | 1 | name.notequals('test') | 不等于给定值 |
  7036. isnull | 0 | name.isnull() | 值为SQL的NULL |
  7037. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  7038. isempty | 0 | name.isempty('test') | 值为空字符串 |
  7039. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  7040. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  7041. in: query
  7042. items:
  7043. type: string
  7044. name: filter
  7045. type: array
  7046. x-go-name: Filter
  7047. - description: |-
  7048. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  7049. 和其他表关联的语法如下:
  7050. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  7051. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  7052. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  7053. 举例:
  7054. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  7055. in: query
  7056. items:
  7057. type: string
  7058. name: joint_filter
  7059. type: array
  7060. x-go-name: JointFilter
  7061. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  7062. in: query
  7063. name: filter_any
  7064. type: boolean
  7065. x-go-name: FilterAny
  7066. - description: 返回结果只包含指定的字段
  7067. in: query
  7068. items:
  7069. type: string
  7070. name: field
  7071. type: array
  7072. x-go-name: Field
  7073. - description: 用于数据导出,指定导出的数据字段
  7074. in: query
  7075. name: export_keys
  7076. type: string
  7077. x-go-name: ExportKeys
  7078. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  7079. in: query
  7080. name: show_fail_reason
  7081. type: boolean
  7082. x-go-name: ShowFailReason
  7083. - description: 是否返回状态统计信息,默认为False
  7084. in: query
  7085. name: summary_stats
  7086. type: boolean
  7087. x-go-name: SummaryStats
  7088. - $ref: '#/definitions/TTagSet'
  7089. description: 通过标签过滤(包含这些标签)
  7090. in: query
  7091. name: tags
  7092. x-go-name: Tags
  7093. - $ref: '#/definitions/TTagSetList'
  7094. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  7095. in: query
  7096. name: obj_tags
  7097. x-go-name: ObjTags
  7098. - $ref: '#/definitions/TTagSet'
  7099. description: 通过标签过滤(不包含这些标签)
  7100. in: query
  7101. name: no_tags
  7102. x-go-name: NoTags
  7103. - $ref: '#/definitions/TTagSetList'
  7104. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  7105. in: query
  7106. name: no_obj_tags
  7107. x-go-name: NoObjTags
  7108. - description: 通过标签排序
  7109. in: query
  7110. name: order_by_tag
  7111. type: string
  7112. x-go-name: OrderByTag
  7113. - description: |-
  7114. deprecated
  7115. 返回资源的标签不包含用户标签
  7116. in: query
  7117. name: without_user_meta
  7118. type: boolean
  7119. x-go-name: WithoutUserMeta
  7120. - description: 返回包含用户标签的资源
  7121. in: query
  7122. name: with_user_meta
  7123. type: boolean
  7124. x-go-name: WithUserMeta
  7125. - description: 返回包含外部标签的资源
  7126. in: query
  7127. name: with_cloud_meta
  7128. type: boolean
  7129. x-go-name: WithCloudMeta
  7130. - description: 返回包含任意标签的资源
  7131. in: query
  7132. name: with_any_meta
  7133. type: boolean
  7134. x-go-name: WithAnyMeta
  7135. - description: 返回列表数据中包含资源的标签数据(Metadata)
  7136. in: query
  7137. name: with_meta
  7138. type: boolean
  7139. x-go-name: WithMeta
  7140. - description: 显示所有的资源,包括模拟的资源
  7141. in: query
  7142. name: show_emulated
  7143. type: boolean
  7144. x-go-name: ShowEmulated
  7145. - description: 以资源ID过滤列表
  7146. in: query
  7147. items:
  7148. type: string
  7149. name: id
  7150. type: array
  7151. x-go-name: Ids
  7152. - description: 以资源名称过滤列表
  7153. in: query
  7154. items:
  7155. type: string
  7156. name: name
  7157. type: array
  7158. x-go-name: Names
  7159. - description: 以资源的状态过滤列表
  7160. in: query
  7161. items:
  7162. type: string
  7163. name: status
  7164. type: array
  7165. x-go-name: Status
  7166. - description: |-
  7167. 以报警是否启用/禁用过滤列表
  7168. Enabled *bool `json:"enabled"`
  7169. in: query
  7170. items:
  7171. type: string
  7172. name: monitor_resource_id
  7173. type: array
  7174. x-go-name: MonitorResourceId
  7175. responses:
  7176. "200":
  7177. $ref: '#/responses/alert_ListItemFilterOutput'
  7178. summary: 列表
  7179. tags:
  7180. - alert
  7181. post:
  7182. description: 新建
  7183. operationId: alert_ValidateCreateData
  7184. parameters:
  7185. - in: body
  7186. name: body
  7187. schema:
  7188. properties:
  7189. alert:
  7190. $ref: '#/definitions/AlertCreateInput'
  7191. count:
  7192. default: 1
  7193. format: int64
  7194. type: integer
  7195. x-go-name: Count
  7196. type: object
  7197. x-go-name: Body
  7198. responses:
  7199. "200":
  7200. $ref: '#/responses/alert_ValidateCreateDataOutput'
  7201. summary: 新建
  7202. tags:
  7203. - alert
  7204. /alerts/{id}:
  7205. delete:
  7206. description: 删除
  7207. operationId: alert_CustomizeDelete
  7208. parameters:
  7209. - description: The Id or Name of alert
  7210. in: path
  7211. name: id
  7212. required: true
  7213. type: string
  7214. x-go-name: Id
  7215. responses:
  7216. "200":
  7217. $ref: '#/responses/alert_CustomizeDeleteOutput'
  7218. summary: 删除
  7219. tags:
  7220. - alert
  7221. get:
  7222. description: 获取详情
  7223. operationId: alert_FetchCustomizeColumns
  7224. parameters:
  7225. - description: The Id or Name of alert
  7226. in: path
  7227. name: id
  7228. required: true
  7229. type: string
  7230. x-go-name: Id
  7231. responses:
  7232. "200":
  7233. $ref: '#/responses/alert_FetchCustomizeColumnsOutput'
  7234. summary: 获取详情
  7235. tags:
  7236. - alert
  7237. put:
  7238. description: 更新
  7239. operationId: alert_ValidateUpdateData
  7240. parameters:
  7241. - description: The Id or Name of alert
  7242. in: path
  7243. name: id
  7244. required: true
  7245. type: string
  7246. x-go-name: Id
  7247. - in: body
  7248. name: body
  7249. schema:
  7250. properties:
  7251. alert:
  7252. $ref: '#/definitions/AlertUpdateInput'
  7253. type: object
  7254. x-go-name: Body
  7255. responses:
  7256. "200":
  7257. $ref: '#/responses/alert_ValidateUpdateDataOutput'
  7258. summary: 更新
  7259. tags:
  7260. - alert
  7261. /alerts/{id}/disable:
  7262. post:
  7263. description: 执行操作Disable
  7264. operationId: alert_PerformDisable
  7265. parameters:
  7266. - description: The Id or Name of alert
  7267. in: path
  7268. name: id
  7269. required: true
  7270. type: string
  7271. x-go-name: Id
  7272. - in: body
  7273. name: body
  7274. schema:
  7275. properties:
  7276. alert:
  7277. $ref: '#/definitions/PerformDisableInput'
  7278. type: object
  7279. x-go-name: Body
  7280. responses:
  7281. "200":
  7282. $ref: '#/responses/alert_PerformDisableOutput'
  7283. summary: 执行操作Disable
  7284. tags:
  7285. - alert
  7286. /alerts/{id}/enable:
  7287. post:
  7288. description: 执行操作Enable
  7289. operationId: alert_PerformEnable
  7290. parameters:
  7291. - description: The Id or Name of alert
  7292. in: path
  7293. name: id
  7294. required: true
  7295. type: string
  7296. x-go-name: Id
  7297. - in: body
  7298. name: body
  7299. schema:
  7300. properties:
  7301. alert:
  7302. $ref: '#/definitions/PerformEnableInput'
  7303. type: object
  7304. x-go-name: Body
  7305. responses:
  7306. "200":
  7307. $ref: '#/responses/alert_PerformEnableOutput'
  7308. summary: 执行操作Enable
  7309. tags:
  7310. - alert
  7311. /alerts/{id}/metadata:
  7312. get:
  7313. description: 获取指定信息Metadata
  7314. operationId: alert_GetDetailsMetadata
  7315. parameters:
  7316. - description: |-
  7317. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  7318. 标签分为
  7319. 类型 | 说明 |
  7320. ----------|---------------------------------------------|
  7321. 系统标签 | 平台定义的标签 |
  7322. 用户标签 | key以user:为前缀,用户自定义标签 |
  7323. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  7324. in: query
  7325. items:
  7326. type: string
  7327. name: field
  7328. type: array
  7329. x-go-name: Field
  7330. - description: 按标签前缀过滤
  7331. in: query
  7332. name: prefix
  7333. type: string
  7334. x-go-name: Prefix
  7335. - description: The Id or Name of alert
  7336. in: path
  7337. name: id
  7338. required: true
  7339. type: string
  7340. x-go-name: Id
  7341. responses:
  7342. "200":
  7343. $ref: '#/responses/alert_GetDetailsMetadataOutput'
  7344. summary: 获取资源标签(元数据)
  7345. tags:
  7346. - alert
  7347. /alerts/{id}/pause:
  7348. post:
  7349. description: 执行操作Pause
  7350. operationId: alert_PerformPause
  7351. parameters:
  7352. - description: The Id or Name of alert
  7353. in: path
  7354. name: id
  7355. required: true
  7356. type: string
  7357. x-go-name: Id
  7358. - in: body
  7359. name: body
  7360. schema:
  7361. properties:
  7362. alert:
  7363. $ref: '#/definitions/AlertPauseInput'
  7364. type: object
  7365. x-go-name: Body
  7366. responses:
  7367. "200":
  7368. $ref: '#/responses/alert_PerformPauseOutput'
  7369. summary: 执行操作Pause
  7370. tags:
  7371. - alert
  7372. /alerts/{id}/status:
  7373. get:
  7374. description: 获取指定信息Status
  7375. operationId: alert_GetDetailsStatus
  7376. parameters:
  7377. - description: The Id or Name of alert
  7378. in: path
  7379. name: id
  7380. required: true
  7381. type: string
  7382. x-go-name: Id
  7383. responses:
  7384. "200":
  7385. $ref: '#/responses/alert_GetDetailsStatusOutput'
  7386. summary: 获取资源状态
  7387. tags:
  7388. - alert
  7389. /alerts/{id}/test-run:
  7390. post:
  7391. description: 执行操作TestRun
  7392. operationId: alert_PerformTestRun
  7393. parameters:
  7394. - description: The Id or Name of alert
  7395. in: path
  7396. name: id
  7397. required: true
  7398. type: string
  7399. x-go-name: Id
  7400. - in: body
  7401. name: body
  7402. schema:
  7403. properties:
  7404. alert:
  7405. $ref: '#/definitions/AlertTestRunInput'
  7406. type: object
  7407. x-go-name: Body
  7408. responses:
  7409. "200":
  7410. $ref: '#/responses/alert_PerformTestRunOutput'
  7411. summary: 执行操作TestRun
  7412. tags:
  7413. - alert
  7414. /commonalerts:
  7415. get:
  7416. description: 列表
  7417. operationId: commonalert_ListItemFilter
  7418. parameters:
  7419. - description: 指定查询的权限范围,可能值为project, domain or system
  7420. in: query
  7421. name: scope
  7422. type: string
  7423. x-go-name: Scope
  7424. - description: 指定项目归属域名称或ID
  7425. in: query
  7426. name: project_domain_id
  7427. type: string
  7428. x-go-name: ProjectDomainId
  7429. - description: 对具有域属性的资源,严格匹配域ID
  7430. in: query
  7431. items:
  7432. type: string
  7433. name: project_domain_ids
  7434. type: array
  7435. x-go-name: ProjectDomainIds
  7436. - description: 按domain名称排序,可能值为asc|desc
  7437. in: query
  7438. name: order_by_domain
  7439. pattern: asc|desc
  7440. type: string
  7441. x-go-name: OrderByDomain
  7442. - $ref: '#/definitions/TTagSetList'
  7443. description: filter by domain tags
  7444. in: query
  7445. name: domain_tags
  7446. x-go-name: DomainTags
  7447. - $ref: '#/definitions/TTagSetList'
  7448. description: filter by domain tags
  7449. in: query
  7450. name: no_domain_tags
  7451. x-go-name: NoDomainTags
  7452. - description: 指定项目的名称或ID
  7453. in: query
  7454. name: project_id
  7455. type: string
  7456. x-go-name: ProjectId
  7457. - description: 对具有项目属性的资源,严格匹配项目ID
  7458. in: query
  7459. items:
  7460. type: string
  7461. name: project_ids
  7462. type: array
  7463. x-go-name: ProjectIds
  7464. - description: 按project名称排序,可能值为asc|desc
  7465. in: query
  7466. name: order_by_project
  7467. pattern: asc|desc
  7468. type: string
  7469. x-go-name: OrderByProject
  7470. - $ref: '#/definitions/TTagSetList'
  7471. description: filter by project tags
  7472. in: query
  7473. name: project_tags
  7474. x-go-name: ProjectTags
  7475. - $ref: '#/definitions/TTagSetList'
  7476. description: filter by no project tags
  7477. in: query
  7478. name: no_project_tags
  7479. x-go-name: NoProjectTags
  7480. - description: filter by project organizations
  7481. in: query
  7482. items:
  7483. type: string
  7484. name: project_organizations
  7485. type: array
  7486. x-go-name: ProjectOrganizations
  7487. - $ref: '#/definitions/TTagSetList'
  7488. description: |-
  7489. ignore
  7490. project tag fitlers imposed by policy
  7491. in: query
  7492. name: policy_project_tags
  7493. x-go-name: PolicyProjectTags
  7494. - description: 指定匹配的范围,可能值为project, domain or system
  7495. in: query
  7496. name: belong_scope
  7497. type: string
  7498. x-go-name: BelongScope
  7499. - description: 以资源是否启用/禁用过滤列表
  7500. in: query
  7501. name: enabled
  7502. type: boolean
  7503. x-go-name: Enabled
  7504. - default: 20
  7505. description: 查询限制量
  7506. format: int64
  7507. in: query
  7508. name: limit
  7509. type: integer
  7510. x-go-name: Limit
  7511. - default: 0
  7512. description: 查询偏移量
  7513. format: int64
  7514. in: query
  7515. name: offset
  7516. type: integer
  7517. x-go-name: Offset
  7518. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  7519. in: query
  7520. items:
  7521. type: string
  7522. name: order_by
  7523. type: array
  7524. x-go-name: OrderBy
  7525. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  7526. example: desc|asc
  7527. in: query
  7528. name: order
  7529. type: string
  7530. x-go-name: Order
  7531. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  7532. in: query
  7533. name: details
  7534. type: boolean
  7535. x-go-name: Details
  7536. - description: 模糊搜索所有字段
  7537. in: query
  7538. name: search
  7539. type: string
  7540. x-go-name: Search
  7541. - description: |-
  7542. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  7543. 支持的操作符如下:
  7544. 操作符 | 参数个数 | 举例 | 说明 |
  7545. ---------------|----------|------------------------------------------------|-----------------------------|
  7546. in | > 0 | name.in("test", "good") | 在给定数组中 |
  7547. notin | > 0 | name.notin('test') | 不在给定数组中 |
  7548. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  7549. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  7550. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  7551. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  7552. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  7553. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  7554. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  7555. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  7556. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  7557. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  7558. notequals | 1 | name.notequals('test') | 不等于给定值 |
  7559. isnull | 0 | name.isnull() | 值为SQL的NULL |
  7560. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  7561. isempty | 0 | name.isempty('test') | 值为空字符串 |
  7562. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  7563. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  7564. in: query
  7565. items:
  7566. type: string
  7567. name: filter
  7568. type: array
  7569. x-go-name: Filter
  7570. - description: |-
  7571. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  7572. 和其他表关联的语法如下:
  7573. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  7574. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  7575. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  7576. 举例:
  7577. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  7578. in: query
  7579. items:
  7580. type: string
  7581. name: joint_filter
  7582. type: array
  7583. x-go-name: JointFilter
  7584. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  7585. in: query
  7586. name: filter_any
  7587. type: boolean
  7588. x-go-name: FilterAny
  7589. - description: 返回结果只包含指定的字段
  7590. in: query
  7591. items:
  7592. type: string
  7593. name: field
  7594. type: array
  7595. x-go-name: Field
  7596. - description: 用于数据导出,指定导出的数据字段
  7597. in: query
  7598. name: export_keys
  7599. type: string
  7600. x-go-name: ExportKeys
  7601. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  7602. in: query
  7603. name: show_fail_reason
  7604. type: boolean
  7605. x-go-name: ShowFailReason
  7606. - description: 是否返回状态统计信息,默认为False
  7607. in: query
  7608. name: summary_stats
  7609. type: boolean
  7610. x-go-name: SummaryStats
  7611. - $ref: '#/definitions/TTagSet'
  7612. description: 通过标签过滤(包含这些标签)
  7613. in: query
  7614. name: tags
  7615. x-go-name: Tags
  7616. - $ref: '#/definitions/TTagSetList'
  7617. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  7618. in: query
  7619. name: obj_tags
  7620. x-go-name: ObjTags
  7621. - $ref: '#/definitions/TTagSet'
  7622. description: 通过标签过滤(不包含这些标签)
  7623. in: query
  7624. name: no_tags
  7625. x-go-name: NoTags
  7626. - $ref: '#/definitions/TTagSetList'
  7627. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  7628. in: query
  7629. name: no_obj_tags
  7630. x-go-name: NoObjTags
  7631. - description: 通过标签排序
  7632. in: query
  7633. name: order_by_tag
  7634. type: string
  7635. x-go-name: OrderByTag
  7636. - description: |-
  7637. deprecated
  7638. 返回资源的标签不包含用户标签
  7639. in: query
  7640. name: without_user_meta
  7641. type: boolean
  7642. x-go-name: WithoutUserMeta
  7643. - description: 返回包含用户标签的资源
  7644. in: query
  7645. name: with_user_meta
  7646. type: boolean
  7647. x-go-name: WithUserMeta
  7648. - description: 返回包含外部标签的资源
  7649. in: query
  7650. name: with_cloud_meta
  7651. type: boolean
  7652. x-go-name: WithCloudMeta
  7653. - description: 返回包含任意标签的资源
  7654. in: query
  7655. name: with_any_meta
  7656. type: boolean
  7657. x-go-name: WithAnyMeta
  7658. - description: 返回列表数据中包含资源的标签数据(Metadata)
  7659. in: query
  7660. name: with_meta
  7661. type: boolean
  7662. x-go-name: WithMeta
  7663. - description: 显示所有的资源,包括模拟的资源
  7664. in: query
  7665. name: show_emulated
  7666. type: boolean
  7667. x-go-name: ShowEmulated
  7668. - description: 以资源ID过滤列表
  7669. in: query
  7670. items:
  7671. type: string
  7672. name: id
  7673. type: array
  7674. x-go-name: Ids
  7675. - description: 以资源的状态过滤列表
  7676. in: query
  7677. items:
  7678. type: string
  7679. name: status
  7680. type: array
  7681. x-go-name: Status
  7682. - description: |-
  7683. 以报警是否启用/禁用过滤列表
  7684. Enabled *bool `json:"enabled"`
  7685. in: query
  7686. items:
  7687. type: string
  7688. name: monitor_resource_id
  7689. type: array
  7690. x-go-name: MonitorResourceId
  7691. - description: 查询时间段开始时间
  7692. format: date-time
  7693. in: query
  7694. name: start_time
  7695. type: string
  7696. x-go-name: StartTime
  7697. - description: 查询时间段结束时间
  7698. format: date-time
  7699. in: query
  7700. name: end_time
  7701. type: string
  7702. x-go-name: EndTime
  7703. - description: 返回 top N(默认 5)
  7704. format: int64
  7705. in: query
  7706. name: top
  7707. type: integer
  7708. x-go-name: Top
  7709. - description: |-
  7710. V1AlertListInput
  7711. 报警类型
  7712. in: query
  7713. name: alert_type
  7714. type: string
  7715. x-go-name: AlertType
  7716. - description: 监控指标名称
  7717. in: query
  7718. name: metric
  7719. type: string
  7720. x-go-name: Metric
  7721. - in: query
  7722. name: level
  7723. type: string
  7724. x-go-name: Level
  7725. - in: query
  7726. items:
  7727. type: string
  7728. name: res_type
  7729. type: array
  7730. x-go-name: ResType
  7731. - in: query
  7732. name: used_by
  7733. type: string
  7734. x-go-name: UsedBy
  7735. - description: 以资源名称过滤列表
  7736. in: query
  7737. items:
  7738. type: string
  7739. name: name
  7740. type: string
  7741. x-go-name: Name
  7742. responses:
  7743. "200":
  7744. $ref: '#/responses/commonalert_ListItemFilterOutput'
  7745. summary: 列表
  7746. tags:
  7747. - commonalert
  7748. post:
  7749. description: 新建
  7750. operationId: commonalert_ValidateCreateData
  7751. parameters:
  7752. - in: body
  7753. name: body
  7754. schema:
  7755. properties:
  7756. commonalert:
  7757. $ref: '#/definitions/CommonAlertCreateInput'
  7758. count:
  7759. default: 1
  7760. format: int64
  7761. type: integer
  7762. x-go-name: Count
  7763. type: object
  7764. x-go-name: Body
  7765. responses:
  7766. "200":
  7767. $ref: '#/responses/commonalert_ValidateCreateDataOutput'
  7768. summary: 新建
  7769. tags:
  7770. - commonalert
  7771. /commonalerts/{id}:
  7772. delete:
  7773. description: 删除
  7774. operationId: commonalert_CustomizeDelete
  7775. parameters:
  7776. - description: The Id or Name of commonalert
  7777. in: path
  7778. name: id
  7779. required: true
  7780. type: string
  7781. x-go-name: Id
  7782. responses:
  7783. "200":
  7784. $ref: '#/responses/commonalert_CustomizeDeleteOutput'
  7785. summary: 删除
  7786. tags:
  7787. - commonalert
  7788. get:
  7789. description: 获取详情
  7790. operationId: commonalert_FetchCustomizeColumns
  7791. parameters:
  7792. - description: The Id or Name of commonalert
  7793. in: path
  7794. name: id
  7795. required: true
  7796. type: string
  7797. x-go-name: Id
  7798. responses:
  7799. "200":
  7800. $ref: '#/responses/commonalert_FetchCustomizeColumnsOutput'
  7801. summary: 获取详情
  7802. tags:
  7803. - commonalert
  7804. put:
  7805. description: 更新
  7806. operationId: commonalert_ValidateUpdateData
  7807. parameters:
  7808. - description: The Id or Name of commonalert
  7809. in: path
  7810. name: id
  7811. required: true
  7812. type: string
  7813. x-go-name: Id
  7814. responses:
  7815. "200":
  7816. $ref: '#/responses/commonalert_ValidateUpdateDataOutput'
  7817. summary: 更新
  7818. tags:
  7819. - commonalert
  7820. /commonalerts/{id}/config:
  7821. post:
  7822. description: 执行操作Config
  7823. operationId: commonalert_PerformConfig
  7824. parameters:
  7825. - description: The Id or Name of commonalert
  7826. in: path
  7827. name: id
  7828. required: true
  7829. type: string
  7830. x-go-name: Id
  7831. responses:
  7832. "200":
  7833. $ref: '#/responses/commonalert_PerformConfigOutput'
  7834. summary: 执行操作Config
  7835. tags:
  7836. - commonalert
  7837. /commonalerts/{id}/disable:
  7838. post:
  7839. description: 执行操作Disable
  7840. operationId: commonalert_PerformDisable
  7841. parameters:
  7842. - description: The Id or Name of commonalert
  7843. in: path
  7844. name: id
  7845. required: true
  7846. type: string
  7847. x-go-name: Id
  7848. - in: body
  7849. name: body
  7850. schema:
  7851. properties:
  7852. commonalert:
  7853. $ref: '#/definitions/PerformDisableInput'
  7854. type: object
  7855. x-go-name: Body
  7856. responses:
  7857. "200":
  7858. $ref: '#/responses/commonalert_PerformDisableOutput'
  7859. summary: 执行操作Disable
  7860. tags:
  7861. - commonalert
  7862. /commonalerts/{id}/enable:
  7863. post:
  7864. description: 执行操作Enable
  7865. operationId: commonalert_PerformEnable
  7866. parameters:
  7867. - description: The Id or Name of commonalert
  7868. in: path
  7869. name: id
  7870. required: true
  7871. type: string
  7872. x-go-name: Id
  7873. - in: body
  7874. name: body
  7875. schema:
  7876. properties:
  7877. commonalert:
  7878. $ref: '#/definitions/PerformEnableInput'
  7879. type: object
  7880. x-go-name: Body
  7881. responses:
  7882. "200":
  7883. $ref: '#/responses/commonalert_PerformEnableOutput'
  7884. summary: 执行操作Enable
  7885. tags:
  7886. - commonalert
  7887. /commonalerts/{id}/metadata:
  7888. get:
  7889. description: 获取指定信息Metadata
  7890. operationId: commonalert_GetDetailsMetadata
  7891. parameters:
  7892. - description: |-
  7893. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  7894. 标签分为
  7895. 类型 | 说明 |
  7896. ----------|---------------------------------------------|
  7897. 系统标签 | 平台定义的标签 |
  7898. 用户标签 | key以user:为前缀,用户自定义标签 |
  7899. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  7900. in: query
  7901. items:
  7902. type: string
  7903. name: field
  7904. type: array
  7905. x-go-name: Field
  7906. - description: 按标签前缀过滤
  7907. in: query
  7908. name: prefix
  7909. type: string
  7910. x-go-name: Prefix
  7911. - description: The Id or Name of commonalert
  7912. in: path
  7913. name: id
  7914. required: true
  7915. type: string
  7916. x-go-name: Id
  7917. responses:
  7918. "200":
  7919. $ref: '#/responses/commonalert_GetDetailsMetadataOutput'
  7920. summary: 获取资源标签(元数据)
  7921. tags:
  7922. - commonalert
  7923. /commonalerts/{id}/pause:
  7924. post:
  7925. description: 执行操作Pause
  7926. operationId: commonalert_PerformPause
  7927. parameters:
  7928. - description: The Id or Name of commonalert
  7929. in: path
  7930. name: id
  7931. required: true
  7932. type: string
  7933. x-go-name: Id
  7934. - in: body
  7935. name: body
  7936. schema:
  7937. properties:
  7938. commonalert:
  7939. $ref: '#/definitions/AlertPauseInput'
  7940. type: object
  7941. x-go-name: Body
  7942. responses:
  7943. "200":
  7944. $ref: '#/responses/commonalert_PerformPauseOutput'
  7945. summary: 执行操作Pause
  7946. tags:
  7947. - commonalert
  7948. /commonalerts/{id}/set-scope:
  7949. post:
  7950. description: 执行操作SetScope
  7951. operationId: commonalert_PerformSetScope
  7952. parameters:
  7953. - description: The Id or Name of commonalert
  7954. in: path
  7955. name: id
  7956. required: true
  7957. type: string
  7958. x-go-name: Id
  7959. responses:
  7960. "200":
  7961. $ref: '#/responses/commonalert_PerformSetScopeOutput'
  7962. summary: 执行操作SetScope
  7963. tags:
  7964. - commonalert
  7965. /commonalerts/{id}/status:
  7966. get:
  7967. description: 获取指定信息Status
  7968. operationId: commonalert_GetDetailsStatus
  7969. parameters:
  7970. - description: The Id or Name of commonalert
  7971. in: path
  7972. name: id
  7973. required: true
  7974. type: string
  7975. x-go-name: Id
  7976. responses:
  7977. "200":
  7978. $ref: '#/responses/commonalert_GetDetailsStatusOutput'
  7979. summary: 获取资源状态
  7980. tags:
  7981. - commonalert
  7982. /commonalerts/{id}/test-run:
  7983. post:
  7984. description: 执行操作TestRun
  7985. operationId: commonalert_PerformTestRun
  7986. parameters:
  7987. - description: The Id or Name of commonalert
  7988. in: path
  7989. name: id
  7990. required: true
  7991. type: string
  7992. x-go-name: Id
  7993. - in: body
  7994. name: body
  7995. schema:
  7996. properties:
  7997. commonalert:
  7998. $ref: '#/definitions/AlertTestRunInput'
  7999. type: object
  8000. x-go-name: Body
  8001. responses:
  8002. "200":
  8003. $ref: '#/responses/commonalert_PerformTestRunOutput'
  8004. summary: 执行操作TestRun
  8005. tags:
  8006. - commonalert
  8007. /datasources:
  8008. get:
  8009. description: 列表
  8010. operationId: datasource_ListItemFilter
  8011. parameters:
  8012. - default: 20
  8013. description: 查询限制量
  8014. format: int64
  8015. in: query
  8016. name: limit
  8017. type: integer
  8018. x-go-name: Limit
  8019. - default: 0
  8020. description: 查询偏移量
  8021. format: int64
  8022. in: query
  8023. name: offset
  8024. type: integer
  8025. x-go-name: Offset
  8026. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  8027. in: query
  8028. items:
  8029. type: string
  8030. name: order_by
  8031. type: array
  8032. x-go-name: OrderBy
  8033. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  8034. example: desc|asc
  8035. in: query
  8036. name: order
  8037. type: string
  8038. x-go-name: Order
  8039. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  8040. in: query
  8041. name: details
  8042. type: boolean
  8043. x-go-name: Details
  8044. - description: 模糊搜索所有字段
  8045. in: query
  8046. name: search
  8047. type: string
  8048. x-go-name: Search
  8049. - description: |-
  8050. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  8051. 支持的操作符如下:
  8052. 操作符 | 参数个数 | 举例 | 说明 |
  8053. ---------------|----------|------------------------------------------------|-----------------------------|
  8054. in | > 0 | name.in("test", "good") | 在给定数组中 |
  8055. notin | > 0 | name.notin('test') | 不在给定数组中 |
  8056. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  8057. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  8058. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  8059. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  8060. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  8061. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  8062. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  8063. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  8064. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  8065. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  8066. notequals | 1 | name.notequals('test') | 不等于给定值 |
  8067. isnull | 0 | name.isnull() | 值为SQL的NULL |
  8068. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  8069. isempty | 0 | name.isempty('test') | 值为空字符串 |
  8070. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  8071. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  8072. in: query
  8073. items:
  8074. type: string
  8075. name: filter
  8076. type: array
  8077. x-go-name: Filter
  8078. - description: |-
  8079. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  8080. 和其他表关联的语法如下:
  8081. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  8082. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  8083. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  8084. 举例:
  8085. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  8086. in: query
  8087. items:
  8088. type: string
  8089. name: joint_filter
  8090. type: array
  8091. x-go-name: JointFilter
  8092. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  8093. in: query
  8094. name: filter_any
  8095. type: boolean
  8096. x-go-name: FilterAny
  8097. - description: 返回结果只包含指定的字段
  8098. in: query
  8099. items:
  8100. type: string
  8101. name: field
  8102. type: array
  8103. x-go-name: Field
  8104. - description: 用于数据导出,指定导出的数据字段
  8105. in: query
  8106. name: export_keys
  8107. type: string
  8108. x-go-name: ExportKeys
  8109. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  8110. in: query
  8111. name: show_fail_reason
  8112. type: boolean
  8113. x-go-name: ShowFailReason
  8114. - description: 是否返回状态统计信息,默认为False
  8115. in: query
  8116. name: summary_stats
  8117. type: boolean
  8118. x-go-name: SummaryStats
  8119. - $ref: '#/definitions/TTagSet'
  8120. description: 通过标签过滤(包含这些标签)
  8121. in: query
  8122. name: tags
  8123. x-go-name: Tags
  8124. - $ref: '#/definitions/TTagSetList'
  8125. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  8126. in: query
  8127. name: obj_tags
  8128. x-go-name: ObjTags
  8129. - $ref: '#/definitions/TTagSet'
  8130. description: 通过标签过滤(不包含这些标签)
  8131. in: query
  8132. name: no_tags
  8133. x-go-name: NoTags
  8134. - $ref: '#/definitions/TTagSetList'
  8135. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  8136. in: query
  8137. name: no_obj_tags
  8138. x-go-name: NoObjTags
  8139. - description: 通过标签排序
  8140. in: query
  8141. name: order_by_tag
  8142. type: string
  8143. x-go-name: OrderByTag
  8144. - description: |-
  8145. deprecated
  8146. 返回资源的标签不包含用户标签
  8147. in: query
  8148. name: without_user_meta
  8149. type: boolean
  8150. x-go-name: WithoutUserMeta
  8151. - description: 返回包含用户标签的资源
  8152. in: query
  8153. name: with_user_meta
  8154. type: boolean
  8155. x-go-name: WithUserMeta
  8156. - description: 返回包含外部标签的资源
  8157. in: query
  8158. name: with_cloud_meta
  8159. type: boolean
  8160. x-go-name: WithCloudMeta
  8161. - description: 返回包含任意标签的资源
  8162. in: query
  8163. name: with_any_meta
  8164. type: boolean
  8165. x-go-name: WithAnyMeta
  8166. - description: 返回列表数据中包含资源的标签数据(Metadata)
  8167. in: query
  8168. name: with_meta
  8169. type: boolean
  8170. x-go-name: WithMeta
  8171. - description: 显示所有的资源,包括模拟的资源
  8172. in: query
  8173. name: show_emulated
  8174. type: boolean
  8175. x-go-name: ShowEmulated
  8176. - description: 以资源ID过滤列表
  8177. in: query
  8178. items:
  8179. type: string
  8180. name: id
  8181. type: array
  8182. x-go-name: Ids
  8183. - description: 以资源名称过滤列表
  8184. in: query
  8185. items:
  8186. type: string
  8187. name: name
  8188. type: array
  8189. x-go-name: Names
  8190. responses:
  8191. "200":
  8192. $ref: '#/responses/datasource_ListItemFilterOutput'
  8193. summary: 列表
  8194. tags:
  8195. - datasource
  8196. post:
  8197. description: 新建
  8198. operationId: datasource_ValidateCreateData
  8199. parameters:
  8200. - in: body
  8201. name: body
  8202. schema:
  8203. properties:
  8204. count:
  8205. default: 1
  8206. format: int64
  8207. type: integer
  8208. x-go-name: Count
  8209. datasource:
  8210. $ref: '#/definitions/StandaloneResourceCreateInput'
  8211. type: object
  8212. x-go-name: Body
  8213. responses:
  8214. "200":
  8215. $ref: '#/responses/datasource_ValidateCreateDataOutput'
  8216. summary: 新建
  8217. tags:
  8218. - datasource
  8219. /datasources/{id}:
  8220. delete:
  8221. description: 删除
  8222. operationId: datasource_CustomizeDelete
  8223. parameters:
  8224. - description: The Id or Name of datasource
  8225. in: path
  8226. name: id
  8227. required: true
  8228. type: string
  8229. x-go-name: Id
  8230. responses:
  8231. "200":
  8232. $ref: '#/responses/datasource_CustomizeDeleteOutput'
  8233. summary: 删除
  8234. tags:
  8235. - datasource
  8236. get:
  8237. description: 获取详情
  8238. operationId: datasource_FetchCustomizeColumns
  8239. parameters:
  8240. - description: The Id or Name of datasource
  8241. in: path
  8242. name: id
  8243. required: true
  8244. type: string
  8245. x-go-name: Id
  8246. responses:
  8247. "200":
  8248. $ref: '#/responses/datasource_FetchCustomizeColumnsOutput'
  8249. summary: 获取详情
  8250. tags:
  8251. - datasource
  8252. put:
  8253. description: 更新
  8254. operationId: datasource_ValidateUpdateData
  8255. parameters:
  8256. - description: The Id or Name of datasource
  8257. in: path
  8258. name: id
  8259. required: true
  8260. type: string
  8261. x-go-name: Id
  8262. - in: body
  8263. name: body
  8264. schema:
  8265. properties:
  8266. datasource:
  8267. $ref: '#/definitions/StandaloneResourceBaseUpdateInput'
  8268. type: object
  8269. x-go-name: Body
  8270. responses:
  8271. "200":
  8272. $ref: '#/responses/datasource_ValidateUpdateDataOutput'
  8273. summary: 更新
  8274. tags:
  8275. - datasource
  8276. /datasources/{id}/metadata:
  8277. get:
  8278. description: 获取指定信息Metadata
  8279. operationId: datasource_GetDetailsMetadata
  8280. parameters:
  8281. - description: |-
  8282. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  8283. 标签分为
  8284. 类型 | 说明 |
  8285. ----------|---------------------------------------------|
  8286. 系统标签 | 平台定义的标签 |
  8287. 用户标签 | key以user:为前缀,用户自定义标签 |
  8288. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  8289. in: query
  8290. items:
  8291. type: string
  8292. name: field
  8293. type: array
  8294. x-go-name: Field
  8295. - description: 按标签前缀过滤
  8296. in: query
  8297. name: prefix
  8298. type: string
  8299. x-go-name: Prefix
  8300. - description: The Id or Name of datasource
  8301. in: path
  8302. name: id
  8303. required: true
  8304. type: string
  8305. x-go-name: Id
  8306. responses:
  8307. "200":
  8308. $ref: '#/responses/datasource_GetDetailsMetadataOutput'
  8309. summary: 获取资源标签(元数据)
  8310. tags:
  8311. - datasource
  8312. /metricfields:
  8313. get:
  8314. description: 列表
  8315. operationId: metricfield_ListItemFilter
  8316. parameters:
  8317. - default: 20
  8318. description: 查询限制量
  8319. format: int64
  8320. in: query
  8321. name: limit
  8322. type: integer
  8323. x-go-name: Limit
  8324. - default: 0
  8325. description: 查询偏移量
  8326. format: int64
  8327. in: query
  8328. name: offset
  8329. type: integer
  8330. x-go-name: Offset
  8331. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  8332. in: query
  8333. items:
  8334. type: string
  8335. name: order_by
  8336. type: array
  8337. x-go-name: OrderBy
  8338. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  8339. example: desc|asc
  8340. in: query
  8341. name: order
  8342. type: string
  8343. x-go-name: Order
  8344. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  8345. in: query
  8346. name: details
  8347. type: boolean
  8348. x-go-name: Details
  8349. - description: 模糊搜索所有字段
  8350. in: query
  8351. name: search
  8352. type: string
  8353. x-go-name: Search
  8354. - description: |-
  8355. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  8356. 支持的操作符如下:
  8357. 操作符 | 参数个数 | 举例 | 说明 |
  8358. ---------------|----------|------------------------------------------------|-----------------------------|
  8359. in | > 0 | name.in("test", "good") | 在给定数组中 |
  8360. notin | > 0 | name.notin('test') | 不在给定数组中 |
  8361. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  8362. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  8363. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  8364. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  8365. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  8366. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  8367. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  8368. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  8369. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  8370. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  8371. notequals | 1 | name.notequals('test') | 不等于给定值 |
  8372. isnull | 0 | name.isnull() | 值为SQL的NULL |
  8373. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  8374. isempty | 0 | name.isempty('test') | 值为空字符串 |
  8375. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  8376. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  8377. in: query
  8378. items:
  8379. type: string
  8380. name: filter
  8381. type: array
  8382. x-go-name: Filter
  8383. - description: |-
  8384. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  8385. 和其他表关联的语法如下:
  8386. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  8387. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  8388. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  8389. 举例:
  8390. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  8391. in: query
  8392. items:
  8393. type: string
  8394. name: joint_filter
  8395. type: array
  8396. x-go-name: JointFilter
  8397. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  8398. in: query
  8399. name: filter_any
  8400. type: boolean
  8401. x-go-name: FilterAny
  8402. - description: 返回结果只包含指定的字段
  8403. in: query
  8404. items:
  8405. type: string
  8406. name: field
  8407. type: array
  8408. x-go-name: Field
  8409. - description: 用于数据导出,指定导出的数据字段
  8410. in: query
  8411. name: export_keys
  8412. type: string
  8413. x-go-name: ExportKeys
  8414. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  8415. in: query
  8416. name: show_fail_reason
  8417. type: boolean
  8418. x-go-name: ShowFailReason
  8419. - description: 是否返回状态统计信息,默认为False
  8420. in: query
  8421. name: summary_stats
  8422. type: boolean
  8423. x-go-name: SummaryStats
  8424. - $ref: '#/definitions/TTagSet'
  8425. description: 通过标签过滤(包含这些标签)
  8426. in: query
  8427. name: tags
  8428. x-go-name: Tags
  8429. - $ref: '#/definitions/TTagSetList'
  8430. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  8431. in: query
  8432. name: obj_tags
  8433. x-go-name: ObjTags
  8434. - $ref: '#/definitions/TTagSet'
  8435. description: 通过标签过滤(不包含这些标签)
  8436. in: query
  8437. name: no_tags
  8438. x-go-name: NoTags
  8439. - $ref: '#/definitions/TTagSetList'
  8440. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  8441. in: query
  8442. name: no_obj_tags
  8443. x-go-name: NoObjTags
  8444. - description: 通过标签排序
  8445. in: query
  8446. name: order_by_tag
  8447. type: string
  8448. x-go-name: OrderByTag
  8449. - description: |-
  8450. deprecated
  8451. 返回资源的标签不包含用户标签
  8452. in: query
  8453. name: without_user_meta
  8454. type: boolean
  8455. x-go-name: WithoutUserMeta
  8456. - description: 返回包含用户标签的资源
  8457. in: query
  8458. name: with_user_meta
  8459. type: boolean
  8460. x-go-name: WithUserMeta
  8461. - description: 返回包含外部标签的资源
  8462. in: query
  8463. name: with_cloud_meta
  8464. type: boolean
  8465. x-go-name: WithCloudMeta
  8466. - description: 返回包含任意标签的资源
  8467. in: query
  8468. name: with_any_meta
  8469. type: boolean
  8470. x-go-name: WithAnyMeta
  8471. - description: 返回列表数据中包含资源的标签数据(Metadata)
  8472. in: query
  8473. name: with_meta
  8474. type: boolean
  8475. x-go-name: WithMeta
  8476. - description: 显示所有的资源,包括模拟的资源
  8477. in: query
  8478. name: show_emulated
  8479. type: boolean
  8480. x-go-name: ShowEmulated
  8481. - description: 以资源ID过滤列表
  8482. in: query
  8483. items:
  8484. type: string
  8485. name: id
  8486. type: array
  8487. x-go-name: Ids
  8488. - description: 以资源名称过滤列表
  8489. in: query
  8490. items:
  8491. type: string
  8492. name: name
  8493. type: array
  8494. x-go-name: Names
  8495. - description: 以资源的状态过滤列表
  8496. in: query
  8497. items:
  8498. type: string
  8499. name: status
  8500. type: array
  8501. x-go-name: Status
  8502. - description: 以资源是否启用/禁用过滤列表
  8503. in: query
  8504. name: enabled
  8505. type: boolean
  8506. x-go-name: Enabled
  8507. - description: 指定项目归属域名称或ID
  8508. in: query
  8509. name: project_domain_id
  8510. type: string
  8511. x-go-name: ProjectDomainId
  8512. - description: 对具有域属性的资源,严格匹配域ID
  8513. in: query
  8514. items:
  8515. type: string
  8516. name: project_domain_ids
  8517. type: array
  8518. x-go-name: ProjectDomainIds
  8519. - description: 按domain名称排序,可能值为asc|desc
  8520. in: query
  8521. name: order_by_domain
  8522. pattern: asc|desc
  8523. type: string
  8524. x-go-name: OrderByDomain
  8525. - $ref: '#/definitions/TTagSetList'
  8526. description: filter by domain tags
  8527. in: query
  8528. name: domain_tags
  8529. x-go-name: DomainTags
  8530. - $ref: '#/definitions/TTagSetList'
  8531. description: filter by domain tags
  8532. in: query
  8533. name: no_domain_tags
  8534. x-go-name: NoDomainTags
  8535. - description: 指定项目的名称或ID
  8536. in: query
  8537. name: project_id
  8538. type: string
  8539. x-go-name: ProjectId
  8540. - description: 对具有项目属性的资源,严格匹配项目ID
  8541. in: query
  8542. items:
  8543. type: string
  8544. name: project_ids
  8545. type: array
  8546. x-go-name: ProjectIds
  8547. - description: 按project名称排序,可能值为asc|desc
  8548. in: query
  8549. name: order_by_project
  8550. pattern: asc|desc
  8551. type: string
  8552. x-go-name: OrderByProject
  8553. - $ref: '#/definitions/TTagSetList'
  8554. description: filter by project tags
  8555. in: query
  8556. name: project_tags
  8557. x-go-name: ProjectTags
  8558. - $ref: '#/definitions/TTagSetList'
  8559. description: filter by no project tags
  8560. in: query
  8561. name: no_project_tags
  8562. x-go-name: NoProjectTags
  8563. - description: filter by project organizations
  8564. in: query
  8565. items:
  8566. type: string
  8567. name: project_organizations
  8568. type: array
  8569. x-go-name: ProjectOrganizations
  8570. - $ref: '#/definitions/TTagSetList'
  8571. description: |-
  8572. ignore
  8573. project tag fitlers imposed by policy
  8574. in: query
  8575. name: policy_project_tags
  8576. x-go-name: PolicyProjectTags
  8577. - description: 指定匹配的范围,可能值为project, domain or system
  8578. in: query
  8579. name: belong_scope
  8580. type: string
  8581. x-go-name: BelongScope
  8582. - in: query
  8583. name: display_name
  8584. type: string
  8585. x-go-name: DisplayName
  8586. - in: query
  8587. name: unit
  8588. type: string
  8589. x-go-name: Unit
  8590. - description: 指定查询的权限范围,可能值为project, domain or system
  8591. in: query
  8592. name: scope
  8593. type: string
  8594. x-go-name: Scope
  8595. responses:
  8596. "200":
  8597. $ref: '#/responses/metricfield_ListItemFilterOutput'
  8598. summary: 列表
  8599. tags:
  8600. - metricfield
  8601. post:
  8602. description: 新建
  8603. operationId: metricfield_ValidateCreateData
  8604. parameters:
  8605. - in: body
  8606. name: body
  8607. schema:
  8608. properties:
  8609. count:
  8610. default: 1
  8611. format: int64
  8612. type: integer
  8613. x-go-name: Count
  8614. metricfield:
  8615. $ref: '#/definitions/MetricFieldCreateInput'
  8616. type: object
  8617. x-go-name: Body
  8618. responses:
  8619. "200":
  8620. $ref: '#/responses/metricfield_ValidateCreateDataOutput'
  8621. summary: 新建
  8622. tags:
  8623. - metricfield
  8624. /metricfields/{id}:
  8625. delete:
  8626. description: 删除
  8627. operationId: metricfield_CustomizeDelete
  8628. parameters:
  8629. - description: The Id or Name of metricfield
  8630. in: path
  8631. name: id
  8632. required: true
  8633. type: string
  8634. x-go-name: Id
  8635. responses:
  8636. "200":
  8637. $ref: '#/responses/metricfield_CustomizeDeleteOutput'
  8638. summary: 删除
  8639. tags:
  8640. - metricfield
  8641. get:
  8642. description: 获取详情
  8643. operationId: metricfield_FetchCustomizeColumns
  8644. parameters:
  8645. - description: The Id or Name of metricfield
  8646. in: path
  8647. name: id
  8648. required: true
  8649. type: string
  8650. x-go-name: Id
  8651. responses:
  8652. "200":
  8653. $ref: '#/responses/metricfield_FetchCustomizeColumnsOutput'
  8654. summary: 获取详情
  8655. tags:
  8656. - metricfield
  8657. put:
  8658. description: 更新
  8659. operationId: metricfield_ValidateUpdateData
  8660. parameters:
  8661. - description: The Id or Name of metricfield
  8662. in: path
  8663. name: id
  8664. required: true
  8665. type: string
  8666. x-go-name: Id
  8667. - in: body
  8668. name: body
  8669. schema:
  8670. properties:
  8671. metricfield:
  8672. $ref: '#/definitions/MetricFieldUpdateInput'
  8673. type: object
  8674. x-go-name: Body
  8675. responses:
  8676. "200":
  8677. $ref: '#/responses/metricfield_ValidateUpdateDataOutput'
  8678. summary: 更新
  8679. tags:
  8680. - metricfield
  8681. /metricfields/{id}/metadata:
  8682. get:
  8683. description: 获取指定信息Metadata
  8684. operationId: metricfield_GetDetailsMetadata
  8685. parameters:
  8686. - description: |-
  8687. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  8688. 标签分为
  8689. 类型 | 说明 |
  8690. ----------|---------------------------------------------|
  8691. 系统标签 | 平台定义的标签 |
  8692. 用户标签 | key以user:为前缀,用户自定义标签 |
  8693. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  8694. in: query
  8695. items:
  8696. type: string
  8697. name: field
  8698. type: array
  8699. x-go-name: Field
  8700. - description: 按标签前缀过滤
  8701. in: query
  8702. name: prefix
  8703. type: string
  8704. x-go-name: Prefix
  8705. - description: The Id or Name of metricfield
  8706. in: path
  8707. name: id
  8708. required: true
  8709. type: string
  8710. x-go-name: Id
  8711. responses:
  8712. "200":
  8713. $ref: '#/responses/metricfield_GetDetailsMetadataOutput'
  8714. summary: 获取资源标签(元数据)
  8715. tags:
  8716. - metricfield
  8717. /metricfields/{id}/status:
  8718. get:
  8719. description: 获取指定信息Status
  8720. operationId: metricfield_GetDetailsStatus
  8721. parameters:
  8722. - description: The Id or Name of metricfield
  8723. in: path
  8724. name: id
  8725. required: true
  8726. type: string
  8727. x-go-name: Id
  8728. responses:
  8729. "200":
  8730. $ref: '#/responses/metricfield_GetDetailsStatusOutput'
  8731. summary: 获取资源状态
  8732. tags:
  8733. - metricfield
  8734. /metricmeasurements:
  8735. get:
  8736. description: 列表
  8737. operationId: metricmeasurement_ListItemFilter
  8738. parameters:
  8739. - $ref: '#/definitions/MetricMeasurementListInput'
  8740. in: query
  8741. name: measurement
  8742. x-go-name: Measurement
  8743. - $ref: '#/definitions/MetricFieldListInput'
  8744. in: query
  8745. name: metric_fields
  8746. x-go-name: MetricFields
  8747. - in: query
  8748. name: scope
  8749. type: string
  8750. x-go-name: Scope
  8751. responses:
  8752. "200":
  8753. $ref: '#/responses/metricmeasurement_ListItemFilterOutput'
  8754. summary: 列表
  8755. tags:
  8756. - metricmeasurement
  8757. post:
  8758. description: 新建
  8759. operationId: metricmeasurement_ValidateCreateData
  8760. parameters:
  8761. - in: body
  8762. name: body
  8763. schema:
  8764. properties:
  8765. count:
  8766. default: 1
  8767. format: int64
  8768. type: integer
  8769. x-go-name: Count
  8770. metricmeasurement:
  8771. $ref: '#/definitions/MetricCreateInput'
  8772. type: object
  8773. x-go-name: Body
  8774. responses:
  8775. "200":
  8776. $ref: '#/responses/metricmeasurement_ValidateCreateDataOutput'
  8777. summary: 新建
  8778. tags:
  8779. - metricmeasurement
  8780. /metricmeasurements/{id}:
  8781. delete:
  8782. description: 删除
  8783. operationId: metricmeasurement_CustomizeDelete
  8784. parameters:
  8785. - description: The Id or Name of metricmeasurement
  8786. in: path
  8787. name: id
  8788. required: true
  8789. type: string
  8790. x-go-name: Id
  8791. responses:
  8792. "200":
  8793. $ref: '#/responses/metricmeasurement_CustomizeDeleteOutput'
  8794. summary: 删除
  8795. tags:
  8796. - metricmeasurement
  8797. get:
  8798. description: 获取详情
  8799. operationId: metricmeasurement_FetchCustomizeColumns
  8800. parameters:
  8801. - description: The Id or Name of metricmeasurement
  8802. in: path
  8803. name: id
  8804. required: true
  8805. type: string
  8806. x-go-name: Id
  8807. responses:
  8808. "200":
  8809. $ref: '#/responses/metricmeasurement_FetchCustomizeColumnsOutput'
  8810. summary: 获取详情
  8811. tags:
  8812. - metricmeasurement
  8813. put:
  8814. description: 更新
  8815. operationId: metricmeasurement_ValidateUpdateData
  8816. parameters:
  8817. - description: The Id or Name of metricmeasurement
  8818. in: path
  8819. name: id
  8820. required: true
  8821. type: string
  8822. x-go-name: Id
  8823. - in: body
  8824. name: body
  8825. schema:
  8826. properties:
  8827. metricmeasurement:
  8828. $ref: '#/definitions/MetricUpdateInput'
  8829. type: object
  8830. x-go-name: Body
  8831. responses:
  8832. "200":
  8833. $ref: '#/responses/metricmeasurement_ValidateUpdateDataOutput'
  8834. summary: 更新
  8835. tags:
  8836. - metricmeasurement
  8837. /metricmeasurements/{id}/metadata:
  8838. get:
  8839. description: 获取指定信息Metadata
  8840. operationId: metricmeasurement_GetDetailsMetadata
  8841. parameters:
  8842. - description: |-
  8843. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  8844. 标签分为
  8845. 类型 | 说明 |
  8846. ----------|---------------------------------------------|
  8847. 系统标签 | 平台定义的标签 |
  8848. 用户标签 | key以user:为前缀,用户自定义标签 |
  8849. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  8850. in: query
  8851. items:
  8852. type: string
  8853. name: field
  8854. type: array
  8855. x-go-name: Field
  8856. - description: 按标签前缀过滤
  8857. in: query
  8858. name: prefix
  8859. type: string
  8860. x-go-name: Prefix
  8861. - description: The Id or Name of metricmeasurement
  8862. in: path
  8863. name: id
  8864. required: true
  8865. type: string
  8866. x-go-name: Id
  8867. responses:
  8868. "200":
  8869. $ref: '#/responses/metricmeasurement_GetDetailsMetadataOutput'
  8870. summary: 获取资源标签(元数据)
  8871. tags:
  8872. - metricmeasurement
  8873. /metricmeasurements/{id}/status:
  8874. get:
  8875. description: 获取指定信息Status
  8876. operationId: metricmeasurement_GetDetailsStatus
  8877. parameters:
  8878. - description: The Id or Name of metricmeasurement
  8879. in: path
  8880. name: id
  8881. required: true
  8882. type: string
  8883. x-go-name: Id
  8884. responses:
  8885. "200":
  8886. $ref: '#/responses/metricmeasurement_GetDetailsStatusOutput'
  8887. summary: 获取资源状态
  8888. tags:
  8889. - metricmeasurement
  8890. /metrics:
  8891. get:
  8892. description: 列表
  8893. operationId: metric_ListItemFilter
  8894. parameters:
  8895. - default: 20
  8896. description: 查询限制量
  8897. format: int64
  8898. in: query
  8899. name: limit
  8900. type: integer
  8901. x-go-name: Limit
  8902. - default: 0
  8903. description: 查询偏移量
  8904. format: int64
  8905. in: query
  8906. name: offset
  8907. type: integer
  8908. x-go-name: Offset
  8909. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  8910. in: query
  8911. items:
  8912. type: string
  8913. name: order_by
  8914. type: array
  8915. x-go-name: OrderBy
  8916. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  8917. example: desc|asc
  8918. in: query
  8919. name: order
  8920. type: string
  8921. x-go-name: Order
  8922. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  8923. in: query
  8924. name: details
  8925. type: boolean
  8926. x-go-name: Details
  8927. - description: 模糊搜索所有字段
  8928. in: query
  8929. name: search
  8930. type: string
  8931. x-go-name: Search
  8932. - description: |-
  8933. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  8934. 支持的操作符如下:
  8935. 操作符 | 参数个数 | 举例 | 说明 |
  8936. ---------------|----------|------------------------------------------------|-----------------------------|
  8937. in | > 0 | name.in("test", "good") | 在给定数组中 |
  8938. notin | > 0 | name.notin('test') | 不在给定数组中 |
  8939. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  8940. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  8941. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  8942. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  8943. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  8944. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  8945. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  8946. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  8947. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  8948. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  8949. notequals | 1 | name.notequals('test') | 不等于给定值 |
  8950. isnull | 0 | name.isnull() | 值为SQL的NULL |
  8951. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  8952. isempty | 0 | name.isempty('test') | 值为空字符串 |
  8953. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  8954. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  8955. in: query
  8956. items:
  8957. type: string
  8958. name: filter
  8959. type: array
  8960. x-go-name: Filter
  8961. - description: |-
  8962. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  8963. 和其他表关联的语法如下:
  8964. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  8965. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  8966. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  8967. 举例:
  8968. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  8969. in: query
  8970. items:
  8971. type: string
  8972. name: joint_filter
  8973. type: array
  8974. x-go-name: JointFilter
  8975. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  8976. in: query
  8977. name: filter_any
  8978. type: boolean
  8979. x-go-name: FilterAny
  8980. - description: 返回结果只包含指定的字段
  8981. in: query
  8982. items:
  8983. type: string
  8984. name: field
  8985. type: array
  8986. x-go-name: Field
  8987. - description: 用于数据导出,指定导出的数据字段
  8988. in: query
  8989. name: export_keys
  8990. type: string
  8991. x-go-name: ExportKeys
  8992. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  8993. in: query
  8994. name: show_fail_reason
  8995. type: boolean
  8996. x-go-name: ShowFailReason
  8997. - description: 是否返回状态统计信息,默认为False
  8998. in: query
  8999. name: summary_stats
  9000. type: boolean
  9001. x-go-name: SummaryStats
  9002. responses:
  9003. "200":
  9004. $ref: '#/responses/metric_ListItemFilterOutput'
  9005. summary: 列表
  9006. tags:
  9007. - metric
  9008. post:
  9009. description: 新建
  9010. operationId: metric_ValidateCreateData
  9011. parameters:
  9012. - in: body
  9013. name: body
  9014. schema:
  9015. properties:
  9016. count:
  9017. default: 1
  9018. format: int64
  9019. type: integer
  9020. x-go-name: Count
  9021. metric:
  9022. $ref: '#/definitions/JoinResourceBaseCreateInput'
  9023. type: object
  9024. x-go-name: Body
  9025. responses:
  9026. "200":
  9027. $ref: '#/responses/metric_ValidateCreateDataOutput'
  9028. summary: 新建
  9029. tags:
  9030. - metric
  9031. /metrics/{id}:
  9032. delete:
  9033. description: 删除
  9034. operationId: metric_CustomizeDelete
  9035. parameters:
  9036. - description: The Id or Name of metric
  9037. in: path
  9038. name: id
  9039. required: true
  9040. type: string
  9041. x-go-name: Id
  9042. responses:
  9043. "200":
  9044. $ref: '#/responses/metric_CustomizeDeleteOutput'
  9045. summary: 删除
  9046. tags:
  9047. - metric
  9048. get:
  9049. description: 获取详情
  9050. operationId: metric_FetchCustomizeColumns
  9051. parameters:
  9052. - description: The Id or Name of metric
  9053. in: path
  9054. name: id
  9055. required: true
  9056. type: string
  9057. x-go-name: Id
  9058. responses:
  9059. "200":
  9060. $ref: '#/responses/metric_FetchCustomizeColumnsOutput'
  9061. summary: 获取详情
  9062. tags:
  9063. - metric
  9064. put:
  9065. description: 更新
  9066. operationId: metric_ValidateUpdateData
  9067. parameters:
  9068. - description: The Id or Name of metric
  9069. in: path
  9070. name: id
  9071. required: true
  9072. type: string
  9073. x-go-name: Id
  9074. - in: body
  9075. name: body
  9076. schema:
  9077. properties:
  9078. metric:
  9079. $ref: '#/definitions/VirtualJointResourceBaseUpdateInput'
  9080. type: object
  9081. x-go-name: Body
  9082. responses:
  9083. "200":
  9084. $ref: '#/responses/metric_ValidateUpdateDataOutput'
  9085. summary: 更新
  9086. tags:
  9087. - metric
  9088. /migrationalerts:
  9089. get:
  9090. description: 列表
  9091. operationId: migrationalert_ListItemFilter
  9092. parameters:
  9093. - description: 指定查询的权限范围,可能值为project, domain or system
  9094. in: query
  9095. name: scope
  9096. type: string
  9097. x-go-name: Scope
  9098. - description: 指定项目归属域名称或ID
  9099. in: query
  9100. name: project_domain_id
  9101. type: string
  9102. x-go-name: ProjectDomainId
  9103. - description: 对具有域属性的资源,严格匹配域ID
  9104. in: query
  9105. items:
  9106. type: string
  9107. name: project_domain_ids
  9108. type: array
  9109. x-go-name: ProjectDomainIds
  9110. - description: 按domain名称排序,可能值为asc|desc
  9111. in: query
  9112. name: order_by_domain
  9113. pattern: asc|desc
  9114. type: string
  9115. x-go-name: OrderByDomain
  9116. - $ref: '#/definitions/TTagSetList'
  9117. description: filter by domain tags
  9118. in: query
  9119. name: domain_tags
  9120. x-go-name: DomainTags
  9121. - $ref: '#/definitions/TTagSetList'
  9122. description: filter by domain tags
  9123. in: query
  9124. name: no_domain_tags
  9125. x-go-name: NoDomainTags
  9126. - description: 指定项目的名称或ID
  9127. in: query
  9128. name: project_id
  9129. type: string
  9130. x-go-name: ProjectId
  9131. - description: 对具有项目属性的资源,严格匹配项目ID
  9132. in: query
  9133. items:
  9134. type: string
  9135. name: project_ids
  9136. type: array
  9137. x-go-name: ProjectIds
  9138. - description: 按project名称排序,可能值为asc|desc
  9139. in: query
  9140. name: order_by_project
  9141. pattern: asc|desc
  9142. type: string
  9143. x-go-name: OrderByProject
  9144. - $ref: '#/definitions/TTagSetList'
  9145. description: filter by project tags
  9146. in: query
  9147. name: project_tags
  9148. x-go-name: ProjectTags
  9149. - $ref: '#/definitions/TTagSetList'
  9150. description: filter by no project tags
  9151. in: query
  9152. name: no_project_tags
  9153. x-go-name: NoProjectTags
  9154. - description: filter by project organizations
  9155. in: query
  9156. items:
  9157. type: string
  9158. name: project_organizations
  9159. type: array
  9160. x-go-name: ProjectOrganizations
  9161. - $ref: '#/definitions/TTagSetList'
  9162. description: |-
  9163. ignore
  9164. project tag fitlers imposed by policy
  9165. in: query
  9166. name: policy_project_tags
  9167. x-go-name: PolicyProjectTags
  9168. - description: 指定匹配的范围,可能值为project, domain or system
  9169. in: query
  9170. name: belong_scope
  9171. type: string
  9172. x-go-name: BelongScope
  9173. - description: 以资源是否启用/禁用过滤列表
  9174. in: query
  9175. name: enabled
  9176. type: boolean
  9177. x-go-name: Enabled
  9178. - default: 20
  9179. description: 查询限制量
  9180. format: int64
  9181. in: query
  9182. name: limit
  9183. type: integer
  9184. x-go-name: Limit
  9185. - default: 0
  9186. description: 查询偏移量
  9187. format: int64
  9188. in: query
  9189. name: offset
  9190. type: integer
  9191. x-go-name: Offset
  9192. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  9193. in: query
  9194. items:
  9195. type: string
  9196. name: order_by
  9197. type: array
  9198. x-go-name: OrderBy
  9199. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  9200. example: desc|asc
  9201. in: query
  9202. name: order
  9203. type: string
  9204. x-go-name: Order
  9205. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  9206. in: query
  9207. name: details
  9208. type: boolean
  9209. x-go-name: Details
  9210. - description: 模糊搜索所有字段
  9211. in: query
  9212. name: search
  9213. type: string
  9214. x-go-name: Search
  9215. - description: |-
  9216. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  9217. 支持的操作符如下:
  9218. 操作符 | 参数个数 | 举例 | 说明 |
  9219. ---------------|----------|------------------------------------------------|-----------------------------|
  9220. in | > 0 | name.in("test", "good") | 在给定数组中 |
  9221. notin | > 0 | name.notin('test') | 不在给定数组中 |
  9222. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  9223. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  9224. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  9225. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  9226. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  9227. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  9228. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  9229. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  9230. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  9231. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  9232. notequals | 1 | name.notequals('test') | 不等于给定值 |
  9233. isnull | 0 | name.isnull() | 值为SQL的NULL |
  9234. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  9235. isempty | 0 | name.isempty('test') | 值为空字符串 |
  9236. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  9237. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  9238. in: query
  9239. items:
  9240. type: string
  9241. name: filter
  9242. type: array
  9243. x-go-name: Filter
  9244. - description: |-
  9245. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  9246. 和其他表关联的语法如下:
  9247. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  9248. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  9249. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  9250. 举例:
  9251. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  9252. in: query
  9253. items:
  9254. type: string
  9255. name: joint_filter
  9256. type: array
  9257. x-go-name: JointFilter
  9258. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  9259. in: query
  9260. name: filter_any
  9261. type: boolean
  9262. x-go-name: FilterAny
  9263. - description: 返回结果只包含指定的字段
  9264. in: query
  9265. items:
  9266. type: string
  9267. name: field
  9268. type: array
  9269. x-go-name: Field
  9270. - description: 用于数据导出,指定导出的数据字段
  9271. in: query
  9272. name: export_keys
  9273. type: string
  9274. x-go-name: ExportKeys
  9275. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  9276. in: query
  9277. name: show_fail_reason
  9278. type: boolean
  9279. x-go-name: ShowFailReason
  9280. - description: 是否返回状态统计信息,默认为False
  9281. in: query
  9282. name: summary_stats
  9283. type: boolean
  9284. x-go-name: SummaryStats
  9285. - $ref: '#/definitions/TTagSet'
  9286. description: 通过标签过滤(包含这些标签)
  9287. in: query
  9288. name: tags
  9289. x-go-name: Tags
  9290. - $ref: '#/definitions/TTagSetList'
  9291. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  9292. in: query
  9293. name: obj_tags
  9294. x-go-name: ObjTags
  9295. - $ref: '#/definitions/TTagSet'
  9296. description: 通过标签过滤(不包含这些标签)
  9297. in: query
  9298. name: no_tags
  9299. x-go-name: NoTags
  9300. - $ref: '#/definitions/TTagSetList'
  9301. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  9302. in: query
  9303. name: no_obj_tags
  9304. x-go-name: NoObjTags
  9305. - description: 通过标签排序
  9306. in: query
  9307. name: order_by_tag
  9308. type: string
  9309. x-go-name: OrderByTag
  9310. - description: |-
  9311. deprecated
  9312. 返回资源的标签不包含用户标签
  9313. in: query
  9314. name: without_user_meta
  9315. type: boolean
  9316. x-go-name: WithoutUserMeta
  9317. - description: 返回包含用户标签的资源
  9318. in: query
  9319. name: with_user_meta
  9320. type: boolean
  9321. x-go-name: WithUserMeta
  9322. - description: 返回包含外部标签的资源
  9323. in: query
  9324. name: with_cloud_meta
  9325. type: boolean
  9326. x-go-name: WithCloudMeta
  9327. - description: 返回包含任意标签的资源
  9328. in: query
  9329. name: with_any_meta
  9330. type: boolean
  9331. x-go-name: WithAnyMeta
  9332. - description: 返回列表数据中包含资源的标签数据(Metadata)
  9333. in: query
  9334. name: with_meta
  9335. type: boolean
  9336. x-go-name: WithMeta
  9337. - description: 显示所有的资源,包括模拟的资源
  9338. in: query
  9339. name: show_emulated
  9340. type: boolean
  9341. x-go-name: ShowEmulated
  9342. - description: 以资源ID过滤列表
  9343. in: query
  9344. items:
  9345. type: string
  9346. name: id
  9347. type: array
  9348. x-go-name: Ids
  9349. - description: 以资源名称过滤列表
  9350. in: query
  9351. items:
  9352. type: string
  9353. name: name
  9354. type: array
  9355. x-go-name: Names
  9356. - description: 以资源的状态过滤列表
  9357. in: query
  9358. items:
  9359. type: string
  9360. name: status
  9361. type: array
  9362. x-go-name: Status
  9363. - description: |-
  9364. 以报警是否启用/禁用过滤列表
  9365. Enabled *bool `json:"enabled"`
  9366. in: query
  9367. items:
  9368. type: string
  9369. name: monitor_resource_id
  9370. type: array
  9371. x-go-name: MonitorResourceId
  9372. - in: query
  9373. name: metric_type
  9374. type: string
  9375. x-go-name: MetricType
  9376. responses:
  9377. "200":
  9378. $ref: '#/responses/migrationalert_ListItemFilterOutput'
  9379. summary: 列表
  9380. tags:
  9381. - migrationalert
  9382. post:
  9383. description: 新建
  9384. operationId: migrationalert_ValidateCreateData
  9385. parameters:
  9386. - in: body
  9387. name: body
  9388. schema:
  9389. properties:
  9390. count:
  9391. default: 1
  9392. format: int64
  9393. type: integer
  9394. x-go-name: Count
  9395. migrationalert:
  9396. $ref: '#/definitions/MigrationAlertCreateInput'
  9397. type: object
  9398. x-go-name: Body
  9399. responses:
  9400. "200":
  9401. $ref: '#/responses/migrationalert_ValidateCreateDataOutput'
  9402. summary: 新建
  9403. tags:
  9404. - migrationalert
  9405. /migrationalerts/{id}:
  9406. delete:
  9407. description: 删除
  9408. operationId: migrationalert_CustomizeDelete
  9409. parameters:
  9410. - description: The Id or Name of migrationalert
  9411. in: path
  9412. name: id
  9413. required: true
  9414. type: string
  9415. x-go-name: Id
  9416. responses:
  9417. "200":
  9418. $ref: '#/responses/migrationalert_CustomizeDeleteOutput'
  9419. summary: 删除
  9420. tags:
  9421. - migrationalert
  9422. get:
  9423. description: 获取详情
  9424. operationId: migrationalert_FetchCustomizeColumns
  9425. parameters:
  9426. - description: The Id or Name of migrationalert
  9427. in: path
  9428. name: id
  9429. required: true
  9430. type: string
  9431. x-go-name: Id
  9432. responses:
  9433. "200":
  9434. $ref: '#/responses/migrationalert_FetchCustomizeColumnsOutput'
  9435. summary: 获取详情
  9436. tags:
  9437. - migrationalert
  9438. put:
  9439. description: 更新
  9440. operationId: migrationalert_ValidateUpdateData
  9441. parameters:
  9442. - description: The Id or Name of migrationalert
  9443. in: path
  9444. name: id
  9445. required: true
  9446. type: string
  9447. x-go-name: Id
  9448. - in: body
  9449. name: body
  9450. schema:
  9451. properties:
  9452. migrationalert:
  9453. $ref: '#/definitions/AlertUpdateInput'
  9454. type: object
  9455. x-go-name: Body
  9456. responses:
  9457. "200":
  9458. $ref: '#/responses/migrationalert_ValidateUpdateDataOutput'
  9459. summary: 更新
  9460. tags:
  9461. - migrationalert
  9462. /migrationalerts/{id}/disable:
  9463. post:
  9464. description: 执行操作Disable
  9465. operationId: migrationalert_PerformDisable
  9466. parameters:
  9467. - description: The Id or Name of migrationalert
  9468. in: path
  9469. name: id
  9470. required: true
  9471. type: string
  9472. x-go-name: Id
  9473. - in: body
  9474. name: body
  9475. schema:
  9476. properties:
  9477. migrationalert:
  9478. $ref: '#/definitions/PerformDisableInput'
  9479. type: object
  9480. x-go-name: Body
  9481. responses:
  9482. "200":
  9483. $ref: '#/responses/migrationalert_PerformDisableOutput'
  9484. summary: 执行操作Disable
  9485. tags:
  9486. - migrationalert
  9487. /migrationalerts/{id}/enable:
  9488. post:
  9489. description: 执行操作Enable
  9490. operationId: migrationalert_PerformEnable
  9491. parameters:
  9492. - description: The Id or Name of migrationalert
  9493. in: path
  9494. name: id
  9495. required: true
  9496. type: string
  9497. x-go-name: Id
  9498. - in: body
  9499. name: body
  9500. schema:
  9501. properties:
  9502. migrationalert:
  9503. $ref: '#/definitions/PerformEnableInput'
  9504. type: object
  9505. x-go-name: Body
  9506. responses:
  9507. "200":
  9508. $ref: '#/responses/migrationalert_PerformEnableOutput'
  9509. summary: 执行操作Enable
  9510. tags:
  9511. - migrationalert
  9512. /migrationalerts/{id}/metadata:
  9513. get:
  9514. description: 获取指定信息Metadata
  9515. operationId: migrationalert_GetDetailsMetadata
  9516. parameters:
  9517. - description: |-
  9518. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  9519. 标签分为
  9520. 类型 | 说明 |
  9521. ----------|---------------------------------------------|
  9522. 系统标签 | 平台定义的标签 |
  9523. 用户标签 | key以user:为前缀,用户自定义标签 |
  9524. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  9525. in: query
  9526. items:
  9527. type: string
  9528. name: field
  9529. type: array
  9530. x-go-name: Field
  9531. - description: 按标签前缀过滤
  9532. in: query
  9533. name: prefix
  9534. type: string
  9535. x-go-name: Prefix
  9536. - description: The Id or Name of migrationalert
  9537. in: path
  9538. name: id
  9539. required: true
  9540. type: string
  9541. x-go-name: Id
  9542. responses:
  9543. "200":
  9544. $ref: '#/responses/migrationalert_GetDetailsMetadataOutput'
  9545. summary: 获取资源标签(元数据)
  9546. tags:
  9547. - migrationalert
  9548. /migrationalerts/{id}/pause:
  9549. post:
  9550. description: 执行操作Pause
  9551. operationId: migrationalert_PerformPause
  9552. parameters:
  9553. - description: The Id or Name of migrationalert
  9554. in: path
  9555. name: id
  9556. required: true
  9557. type: string
  9558. x-go-name: Id
  9559. - in: body
  9560. name: body
  9561. schema:
  9562. properties:
  9563. migrationalert:
  9564. $ref: '#/definitions/AlertPauseInput'
  9565. type: object
  9566. x-go-name: Body
  9567. responses:
  9568. "200":
  9569. $ref: '#/responses/migrationalert_PerformPauseOutput'
  9570. summary: 执行操作Pause
  9571. tags:
  9572. - migrationalert
  9573. /migrationalerts/{id}/status:
  9574. get:
  9575. description: 获取指定信息Status
  9576. operationId: migrationalert_GetDetailsStatus
  9577. parameters:
  9578. - description: The Id or Name of migrationalert
  9579. in: path
  9580. name: id
  9581. required: true
  9582. type: string
  9583. x-go-name: Id
  9584. responses:
  9585. "200":
  9586. $ref: '#/responses/migrationalert_GetDetailsStatusOutput'
  9587. summary: 获取资源状态
  9588. tags:
  9589. - migrationalert
  9590. /migrationalerts/{id}/test-run:
  9591. post:
  9592. description: 执行操作TestRun
  9593. operationId: migrationalert_PerformTestRun
  9594. parameters:
  9595. - description: The Id or Name of migrationalert
  9596. in: path
  9597. name: id
  9598. required: true
  9599. type: string
  9600. x-go-name: Id
  9601. - in: body
  9602. name: body
  9603. schema:
  9604. properties:
  9605. migrationalert:
  9606. $ref: '#/definitions/AlertTestRunInput'
  9607. type: object
  9608. x-go-name: Body
  9609. responses:
  9610. "200":
  9611. $ref: '#/responses/migrationalert_PerformTestRunOutput'
  9612. summary: 执行操作TestRun
  9613. tags:
  9614. - migrationalert
  9615. /monitorresourcealerts:
  9616. get:
  9617. description: 列表
  9618. operationId: monitorresourcealert_ListItemFilter
  9619. parameters:
  9620. - default: 20
  9621. description: 查询限制量
  9622. format: int64
  9623. in: query
  9624. name: limit
  9625. type: integer
  9626. x-go-name: Limit
  9627. - default: 0
  9628. description: 查询偏移量
  9629. format: int64
  9630. in: query
  9631. name: offset
  9632. type: integer
  9633. x-go-name: Offset
  9634. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  9635. in: query
  9636. items:
  9637. type: string
  9638. name: order_by
  9639. type: array
  9640. x-go-name: OrderBy
  9641. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  9642. example: desc|asc
  9643. in: query
  9644. name: order
  9645. type: string
  9646. x-go-name: Order
  9647. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  9648. in: query
  9649. name: details
  9650. type: boolean
  9651. x-go-name: Details
  9652. - description: 模糊搜索所有字段
  9653. in: query
  9654. name: search
  9655. type: string
  9656. x-go-name: Search
  9657. - description: |-
  9658. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  9659. 支持的操作符如下:
  9660. 操作符 | 参数个数 | 举例 | 说明 |
  9661. ---------------|----------|------------------------------------------------|-----------------------------|
  9662. in | > 0 | name.in("test", "good") | 在给定数组中 |
  9663. notin | > 0 | name.notin('test') | 不在给定数组中 |
  9664. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  9665. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  9666. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  9667. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  9668. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  9669. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  9670. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  9671. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  9672. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  9673. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  9674. notequals | 1 | name.notequals('test') | 不等于给定值 |
  9675. isnull | 0 | name.isnull() | 值为SQL的NULL |
  9676. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  9677. isempty | 0 | name.isempty('test') | 值为空字符串 |
  9678. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  9679. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  9680. in: query
  9681. items:
  9682. type: string
  9683. name: filter
  9684. type: array
  9685. x-go-name: Filter
  9686. - description: |-
  9687. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  9688. 和其他表关联的语法如下:
  9689. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  9690. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  9691. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  9692. 举例:
  9693. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  9694. in: query
  9695. items:
  9696. type: string
  9697. name: joint_filter
  9698. type: array
  9699. x-go-name: JointFilter
  9700. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  9701. in: query
  9702. name: filter_any
  9703. type: boolean
  9704. x-go-name: FilterAny
  9705. - description: 返回结果只包含指定的字段
  9706. in: query
  9707. items:
  9708. type: string
  9709. name: field
  9710. type: array
  9711. x-go-name: Field
  9712. - description: 用于数据导出,指定导出的数据字段
  9713. in: query
  9714. name: export_keys
  9715. type: string
  9716. x-go-name: ExportKeys
  9717. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  9718. in: query
  9719. name: show_fail_reason
  9720. type: boolean
  9721. x-go-name: ShowFailReason
  9722. - description: 是否返回状态统计信息,默认为False
  9723. in: query
  9724. name: summary_stats
  9725. type: boolean
  9726. x-go-name: SummaryStats
  9727. - $ref: '#/definitions/TTagSet'
  9728. description: 通过标签过滤(包含这些标签)
  9729. in: query
  9730. name: tags
  9731. x-go-name: Tags
  9732. - $ref: '#/definitions/TTagSetList'
  9733. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  9734. in: query
  9735. name: obj_tags
  9736. x-go-name: ObjTags
  9737. - $ref: '#/definitions/TTagSet'
  9738. description: 通过标签过滤(不包含这些标签)
  9739. in: query
  9740. name: no_tags
  9741. x-go-name: NoTags
  9742. - $ref: '#/definitions/TTagSetList'
  9743. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  9744. in: query
  9745. name: no_obj_tags
  9746. x-go-name: NoObjTags
  9747. - description: 通过标签排序
  9748. in: query
  9749. name: order_by_tag
  9750. type: string
  9751. x-go-name: OrderByTag
  9752. - description: |-
  9753. deprecated
  9754. 返回资源的标签不包含用户标签
  9755. in: query
  9756. name: without_user_meta
  9757. type: boolean
  9758. x-go-name: WithoutUserMeta
  9759. - description: 返回包含用户标签的资源
  9760. in: query
  9761. name: with_user_meta
  9762. type: boolean
  9763. x-go-name: WithUserMeta
  9764. - description: 返回包含外部标签的资源
  9765. in: query
  9766. name: with_cloud_meta
  9767. type: boolean
  9768. x-go-name: WithCloudMeta
  9769. - description: 返回包含任意标签的资源
  9770. in: query
  9771. name: with_any_meta
  9772. type: boolean
  9773. x-go-name: WithAnyMeta
  9774. - description: 返回列表数据中包含资源的标签数据(Metadata)
  9775. in: query
  9776. name: with_meta
  9777. type: boolean
  9778. x-go-name: WithMeta
  9779. - description: 显示所有的资源,包括模拟的资源
  9780. in: query
  9781. name: show_emulated
  9782. type: boolean
  9783. x-go-name: ShowEmulated
  9784. - description: 以资源ID过滤列表
  9785. in: query
  9786. items:
  9787. type: string
  9788. name: id
  9789. type: array
  9790. x-go-name: Ids
  9791. - description: 以资源名称过滤列表
  9792. in: query
  9793. items:
  9794. type: string
  9795. name: name
  9796. type: array
  9797. x-go-name: Names
  9798. - description: 以资源的状态过滤列表
  9799. in: query
  9800. items:
  9801. type: string
  9802. name: status
  9803. type: array
  9804. x-go-name: Status
  9805. - description: 指定查询的权限范围,可能值为project, domain or system
  9806. in: query
  9807. name: scope
  9808. type: string
  9809. x-go-name: Scope
  9810. - description: 指定项目归属域名称或ID
  9811. in: query
  9812. name: project_domain_id
  9813. type: string
  9814. x-go-name: ProjectDomainId
  9815. - description: 对具有域属性的资源,严格匹配域ID
  9816. in: query
  9817. items:
  9818. type: string
  9819. name: project_domain_ids
  9820. type: array
  9821. x-go-name: ProjectDomainIds
  9822. - description: 按domain名称排序,可能值为asc|desc
  9823. in: query
  9824. name: order_by_domain
  9825. pattern: asc|desc
  9826. type: string
  9827. x-go-name: OrderByDomain
  9828. - $ref: '#/definitions/TTagSetList'
  9829. description: filter by domain tags
  9830. in: query
  9831. name: domain_tags
  9832. x-go-name: DomainTags
  9833. - $ref: '#/definitions/TTagSetList'
  9834. description: filter by domain tags
  9835. in: query
  9836. name: no_domain_tags
  9837. x-go-name: NoDomainTags
  9838. - description: 指定项目的名称或ID
  9839. in: query
  9840. name: project_id
  9841. type: string
  9842. x-go-name: ProjectId
  9843. - description: 对具有项目属性的资源,严格匹配项目ID
  9844. in: query
  9845. items:
  9846. type: string
  9847. name: project_ids
  9848. type: array
  9849. x-go-name: ProjectIds
  9850. - description: 按project名称排序,可能值为asc|desc
  9851. in: query
  9852. name: order_by_project
  9853. pattern: asc|desc
  9854. type: string
  9855. x-go-name: OrderByProject
  9856. - $ref: '#/definitions/TTagSetList'
  9857. description: filter by project tags
  9858. in: query
  9859. name: project_tags
  9860. x-go-name: ProjectTags
  9861. - $ref: '#/definitions/TTagSetList'
  9862. description: filter by no project tags
  9863. in: query
  9864. name: no_project_tags
  9865. x-go-name: NoProjectTags
  9866. - description: filter by project organizations
  9867. in: query
  9868. items:
  9869. type: string
  9870. name: project_organizations
  9871. type: array
  9872. x-go-name: ProjectOrganizations
  9873. - $ref: '#/definitions/TTagSetList'
  9874. description: |-
  9875. ignore
  9876. project tag fitlers imposed by policy
  9877. in: query
  9878. name: policy_project_tags
  9879. x-go-name: PolicyProjectTags
  9880. - description: 列表中包含标记为"系统资源"的资源
  9881. in: query
  9882. name: system
  9883. type: boolean
  9884. x-go-name: System
  9885. - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
  9886. in: query
  9887. name: pending_delete
  9888. type: boolean
  9889. x-go-name: PendingDelete
  9890. - description: 查询时间段开始时间
  9891. format: date-time
  9892. in: query
  9893. name: start_time
  9894. type: string
  9895. x-go-name: StartTime
  9896. - description: 查询时间段结束时间
  9897. format: date-time
  9898. in: query
  9899. name: end_time
  9900. type: string
  9901. x-go-name: EndTime
  9902. - description: 返回 top N(默认 5)
  9903. format: int64
  9904. in: query
  9905. name: top
  9906. type: integer
  9907. x-go-name: Top
  9908. - in: query
  9909. name: monitor_resource_id
  9910. type: string
  9911. x-go-name: MonitorResourceId
  9912. - in: query
  9913. name: alert_id
  9914. type: string
  9915. x-go-name: AlertId
  9916. - in: query
  9917. items:
  9918. format: int64
  9919. type: integer
  9920. name: joint_id
  9921. type: array
  9922. x-go-name: JointId
  9923. - in: query
  9924. name: alerting
  9925. type: boolean
  9926. x-go-name: Alerting
  9927. - in: query
  9928. name: alert_state
  9929. type: string
  9930. x-go-name: AlertState
  9931. - in: query
  9932. name: send_state
  9933. type: string
  9934. x-go-name: SendState
  9935. - in: query
  9936. name: res_type
  9937. type: string
  9938. x-go-name: ResType
  9939. - in: query
  9940. name: metric
  9941. type: string
  9942. x-go-name: Metric
  9943. - in: query
  9944. name: res_name
  9945. type: string
  9946. x-go-name: ResName
  9947. - in: query
  9948. name: alert_name
  9949. type: string
  9950. x-go-name: AlertName
  9951. - in: query
  9952. name: level
  9953. type: string
  9954. x-go-name: Level
  9955. - description: 查询所有状态
  9956. in: query
  9957. name: all_state
  9958. type: boolean
  9959. x-go-name: AllState
  9960. responses:
  9961. "200":
  9962. $ref: '#/responses/monitorresourcealert_ListItemFilterOutput'
  9963. summary: 列表
  9964. tags:
  9965. - monitorresourcealert
  9966. post:
  9967. description: 新建
  9968. operationId: monitorresourcealert_ValidateCreateData
  9969. parameters:
  9970. - in: body
  9971. name: body
  9972. schema:
  9973. properties:
  9974. count:
  9975. default: 1
  9976. format: int64
  9977. type: integer
  9978. x-go-name: Count
  9979. monitorresourcealert:
  9980. $ref: '#/definitions/JoinResourceBaseCreateInput'
  9981. type: object
  9982. x-go-name: Body
  9983. responses:
  9984. "200":
  9985. $ref: '#/responses/monitorresourcealert_ValidateCreateDataOutput'
  9986. summary: 新建
  9987. tags:
  9988. - monitorresourcealert
  9989. /monitorresourcealerts/{id}:
  9990. delete:
  9991. description: 删除
  9992. operationId: monitorresourcealert_CustomizeDelete
  9993. parameters:
  9994. - description: The Id or Name of monitorresourcealert
  9995. in: path
  9996. name: id
  9997. required: true
  9998. type: string
  9999. x-go-name: Id
  10000. responses:
  10001. "200":
  10002. $ref: '#/responses/monitorresourcealert_CustomizeDeleteOutput'
  10003. summary: 删除
  10004. tags:
  10005. - monitorresourcealert
  10006. get:
  10007. description: 获取详情
  10008. operationId: monitorresourcealert_FetchCustomizeColumns
  10009. parameters:
  10010. - description: The Id or Name of monitorresourcealert
  10011. in: path
  10012. name: id
  10013. required: true
  10014. type: string
  10015. x-go-name: Id
  10016. responses:
  10017. "200":
  10018. $ref: '#/responses/monitorresourcealert_FetchCustomizeColumnsOutput'
  10019. summary: 获取详情
  10020. tags:
  10021. - monitorresourcealert
  10022. put:
  10023. description: 更新
  10024. operationId: monitorresourcealert_ValidateUpdateData
  10025. parameters:
  10026. - description: The Id or Name of monitorresourcealert
  10027. in: path
  10028. name: id
  10029. required: true
  10030. type: string
  10031. x-go-name: Id
  10032. - in: body
  10033. name: body
  10034. schema:
  10035. properties:
  10036. monitorresourcealert:
  10037. $ref: '#/definitions/JointResourceBaseUpdateInput'
  10038. type: object
  10039. x-go-name: Body
  10040. responses:
  10041. "200":
  10042. $ref: '#/responses/monitorresourcealert_ValidateUpdateDataOutput'
  10043. summary: 更新
  10044. tags:
  10045. - monitorresourcealert
  10046. /monitorresources:
  10047. get:
  10048. description: 列表
  10049. operationId: monitorresource_ListItemFilter
  10050. parameters:
  10051. - default: 20
  10052. description: 查询限制量
  10053. format: int64
  10054. in: query
  10055. name: limit
  10056. type: integer
  10057. x-go-name: Limit
  10058. - default: 0
  10059. description: 查询偏移量
  10060. format: int64
  10061. in: query
  10062. name: offset
  10063. type: integer
  10064. x-go-name: Offset
  10065. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  10066. in: query
  10067. items:
  10068. type: string
  10069. name: order_by
  10070. type: array
  10071. x-go-name: OrderBy
  10072. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  10073. example: desc|asc
  10074. in: query
  10075. name: order
  10076. type: string
  10077. x-go-name: Order
  10078. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  10079. in: query
  10080. name: details
  10081. type: boolean
  10082. x-go-name: Details
  10083. - description: 模糊搜索所有字段
  10084. in: query
  10085. name: search
  10086. type: string
  10087. x-go-name: Search
  10088. - description: |-
  10089. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  10090. 支持的操作符如下:
  10091. 操作符 | 参数个数 | 举例 | 说明 |
  10092. ---------------|----------|------------------------------------------------|-----------------------------|
  10093. in | > 0 | name.in("test", "good") | 在给定数组中 |
  10094. notin | > 0 | name.notin('test') | 不在给定数组中 |
  10095. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  10096. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  10097. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  10098. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  10099. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  10100. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  10101. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  10102. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  10103. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  10104. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  10105. notequals | 1 | name.notequals('test') | 不等于给定值 |
  10106. isnull | 0 | name.isnull() | 值为SQL的NULL |
  10107. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  10108. isempty | 0 | name.isempty('test') | 值为空字符串 |
  10109. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  10110. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  10111. in: query
  10112. items:
  10113. type: string
  10114. name: filter
  10115. type: array
  10116. x-go-name: Filter
  10117. - description: |-
  10118. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  10119. 和其他表关联的语法如下:
  10120. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  10121. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  10122. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  10123. 举例:
  10124. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  10125. in: query
  10126. items:
  10127. type: string
  10128. name: joint_filter
  10129. type: array
  10130. x-go-name: JointFilter
  10131. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  10132. in: query
  10133. name: filter_any
  10134. type: boolean
  10135. x-go-name: FilterAny
  10136. - description: 返回结果只包含指定的字段
  10137. in: query
  10138. items:
  10139. type: string
  10140. name: field
  10141. type: array
  10142. x-go-name: Field
  10143. - description: 用于数据导出,指定导出的数据字段
  10144. in: query
  10145. name: export_keys
  10146. type: string
  10147. x-go-name: ExportKeys
  10148. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  10149. in: query
  10150. name: show_fail_reason
  10151. type: boolean
  10152. x-go-name: ShowFailReason
  10153. - description: 是否返回状态统计信息,默认为False
  10154. in: query
  10155. name: summary_stats
  10156. type: boolean
  10157. x-go-name: SummaryStats
  10158. - $ref: '#/definitions/TTagSet'
  10159. description: 通过标签过滤(包含这些标签)
  10160. in: query
  10161. name: tags
  10162. x-go-name: Tags
  10163. - $ref: '#/definitions/TTagSetList'
  10164. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  10165. in: query
  10166. name: obj_tags
  10167. x-go-name: ObjTags
  10168. - $ref: '#/definitions/TTagSet'
  10169. description: 通过标签过滤(不包含这些标签)
  10170. in: query
  10171. name: no_tags
  10172. x-go-name: NoTags
  10173. - $ref: '#/definitions/TTagSetList'
  10174. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  10175. in: query
  10176. name: no_obj_tags
  10177. x-go-name: NoObjTags
  10178. - description: 通过标签排序
  10179. in: query
  10180. name: order_by_tag
  10181. type: string
  10182. x-go-name: OrderByTag
  10183. - description: |-
  10184. deprecated
  10185. 返回资源的标签不包含用户标签
  10186. in: query
  10187. name: without_user_meta
  10188. type: boolean
  10189. x-go-name: WithoutUserMeta
  10190. - description: 返回包含用户标签的资源
  10191. in: query
  10192. name: with_user_meta
  10193. type: boolean
  10194. x-go-name: WithUserMeta
  10195. - description: 返回包含外部标签的资源
  10196. in: query
  10197. name: with_cloud_meta
  10198. type: boolean
  10199. x-go-name: WithCloudMeta
  10200. - description: 返回包含任意标签的资源
  10201. in: query
  10202. name: with_any_meta
  10203. type: boolean
  10204. x-go-name: WithAnyMeta
  10205. - description: 返回列表数据中包含资源的标签数据(Metadata)
  10206. in: query
  10207. name: with_meta
  10208. type: boolean
  10209. x-go-name: WithMeta
  10210. - description: 显示所有的资源,包括模拟的资源
  10211. in: query
  10212. name: show_emulated
  10213. type: boolean
  10214. x-go-name: ShowEmulated
  10215. - description: 以资源ID过滤列表
  10216. in: query
  10217. items:
  10218. type: string
  10219. name: id
  10220. type: array
  10221. x-go-name: Ids
  10222. - description: 以资源名称过滤列表
  10223. in: query
  10224. items:
  10225. type: string
  10226. name: name
  10227. type: array
  10228. x-go-name: Names
  10229. - description: 以资源的状态过滤列表
  10230. in: query
  10231. items:
  10232. type: string
  10233. name: status
  10234. type: array
  10235. x-go-name: Status
  10236. - description: 指定项目的名称或ID
  10237. in: query
  10238. name: project_id
  10239. type: string
  10240. x-go-name: ProjectId
  10241. - description: 对具有项目属性的资源,严格匹配项目ID
  10242. in: query
  10243. items:
  10244. type: string
  10245. name: project_ids
  10246. type: array
  10247. x-go-name: ProjectIds
  10248. - description: 按project名称排序,可能值为asc|desc
  10249. in: query
  10250. name: order_by_project
  10251. pattern: asc|desc
  10252. type: string
  10253. x-go-name: OrderByProject
  10254. - $ref: '#/definitions/TTagSetList'
  10255. description: filter by project tags
  10256. in: query
  10257. name: project_tags
  10258. x-go-name: ProjectTags
  10259. - $ref: '#/definitions/TTagSetList'
  10260. description: filter by no project tags
  10261. in: query
  10262. name: no_project_tags
  10263. x-go-name: NoProjectTags
  10264. - description: filter by project organizations
  10265. in: query
  10266. items:
  10267. type: string
  10268. name: project_organizations
  10269. type: array
  10270. x-go-name: ProjectOrganizations
  10271. - $ref: '#/definitions/TTagSetList'
  10272. description: |-
  10273. ignore
  10274. project tag fitlers imposed by policy
  10275. in: query
  10276. name: policy_project_tags
  10277. x-go-name: PolicyProjectTags
  10278. - description: 列表中包含标记为"系统资源"的资源
  10279. in: query
  10280. name: system
  10281. type: boolean
  10282. x-go-name: System
  10283. - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
  10284. in: query
  10285. name: pending_delete
  10286. type: boolean
  10287. x-go-name: PendingDelete
  10288. - description: 以资源是否启用/禁用过滤列表
  10289. in: query
  10290. name: enabled
  10291. type: boolean
  10292. x-go-name: Enabled
  10293. - description: 指定查询的权限范围,可能值为project, domain or system
  10294. in: query
  10295. name: scope
  10296. type: string
  10297. x-go-name: Scope
  10298. - description: 指定项目归属域名称或ID
  10299. in: query
  10300. name: project_domain_id
  10301. type: string
  10302. x-go-name: ProjectDomainId
  10303. - description: 对具有域属性的资源,严格匹配域ID
  10304. in: query
  10305. items:
  10306. type: string
  10307. name: project_domain_ids
  10308. type: array
  10309. x-go-name: ProjectDomainIds
  10310. - description: 按domain名称排序,可能值为asc|desc
  10311. in: query
  10312. name: order_by_domain
  10313. pattern: asc|desc
  10314. type: string
  10315. x-go-name: OrderByDomain
  10316. - $ref: '#/definitions/TTagSetList'
  10317. description: filter by domain tags
  10318. in: query
  10319. name: domain_tags
  10320. x-go-name: DomainTags
  10321. - $ref: '#/definitions/TTagSetList'
  10322. description: filter by domain tags
  10323. in: query
  10324. name: no_domain_tags
  10325. x-go-name: NoDomainTags
  10326. - description: |-
  10327. 列出指定云平台的资源,支持的云平台如下
  10328. Provider | 开始支持版本 | 平台 |
  10329. -----------|------------|-------------------------------------|
  10330. OneCloud | 0.0 | OneCloud内置私有云,包括KVM和裸金属管理 |
  10331. VMware | 1.2 | VMware vCenter |
  10332. OpenStack | 2.6 | OpenStack M版本以上私有云 |
  10333. ZStack | 2.10 | ZStack私有云 |
  10334. Aliyun | 2.0 | 阿里云 |
  10335. Aws | 2.3 | Amazon AWS |
  10336. Azure | 2.2 | Microsoft Azure |
  10337. Google | 2.13 | Google Cloud Platform |
  10338. Qcloud | 2.3 | 腾讯云 |
  10339. Huawei | 2.5 | 华为公有云 |
  10340. Ucloud | 2.7 | UCLOUD |
  10341. Ctyun | 2.13 | 天翼云 |
  10342. S3 | 2.11 | 通用s3对象存储 |
  10343. Ceph | 2.11 | Ceph对象存储 |
  10344. Xsky | 2.11 | XSKY启明星辰Ceph对象存储 |
  10345. enum:
  10346. - OneCloud
  10347. - VMware
  10348. - Aliyun
  10349. - Qcloud
  10350. - Azure
  10351. - Aws
  10352. - Huawei
  10353. - OpenStack
  10354. - Ucloud
  10355. - ZStack
  10356. - Google
  10357. - Ctyun
  10358. - S3
  10359. - Ceph
  10360. - Xsky
  10361. in: query
  10362. items:
  10363. type: string
  10364. name: providers
  10365. type: array
  10366. x-go-name: Providers
  10367. - in: query
  10368. items:
  10369. type: string
  10370. name: brands
  10371. type: array
  10372. x-go-name: Brands
  10373. - description: |-
  10374. 列出指定云环境的资源,支持云环境如下:
  10375. CloudEnv | 说明 |
  10376. -----------|--------|
  10377. public | 公有云 |
  10378. private | 私有云 |
  10379. onpremise | 本地IDC |
  10380. enum:
  10381. - public
  10382. - private
  10383. - onpremise
  10384. in: query
  10385. name: cloud_env
  10386. type: string
  10387. x-go-name: CloudEnv
  10388. - description: 以平台名称排序
  10389. in: query
  10390. name: order_by_provider
  10391. pattern: asc|desc
  10392. type: string
  10393. x-go-name: OrderByProvider
  10394. - description: 以平台品牌排序
  10395. in: query
  10396. name: order_by_brand
  10397. pattern: asc|desc
  10398. type: string
  10399. x-go-name: OrderByBrand
  10400. - description: 列出关联指定云订阅(ID或Name)的资源
  10401. in: query
  10402. items:
  10403. type: string
  10404. name: cloudprovider_id
  10405. type: array
  10406. x-go-name: CloudproviderId
  10407. - description: 列出关联指定云账号(ID或Name)的资源
  10408. in: query
  10409. items:
  10410. type: string
  10411. name: cloudaccount_id
  10412. type: array
  10413. x-go-name: CloudaccountId
  10414. - default: false
  10415. description: 过滤资源,是否为非OneCloud内置私有云管理的资源
  10416. in: query
  10417. name: is_managed
  10418. type: boolean
  10419. x-go-name: IsManaged
  10420. - description: 以云账号名称排序
  10421. in: query
  10422. name: order_by_account
  10423. pattern: asc|desc
  10424. type: string
  10425. x-go-name: OrderByAccount
  10426. - description: 以云订阅名称排序
  10427. in: query
  10428. name: order_by_manager
  10429. pattern: asc|desc
  10430. type: string
  10431. x-go-name: OrderByManager
  10432. - description: 查询时间段开始时间
  10433. format: date-time
  10434. in: query
  10435. name: start_time
  10436. type: string
  10437. x-go-name: StartTime
  10438. - description: 查询时间段结束时间
  10439. format: date-time
  10440. in: query
  10441. name: end_time
  10442. type: string
  10443. x-go-name: EndTime
  10444. - description: 返回 top N(默认 5)
  10445. format: int64
  10446. in: query
  10447. name: top
  10448. type: integer
  10449. x-go-name: Top
  10450. - in: query
  10451. items:
  10452. type: string
  10453. name: res_id
  10454. type: array
  10455. x-go-name: ResId
  10456. - in: query
  10457. name: res_type
  10458. type: string
  10459. x-go-name: ResType
  10460. - in: query
  10461. name: only_res_id
  10462. type: boolean
  10463. x-go-name: OnlyResId
  10464. - in: query
  10465. items:
  10466. type: string
  10467. name: alert_states
  10468. type: array
  10469. x-go-name: AlertStates
  10470. - in: query
  10471. name: res_name
  10472. type: string
  10473. x-go-name: ResName
  10474. responses:
  10475. "200":
  10476. $ref: '#/responses/monitorresource_ListItemFilterOutput'
  10477. summary: 列表
  10478. tags:
  10479. - monitorresource
  10480. post:
  10481. description: 新建
  10482. operationId: monitorresource_ValidateCreateData
  10483. parameters:
  10484. - in: body
  10485. name: body
  10486. schema:
  10487. properties:
  10488. count:
  10489. default: 1
  10490. format: int64
  10491. type: integer
  10492. x-go-name: Count
  10493. monitorresource:
  10494. $ref: '#/definitions/MonitorResourceCreateInput'
  10495. type: object
  10496. x-go-name: Body
  10497. responses:
  10498. "200":
  10499. $ref: '#/responses/monitorresource_ValidateCreateDataOutput'
  10500. summary: 新建
  10501. tags:
  10502. - monitorresource
  10503. /monitorresources/{id}:
  10504. delete:
  10505. description: 删除
  10506. operationId: monitorresource_CustomizeDelete
  10507. parameters:
  10508. - description: The Id or Name of monitorresource
  10509. in: path
  10510. name: id
  10511. required: true
  10512. type: string
  10513. x-go-name: Id
  10514. responses:
  10515. "200":
  10516. $ref: '#/responses/monitorresource_CustomizeDeleteOutput'
  10517. summary: 删除
  10518. tags:
  10519. - monitorresource
  10520. get:
  10521. description: 获取详情
  10522. operationId: monitorresource_FetchCustomizeColumns
  10523. parameters:
  10524. - description: The Id or Name of monitorresource
  10525. in: path
  10526. name: id
  10527. required: true
  10528. type: string
  10529. x-go-name: Id
  10530. responses:
  10531. "200":
  10532. $ref: '#/responses/monitorresource_FetchCustomizeColumnsOutput'
  10533. summary: 获取详情
  10534. tags:
  10535. - monitorresource
  10536. put:
  10537. description: 更新
  10538. operationId: monitorresource_ValidateUpdateData
  10539. parameters:
  10540. - description: The Id or Name of monitorresource
  10541. in: path
  10542. name: id
  10543. required: true
  10544. type: string
  10545. x-go-name: Id
  10546. - in: body
  10547. name: body
  10548. schema:
  10549. properties:
  10550. monitorresource:
  10551. $ref: '#/definitions/VirtualResourceBaseUpdateInput'
  10552. type: object
  10553. x-go-name: Body
  10554. responses:
  10555. "200":
  10556. $ref: '#/responses/monitorresource_ValidateUpdateDataOutput'
  10557. summary: 更新
  10558. tags:
  10559. - monitorresource
  10560. /monitorresources/{id}/change-owner:
  10561. post:
  10562. description: 执行操作ChangeOwner
  10563. operationId: monitorresource_PerformChangeOwner
  10564. parameters:
  10565. - description: The Id or Name of monitorresource
  10566. in: path
  10567. name: id
  10568. required: true
  10569. type: string
  10570. x-go-name: Id
  10571. - in: body
  10572. name: body
  10573. schema:
  10574. properties:
  10575. monitorresource:
  10576. $ref: '#/definitions/PerformChangeProjectOwnerInput'
  10577. type: object
  10578. x-go-name: Body
  10579. responses:
  10580. "200":
  10581. $ref: '#/responses/monitorresource_PerformChangeOwnerOutput'
  10582. summary: 更改项目
  10583. tags:
  10584. - monitorresource
  10585. /monitorresources/{id}/do-action:
  10586. post:
  10587. description: 执行操作DoAction
  10588. operationId: monitorresource_PerformDoAction
  10589. parameters:
  10590. - description: The Id or Name of monitorresource
  10591. in: path
  10592. name: id
  10593. required: true
  10594. type: string
  10595. x-go-name: Id
  10596. - in: body
  10597. name: body
  10598. schema:
  10599. properties:
  10600. monitorresource:
  10601. $ref: '#/definitions/MonitorResourceDoActionInput'
  10602. type: object
  10603. x-go-name: Body
  10604. responses:
  10605. "200":
  10606. $ref: '#/responses/monitorresource_PerformDoActionOutput'
  10607. summary: 执行操作DoAction
  10608. tags:
  10609. - monitorresource
  10610. /monitorresources/{id}/metadata:
  10611. get:
  10612. description: 获取指定信息Metadata
  10613. operationId: monitorresource_GetDetailsMetadata
  10614. parameters:
  10615. - description: |-
  10616. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  10617. 标签分为
  10618. 类型 | 说明 |
  10619. ----------|---------------------------------------------|
  10620. 系统标签 | 平台定义的标签 |
  10621. 用户标签 | key以user:为前缀,用户自定义标签 |
  10622. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  10623. in: query
  10624. items:
  10625. type: string
  10626. name: field
  10627. type: array
  10628. x-go-name: Field
  10629. - description: 按标签前缀过滤
  10630. in: query
  10631. name: prefix
  10632. type: string
  10633. x-go-name: Prefix
  10634. - description: The Id or Name of monitorresource
  10635. in: path
  10636. name: id
  10637. required: true
  10638. type: string
  10639. x-go-name: Id
  10640. responses:
  10641. "200":
  10642. $ref: '#/responses/monitorresource_GetDetailsMetadataOutput'
  10643. summary: 获取资源标签(元数据)
  10644. tags:
  10645. - monitorresource
  10646. /monitorresources/{id}/status:
  10647. get:
  10648. description: 获取指定信息Status
  10649. operationId: monitorresource_GetDetailsStatus
  10650. parameters:
  10651. - description: The Id or Name of monitorresource
  10652. in: path
  10653. name: id
  10654. required: true
  10655. type: string
  10656. x-go-name: Id
  10657. responses:
  10658. "200":
  10659. $ref: '#/responses/monitorresource_GetDetailsStatusOutput'
  10660. summary: 获取资源状态
  10661. tags:
  10662. - monitorresource
  10663. /monitorresources/alert:
  10664. get:
  10665. description: 获取指定资源类的信息Alert
  10666. operationId: monitorresource_GetPropertyAlert
  10667. responses:
  10668. "200":
  10669. $ref: '#/responses/monitorresource_GetPropertyAlertOutput'
  10670. summary: 获取指定资源类的信息Alert
  10671. tags:
  10672. - monitorresource
  10673. /nodealerts:
  10674. get:
  10675. description: 列表
  10676. operationId: nodealert_ListItemFilter
  10677. parameters:
  10678. - description: 指定查询的权限范围,可能值为project, domain or system
  10679. in: query
  10680. name: scope
  10681. type: string
  10682. x-go-name: Scope
  10683. - description: 指定项目归属域名称或ID
  10684. in: query
  10685. name: project_domain_id
  10686. type: string
  10687. x-go-name: ProjectDomainId
  10688. - description: 对具有域属性的资源,严格匹配域ID
  10689. in: query
  10690. items:
  10691. type: string
  10692. name: project_domain_ids
  10693. type: array
  10694. x-go-name: ProjectDomainIds
  10695. - description: 按domain名称排序,可能值为asc|desc
  10696. in: query
  10697. name: order_by_domain
  10698. pattern: asc|desc
  10699. type: string
  10700. x-go-name: OrderByDomain
  10701. - $ref: '#/definitions/TTagSetList'
  10702. description: filter by domain tags
  10703. in: query
  10704. name: domain_tags
  10705. x-go-name: DomainTags
  10706. - $ref: '#/definitions/TTagSetList'
  10707. description: filter by domain tags
  10708. in: query
  10709. name: no_domain_tags
  10710. x-go-name: NoDomainTags
  10711. - description: 指定项目的名称或ID
  10712. in: query
  10713. name: project_id
  10714. type: string
  10715. x-go-name: ProjectId
  10716. - description: 对具有项目属性的资源,严格匹配项目ID
  10717. in: query
  10718. items:
  10719. type: string
  10720. name: project_ids
  10721. type: array
  10722. x-go-name: ProjectIds
  10723. - description: 按project名称排序,可能值为asc|desc
  10724. in: query
  10725. name: order_by_project
  10726. pattern: asc|desc
  10727. type: string
  10728. x-go-name: OrderByProject
  10729. - $ref: '#/definitions/TTagSetList'
  10730. description: filter by project tags
  10731. in: query
  10732. name: project_tags
  10733. x-go-name: ProjectTags
  10734. - $ref: '#/definitions/TTagSetList'
  10735. description: filter by no project tags
  10736. in: query
  10737. name: no_project_tags
  10738. x-go-name: NoProjectTags
  10739. - description: filter by project organizations
  10740. in: query
  10741. items:
  10742. type: string
  10743. name: project_organizations
  10744. type: array
  10745. x-go-name: ProjectOrganizations
  10746. - $ref: '#/definitions/TTagSetList'
  10747. description: |-
  10748. ignore
  10749. project tag fitlers imposed by policy
  10750. in: query
  10751. name: policy_project_tags
  10752. x-go-name: PolicyProjectTags
  10753. - description: 指定匹配的范围,可能值为project, domain or system
  10754. in: query
  10755. name: belong_scope
  10756. type: string
  10757. x-go-name: BelongScope
  10758. - description: 以资源是否启用/禁用过滤列表
  10759. in: query
  10760. name: enabled
  10761. type: boolean
  10762. x-go-name: Enabled
  10763. - default: 20
  10764. description: 查询限制量
  10765. format: int64
  10766. in: query
  10767. name: limit
  10768. type: integer
  10769. x-go-name: Limit
  10770. - default: 0
  10771. description: 查询偏移量
  10772. format: int64
  10773. in: query
  10774. name: offset
  10775. type: integer
  10776. x-go-name: Offset
  10777. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  10778. in: query
  10779. items:
  10780. type: string
  10781. name: order_by
  10782. type: array
  10783. x-go-name: OrderBy
  10784. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  10785. example: desc|asc
  10786. in: query
  10787. name: order
  10788. type: string
  10789. x-go-name: Order
  10790. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  10791. in: query
  10792. name: details
  10793. type: boolean
  10794. x-go-name: Details
  10795. - description: 模糊搜索所有字段
  10796. in: query
  10797. name: search
  10798. type: string
  10799. x-go-name: Search
  10800. - description: |-
  10801. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  10802. 支持的操作符如下:
  10803. 操作符 | 参数个数 | 举例 | 说明 |
  10804. ---------------|----------|------------------------------------------------|-----------------------------|
  10805. in | > 0 | name.in("test", "good") | 在给定数组中 |
  10806. notin | > 0 | name.notin('test') | 不在给定数组中 |
  10807. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  10808. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  10809. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  10810. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  10811. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  10812. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  10813. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  10814. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  10815. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  10816. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  10817. notequals | 1 | name.notequals('test') | 不等于给定值 |
  10818. isnull | 0 | name.isnull() | 值为SQL的NULL |
  10819. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  10820. isempty | 0 | name.isempty('test') | 值为空字符串 |
  10821. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  10822. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  10823. in: query
  10824. items:
  10825. type: string
  10826. name: filter
  10827. type: array
  10828. x-go-name: Filter
  10829. - description: |-
  10830. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  10831. 和其他表关联的语法如下:
  10832. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  10833. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  10834. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  10835. 举例:
  10836. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  10837. in: query
  10838. items:
  10839. type: string
  10840. name: joint_filter
  10841. type: array
  10842. x-go-name: JointFilter
  10843. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  10844. in: query
  10845. name: filter_any
  10846. type: boolean
  10847. x-go-name: FilterAny
  10848. - description: 返回结果只包含指定的字段
  10849. in: query
  10850. items:
  10851. type: string
  10852. name: field
  10853. type: array
  10854. x-go-name: Field
  10855. - description: 用于数据导出,指定导出的数据字段
  10856. in: query
  10857. name: export_keys
  10858. type: string
  10859. x-go-name: ExportKeys
  10860. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  10861. in: query
  10862. name: show_fail_reason
  10863. type: boolean
  10864. x-go-name: ShowFailReason
  10865. - description: 是否返回状态统计信息,默认为False
  10866. in: query
  10867. name: summary_stats
  10868. type: boolean
  10869. x-go-name: SummaryStats
  10870. - $ref: '#/definitions/TTagSet'
  10871. description: 通过标签过滤(包含这些标签)
  10872. in: query
  10873. name: tags
  10874. x-go-name: Tags
  10875. - $ref: '#/definitions/TTagSetList'
  10876. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  10877. in: query
  10878. name: obj_tags
  10879. x-go-name: ObjTags
  10880. - $ref: '#/definitions/TTagSet'
  10881. description: 通过标签过滤(不包含这些标签)
  10882. in: query
  10883. name: no_tags
  10884. x-go-name: NoTags
  10885. - $ref: '#/definitions/TTagSetList'
  10886. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  10887. in: query
  10888. name: no_obj_tags
  10889. x-go-name: NoObjTags
  10890. - description: 通过标签排序
  10891. in: query
  10892. name: order_by_tag
  10893. type: string
  10894. x-go-name: OrderByTag
  10895. - description: |-
  10896. deprecated
  10897. 返回资源的标签不包含用户标签
  10898. in: query
  10899. name: without_user_meta
  10900. type: boolean
  10901. x-go-name: WithoutUserMeta
  10902. - description: 返回包含用户标签的资源
  10903. in: query
  10904. name: with_user_meta
  10905. type: boolean
  10906. x-go-name: WithUserMeta
  10907. - description: 返回包含外部标签的资源
  10908. in: query
  10909. name: with_cloud_meta
  10910. type: boolean
  10911. x-go-name: WithCloudMeta
  10912. - description: 返回包含任意标签的资源
  10913. in: query
  10914. name: with_any_meta
  10915. type: boolean
  10916. x-go-name: WithAnyMeta
  10917. - description: 返回列表数据中包含资源的标签数据(Metadata)
  10918. in: query
  10919. name: with_meta
  10920. type: boolean
  10921. x-go-name: WithMeta
  10922. - description: 显示所有的资源,包括模拟的资源
  10923. in: query
  10924. name: show_emulated
  10925. type: boolean
  10926. x-go-name: ShowEmulated
  10927. - description: 以资源ID过滤列表
  10928. in: query
  10929. items:
  10930. type: string
  10931. name: id
  10932. type: array
  10933. x-go-name: Ids
  10934. - description: 以资源名称过滤列表
  10935. in: query
  10936. items:
  10937. type: string
  10938. name: name
  10939. type: array
  10940. x-go-name: Names
  10941. - description: 以资源的状态过滤列表
  10942. in: query
  10943. items:
  10944. type: string
  10945. name: status
  10946. type: array
  10947. x-go-name: Status
  10948. - description: |-
  10949. 以报警是否启用/禁用过滤列表
  10950. Enabled *bool `json:"enabled"`
  10951. in: query
  10952. items:
  10953. type: string
  10954. name: monitor_resource_id
  10955. type: array
  10956. x-go-name: MonitorResourceId
  10957. - description: 监控指标名称
  10958. in: query
  10959. name: metric
  10960. type: string
  10961. x-go-name: Metric
  10962. - description: '监控资源类型, 比如: guest, host'
  10963. in: query
  10964. name: type
  10965. type: string
  10966. x-go-name: Type
  10967. - description: 监控资源名称
  10968. in: query
  10969. name: node_name
  10970. type: string
  10971. x-go-name: NodeName
  10972. - description: 监控资源 Id
  10973. in: query
  10974. name: node_id
  10975. type: string
  10976. x-go-name: NodeId
  10977. responses:
  10978. "200":
  10979. $ref: '#/responses/nodealert_ListItemFilterOutput'
  10980. summary: 列表
  10981. tags:
  10982. - nodealert
  10983. post:
  10984. description: 新建
  10985. operationId: nodealert_ValidateCreateData
  10986. parameters:
  10987. - in: body
  10988. name: body
  10989. schema:
  10990. properties:
  10991. count:
  10992. default: 1
  10993. format: int64
  10994. type: integer
  10995. x-go-name: Count
  10996. nodealert:
  10997. $ref: '#/definitions/NodeAlertCreateInput'
  10998. type: object
  10999. x-go-name: Body
  11000. responses:
  11001. "200":
  11002. $ref: '#/responses/nodealert_ValidateCreateDataOutput'
  11003. summary: 新建
  11004. tags:
  11005. - nodealert
  11006. /nodealerts/{id}:
  11007. delete:
  11008. description: 删除
  11009. operationId: nodealert_CustomizeDelete
  11010. parameters:
  11011. - description: The Id or Name of nodealert
  11012. in: path
  11013. name: id
  11014. required: true
  11015. type: string
  11016. x-go-name: Id
  11017. responses:
  11018. "200":
  11019. $ref: '#/responses/nodealert_CustomizeDeleteOutput'
  11020. summary: 删除
  11021. tags:
  11022. - nodealert
  11023. get:
  11024. description: 获取详情
  11025. operationId: nodealert_FetchCustomizeColumns
  11026. parameters:
  11027. - description: The Id or Name of nodealert
  11028. in: path
  11029. name: id
  11030. required: true
  11031. type: string
  11032. x-go-name: Id
  11033. responses:
  11034. "200":
  11035. $ref: '#/responses/nodealert_FetchCustomizeColumnsOutput'
  11036. summary: 获取详情
  11037. tags:
  11038. - nodealert
  11039. put:
  11040. description: 更新
  11041. operationId: nodealert_ValidateUpdateData
  11042. parameters:
  11043. - description: The Id or Name of nodealert
  11044. in: path
  11045. name: id
  11046. required: true
  11047. type: string
  11048. x-go-name: Id
  11049. - in: body
  11050. name: body
  11051. schema:
  11052. properties:
  11053. nodealert:
  11054. $ref: '#/definitions/NodeAlertUpdateInput'
  11055. type: object
  11056. x-go-name: Body
  11057. responses:
  11058. "200":
  11059. $ref: '#/responses/nodealert_ValidateUpdateDataOutput'
  11060. summary: 更新
  11061. tags:
  11062. - nodealert
  11063. /nodealerts/{id}/config:
  11064. post:
  11065. description: 执行操作Config
  11066. operationId: nodealert_PerformConfig
  11067. parameters:
  11068. - description: The Id or Name of nodealert
  11069. in: path
  11070. name: id
  11071. required: true
  11072. type: string
  11073. x-go-name: Id
  11074. responses:
  11075. "200":
  11076. $ref: '#/responses/nodealert_PerformConfigOutput'
  11077. summary: 执行操作Config
  11078. tags:
  11079. - nodealert
  11080. /nodealerts/{id}/disable:
  11081. post:
  11082. description: 执行操作Disable
  11083. operationId: nodealert_PerformDisable
  11084. parameters:
  11085. - description: The Id or Name of nodealert
  11086. in: path
  11087. name: id
  11088. required: true
  11089. type: string
  11090. x-go-name: Id
  11091. - in: body
  11092. name: body
  11093. schema:
  11094. properties:
  11095. nodealert:
  11096. $ref: '#/definitions/PerformDisableInput'
  11097. type: object
  11098. x-go-name: Body
  11099. responses:
  11100. "200":
  11101. $ref: '#/responses/nodealert_PerformDisableOutput'
  11102. summary: 执行操作Disable
  11103. tags:
  11104. - nodealert
  11105. /nodealerts/{id}/enable:
  11106. post:
  11107. description: 执行操作Enable
  11108. operationId: nodealert_PerformEnable
  11109. parameters:
  11110. - description: The Id or Name of nodealert
  11111. in: path
  11112. name: id
  11113. required: true
  11114. type: string
  11115. x-go-name: Id
  11116. - in: body
  11117. name: body
  11118. schema:
  11119. properties:
  11120. nodealert:
  11121. $ref: '#/definitions/PerformEnableInput'
  11122. type: object
  11123. x-go-name: Body
  11124. responses:
  11125. "200":
  11126. $ref: '#/responses/nodealert_PerformEnableOutput'
  11127. summary: 执行操作Enable
  11128. tags:
  11129. - nodealert
  11130. /nodealerts/{id}/metadata:
  11131. get:
  11132. description: 获取指定信息Metadata
  11133. operationId: nodealert_GetDetailsMetadata
  11134. parameters:
  11135. - description: |-
  11136. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  11137. 标签分为
  11138. 类型 | 说明 |
  11139. ----------|---------------------------------------------|
  11140. 系统标签 | 平台定义的标签 |
  11141. 用户标签 | key以user:为前缀,用户自定义标签 |
  11142. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  11143. in: query
  11144. items:
  11145. type: string
  11146. name: field
  11147. type: array
  11148. x-go-name: Field
  11149. - description: 按标签前缀过滤
  11150. in: query
  11151. name: prefix
  11152. type: string
  11153. x-go-name: Prefix
  11154. - description: The Id or Name of nodealert
  11155. in: path
  11156. name: id
  11157. required: true
  11158. type: string
  11159. x-go-name: Id
  11160. responses:
  11161. "200":
  11162. $ref: '#/responses/nodealert_GetDetailsMetadataOutput'
  11163. summary: 获取资源标签(元数据)
  11164. tags:
  11165. - nodealert
  11166. /nodealerts/{id}/pause:
  11167. post:
  11168. description: 执行操作Pause
  11169. operationId: nodealert_PerformPause
  11170. parameters:
  11171. - description: The Id or Name of nodealert
  11172. in: path
  11173. name: id
  11174. required: true
  11175. type: string
  11176. x-go-name: Id
  11177. - in: body
  11178. name: body
  11179. schema:
  11180. properties:
  11181. nodealert:
  11182. $ref: '#/definitions/AlertPauseInput'
  11183. type: object
  11184. x-go-name: Body
  11185. responses:
  11186. "200":
  11187. $ref: '#/responses/nodealert_PerformPauseOutput'
  11188. summary: 执行操作Pause
  11189. tags:
  11190. - nodealert
  11191. /nodealerts/{id}/set-scope:
  11192. post:
  11193. description: 执行操作SetScope
  11194. operationId: nodealert_PerformSetScope
  11195. parameters:
  11196. - description: The Id or Name of nodealert
  11197. in: path
  11198. name: id
  11199. required: true
  11200. type: string
  11201. x-go-name: Id
  11202. responses:
  11203. "200":
  11204. $ref: '#/responses/nodealert_PerformSetScopeOutput'
  11205. summary: 执行操作SetScope
  11206. tags:
  11207. - nodealert
  11208. /nodealerts/{id}/status:
  11209. get:
  11210. description: 获取指定信息Status
  11211. operationId: nodealert_GetDetailsStatus
  11212. parameters:
  11213. - description: The Id or Name of nodealert
  11214. in: path
  11215. name: id
  11216. required: true
  11217. type: string
  11218. x-go-name: Id
  11219. responses:
  11220. "200":
  11221. $ref: '#/responses/nodealert_GetDetailsStatusOutput'
  11222. summary: 获取资源状态
  11223. tags:
  11224. - nodealert
  11225. /nodealerts/{id}/test-run:
  11226. post:
  11227. description: 执行操作TestRun
  11228. operationId: nodealert_PerformTestRun
  11229. parameters:
  11230. - description: The Id or Name of nodealert
  11231. in: path
  11232. name: id
  11233. required: true
  11234. type: string
  11235. x-go-name: Id
  11236. - in: body
  11237. name: body
  11238. schema:
  11239. properties:
  11240. nodealert:
  11241. $ref: '#/definitions/AlertTestRunInput'
  11242. type: object
  11243. x-go-name: Body
  11244. responses:
  11245. "200":
  11246. $ref: '#/responses/nodealert_PerformTestRunOutput'
  11247. summary: 执行操作TestRun
  11248. tags:
  11249. - nodealert
  11250. /unifiedmonitors/query:
  11251. post:
  11252. description: 查询监控数据接口
  11253. operationId: models_PerformQuery
  11254. parameters:
  11255. - in: body
  11256. name: body
  11257. schema:
  11258. $ref: '#/definitions/MetricQueryInput'
  11259. x-go-name: Body
  11260. responses:
  11261. "200":
  11262. $ref: '#/responses/models_PerformQueryOutput'
  11263. summary: 查询监控数据接口
  11264. tags:
  11265. - unifiedmonitor
  11266. produces:
  11267. - application/json
  11268. responses:
  11269. alert_CustomizeDeleteOutput:
  11270. description: ""
  11271. schema:
  11272. properties:
  11273. alert:
  11274. $ref: '#/definitions/AlertDetails'
  11275. type: object
  11276. alert_FetchCustomizeColumnsOutput:
  11277. description: ""
  11278. schema:
  11279. properties:
  11280. alert:
  11281. $ref: '#/definitions/AlertDetails'
  11282. type: object
  11283. alert_GetDetailsMetadataOutput:
  11284. description: ""
  11285. schema:
  11286. properties:
  11287. alert:
  11288. additionalProperties:
  11289. type: string
  11290. type: object
  11291. x-go-name: Output
  11292. type: object
  11293. alert_GetDetailsStatusOutput:
  11294. description: ""
  11295. schema:
  11296. properties:
  11297. alert:
  11298. $ref: '#/definitions/GetDetailsStatusOutput'
  11299. type: object
  11300. alert_ListItemFilterOutput:
  11301. description: ""
  11302. schema:
  11303. properties:
  11304. alerts:
  11305. items:
  11306. $ref: '#/definitions/AlertDetails'
  11307. type: array
  11308. x-go-name: Output
  11309. limit:
  11310. format: int64
  11311. type: integer
  11312. x-go-name: Limit
  11313. offset:
  11314. format: int64
  11315. type: integer
  11316. x-go-name: Offset
  11317. total:
  11318. format: int64
  11319. type: integer
  11320. x-go-name: Total
  11321. type: object
  11322. alert_PerformDisableOutput:
  11323. description: ""
  11324. alert_PerformEnableOutput:
  11325. description: ""
  11326. alert_PerformPauseOutput:
  11327. description: ""
  11328. alert_PerformTestRunOutput:
  11329. description: ""
  11330. schema:
  11331. properties:
  11332. alert:
  11333. $ref: '#/definitions/AlertTestRunOutput'
  11334. type: object
  11335. alert_ValidateCreateDataOutput:
  11336. description: ""
  11337. schema:
  11338. properties:
  11339. alert:
  11340. $ref: '#/definitions/AlertDetails'
  11341. type: object
  11342. alert_ValidateUpdateDataOutput:
  11343. description: ""
  11344. schema:
  11345. properties:
  11346. alert:
  11347. $ref: '#/definitions/AlertDetails'
  11348. type: object
  11349. alert_notification_CustomizeDeleteOutput:
  11350. description: ""
  11351. schema:
  11352. properties:
  11353. alert_notification:
  11354. $ref: '#/definitions/VirtualResourceDetails'
  11355. type: object
  11356. alert_notification_FetchCustomizeColumnsOutput:
  11357. description: ""
  11358. schema:
  11359. properties:
  11360. alert_notification:
  11361. $ref: '#/definitions/VirtualResourceDetails'
  11362. type: object
  11363. alert_notification_GetDetailsMetadataOutput:
  11364. description: ""
  11365. schema:
  11366. properties:
  11367. alert_notification:
  11368. additionalProperties:
  11369. type: string
  11370. type: object
  11371. x-go-name: Output
  11372. type: object
  11373. alert_notification_GetDetailsStatusOutput:
  11374. description: ""
  11375. schema:
  11376. properties:
  11377. alert_notification:
  11378. $ref: '#/definitions/GetDetailsStatusOutput'
  11379. type: object
  11380. alert_notification_ListItemFilterOutput:
  11381. description: ""
  11382. schema:
  11383. properties:
  11384. alert_notifications:
  11385. items:
  11386. $ref: '#/definitions/VirtualResourceDetails'
  11387. type: array
  11388. x-go-name: Output
  11389. limit:
  11390. format: int64
  11391. type: integer
  11392. x-go-name: Limit
  11393. offset:
  11394. format: int64
  11395. type: integer
  11396. x-go-name: Offset
  11397. total:
  11398. format: int64
  11399. type: integer
  11400. x-go-name: Total
  11401. type: object
  11402. alert_notification_PerformChangeOwnerOutput:
  11403. description: ""
  11404. alert_notification_ValidateCreateDataOutput:
  11405. description: ""
  11406. schema:
  11407. properties:
  11408. alert_notification:
  11409. $ref: '#/definitions/VirtualResourceDetails'
  11410. type: object
  11411. alert_notification_ValidateUpdateDataOutput:
  11412. description: ""
  11413. schema:
  11414. properties:
  11415. alert_notification:
  11416. $ref: '#/definitions/VirtualResourceDetails'
  11417. type: object
  11418. alertdashboard_CustomizeDeleteOutput:
  11419. description: ""
  11420. schema:
  11421. properties:
  11422. alertdashboard:
  11423. $ref: '#/definitions/AlertDashBoardDetails'
  11424. type: object
  11425. alertdashboard_FetchCustomizeColumnsOutput:
  11426. description: ""
  11427. schema:
  11428. properties:
  11429. alertdashboard:
  11430. $ref: '#/definitions/AlertDashBoardDetails'
  11431. type: object
  11432. alertdashboard_GetDetailsMetadataOutput:
  11433. description: ""
  11434. schema:
  11435. properties:
  11436. alertdashboard:
  11437. additionalProperties:
  11438. type: string
  11439. type: object
  11440. x-go-name: Output
  11441. type: object
  11442. alertdashboard_GetDetailsStatusOutput:
  11443. description: ""
  11444. schema:
  11445. properties:
  11446. alertdashboard:
  11447. $ref: '#/definitions/GetDetailsStatusOutput'
  11448. type: object
  11449. alertdashboard_ListItemFilterOutput:
  11450. description: ""
  11451. schema:
  11452. properties:
  11453. alertdashboards:
  11454. items:
  11455. $ref: '#/definitions/AlertDashBoardDetails'
  11456. type: array
  11457. x-go-name: Output
  11458. limit:
  11459. format: int64
  11460. type: integer
  11461. x-go-name: Limit
  11462. offset:
  11463. format: int64
  11464. type: integer
  11465. x-go-name: Offset
  11466. total:
  11467. format: int64
  11468. type: integer
  11469. x-go-name: Total
  11470. type: object
  11471. alertdashboard_PerformCloneDashboardOutput:
  11472. description: ""
  11473. alertdashboard_PerformClonePanelOutput:
  11474. description: ""
  11475. alertdashboard_PerformSetPanelOrderOutput:
  11476. description: ""
  11477. alertdashboard_PerformSetScopeOutput:
  11478. description: ""
  11479. alertdashboard_ValidateCreateDataOutput:
  11480. description: ""
  11481. schema:
  11482. properties:
  11483. alertdashboard:
  11484. $ref: '#/definitions/AlertDashBoardDetails'
  11485. type: object
  11486. alertdashboard_ValidateUpdateDataOutput:
  11487. description: ""
  11488. schema:
  11489. properties:
  11490. alertdashboard:
  11491. $ref: '#/definitions/AlertDashBoardDetails'
  11492. type: object
  11493. alertpanel_CustomizeDeleteOutput:
  11494. description: ""
  11495. schema:
  11496. properties:
  11497. alertpanel:
  11498. $ref: '#/definitions/PanelDetails'
  11499. type: object
  11500. alertpanel_FetchCustomizeColumnsOutput:
  11501. description: ""
  11502. schema:
  11503. properties:
  11504. alertpanel:
  11505. $ref: '#/definitions/PanelDetails'
  11506. type: object
  11507. alertpanel_GetDetailsMetadataOutput:
  11508. description: ""
  11509. schema:
  11510. properties:
  11511. alertpanel:
  11512. additionalProperties:
  11513. type: string
  11514. type: object
  11515. x-go-name: Output
  11516. type: object
  11517. alertpanel_GetDetailsStatusOutput:
  11518. description: ""
  11519. schema:
  11520. properties:
  11521. alertpanel:
  11522. $ref: '#/definitions/GetDetailsStatusOutput'
  11523. type: object
  11524. alertpanel_ListItemFilterOutput:
  11525. description: ""
  11526. schema:
  11527. properties:
  11528. alertpanels:
  11529. items:
  11530. $ref: '#/definitions/PanelDetails'
  11531. type: array
  11532. x-go-name: Output
  11533. limit:
  11534. format: int64
  11535. type: integer
  11536. x-go-name: Limit
  11537. offset:
  11538. format: int64
  11539. type: integer
  11540. x-go-name: Offset
  11541. total:
  11542. format: int64
  11543. type: integer
  11544. x-go-name: Total
  11545. type: object
  11546. alertpanel_ValidateCreateDataOutput:
  11547. description: ""
  11548. schema:
  11549. properties:
  11550. alertpanel:
  11551. $ref: '#/definitions/PanelDetails'
  11552. type: object
  11553. alertpanel_ValidateUpdateDataOutput:
  11554. description: ""
  11555. schema:
  11556. properties:
  11557. alertpanel:
  11558. $ref: '#/definitions/PanelDetails'
  11559. type: object
  11560. alertrecord_CustomizeDeleteOutput:
  11561. description: ""
  11562. schema:
  11563. properties:
  11564. alertrecord:
  11565. $ref: '#/definitions/AlertRecordDetails'
  11566. type: object
  11567. alertrecord_FetchCustomizeColumnsOutput:
  11568. description: ""
  11569. schema:
  11570. properties:
  11571. alertrecord:
  11572. $ref: '#/definitions/AlertRecordDetails'
  11573. type: object
  11574. alertrecord_GetDetailsMetadataOutput:
  11575. description: ""
  11576. schema:
  11577. properties:
  11578. alertrecord:
  11579. additionalProperties:
  11580. type: string
  11581. type: object
  11582. x-go-name: Output
  11583. type: object
  11584. alertrecord_GetPropertyHistoryAlertOutput:
  11585. description: ""
  11586. schema:
  11587. properties:
  11588. alertrecord:
  11589. $ref: '#/definitions/AlertRecordHistoryAlert'
  11590. type: object
  11591. alertrecord_GetPropertyProjectAlertResourceCountOutput:
  11592. description: ""
  11593. schema:
  11594. properties:
  11595. alertrecord:
  11596. $ref: '#/definitions/ProjectAlertResourceCount'
  11597. type: object
  11598. alertrecord_GetPropertyTotalAlertOutput:
  11599. description: ""
  11600. alertrecord_ListItemFilterOutput:
  11601. description: ""
  11602. schema:
  11603. properties:
  11604. alertrecords:
  11605. items:
  11606. $ref: '#/definitions/AlertRecordDetails'
  11607. type: array
  11608. x-go-name: Output
  11609. limit:
  11610. format: int64
  11611. type: integer
  11612. x-go-name: Limit
  11613. offset:
  11614. format: int64
  11615. type: integer
  11616. x-go-name: Offset
  11617. total:
  11618. format: int64
  11619. type: integer
  11620. x-go-name: Total
  11621. type: object
  11622. alertrecord_ValidateCreateDataOutput:
  11623. description: ""
  11624. schema:
  11625. properties:
  11626. alertrecord:
  11627. $ref: '#/definitions/AlertRecordDetails'
  11628. type: object
  11629. alertrecord_ValidateUpdateDataOutput:
  11630. description: ""
  11631. schema:
  11632. properties:
  11633. alertrecord:
  11634. $ref: '#/definitions/AlertRecordDetails'
  11635. type: object
  11636. alertrecordshield_CustomizeDeleteOutput:
  11637. description: ""
  11638. schema:
  11639. properties:
  11640. alertrecordshield:
  11641. $ref: '#/definitions/AlertRecordShieldDetails'
  11642. type: object
  11643. alertrecordshield_FetchCustomizeColumnsOutput:
  11644. description: ""
  11645. schema:
  11646. properties:
  11647. alertrecordshield:
  11648. $ref: '#/definitions/AlertRecordShieldDetails'
  11649. type: object
  11650. alertrecordshield_GetDetailsMetadataOutput:
  11651. description: ""
  11652. schema:
  11653. properties:
  11654. alertrecordshield:
  11655. additionalProperties:
  11656. type: string
  11657. type: object
  11658. x-go-name: Output
  11659. type: object
  11660. alertrecordshield_GetDetailsStatusOutput:
  11661. description: ""
  11662. schema:
  11663. properties:
  11664. alertrecordshield:
  11665. $ref: '#/definitions/GetDetailsStatusOutput'
  11666. type: object
  11667. alertrecordshield_ListItemFilterOutput:
  11668. description: ""
  11669. schema:
  11670. properties:
  11671. alertrecordshields:
  11672. items:
  11673. $ref: '#/definitions/AlertRecordShieldDetails'
  11674. type: array
  11675. x-go-name: Output
  11676. limit:
  11677. format: int64
  11678. type: integer
  11679. x-go-name: Limit
  11680. offset:
  11681. format: int64
  11682. type: integer
  11683. x-go-name: Offset
  11684. total:
  11685. format: int64
  11686. type: integer
  11687. x-go-name: Total
  11688. type: object
  11689. alertrecordshield_ValidateCreateDataOutput:
  11690. description: ""
  11691. schema:
  11692. properties:
  11693. alertrecordshield:
  11694. $ref: '#/definitions/AlertRecordShieldDetails'
  11695. type: object
  11696. alertrecordshield_ValidateUpdateDataOutput:
  11697. description: ""
  11698. schema:
  11699. properties:
  11700. alertrecordshield:
  11701. $ref: '#/definitions/AlertRecordShieldDetails'
  11702. type: object
  11703. alertresource_CustomizeDeleteOutput:
  11704. description: ""
  11705. schema:
  11706. properties:
  11707. alertresource:
  11708. $ref: '#/definitions/AlertResourceDetails'
  11709. type: object
  11710. alertresource_FetchCustomizeColumnsOutput:
  11711. description: ""
  11712. schema:
  11713. properties:
  11714. alertresource:
  11715. $ref: '#/definitions/AlertResourceDetails'
  11716. type: object
  11717. alertresource_GetDetailsMetadataOutput:
  11718. description: ""
  11719. schema:
  11720. properties:
  11721. alertresource:
  11722. additionalProperties:
  11723. type: string
  11724. type: object
  11725. x-go-name: Output
  11726. type: object
  11727. alertresource_ListItemFilterOutput:
  11728. description: ""
  11729. schema:
  11730. properties:
  11731. alertresources:
  11732. items:
  11733. $ref: '#/definitions/AlertResourceDetails'
  11734. type: array
  11735. x-go-name: Output
  11736. limit:
  11737. format: int64
  11738. type: integer
  11739. x-go-name: Limit
  11740. offset:
  11741. format: int64
  11742. type: integer
  11743. x-go-name: Offset
  11744. total:
  11745. format: int64
  11746. type: integer
  11747. x-go-name: Total
  11748. type: object
  11749. alertresource_ValidateCreateDataOutput:
  11750. description: ""
  11751. schema:
  11752. properties:
  11753. alertresource:
  11754. $ref: '#/definitions/AlertResourceDetails'
  11755. type: object
  11756. alertresource_ValidateUpdateDataOutput:
  11757. description: ""
  11758. schema:
  11759. properties:
  11760. alertresource:
  11761. $ref: '#/definitions/AlertResourceDetails'
  11762. type: object
  11763. commonalert_CustomizeDeleteOutput:
  11764. description: ""
  11765. schema:
  11766. properties:
  11767. commonalert:
  11768. $ref: '#/definitions/CommonAlertDetails'
  11769. type: object
  11770. commonalert_FetchCustomizeColumnsOutput:
  11771. description: ""
  11772. schema:
  11773. properties:
  11774. commonalert:
  11775. $ref: '#/definitions/CommonAlertDetails'
  11776. type: object
  11777. commonalert_GetDetailsMetadataOutput:
  11778. description: ""
  11779. schema:
  11780. properties:
  11781. commonalert:
  11782. additionalProperties:
  11783. type: string
  11784. type: object
  11785. x-go-name: Output
  11786. type: object
  11787. commonalert_GetDetailsStatusOutput:
  11788. description: ""
  11789. schema:
  11790. properties:
  11791. commonalert:
  11792. $ref: '#/definitions/GetDetailsStatusOutput'
  11793. type: object
  11794. commonalert_ListItemFilterOutput:
  11795. description: ""
  11796. schema:
  11797. properties:
  11798. commonalerts:
  11799. items:
  11800. $ref: '#/definitions/CommonAlertDetails'
  11801. type: array
  11802. x-go-name: Output
  11803. limit:
  11804. format: int64
  11805. type: integer
  11806. x-go-name: Limit
  11807. offset:
  11808. format: int64
  11809. type: integer
  11810. x-go-name: Offset
  11811. total:
  11812. format: int64
  11813. type: integer
  11814. x-go-name: Total
  11815. type: object
  11816. commonalert_PerformConfigOutput:
  11817. description: ""
  11818. commonalert_PerformDisableOutput:
  11819. description: ""
  11820. commonalert_PerformEnableOutput:
  11821. description: ""
  11822. commonalert_PerformPauseOutput:
  11823. description: ""
  11824. commonalert_PerformSetScopeOutput:
  11825. description: ""
  11826. commonalert_PerformTestRunOutput:
  11827. description: ""
  11828. schema:
  11829. properties:
  11830. commonalert:
  11831. $ref: '#/definitions/AlertTestRunOutput'
  11832. type: object
  11833. commonalert_ValidateCreateDataOutput:
  11834. description: ""
  11835. schema:
  11836. properties:
  11837. commonalert:
  11838. $ref: '#/definitions/CommonAlertDetails'
  11839. type: object
  11840. commonalert_ValidateUpdateDataOutput:
  11841. description: ""
  11842. schema:
  11843. properties:
  11844. commonalert:
  11845. $ref: '#/definitions/CommonAlertDetails'
  11846. type: object
  11847. datasource_CustomizeDeleteOutput:
  11848. description: ""
  11849. schema:
  11850. properties:
  11851. datasource:
  11852. $ref: '#/definitions/StandaloneResourceDetails'
  11853. type: object
  11854. datasource_FetchCustomizeColumnsOutput:
  11855. description: ""
  11856. schema:
  11857. properties:
  11858. datasource:
  11859. $ref: '#/definitions/StandaloneResourceDetails'
  11860. type: object
  11861. datasource_GetDetailsMetadataOutput:
  11862. description: ""
  11863. schema:
  11864. properties:
  11865. datasource:
  11866. additionalProperties:
  11867. type: string
  11868. type: object
  11869. x-go-name: Output
  11870. type: object
  11871. datasource_ListItemFilterOutput:
  11872. description: ""
  11873. schema:
  11874. properties:
  11875. datasources:
  11876. items:
  11877. $ref: '#/definitions/StandaloneResourceDetails'
  11878. type: array
  11879. x-go-name: Output
  11880. limit:
  11881. format: int64
  11882. type: integer
  11883. x-go-name: Limit
  11884. offset:
  11885. format: int64
  11886. type: integer
  11887. x-go-name: Offset
  11888. total:
  11889. format: int64
  11890. type: integer
  11891. x-go-name: Total
  11892. type: object
  11893. datasource_ValidateCreateDataOutput:
  11894. description: ""
  11895. schema:
  11896. properties:
  11897. datasource:
  11898. $ref: '#/definitions/StandaloneResourceDetails'
  11899. type: object
  11900. datasource_ValidateUpdateDataOutput:
  11901. description: ""
  11902. schema:
  11903. properties:
  11904. datasource:
  11905. $ref: '#/definitions/StandaloneResourceDetails'
  11906. type: object
  11907. metric_CustomizeDeleteOutput:
  11908. description: ""
  11909. schema:
  11910. properties:
  11911. metric:
  11912. $ref: '#/definitions/JointResourceBaseDetails'
  11913. type: object
  11914. metric_FetchCustomizeColumnsOutput:
  11915. description: ""
  11916. schema:
  11917. properties:
  11918. metric:
  11919. $ref: '#/definitions/JointResourceBaseDetails'
  11920. type: object
  11921. metric_ListItemFilterOutput:
  11922. description: ""
  11923. schema:
  11924. properties:
  11925. limit:
  11926. format: int64
  11927. type: integer
  11928. x-go-name: Limit
  11929. metrics:
  11930. items:
  11931. $ref: '#/definitions/JointResourceBaseDetails'
  11932. type: array
  11933. x-go-name: Output
  11934. offset:
  11935. format: int64
  11936. type: integer
  11937. x-go-name: Offset
  11938. total:
  11939. format: int64
  11940. type: integer
  11941. x-go-name: Total
  11942. type: object
  11943. metric_ValidateCreateDataOutput:
  11944. description: ""
  11945. schema:
  11946. properties:
  11947. metric:
  11948. $ref: '#/definitions/JointResourceBaseDetails'
  11949. type: object
  11950. metric_ValidateUpdateDataOutput:
  11951. description: ""
  11952. schema:
  11953. properties:
  11954. metric:
  11955. $ref: '#/definitions/JointResourceBaseDetails'
  11956. type: object
  11957. metricfield_CustomizeDeleteOutput:
  11958. description: ""
  11959. schema:
  11960. properties:
  11961. metricfield:
  11962. $ref: '#/definitions/MetricFieldDetail'
  11963. type: object
  11964. metricfield_FetchCustomizeColumnsOutput:
  11965. description: ""
  11966. schema:
  11967. properties:
  11968. metricfield:
  11969. $ref: '#/definitions/MetricFieldDetail'
  11970. type: object
  11971. metricfield_GetDetailsMetadataOutput:
  11972. description: ""
  11973. schema:
  11974. properties:
  11975. metricfield:
  11976. additionalProperties:
  11977. type: string
  11978. type: object
  11979. x-go-name: Output
  11980. type: object
  11981. metricfield_GetDetailsStatusOutput:
  11982. description: ""
  11983. schema:
  11984. properties:
  11985. metricfield:
  11986. $ref: '#/definitions/GetDetailsStatusOutput'
  11987. type: object
  11988. metricfield_ListItemFilterOutput:
  11989. description: ""
  11990. schema:
  11991. properties:
  11992. limit:
  11993. format: int64
  11994. type: integer
  11995. x-go-name: Limit
  11996. metricfields:
  11997. items:
  11998. $ref: '#/definitions/MetricFieldDetail'
  11999. type: array
  12000. x-go-name: Output
  12001. offset:
  12002. format: int64
  12003. type: integer
  12004. x-go-name: Offset
  12005. total:
  12006. format: int64
  12007. type: integer
  12008. x-go-name: Total
  12009. type: object
  12010. metricfield_ValidateCreateDataOutput:
  12011. description: ""
  12012. schema:
  12013. properties:
  12014. metricfield:
  12015. $ref: '#/definitions/MetricFieldDetail'
  12016. type: object
  12017. metricfield_ValidateUpdateDataOutput:
  12018. description: ""
  12019. schema:
  12020. properties:
  12021. metricfield:
  12022. $ref: '#/definitions/MetricFieldDetail'
  12023. type: object
  12024. metricmeasurement_CustomizeDeleteOutput:
  12025. description: ""
  12026. schema:
  12027. properties:
  12028. metricmeasurement:
  12029. $ref: '#/definitions/MetricDetails'
  12030. type: object
  12031. metricmeasurement_FetchCustomizeColumnsOutput:
  12032. description: ""
  12033. schema:
  12034. properties:
  12035. metricmeasurement:
  12036. $ref: '#/definitions/MetricDetails'
  12037. type: object
  12038. metricmeasurement_GetDetailsMetadataOutput:
  12039. description: ""
  12040. schema:
  12041. properties:
  12042. metricmeasurement:
  12043. additionalProperties:
  12044. type: string
  12045. type: object
  12046. x-go-name: Output
  12047. type: object
  12048. metricmeasurement_GetDetailsStatusOutput:
  12049. description: ""
  12050. schema:
  12051. properties:
  12052. metricmeasurement:
  12053. $ref: '#/definitions/GetDetailsStatusOutput'
  12054. type: object
  12055. metricmeasurement_ListItemFilterOutput:
  12056. description: ""
  12057. schema:
  12058. properties:
  12059. limit:
  12060. format: int64
  12061. type: integer
  12062. x-go-name: Limit
  12063. metricmeasurements:
  12064. items:
  12065. $ref: '#/definitions/MetricDetails'
  12066. type: array
  12067. x-go-name: Output
  12068. offset:
  12069. format: int64
  12070. type: integer
  12071. x-go-name: Offset
  12072. total:
  12073. format: int64
  12074. type: integer
  12075. x-go-name: Total
  12076. type: object
  12077. metricmeasurement_ValidateCreateDataOutput:
  12078. description: ""
  12079. schema:
  12080. properties:
  12081. metricmeasurement:
  12082. $ref: '#/definitions/MetricDetails'
  12083. type: object
  12084. metricmeasurement_ValidateUpdateDataOutput:
  12085. description: ""
  12086. schema:
  12087. properties:
  12088. metricmeasurement:
  12089. $ref: '#/definitions/MetricDetails'
  12090. type: object
  12091. migrationalert_CustomizeDeleteOutput:
  12092. description: ""
  12093. schema:
  12094. properties:
  12095. migrationalert:
  12096. $ref: '#/definitions/AlertDetails'
  12097. type: object
  12098. migrationalert_FetchCustomizeColumnsOutput:
  12099. description: ""
  12100. schema:
  12101. properties:
  12102. migrationalert:
  12103. $ref: '#/definitions/AlertDetails'
  12104. type: object
  12105. migrationalert_GetDetailsMetadataOutput:
  12106. description: ""
  12107. schema:
  12108. properties:
  12109. migrationalert:
  12110. additionalProperties:
  12111. type: string
  12112. type: object
  12113. x-go-name: Output
  12114. type: object
  12115. migrationalert_GetDetailsStatusOutput:
  12116. description: ""
  12117. schema:
  12118. properties:
  12119. migrationalert:
  12120. $ref: '#/definitions/GetDetailsStatusOutput'
  12121. type: object
  12122. migrationalert_ListItemFilterOutput:
  12123. description: ""
  12124. schema:
  12125. properties:
  12126. limit:
  12127. format: int64
  12128. type: integer
  12129. x-go-name: Limit
  12130. migrationalerts:
  12131. items:
  12132. $ref: '#/definitions/AlertDetails'
  12133. type: array
  12134. x-go-name: Output
  12135. offset:
  12136. format: int64
  12137. type: integer
  12138. x-go-name: Offset
  12139. total:
  12140. format: int64
  12141. type: integer
  12142. x-go-name: Total
  12143. type: object
  12144. migrationalert_PerformDisableOutput:
  12145. description: ""
  12146. migrationalert_PerformEnableOutput:
  12147. description: ""
  12148. migrationalert_PerformPauseOutput:
  12149. description: ""
  12150. migrationalert_PerformTestRunOutput:
  12151. description: ""
  12152. schema:
  12153. properties:
  12154. migrationalert:
  12155. $ref: '#/definitions/AlertTestRunOutput'
  12156. type: object
  12157. migrationalert_ValidateCreateDataOutput:
  12158. description: ""
  12159. schema:
  12160. properties:
  12161. migrationalert:
  12162. $ref: '#/definitions/AlertDetails'
  12163. type: object
  12164. migrationalert_ValidateUpdateDataOutput:
  12165. description: ""
  12166. schema:
  12167. properties:
  12168. migrationalert:
  12169. $ref: '#/definitions/AlertDetails'
  12170. type: object
  12171. models_PerformQueryOutput:
  12172. description: ""
  12173. schema:
  12174. properties:
  12175. unifiedmonitor:
  12176. $ref: '#/definitions/MetricsQueryResult'
  12177. type: object
  12178. monitorresource_CustomizeDeleteOutput:
  12179. description: ""
  12180. schema:
  12181. properties:
  12182. monitorresource:
  12183. $ref: '#/definitions/MonitorResourceDetails'
  12184. type: object
  12185. monitorresource_FetchCustomizeColumnsOutput:
  12186. description: ""
  12187. schema:
  12188. properties:
  12189. monitorresource:
  12190. $ref: '#/definitions/MonitorResourceDetails'
  12191. type: object
  12192. monitorresource_GetDetailsMetadataOutput:
  12193. description: ""
  12194. schema:
  12195. properties:
  12196. monitorresource:
  12197. additionalProperties:
  12198. type: string
  12199. type: object
  12200. x-go-name: Output
  12201. type: object
  12202. monitorresource_GetDetailsStatusOutput:
  12203. description: ""
  12204. schema:
  12205. properties:
  12206. monitorresource:
  12207. $ref: '#/definitions/GetDetailsStatusOutput'
  12208. type: object
  12209. monitorresource_GetPropertyAlertOutput:
  12210. description: ""
  12211. monitorresource_ListItemFilterOutput:
  12212. description: ""
  12213. schema:
  12214. properties:
  12215. limit:
  12216. format: int64
  12217. type: integer
  12218. x-go-name: Limit
  12219. monitorresources:
  12220. items:
  12221. $ref: '#/definitions/MonitorResourceDetails'
  12222. type: array
  12223. x-go-name: Output
  12224. offset:
  12225. format: int64
  12226. type: integer
  12227. x-go-name: Offset
  12228. total:
  12229. format: int64
  12230. type: integer
  12231. x-go-name: Total
  12232. type: object
  12233. monitorresource_PerformChangeOwnerOutput:
  12234. description: ""
  12235. monitorresource_PerformDoActionOutput:
  12236. description: ""
  12237. monitorresource_ValidateCreateDataOutput:
  12238. description: ""
  12239. schema:
  12240. properties:
  12241. monitorresource:
  12242. $ref: '#/definitions/MonitorResourceDetails'
  12243. type: object
  12244. monitorresource_ValidateUpdateDataOutput:
  12245. description: ""
  12246. schema:
  12247. properties:
  12248. monitorresource:
  12249. $ref: '#/definitions/MonitorResourceDetails'
  12250. type: object
  12251. monitorresourcealert_CustomizeDeleteOutput:
  12252. description: ""
  12253. schema:
  12254. properties:
  12255. monitorresourcealert:
  12256. $ref: '#/definitions/MonitorResourceJointDetails'
  12257. type: object
  12258. monitorresourcealert_FetchCustomizeColumnsOutput:
  12259. description: ""
  12260. schema:
  12261. properties:
  12262. monitorresourcealert:
  12263. $ref: '#/definitions/MonitorResourceJointDetails'
  12264. type: object
  12265. monitorresourcealert_ListItemFilterOutput:
  12266. description: ""
  12267. schema:
  12268. properties:
  12269. limit:
  12270. format: int64
  12271. type: integer
  12272. x-go-name: Limit
  12273. monitorresourcealerts:
  12274. items:
  12275. $ref: '#/definitions/MonitorResourceJointDetails'
  12276. type: array
  12277. x-go-name: Output
  12278. offset:
  12279. format: int64
  12280. type: integer
  12281. x-go-name: Offset
  12282. total:
  12283. format: int64
  12284. type: integer
  12285. x-go-name: Total
  12286. type: object
  12287. monitorresourcealert_ValidateCreateDataOutput:
  12288. description: ""
  12289. schema:
  12290. properties:
  12291. monitorresourcealert:
  12292. $ref: '#/definitions/MonitorResourceJointDetails'
  12293. type: object
  12294. monitorresourcealert_ValidateUpdateDataOutput:
  12295. description: ""
  12296. schema:
  12297. properties:
  12298. monitorresourcealert:
  12299. $ref: '#/definitions/MonitorResourceJointDetails'
  12300. type: object
  12301. nodealert_CustomizeDeleteOutput:
  12302. description: ""
  12303. schema:
  12304. properties:
  12305. nodealert:
  12306. $ref: '#/definitions/NodeAlertDetails'
  12307. type: object
  12308. nodealert_FetchCustomizeColumnsOutput:
  12309. description: ""
  12310. schema:
  12311. properties:
  12312. nodealert:
  12313. $ref: '#/definitions/NodeAlertDetails'
  12314. type: object
  12315. nodealert_GetDetailsMetadataOutput:
  12316. description: ""
  12317. schema:
  12318. properties:
  12319. nodealert:
  12320. additionalProperties:
  12321. type: string
  12322. type: object
  12323. x-go-name: Output
  12324. type: object
  12325. nodealert_GetDetailsStatusOutput:
  12326. description: ""
  12327. schema:
  12328. properties:
  12329. nodealert:
  12330. $ref: '#/definitions/GetDetailsStatusOutput'
  12331. type: object
  12332. nodealert_ListItemFilterOutput:
  12333. description: ""
  12334. schema:
  12335. properties:
  12336. limit:
  12337. format: int64
  12338. type: integer
  12339. x-go-name: Limit
  12340. nodealerts:
  12341. items:
  12342. $ref: '#/definitions/NodeAlertDetails'
  12343. type: array
  12344. x-go-name: Output
  12345. offset:
  12346. format: int64
  12347. type: integer
  12348. x-go-name: Offset
  12349. total:
  12350. format: int64
  12351. type: integer
  12352. x-go-name: Total
  12353. type: object
  12354. nodealert_PerformConfigOutput:
  12355. description: ""
  12356. nodealert_PerformDisableOutput:
  12357. description: ""
  12358. nodealert_PerformEnableOutput:
  12359. description: ""
  12360. nodealert_PerformPauseOutput:
  12361. description: ""
  12362. nodealert_PerformSetScopeOutput:
  12363. description: ""
  12364. nodealert_PerformTestRunOutput:
  12365. description: ""
  12366. schema:
  12367. properties:
  12368. nodealert:
  12369. $ref: '#/definitions/AlertTestRunOutput'
  12370. type: object
  12371. nodealert_ValidateCreateDataOutput:
  12372. description: ""
  12373. schema:
  12374. properties:
  12375. nodealert:
  12376. $ref: '#/definitions/NodeAlertDetails'
  12377. type: object
  12378. nodealert_ValidateUpdateDataOutput:
  12379. description: ""
  12380. schema:
  12381. properties:
  12382. nodealert:
  12383. $ref: '#/definitions/NodeAlertDetails'
  12384. type: object
  12385. schemes:
  12386. - https
  12387. - http
  12388. securityDefinitions:
  12389. keystone:
  12390. in: header
  12391. name: X-Auth-Token
  12392. type: apiKey
  12393. swagger: "2.0"