| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426 |
- basePath: /
- consumes:
- - application/json
- definitions:
- AlertCloneDashboardInput:
- properties:
- clone_name:
- type: string
- x-go-name: CloneName
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertClonePanelInput:
- properties:
- clone_panel_name:
- type: string
- x-go-name: ClonePanelName
- panel_id:
- type: string
- x-go-name: PanelId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertCondition:
- properties:
- evaluator:
- $ref: '#/definitions/Condition'
- operator:
- type: string
- x-go-name: Operator
- query:
- $ref: '#/definitions/AlertQuery'
- reducer:
- $ref: '#/definitions/Condition'
- reducer_order:
- $ref: '#/definitions/ResultReducerOrder'
- type:
- type: string
- x-go-name: Type
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertCreateInput:
- properties:
- customize_config:
- description: customize info
- type: object
- x-go-name: CustomizeConfig
- enabled:
- description: 启用报警
- type: boolean
- x-go-name: Enabled
- execution_error_state:
- description: 报警执行错误将当前报警状态设置为对应的状态
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: 报警持续时间
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: 报警执行频率
- format: int64
- type: integer
- x-go-name: Frequency
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- name:
- description: 报警名称
- type: string
- x-go-name: Name
- no_data_state:
- description: 没有收到监控指标时将当前报警状态设置为对应的状态
- type: string
- x-go-name: NoDataState
- reason:
- type: string
- x-go-name: Reason
- settings:
- $ref: '#/definitions/AlertSetting'
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertDashBoardCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- refresh:
- type: string
- x-go-name: Refresh
- scope:
- type: string
- x-go-name: Scope
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertDashBoardDetails:
- properties:
- alert_panel_details:
- items:
- $ref: '#/definitions/AlertPanelDetail'
- type: array
- x-go-name: AlertPanelDetails
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- customize_config:
- type: object
- x-go-name: CustomizeConfig
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- execution_error:
- description: Silenced bool
- type: string
- x-go-name: ExecutionError
- execution_error_state:
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: |-
- If an alert rule has a configured `For` and the query violates the configured threshold
- it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
- notifications. Once the alert rule has been firing for more than `For` duration, it will
- change to `Alerting` and send alert notifications.
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: Frequency is evaluate period
- format: int64
- type: integer
- x-go-name: Frequency
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- last_state_change:
- format: date-time
- type: string
- x-go-name: LastStateChange
- level:
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- type: string
- x-go-name: NoDataState
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- res_type:
- type: string
- x-go-name: ResType
- scope:
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- state:
- type: string
- x-go-name: State
- state_changes:
- format: int64
- type: integer
- x-go-name: StateChanges
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- customize_config:
- type: object
- x-go-name: CustomizeConfig
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- execution_error:
- description: Silenced bool
- type: string
- x-go-name: ExecutionError
- execution_error_state:
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: |-
- If an alert rule has a configured `For` and the query violates the configured threshold
- it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
- notifications. Once the alert rule has been firing for more than `For` duration, it will
- change to `Alerting` and send alert notifications.
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: Frequency is evaluate period
- format: int64
- type: integer
- x-go-name: Frequency
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- last_state_change:
- format: date-time
- type: string
- x-go-name: LastStateChange
- level:
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- type: string
- x-go-name: NoDataState
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- res_type:
- type: string
- x-go-name: ResType
- scope:
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- state:
- type: string
- x-go-name: State
- state_changes:
- format: int64
- type: integer
- x-go-name: StateChanges
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertPanelCreateInput:
- properties:
- customize_config:
- description: customize info
- type: object
- x-go-name: CustomizeConfig
- dashboard_id:
- type: string
- x-go-name: DashboardId
- domain_tags:
- $ref: '#/definitions/TTagSetList'
- enabled:
- description: 启用报警
- type: boolean
- x-go-name: Enabled
- execution_error_state:
- description: 报警执行错误将当前报警状态设置为对应的状态
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: 报警持续时间
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: 报警执行频率
- format: int64
- type: integer
- x-go-name: Frequency
- from:
- type: string
- x-go-name: From
- interval:
- type: string
- x-go-name: Interval
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- metric_query:
- items:
- $ref: '#/definitions/CommonAlertQuery'
- type: array
- x-go-name: MetricQuery
- name:
- description: 报警名称
- type: string
- x-go-name: Name
- no_data_state:
- description: 没有收到监控指标时将当前报警状态设置为对应的状态
- type: string
- x-go-name: NoDataState
- no_domain_tags:
- $ref: '#/definitions/TTagSetList'
- no_project_tags:
- $ref: '#/definitions/TTagSetList'
- order_by_domain:
- description: 按domain名称排序,可能值为asc|desc
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- order_by_project:
- description: 按project名称排序,可能值为asc|desc
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- policy_project_tags:
- $ref: '#/definitions/TTagSetList'
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_domain_ids:
- description: 对具有域属性的资源,严格匹配域ID
- items:
- type: string
- type: array
- x-go-name: ProjectDomainIds
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- project_ids:
- description: 对具有项目属性的资源,严格匹配项目ID
- items:
- type: string
- type: array
- x-go-name: ProjectIds
- project_organizations:
- description: filter by project organizations
- items:
- type: string
- type: array
- x-go-name: ProjectOrganizations
- project_tags:
- $ref: '#/definitions/TTagSetList'
- reason:
- type: string
- x-go-name: Reason
- refresh:
- type: string
- x-go-name: Refresh
- scope:
- description: 指定查询的权限范围,可能值为project, domain or system
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- to:
- type: string
- x-go-name: To
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertPanelDetail:
- properties:
- Setting:
- $ref: '#/definitions/AlertSetting'
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- common_alert_metric_details:
- items:
- $ref: '#/definitions/CommonAlertMetricDetails'
- type: array
- x-go-name: CommonAlertMetricDetails
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- customize_config:
- type: object
- x-go-name: CustomizeConfig
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- execution_error:
- description: Silenced bool
- type: string
- x-go-name: ExecutionError
- execution_error_state:
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: |-
- If an alert rule has a configured `For` and the query violates the configured threshold
- it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
- notifications. Once the alert rule has been firing for more than `For` duration, it will
- change to `Alerting` and send alert notifications.
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: Frequency is evaluate period
- format: int64
- type: integer
- x-go-name: Frequency
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- last_state_change:
- format: date-time
- type: string
- x-go-name: LastStateChange
- level:
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- type: string
- x-go-name: NoDataState
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- panel_id:
- type: string
- x-go-name: PanelId
- panel_name:
- type: string
- x-go-name: PanelName
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- refresh:
- type: string
- x-go-name: Refresh
- res_type:
- type: string
- x-go-name: ResType
- scope:
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- state:
- type: string
- x-go-name: State
- state_changes:
- format: int64
- type: integer
- x-go-name: StateChanges
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertPanelSetOrderInput:
- properties:
- order:
- items:
- properties:
- index:
- format: int64
- type: integer
- x-go-name: Index
- panel_id:
- type: string
- x-go-name: PanelId
- type: object
- type: array
- x-go-name: Order
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertPauseInput:
- properties:
- paused:
- type: boolean
- x-go-name: Paused
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertQuery:
- properties:
- from:
- type: string
- x-go-name: From
- model:
- $ref: '#/definitions/MetricQuery'
- result_reducer:
- $ref: '#/definitions/Condition'
- result_reducer_order:
- $ref: '#/definitions/ResultReducerOrder'
- to:
- type: string
- x-go-name: To
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertRecordCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- alert_id:
- type: string
- x-go-name: AlertId
- alert_rule:
- items:
- $ref: '#/definitions/AlertRecordRule'
- type: array
- x-go-name: AlertRule
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- eval_data:
- items:
- $ref: '#/definitions/EvalMatch'
- type: array
- x-go-name: EvalData
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- res_type:
- type: string
- x-go-name: ResType
- send_state:
- type: string
- x-go-name: SendState
- state:
- type: string
- x-go-name: State
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertRecordDetails:
- properties:
- alert_id:
- type: string
- x-go-name: AlertId
- alert_name:
- type: string
- x-go-name: AlertName
- alert_rule:
- type: object
- x-go-name: AlertRule
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- level:
- type: string
- x-go-name: Level
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- res_ids:
- type: string
- x-go-name: ResIds
- res_num:
- format: int64
- type: integer
- x-go-name: ResNum
- res_type:
- type: string
- x-go-name: ResType
- scope:
- type: string
- x-go-name: Scope
- send_state:
- type: string
- x-go-name: SendState
- state:
- type: string
- x-go-name: State
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- trigger_time:
- format: date-time
- type: string
- x-go-name: TriggerTime
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertRecordHistoryAlert:
- properties:
- data:
- items:
- $ref: '#/definitions/AlertRecordHistoryAlertData'
- type: array
- x-go-name: Data
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertRecordHistoryAlertData:
- properties:
- domain:
- type: string
- x-go-name: Domain
- domain_id:
- type: string
- x-go-name: DomainId
- project:
- type: string
- x-go-name: Project
- project_id:
- type: string
- x-go-name: ProjectId
- res_num:
- format: int64
- type: integer
- x-go-name: ResNum
- res_type:
- type: string
- x-go-name: ResType
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertRecordRule:
- properties:
- alert_duration:
- format: int64
- type: integer
- x-go-name: AlertDuration
- comparator:
- description: '比较运算符, 比如: >, <, >=, <='
- type: string
- x-go-name: Comparator
- condition_type:
- type: string
- x-go-name: ConditionType
- database:
- type: string
- x-go-name: Database
- field:
- type: string
- x-go-name: Field
- field_desc:
- type: string
- x-go-name: FieldDesc
- measurement:
- type: string
- x-go-name: Measurement
- measurement_desc:
- type: string
- x-go-name: MeasurementDesc
- metric:
- type: string
- x-go-name: Metric
- period:
- type: string
- x-go-name: Period
- reducer:
- type: string
- x-go-name: Reducer
- res_type:
- type: string
- x-go-name: ResType
- silent_period:
- description: 静默期
- type: string
- x-go-name: SilentPeriod
- threshold:
- description: 报警阀值
- type: string
- x-go-name: Threshold
- threshold_range:
- items:
- format: double
- type: number
- type: array
- x-go-name: ThresholdRange
- unit:
- type: string
- x-go-name: Unit
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertRecordShieldCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- alert_id:
- type: string
- x-go-name: AlertId
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- end_time:
- type: string
- x-go-name: EndTime
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- res_id:
- type: string
- x-go-name: ResId
- res_name:
- type: string
- x-go-name: ResName
- res_type:
- type: string
- x-go-name: ResType
- start_time:
- type: string
- x-go-name: StartTime
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertRecordShieldDetails:
- properties:
- alert_duration:
- description: 报警连续持续周期数
- format: int64
- type: integer
- x-go-name: AlertDuration
- alert_name:
- type: string
- x-go-name: AlertName
- alert_type:
- description: 报警类型
- type: string
- x-go-name: AlertType
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- channel:
- items:
- type: string
- type: array
- x-go-name: Channel
- common_alert_metric_details:
- items:
- $ref: '#/definitions/CommonAlertMetricDetails'
- type: array
- x-go-name: CommonAlertMetricDetails
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- customize_config:
- type: object
- x-go-name: CustomizeConfig
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- disable_notify_recovery:
- type: boolean
- x-go-name: DisableNotifyRecovery
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- execution_error:
- description: Silenced bool
- type: string
- x-go-name: ExecutionError
- execution_error_state:
- type: string
- x-go-name: ExecutionErrorState
- expired:
- type: boolean
- x-go-name: Expired
- for:
- description: |-
- If an alert rule has a configured `For` and the query violates the configured threshold
- it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
- notifications. Once the alert rule has been firing for more than `For` duration, it will
- change to `Alerting` and send alert notifications.
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: Frequency is evaluate period
- format: int64
- type: integer
- x-go-name: Frequency
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- last_state_change:
- format: date-time
- type: string
- x-go-name: LastStateChange
- level:
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- type: string
- x-go-name: NoDataState
- notifier_id:
- type: string
- x-go-name: NotifierId
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- period:
- type: string
- x-go-name: Period
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- recipients:
- items:
- type: string
- type: array
- x-go-name: Recipients
- res_name:
- type: string
- x-go-name: ResName
- res_type:
- type: string
- x-go-name: ResType
- robot_ids:
- items:
- type: string
- type: array
- x-go-name: RobotIds
- role_ids:
- items:
- type: string
- type: array
- x-go-name: RoleIds
- scope:
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- silent_period:
- description: 静默期
- type: string
- x-go-name: SilentPeriod
- state:
- type: string
- x-go-name: State
- state_changes:
- format: int64
- type: integer
- x-go-name: StateChanges
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertResourceDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- count:
- format: int64
- type: integer
- x-go-name: Count
- delete_fail_reason:
- $ref: '#/definitions/Error'
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- tags:
- additionalProperties:
- type: string
- type: object
- x-go-name: Tags
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertSetting:
- description: AlertSettings contains alert conditions
- properties:
- conditions:
- items:
- $ref: '#/definitions/AlertCondition'
- type: array
- x-go-name: Conditions
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertTestRunInput:
- properties:
- is_debug:
- type: boolean
- x-go-name: IsDebug
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertTestRunOutput:
- properties:
- alert_ok_eval_matches:
- items:
- $ref: '#/definitions/EvalMatch'
- type: array
- x-go-name: AlertOKEvalMatches
- condition_evals:
- type: string
- x-go-name: ConditionEvals
- end_time:
- format: date-time
- type: string
- x-go-name: EndTime
- error:
- type: string
- x-go-name: Error
- x-go-type: error
- eval_matches:
- items:
- $ref: '#/definitions/EvalMatch'
- type: array
- x-go-name: EvalMatches
- firing:
- type: boolean
- x-go-name: Firing
- is_debug:
- type: boolean
- x-go-name: IsDebug
- is_test_run:
- type: boolean
- x-go-name: IsTestRun
- logs:
- items:
- $ref: '#/definitions/ResultLogEntry'
- type: array
- x-go-name: Logs
- no_data_found:
- type: boolean
- x-go-name: NoDataFound
- prev_alert_state:
- type: string
- x-go-name: PrevAlertState
- start_time:
- format: date-time
- type: string
- x-go-name: StartTime
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- AlertUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- enabled:
- description: 启用报警
- type: boolean
- x-go-name: Enabled
- execution_error_state:
- description: 报警执行错误将当前报警状态设置为对应的状态
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: 报警持续时间
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: 报警执行频率
- format: int64
- type: integer
- x-go-name: Frequency
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- description: 没有收到监控指标时将当前报警状态设置为对应的状态
- type: string
- x-go-name: NoDataState
- reason:
- description: 报警原因
- type: string
- x-go-name: Reason
- settings:
- $ref: '#/definitions/AlertSetting'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- CommonAlertCreateInput:
- properties:
- alert_duration:
- description: 报警连续持续周期数
- format: int64
- type: integer
- x-go-name: AlertDuration
- alert_type:
- description: 报警类型
- type: string
- x-go-name: AlertType
- channel:
- description: '通知方式, 比如: email, mobile'
- items:
- type: string
- type: array
- x-go-name: Channel
- customize_config:
- description: customize info
- type: object
- x-go-name: CustomizeConfig
- description:
- type: string
- x-go-name: Description
- disable_notify_recovery:
- description: 为 true 时不发送恢复通知(OK)
- type: boolean
- x-go-name: DisableNotifyRecovery
- domain_id:
- type: string
- x-go-name: DomainId
- enabled:
- description: 启用报警
- type: boolean
- x-go-name: Enabled
- execution_error_state:
- description: 报警执行错误将当前报警状态设置为对应的状态
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: 报警持续时间
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: 报警执行频率
- format: int64
- type: integer
- x-go-name: Frequency
- from:
- type: string
- x-go-name: From
- get_point_str:
- type: boolean
- x-go-name: GetPointStr
- interval:
- type: string
- x-go-name: Interval
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- meta_name:
- type: string
- x-go-name: MetaName
- metric_query:
- items:
- $ref: '#/definitions/CommonAlertQuery'
- type: array
- x-go-name: MetricQuery
- name:
- description: 报警名称
- type: string
- x-go-name: Name
- no_data_state:
- description: 没有收到监控指标时将当前报警状态设置为对应的状态
- type: string
- x-go-name: NoDataState
- period:
- description: 查询指标周期
- type: string
- x-go-name: Period
- project_id:
- type: string
- x-go-name: ProjectId
- reason:
- type: string
- x-go-name: Reason
- recipients:
- description: 通知接受者
- items:
- type: string
- type: array
- x-go-name: Recipients
- robot_ids:
- items:
- type: string
- type: array
- x-go-name: RobotIds
- roles:
- description: 角色 id 或者 name
- items:
- type: string
- type: array
- x-go-name: Roles
- scope:
- description: Scope Resource
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- silent_period:
- description: 静默期
- type: string
- x-go-name: SilentPeriod
- to:
- type: string
- x-go-name: To
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- CommonAlertDetails:
- properties:
- alert_duration:
- description: 报警连续持续周期数
- format: int64
- type: integer
- x-go-name: AlertDuration
- alert_type:
- description: 报警类型
- type: string
- x-go-name: AlertType
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- channel:
- items:
- type: string
- type: array
- x-go-name: Channel
- common_alert_metric_details:
- items:
- $ref: '#/definitions/CommonAlertMetricDetails'
- type: array
- x-go-name: CommonAlertMetricDetails
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- customize_config:
- type: object
- x-go-name: CustomizeConfig
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- disable_notify_recovery:
- type: boolean
- x-go-name: DisableNotifyRecovery
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- execution_error:
- description: Silenced bool
- type: string
- x-go-name: ExecutionError
- execution_error_state:
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: |-
- If an alert rule has a configured `For` and the query violates the configured threshold
- it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
- notifications. Once the alert rule has been firing for more than `For` duration, it will
- change to `Alerting` and send alert notifications.
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: Frequency is evaluate period
- format: int64
- type: integer
- x-go-name: Frequency
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- last_state_change:
- format: date-time
- type: string
- x-go-name: LastStateChange
- level:
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- type: string
- x-go-name: NoDataState
- notifier_id:
- type: string
- x-go-name: NotifierId
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- period:
- type: string
- x-go-name: Period
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- recipients:
- items:
- type: string
- type: array
- x-go-name: Recipients
- res_type:
- type: string
- x-go-name: ResType
- robot_ids:
- items:
- type: string
- type: array
- x-go-name: RobotIds
- role_ids:
- items:
- type: string
- type: array
- x-go-name: RoleIds
- scope:
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- silent_period:
- description: 静默期
- type: string
- x-go-name: SilentPeriod
- state:
- type: string
- x-go-name: State
- state_changes:
- format: int64
- type: integer
- x-go-name: StateChanges
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- CommonAlertFieldOpt:
- type: string
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- CommonAlertMetricDetails:
- properties:
- FieldDescription:
- $ref: '#/definitions/MetricFieldDetail'
- comparator:
- type: string
- x-go-name: Comparator
- condition_type:
- type: string
- x-go-name: ConditionType
- db:
- type: string
- x-go-name: DB
- field:
- type: string
- x-go-name: Field
- field_opt:
- type: string
- x-go-name: FieldOpt
- filters:
- items:
- $ref: '#/definitions/MetricQueryTag'
- type: array
- x-go-name: Filters
- get_point_str:
- type: boolean
- x-go-name: GetPointStr
- groupby:
- type: string
- x-go-name: Groupby
- measurement:
- type: string
- x-go-name: Measurement
- measurement_display_name:
- type: string
- x-go-name: MeasurementDisplayName
- operator:
- type: string
- x-go-name: Operator
- reduce:
- description: metric points'value的运算方式
- type: string
- x-go-name: Reduce
- res_type:
- type: string
- x-go-name: ResType
- threshold:
- format: double
- type: number
- x-go-name: Threshold
- threshold_range:
- items:
- format: double
- type: number
- type: array
- x-go-name: ThresholdRange
- threshold_str:
- type: string
- x-go-name: ThresholdStr
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- CommonAlertQuery:
- properties:
- comparator:
- description: '比较运算符, 比如: >, <, >=, <=, within_range, outside_range'
- type: string
- x-go-name: Comparator
- condition_type:
- type: string
- x-go-name: ConditionType
- field_opt:
- $ref: '#/definitions/CommonAlertFieldOpt'
- from:
- type: string
- x-go-name: From
- model:
- $ref: '#/definitions/MetricQuery'
- operator:
- description: Operator should be chosen from 'and | or'
- type: string
- x-go-name: Operator
- reduce:
- description: metric points'value的运算方式
- type: string
- x-go-name: Reduce
- result_reducer:
- $ref: '#/definitions/Condition'
- result_reducer_order:
- $ref: '#/definitions/ResultReducerOrder'
- threshold:
- description: 报警阀值 (用于 gt, lt, eq)
- format: double
- type: number
- x-go-name: Threshold
- threshold_range:
- description: 范围参数 (用于 within_range, outside_range)
- items:
- format: double
- type: number
- type: array
- x-go-name: ThresholdRange
- to:
- type: string
- x-go-name: To
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- Condition:
- properties:
- operators:
- items:
- type: string
- type: array
- x-go-name: Operators
- params:
- items:
- format: double
- type: number
- type: array
- x-go-name: Params
- type:
- type: string
- x-go-name: Type
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- Duration:
- description: |-
- A Duration represents the elapsed time between two instants
- as an int64 nanosecond count. The representation limits the
- largest representable duration to approximately 290 years.
- format: int64
- type: integer
- x-go-package: time
- Error:
- properties:
- class:
- type: string
- x-go-name: Class
- code:
- format: int64
- type: integer
- x-go-name: Code
- details:
- type: string
- x-go-name: Details
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/httperrors
- EvalMatch:
- properties:
- alert_details:
- type: object
- x-go-name: AlertDetails
- condition:
- type: string
- x-go-name: Condition
- is_recovery:
- type: boolean
- x-go-name: IsRecovery
- metric:
- type: string
- x-go-name: Metric
- tags:
- additionalProperties:
- type: string
- type: object
- x-go-name: Tags
- unit:
- type: string
- x-go-name: Unit
- value:
- format: double
- type: number
- x-go-name: Value
- value_str:
- type: string
- x-go-name: ValueStr
- title: EvalMatch represents the series violating the threshold.
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- GetDetailsStatusOutput:
- properties:
- status:
- description: 状态
- type: string
- x-go-name: Status
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- JoinResourceBaseCreateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- JointResourceBaseDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- JointResourceBaseUpdateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- MetricCreateInput:
- properties:
- measurement:
- $ref: '#/definitions/MetricMeasurementCreateInput'
- metric_fields:
- items:
- $ref: '#/definitions/MetricFieldCreateInput'
- type: array
- x-go-name: MetricFields
- scope:
- type: string
- x-go-name: Scope
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- metric_fields:
- items:
- $ref: '#/definitions/MetricFieldDetail'
- type: array
- x-go-name: MetricFields
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- scope:
- type: string
- x-go-name: Scope
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricFieldCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- display_name:
- type: string
- x-go-name: DisplayName
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- score:
- format: int64
- type: integer
- x-go-name: Score
- unit:
- type: string
- x-go-name: Unit
- value_type:
- type: string
- x-go-name: ValueType
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricFieldDetail:
- properties:
- display_name:
- type: string
- x-go-name: DisplayName
- id:
- type: string
- x-go-name: Id
- name:
- type: string
- x-go-name: Name
- unit:
- type: string
- x-go-name: Unit
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricFieldListInput:
- properties:
- belong_scope:
- description: 指定匹配的范围,可能值为project, domain or system
- type: string
- x-go-name: BelongScope
- details:
- description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- type: boolean
- x-go-name: Details
- display_name:
- type: string
- x-go-name: DisplayName
- domain_tags:
- $ref: '#/definitions/TTagSetList'
- enabled:
- description: 以资源是否启用/禁用过滤列表
- type: boolean
- x-go-name: Enabled
- export_keys:
- description: 用于数据导出,指定导出的数据字段
- type: string
- x-go-name: ExportKeys
- field:
- description: 返回结果只包含指定的字段
- items:
- type: string
- type: array
- x-go-name: Field
- filter:
- description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- items:
- type: string
- type: array
- x-go-name: Filter
- filter_any:
- description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- type: boolean
- x-go-name: FilterAny
- id:
- description: 以资源ID过滤列表
- items:
- type: string
- type: array
- x-go-name: Ids
- joint_filter:
- description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- items:
- type: string
- type: array
- x-go-name: JointFilter
- limit:
- default: 20
- description: 查询限制量
- format: int64
- type: integer
- x-go-name: Limit
- name:
- description: 以资源名称过滤列表
- items:
- type: string
- type: array
- x-go-name: Names
- no_domain_tags:
- $ref: '#/definitions/TTagSetList'
- no_obj_tags:
- $ref: '#/definitions/TTagSetList'
- no_project_tags:
- $ref: '#/definitions/TTagSetList'
- no_tags:
- $ref: '#/definitions/TTagSet'
- obj_tags:
- $ref: '#/definitions/TTagSetList'
- offset:
- default: 0
- description: 查询偏移量
- format: int64
- type: integer
- x-go-name: Offset
- order:
- description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- type: string
- x-go-name: Order
- order_by:
- description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- items:
- type: string
- type: array
- x-go-name: OrderBy
- order_by_domain:
- description: 按domain名称排序,可能值为asc|desc
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- order_by_project:
- description: 按project名称排序,可能值为asc|desc
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- order_by_tag:
- description: 通过标签排序
- type: string
- x-go-name: OrderByTag
- policy_project_tags:
- $ref: '#/definitions/TTagSetList'
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_domain_ids:
- description: 对具有域属性的资源,严格匹配域ID
- items:
- type: string
- type: array
- x-go-name: ProjectDomainIds
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- project_ids:
- description: 对具有项目属性的资源,严格匹配项目ID
- items:
- type: string
- type: array
- x-go-name: ProjectIds
- project_organizations:
- description: filter by project organizations
- items:
- type: string
- type: array
- x-go-name: ProjectOrganizations
- project_tags:
- $ref: '#/definitions/TTagSetList'
- scope:
- description: 指定查询的权限范围,可能值为project, domain or system
- type: string
- x-go-name: Scope
- search:
- description: 模糊搜索所有字段
- type: string
- x-go-name: Search
- show_emulated:
- description: 显示所有的资源,包括模拟的资源
- type: boolean
- x-go-name: ShowEmulated
- show_fail_reason:
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
- type: boolean
- x-go-name: ShowFailReason
- status:
- description: 以资源的状态过滤列表
- items:
- type: string
- type: array
- x-go-name: Status
- summary_stats:
- description: 是否返回状态统计信息,默认为False
- type: boolean
- x-go-name: SummaryStats
- tags:
- $ref: '#/definitions/TTagSet'
- unit:
- type: string
- x-go-name: Unit
- with_any_meta:
- description: 返回包含任意标签的资源
- type: boolean
- x-go-name: WithAnyMeta
- with_cloud_meta:
- description: 返回包含外部标签的资源
- type: boolean
- x-go-name: WithCloudMeta
- with_meta:
- description: 返回列表数据中包含资源的标签数据(Metadata)
- type: boolean
- x-go-name: WithMeta
- with_user_meta:
- description: 返回包含用户标签的资源
- type: boolean
- x-go-name: WithUserMeta
- without_user_meta:
- description: |-
- deprecated
- 返回资源的标签不包含用户标签
- type: boolean
- x-go-name: WithoutUserMeta
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricFieldUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- display_name:
- type: string
- x-go-name: DisplayName
- id:
- type: string
- x-go-name: Id
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- score:
- format: int64
- type: integer
- x-go-name: Score
- unit:
- type: string
- x-go-name: Unit
- value_type:
- type: string
- x-go-name: ValueType
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricMeasurementCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- database:
- type: string
- x-go-name: Database
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- disabled:
- description: 该资源是否被管理员*人为*禁用, 和enabled互斥
- type: boolean
- x-go-name: Disabled
- display_name:
- type: string
- x-go-name: DisplayName
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- enabled:
- description: 该资源是否被管理员*人为*启用或者禁用
- type: boolean
- x-go-name: Enabled
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- res_type:
- type: string
- x-go-name: ResType
- score:
- format: int64
- type: integer
- x-go-name: Score
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricMeasurementListInput:
- properties:
- belong_scope:
- description: 指定匹配的范围,可能值为project, domain or system
- type: string
- x-go-name: BelongScope
- details:
- description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- type: boolean
- x-go-name: Details
- display_name:
- type: string
- x-go-name: DisplayName
- domain_tags:
- $ref: '#/definitions/TTagSetList'
- enabled:
- description: 以资源是否启用/禁用过滤列表
- type: boolean
- x-go-name: Enabled
- export_keys:
- description: 用于数据导出,指定导出的数据字段
- type: string
- x-go-name: ExportKeys
- field:
- description: 返回结果只包含指定的字段
- items:
- type: string
- type: array
- x-go-name: Field
- filter:
- description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- items:
- type: string
- type: array
- x-go-name: Filter
- filter_any:
- description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- type: boolean
- x-go-name: FilterAny
- id:
- description: 以资源ID过滤列表
- items:
- type: string
- type: array
- x-go-name: Ids
- joint_filter:
- description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- items:
- type: string
- type: array
- x-go-name: JointFilter
- limit:
- default: 20
- description: 查询限制量
- format: int64
- type: integer
- x-go-name: Limit
- name:
- description: 以资源名称过滤列表
- items:
- type: string
- type: array
- x-go-name: Names
- no_domain_tags:
- $ref: '#/definitions/TTagSetList'
- no_obj_tags:
- $ref: '#/definitions/TTagSetList'
- no_project_tags:
- $ref: '#/definitions/TTagSetList'
- no_tags:
- $ref: '#/definitions/TTagSet'
- obj_tags:
- $ref: '#/definitions/TTagSetList'
- offset:
- default: 0
- description: 查询偏移量
- format: int64
- type: integer
- x-go-name: Offset
- order:
- description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- type: string
- x-go-name: Order
- order_by:
- description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- items:
- type: string
- type: array
- x-go-name: OrderBy
- order_by_domain:
- description: 按domain名称排序,可能值为asc|desc
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- order_by_project:
- description: 按project名称排序,可能值为asc|desc
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- order_by_tag:
- description: 通过标签排序
- type: string
- x-go-name: OrderByTag
- policy_project_tags:
- $ref: '#/definitions/TTagSetList'
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_domain_ids:
- description: 对具有域属性的资源,严格匹配域ID
- items:
- type: string
- type: array
- x-go-name: ProjectDomainIds
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- project_ids:
- description: 对具有项目属性的资源,严格匹配项目ID
- items:
- type: string
- type: array
- x-go-name: ProjectIds
- project_organizations:
- description: filter by project organizations
- items:
- type: string
- type: array
- x-go-name: ProjectOrganizations
- project_tags:
- $ref: '#/definitions/TTagSetList'
- res_type:
- type: string
- x-go-name: ResType
- scope:
- description: 指定查询的权限范围,可能值为project, domain or system
- type: string
- x-go-name: Scope
- search:
- description: 模糊搜索所有字段
- type: string
- x-go-name: Search
- show_emulated:
- description: 显示所有的资源,包括模拟的资源
- type: boolean
- x-go-name: ShowEmulated
- show_fail_reason:
- description: 返回结果携带delete_fail_reason和update_fail_reason字段
- type: boolean
- x-go-name: ShowFailReason
- status:
- description: 以资源的状态过滤列表
- items:
- type: string
- type: array
- x-go-name: Status
- summary_stats:
- description: 是否返回状态统计信息,默认为False
- type: boolean
- x-go-name: SummaryStats
- tags:
- $ref: '#/definitions/TTagSet'
- with_any_meta:
- description: 返回包含任意标签的资源
- type: boolean
- x-go-name: WithAnyMeta
- with_cloud_meta:
- description: 返回包含外部标签的资源
- type: boolean
- x-go-name: WithCloudMeta
- with_meta:
- description: 返回列表数据中包含资源的标签数据(Metadata)
- type: boolean
- x-go-name: WithMeta
- with_user_meta:
- description: 返回包含用户标签的资源
- type: boolean
- x-go-name: WithUserMeta
- without_user_meta:
- description: |-
- deprecated
- 返回资源的标签不包含用户标签
- type: boolean
- x-go-name: WithoutUserMeta
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricMeasurementUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- display_name:
- type: string
- x-go-name: DisplayName
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- res_type:
- type: string
- x-go-name: ResType
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricQuery:
- properties:
- alias:
- type: string
- x-go-name: Alias
- database:
- type: string
- x-go-name: Database
- group_by:
- items:
- $ref: '#/definitions/MetricQueryPart'
- type: array
- x-go-name: GroupBy
- interval:
- type: string
- x-go-name: Interval
- measurement:
- type: string
- x-go-name: Measurement
- policy:
- type: string
- x-go-name: Policy
- result_format:
- type: string
- x-go-name: ResultFormat
- select:
- items:
- $ref: '#/definitions/MetricQuerySelect'
- type: array
- x-go-name: Selects
- tags:
- items:
- $ref: '#/definitions/MetricQueryTag'
- type: array
- x-go-name: Tags
- tz:
- type: string
- x-go-name: Tz
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricQueryInput:
- properties:
- domain_id:
- type: string
- x-go-name: DomainId
- from:
- type: string
- x-go-name: From
- interval:
- type: string
- x-go-name: Interval
- metric_query:
- items:
- $ref: '#/definitions/AlertQuery'
- type: array
- x-go-name: MetricQuery
- project_id:
- type: string
- x-go-name: ProjectId
- scope:
- type: string
- x-go-name: Scope
- show_meta:
- type: boolean
- x-go-name: ShowMeta
- signature:
- type: string
- x-go-name: Signature
- skip_check_series:
- type: boolean
- x-go-name: SkipCheckSeries
- slimit:
- type: string
- x-go-name: Slimit
- soffset:
- type: string
- x-go-name: Soffset
- to:
- type: string
- x-go-name: To
- unit:
- type: boolean
- x-go-name: Unit
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricQueryPart:
- properties:
- params:
- items:
- type: string
- type: array
- x-go-name: Params
- type:
- type: string
- x-go-name: Type
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricQuerySelect:
- items:
- $ref: '#/definitions/MetricQueryPart'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricQueryTag:
- properties:
- condition:
- type: string
- x-go-name: Condition
- key:
- type: string
- x-go-name: Key
- operator:
- type: string
- x-go-name: Operator
- value:
- type: string
- x-go-name: Value
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricUpdateInput:
- properties:
- measurement:
- $ref: '#/definitions/MetricMeasurementUpdateInput'
- metric_fields:
- items:
- $ref: '#/definitions/MetricFieldUpdateInput'
- type: array
- x-go-name: MetricFields
- scope:
- type: string
- x-go-name: Scope
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MetricsQueryResult:
- properties:
- metas:
- items:
- $ref: '#/definitions/QueryResultMeta'
- type: array
- x-go-name: Metas
- reduced_result:
- $ref: '#/definitions/ReducedResult'
- series:
- $ref: '#/definitions/TimeSeriesSlice'
- series_total:
- format: int64
- type: integer
- x-go-name: SeriesTotal
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MigrationAlertCreateInput:
- properties:
- customize_config:
- description: customize info
- type: object
- x-go-name: CustomizeConfig
- enabled:
- description: 启用报警
- type: boolean
- x-go-name: Enabled
- execution_error_state:
- description: 报警执行错误将当前报警状态设置为对应的状态
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: 报警持续时间
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: 报警执行频率
- format: int64
- type: integer
- x-go-name: Frequency
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- metric_type:
- $ref: '#/definitions/MigrationAlertMetricType'
- migration_settings:
- $ref: '#/definitions/MigrationAlertSettings'
- name:
- description: 报警名称
- type: string
- x-go-name: Name
- no_data_state:
- description: 没有收到监控指标时将当前报警状态设置为对应的状态
- type: string
- x-go-name: NoDataState
- period:
- description: Period of querying metrics
- type: string
- x-go-name: Period
- reason:
- type: string
- x-go-name: Reason
- settings:
- $ref: '#/definitions/AlertSetting'
- threshold:
- description: Threshold is the value to trigger migration
- format: double
- type: number
- x-go-name: Threshold
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MigrationAlertMetricType:
- type: string
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MigrationAlertSettings:
- properties:
- source:
- $ref: '#/definitions/MigrationAlertSettingsSource'
- target:
- $ref: '#/definitions/MigrationAlertSettingsTarget'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MigrationAlertSettingsSource:
- properties:
- guest_ids:
- items:
- type: string
- type: array
- x-go-name: GuestIds
- host_ids:
- items:
- type: string
- type: array
- x-go-name: HostIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MigrationAlertSettingsTarget:
- properties:
- host_ids:
- items:
- type: string
- type: array
- x-go-name: HostIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MonitorResourceCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- alert_status:
- type: string
- x-go-name: AlertStatus
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- disabled:
- description: 该资源是否被管理员*人为*禁用, 和enabled互斥
- type: boolean
- x-go-name: Disabled
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- enabled:
- description: 该资源是否被管理员*人为*启用或者禁用
- type: boolean
- x-go-name: Enabled
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- is_system:
- description: 'description: indicate the resource is a system resource, which is not visible to user'
- type: boolean
- x-go-name: IsSystem
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- res_id:
- type: string
- x-go-name: ResId
- res_type:
- type: string
- x-go-name: ResType
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MonitorResourceDetails:
- properties:
- access_ip:
- type: string
- x-go-name: AccessIp
- account:
- description: 云账号名称
- example: google-account
- type: string
- x-go-name: Account
- account_health_status:
- description: 云账号监控状态
- type: string
- x-go-name: AccountHealthStatus
- account_read_only:
- type: boolean
- x-go-name: AccountReadOnly
- account_status:
- description: 云账号状态
- type: string
- x-go-name: AccountStatus
- attach_alert_count:
- format: int64
- type: integer
- x-go-name: AttachAlertCount
- brand:
- description: 云平台品牌
- example: Google
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloud_env:
- description: 云环境
- example: public
- type: string
- x-go-name: CloudEnv
- cloudregion:
- description: 区域的名称
- type: string
- x-go-name: Cloudregion
- delete_fail_reason:
- $ref: '#/definitions/Error'
- environment:
- description: Environment
- type: string
- x-go-name: Environment
- hypervisor:
- type: string
- x-go-name: Hypervisor
- ips:
- type: string
- x-go-name: Ips
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- provider:
- description: 云平台名称
- example: Google
- type: string
- x-go-name: Provider
- region:
- description: 区域的名称
- example: Default
- type: string
- x-go-name: Region
- region_ext_id:
- description: 纳管云区域的Id
- example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4
- type: string
- x-go-name: RegionExtId
- region_external_id:
- description: 纳管云区域的组合Id(平台+Id)
- example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4
- type: string
- x-go-name: RegionExternalId
- region_id:
- description: 区域的Id
- example: default
- type: string
- x-go-name: RegionId
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MonitorResourceDoActionInput:
- properties:
- action:
- type: string
- x-go-name: Action
- data:
- type: object
- x-go-name: Data
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- MonitorResourceJointDetails:
- properties:
- alert_count:
- format: int64
- type: integer
- x-go-name: AlertCount
- alert_name:
- type: string
- x-go-name: AlertName
- alert_rule:
- type: object
- x-go-name: AlertRule
- is_set_shield:
- type: boolean
- x-go-name: IsSetShield
- level:
- type: string
- x-go-name: Level
- monitor_resource_object_id:
- type: string
- x-go-name: MonitorResourceObjectId
- res_id:
- type: string
- x-go-name: ResId
- res_name:
- type: string
- x-go-name: ResName
- res_type:
- type: string
- x-go-name: ResType
- send_state:
- type: string
- x-go-name: SendState
- state:
- type: string
- x-go-name: State
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- NodeAlertCreateInput:
- properties:
- channel:
- description: '通知方式, 比如: email, mobile'
- type: string
- x-go-name: Channel
- common_alert_create_input:
- $ref: '#/definitions/CommonAlertCreateInput'
- comparator:
- description: '比较运算符, 比如: >, <, >=, <='
- type: string
- x-go-name: Comparator
- customize_config:
- description: customize info
- type: object
- x-go-name: CustomizeConfig
- enabled:
- description: 启用报警
- type: boolean
- x-go-name: Enabled
- execution_error_state:
- description: 报警执行错误将当前报警状态设置为对应的状态
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: 报警持续时间
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: 报警执行频率
- format: int64
- type: integer
- x-go-name: Frequency
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- metric:
- description: 监控指标名称
- type: string
- x-go-name: Metric
- name:
- description: 报警名称
- type: string
- x-go-name: Name
- no_data_state:
- description: 没有收到监控指标时将当前报警状态设置为对应的状态
- type: string
- x-go-name: NoDataState
- node_id:
- description: 监控资源 Id
- type: string
- x-go-name: NodeId
- node_name:
- description: 监控资源名称
- type: string
- x-go-name: NodeName
- period:
- description: 查询指标周期
- type: string
- x-go-name: Period
- reason:
- type: string
- x-go-name: Reason
- recipients:
- description: 通知接受者
- type: string
- x-go-name: Recipients
- settings:
- $ref: '#/definitions/AlertSetting'
- threshold:
- description: 报警阀值
- format: double
- type: number
- x-go-name: Threshold
- type:
- description: '监控资源类型, 比如: guest, host'
- type: string
- x-go-name: Type
- used_by:
- type: string
- x-go-name: UsedBy
- window:
- description: 每隔多久查询一次
- type: string
- x-go-name: Window
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- NodeAlertDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- channel:
- type: string
- x-go-name: Channel
- comparator:
- type: string
- x-go-name: Comparator
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- customize_config:
- type: object
- x-go-name: CustomizeConfig
- db:
- type: string
- x-go-name: DB
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- execution_error:
- description: Silenced bool
- type: string
- x-go-name: ExecutionError
- execution_error_state:
- type: string
- x-go-name: ExecutionErrorState
- field:
- type: string
- x-go-name: Field
- for:
- description: |-
- If an alert rule has a configured `For` and the query violates the configured threshold
- it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
- notifications. Once the alert rule has been firing for more than `For` duration, it will
- change to `Alerting` and send alert notifications.
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: Frequency is evaluate period
- format: int64
- type: integer
- x-go-name: Frequency
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- last_state_change:
- format: date-time
- type: string
- x-go-name: LastStateChange
- level:
- type: string
- x-go-name: Level
- measurement:
- type: string
- x-go-name: Measurement
- message:
- type: string
- x-go-name: Message
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- metric:
- type: string
- x-go-name: Metric
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- type: string
- x-go-name: NoDataState
- node_id:
- type: string
- x-go-name: NodeId
- node_name:
- type: string
- x-go-name: NodeName
- notifier_id:
- type: string
- x-go-name: NotifierId
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- period:
- type: string
- x-go-name: Period
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- recipients:
- type: string
- x-go-name: Recipients
- res_type:
- type: string
- x-go-name: ResType
- scope:
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- state:
- type: string
- x-go-name: State
- state_changes:
- format: int64
- type: integer
- x-go-name: StateChanges
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- threshold:
- format: double
- type: number
- x-go-name: Threshold
- type:
- type: string
- x-go-name: Type
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- used_by:
- type: string
- x-go-name: UsedBy
- window:
- type: string
- x-go-name: Window
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- NodeAlertUpdateInput:
- properties:
- channel:
- description: '通知方式, 比如: email, mobile'
- type: string
- x-go-name: Channel
- comparator:
- description: '比较运算符, 比如: >, <, >=, <='
- type: string
- x-go-name: Comparator
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- enabled:
- description: 启用报警
- type: boolean
- x-go-name: Enabled
- execution_error_state:
- description: 报警执行错误将当前报警状态设置为对应的状态
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: 报警持续时间
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: 报警执行频率
- format: int64
- type: integer
- x-go-name: Frequency
- level:
- description: 报警级别
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- metric:
- description: 监控指标名称
- type: string
- x-go-name: Metric
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- description: 没有收到监控指标时将当前报警状态设置为对应的状态
- type: string
- x-go-name: NoDataState
- node_id:
- description: 监控资源 Id
- type: string
- x-go-name: NodeId
- node_name:
- description: 监控资源名称
- type: string
- x-go-name: NodeName
- period:
- description: 查询指标周期
- type: string
- x-go-name: Period
- reason:
- description: 报警原因
- type: string
- x-go-name: Reason
- recipients:
- description: 通知接受者
- type: string
- x-go-name: Recipients
- settings:
- $ref: '#/definitions/AlertSetting'
- threshold:
- description: 报警阀值
- format: double
- type: number
- x-go-name: Threshold
- type:
- description: '监控资源类型, 比如: guest, host'
- type: string
- x-go-name: Type
- window:
- description: 每隔多久查询一次
- type: string
- x-go-name: Window
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- NotificationCreateInput:
- properties:
- disable_resolve_message:
- description: 是否禁用报警恢复提醒
- type: boolean
- x-go-name: DisableResolveMessage
- frequency:
- $ref: '#/definitions/Duration'
- is_default:
- description: 是否为默认通知配置
- type: boolean
- x-go-name: IsDefault
- name:
- description: 报警通知名称
- type: string
- x-go-name: Name
- send_reminder:
- description: 是否一直提醒
- type: boolean
- x-go-name: SendReminder
- settings:
- description: 通知配置
- type: object
- x-go-name: Settings
- type:
- description: 类型
- type: string
- x-go-name: Type
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- PanelDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- common_alert_metric_details:
- items:
- $ref: '#/definitions/CommonAlertMetricDetails'
- type: array
- x-go-name: CommonAlertMetricDetails
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- customize_config:
- type: object
- x-go-name: CustomizeConfig
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- eval_data:
- type: object
- x-go-name: EvalData
- execution_error:
- description: Silenced bool
- type: string
- x-go-name: ExecutionError
- execution_error_state:
- type: string
- x-go-name: ExecutionErrorState
- for:
- description: |-
- If an alert rule has a configured `For` and the query violates the configured threshold
- it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any
- notifications. Once the alert rule has been firing for more than `For` duration, it will
- change to `Alerting` and send alert notifications.
- format: int64
- type: integer
- x-go-name: For
- frequency:
- description: Frequency is evaluate period
- format: int64
- type: integer
- x-go-name: Frequency
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- last_state_change:
- format: date-time
- type: string
- x-go-name: LastStateChange
- level:
- type: string
- x-go-name: Level
- message:
- type: string
- x-go-name: Message
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- no_data_state:
- type: string
- x-go-name: NoDataState
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- res_type:
- type: string
- x-go-name: ResType
- scope:
- type: string
- x-go-name: Scope
- settings:
- $ref: '#/definitions/AlertSetting'
- state:
- type: string
- x-go-name: State
- state_changes:
- format: int64
- type: integer
- x-go-name: StateChanges
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- tenant_id:
- description: 项目Id
- type: string
- x-go-name: ProjectId
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- used_by:
- type: string
- x-go-name: UsedBy
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- PerformChangeProjectOwnerInput:
- properties:
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- project_id:
- description: 指定项目的名称或ID
- type: string
- x-go-name: ProjectId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformDisableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformEnableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- ProjectAlertResourceCount:
- description: ProjectAlertResourceCount 报警资源统计结果
- properties:
- data:
- items:
- $ref: '#/definitions/ProjectAlertResourceCountData'
- type: array
- x-go-name: Data
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- ProjectAlertResourceCountData:
- description: ProjectAlertResourceCountData 报警资源统计数据(按 scope 分类)
- properties:
- domain:
- type: string
- x-go-name: Domain
- domain_id:
- type: string
- x-go-name: DomainId
- project:
- type: string
- x-go-name: Project
- project_id:
- type: string
- x-go-name: ProjectId
- res_count:
- format: int64
- type: integer
- x-go-name: ResCount
- scope:
- type: string
- x-go-name: Scope
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- QueryResultMeta:
- properties:
- raw_query:
- type: string
- x-go-name: RawQuery
- result_reducer_value:
- format: double
- type: number
- x-go-name: ResultReducerValue
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- ReducedResult:
- properties:
- reducer:
- $ref: '#/definitions/Condition'
- result:
- items:
- format: double
- type: number
- type: array
- x-go-name: Result
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- ResultLogEntry:
- properties:
- data:
- x-go-name: Data
- message:
- type: string
- x-go-name: Message
- title: ResultLogEntry represents log data for the alert evaluation.
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- ResultReducerOrder:
- type: string
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- STag:
- properties:
- key:
- description: 标签Kye
- type: string
- x-go-name: Key
- value:
- description: 标签Value
- type: string
- x-go-name: Value
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- StandaloneAnonResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StandaloneResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StandaloneResourceCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StandaloneResourceDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StatusStandaloneResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- progress:
- format: float
- type: number
- x-go-name: Progress
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- TTagSet:
- items:
- $ref: '#/definitions/STag'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- TTagSetList:
- items:
- $ref: '#/definitions/TTagSet'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- TimePoint:
- items: {}
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- TimeSeries:
- properties:
- cloud_tags:
- additionalProperties:
- type: string
- type: object
- x-go-name: CloudTags
- columns:
- items:
- type: string
- type: array
- x-go-name: Columns
- name:
- type: string
- x-go-name: Name
- points:
- $ref: '#/definitions/TimeSeriesPoints'
- raw_name:
- description: RawName is used to frontend displaying the curve name
- type: string
- x-go-name: RawName
- tags:
- additionalProperties:
- type: string
- type: object
- x-go-name: Tags
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- TimeSeriesPoints:
- items:
- $ref: '#/definitions/TimePoint'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- TimeSeriesSlice:
- items:
- $ref: '#/definitions/TimeSeries'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/apis/monitor
- VirtualJointResourceBaseUpdateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- VirtualResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- progress:
- format: float
- type: number
- x-go-name: Progress
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- VirtualResourceDetails:
- properties:
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- delete_fail_reason:
- $ref: '#/definitions/Error'
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- project:
- description: |-
- 资源归属项目的名称(向后兼容别名)
- Deprecated
- type: string
- x-go-name: Tenant
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- project_id:
- description: |-
- 资源归属项目的ID(向后兼容别名)
- Deprecated
- type: string
- x-go-name: TenantId
- project_metadata:
- additionalProperties:
- type: string
- type: object
- x-go-name: ProjectMetadata
- tenant:
- description: |-
- 资源归属项目的名称
- alias:project
- type: string
- x-go-name: Project
- update_fail_reason:
- $ref: '#/definitions/Error'
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- host: '"127.0.0.1:8889"'
- info:
- contact:
- email: lizexi@yunion.cn
- name: Zexi Li
- description: Cloudprovider API
- license:
- name: Apache 2.0
- url: http://www.apache.org/licenses/LICENSE-2.0.html
- version: "1.0"
- paths:
- /alert_notifications:
- get:
- description: 列表
- operationId: alert_notification_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 列表中包含标记为"系统资源"的资源
- in: query
- name: system
- type: boolean
- x-go-name: System
- - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
- in: query
- name: pending_delete
- type: boolean
- x-go-name: PendingDelete
- - description: 类型
- in: query
- name: type
- type: string
- x-go-name: Type
- responses:
- "200":
- $ref: '#/responses/alert_notification_ListItemFilterOutput'
- summary: 列表
- tags:
- - alert_notification
- post:
- description: 新建
- operationId: alert_notification_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/NotificationCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_notification_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - alert_notification
- /alert_notifications/{id}:
- delete:
- description: 删除
- operationId: alert_notification_CustomizeDelete
- parameters:
- - description: The Id or Name of alert_notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_notification_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - alert_notification
- get:
- description: 获取详情
- operationId: alert_notification_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of alert_notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_notification_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - alert_notification
- put:
- description: 更新
- operationId: alert_notification_ValidateUpdateData
- parameters:
- - description: The Id or Name of alert_notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/VirtualResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_notification_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - alert_notification
- /alert_notifications/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: alert_notification_PerformChangeOwner
- parameters:
- - description: The Id or Name of alert_notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/PerformChangeProjectOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_notification_PerformChangeOwnerOutput'
- summary: 更改项目
- tags:
- - alert_notification
- /alert_notifications/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: alert_notification_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of alert_notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_notification_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - alert_notification
- /alert_notifications/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: alert_notification_GetDetailsStatus
- parameters:
- - description: The Id or Name of alert_notification
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_notification_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - alert_notification
- /alertdashboards:
- get:
- description: 列表
- operationId: alertdashboard_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: |-
- 以报警是否启用/禁用过滤列表
- Enabled *bool `json:"enabled"`
- in: query
- items:
- type: string
- name: monitor_resource_id
- type: array
- x-go-name: MonitorResourceId
- responses:
- "200":
- $ref: '#/responses/alertdashboard_ListItemFilterOutput'
- summary: 列表
- tags:
- - alertdashboard
- post:
- description: 新建
- operationId: alertdashboard_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertDashBoardCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertdashboard_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - alertdashboard
- /alertdashboards/{id}:
- delete:
- description: 删除
- operationId: alertdashboard_CustomizeDelete
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertdashboard_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - alertdashboard
- get:
- description: 获取详情
- operationId: alertdashboard_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertdashboard_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - alertdashboard
- put:
- description: 更新
- operationId: alertdashboard_ValidateUpdateData
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertdashboard_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - alertdashboard
- /alertdashboards/{id}/clone-dashboard:
- post:
- description: 执行操作CloneDashboard
- operationId: alertdashboard_PerformCloneDashboard
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertCloneDashboardInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertdashboard_PerformCloneDashboardOutput'
- summary: 执行操作CloneDashboard
- tags:
- - alertdashboard
- /alertdashboards/{id}/clone-panel:
- post:
- description: 执行操作ClonePanel
- operationId: alertdashboard_PerformClonePanel
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertClonePanelInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertdashboard_PerformClonePanelOutput'
- summary: 执行操作ClonePanel
- tags:
- - alertdashboard
- /alertdashboards/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: alertdashboard_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertdashboard_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - alertdashboard
- /alertdashboards/{id}/set-panel-order:
- post:
- description: 执行操作SetPanelOrder
- operationId: alertdashboard_PerformSetPanelOrder
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertPanelSetOrderInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertdashboard_PerformSetPanelOrderOutput'
- summary: 执行操作SetPanelOrder
- tags:
- - alertdashboard
- /alertdashboards/{id}/set-scope:
- post:
- description: 执行操作SetScope
- operationId: alertdashboard_PerformSetScope
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertdashboard_PerformSetScopeOutput'
- summary: 执行操作SetScope
- tags:
- - alertdashboard
- /alertdashboards/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: alertdashboard_GetDetailsStatus
- parameters:
- - description: The Id or Name of alertdashboard
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertdashboard_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - alertdashboard
- /alertpanels:
- get:
- description: 列表
- operationId: alertpanel_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: |-
- 以报警是否启用/禁用过滤列表
- Enabled *bool `json:"enabled"`
- in: query
- items:
- type: string
- name: monitor_resource_id
- type: array
- x-go-name: MonitorResourceId
- - in: query
- name: dashboard_id
- type: string
- x-go-name: DashboardId
- responses:
- "200":
- $ref: '#/responses/alertpanel_ListItemFilterOutput'
- summary: 列表
- tags:
- - alertpanel
- post:
- description: 新建
- operationId: alertpanel_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- alertpanel:
- $ref: '#/definitions/AlertPanelCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertpanel_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - alertpanel
- /alertpanels/{id}:
- delete:
- description: 删除
- operationId: alertpanel_CustomizeDelete
- parameters:
- - description: The Id or Name of alertpanel
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertpanel_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - alertpanel
- get:
- description: 获取详情
- operationId: alertpanel_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of alertpanel
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertpanel_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - alertpanel
- put:
- description: 更新
- operationId: alertpanel_ValidateUpdateData
- parameters:
- - description: The Id or Name of alertpanel
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertpanel_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - alertpanel
- /alertpanels/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: alertpanel_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of alertpanel
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertpanel_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - alertpanel
- /alertpanels/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: alertpanel_GetDetailsStatus
- parameters:
- - description: The Id or Name of alertpanel
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertpanel_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - alertpanel
- /alertrecords:
- get:
- description: 列表
- operationId: alertrecord_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - in: query
- name: alert_id
- type: string
- x-go-name: AlertId
- - in: query
- name: alert_name
- type: string
- x-go-name: AlertName
- - in: query
- name: level
- type: string
- x-go-name: Level
- - in: query
- name: state
- type: string
- x-go-name: State
- - in: query
- name: res_type
- type: string
- x-go-name: ResType
- - in: query
- name: alerting
- type: boolean
- x-go-name: Alerting
- - in: query
- name: res_name
- type: string
- x-go-name: ResName
- - in: query
- name: res_id
- type: string
- x-go-name: ResId
- responses:
- "200":
- $ref: '#/responses/alertrecord_ListItemFilterOutput'
- summary: 列表
- tags:
- - alertrecord
- post:
- description: 新建
- operationId: alertrecord_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/AlertRecordCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertrecord_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - alertrecord
- /alertrecords/{id}:
- delete:
- description: 删除
- operationId: alertrecord_CustomizeDelete
- parameters:
- - description: The Id or Name of alertrecord
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertrecord_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - alertrecord
- get:
- description: 获取详情
- operationId: alertrecord_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of alertrecord
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertrecord_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - alertrecord
- put:
- description: 更新
- operationId: alertrecord_ValidateUpdateData
- parameters:
- - description: The Id or Name of alertrecord
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertrecord_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - alertrecord
- /alertrecords/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: alertrecord_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of alertrecord
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertrecord_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - alertrecord
- /alertrecords/history-alert:
- get:
- description: 获取指定资源类的信息HistoryAlert
- operationId: alertrecord_GetPropertyHistoryAlert
- responses:
- "200":
- $ref: '#/responses/alertrecord_GetPropertyHistoryAlertOutput'
- summary: 获取过去一天的报警历史分布
- tags:
- - alertrecord
- /alertrecords/project-alert-resource-count:
- get:
- description: 获取指定资源类的信息ProjectAlertResourceCount
- operationId: alertrecord_GetPropertyProjectAlertResourceCount
- parameters:
- - format: date-time
- in: query
- name: start_time
- type: string
- x-go-name: StartTime
- - format: date-time
- in: query
- name: end_time
- type: string
- x-go-name: EndTime
- - in: query
- name: res_type
- type: string
- x-go-name: ResType
- - in: query
- name: alert_id
- type: string
- x-go-name: AlertId
- - in: query
- name: scope
- type: string
- x-go-name: Scope
- responses:
- "200":
- $ref: '#/responses/alertrecord_GetPropertyProjectAlertResourceCountOutput'
- summary: GetPropertyProjectAlertResourceCount 获取指定时间段内各项目下的报警资源数量
- tags:
- - alertrecord
- /alertrecords/total-alert:
- get:
- description: 获取指定资源类的信息TotalAlert
- operationId: alertrecord_GetPropertyTotalAlert
- responses:
- "200":
- $ref: '#/responses/alertrecord_GetPropertyTotalAlertOutput'
- summary: 获取指定资源类的信息TotalAlert
- tags:
- - alertrecord
- /alertrecordshields:
- get:
- description: 列表
- operationId: alertrecordshield_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - in: query
- name: alert_name
- type: string
- x-go-name: AlertName
- - in: query
- name: res_type
- type: string
- x-go-name: ResType
- - in: query
- name: res_name
- type: string
- x-go-name: ResName
- - in: query
- name: res_id
- type: string
- x-go-name: ResId
- - in: query
- name: alert_id
- type: string
- x-go-name: AlertId
- - format: date-time
- in: query
- name: start_time
- type: string
- x-go-name: StartTime
- - format: date-time
- in: query
- name: end_time
- type: string
- x-go-name: EndTime
- responses:
- "200":
- $ref: '#/responses/alertrecordshield_ListItemFilterOutput'
- summary: 列表
- tags:
- - alertrecordshield
- post:
- description: 新建
- operationId: alertrecordshield_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- alertrecordshield:
- $ref: '#/definitions/AlertRecordShieldCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertrecordshield_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - alertrecordshield
- /alertrecordshields/{id}:
- delete:
- description: 删除
- operationId: alertrecordshield_CustomizeDelete
- parameters:
- - description: The Id or Name of alertrecordshield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertrecordshield_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - alertrecordshield
- get:
- description: 获取详情
- operationId: alertrecordshield_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of alertrecordshield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertrecordshield_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - alertrecordshield
- put:
- description: 更新
- operationId: alertrecordshield_ValidateUpdateData
- parameters:
- - description: The Id or Name of alertrecordshield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alertrecordshield:
- $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertrecordshield_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - alertrecordshield
- /alertrecordshields/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: alertrecordshield_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of alertrecordshield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertrecordshield_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - alertrecordshield
- /alertrecordshields/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: alertrecordshield_GetDetailsStatus
- parameters:
- - description: The Id or Name of alertrecordshield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertrecordshield_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - alertrecordshield
- /alertresources:
- get:
- description: 列表
- operationId: alertresource_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - in: query
- name: type
- type: string
- x-go-name: Type
- responses:
- "200":
- $ref: '#/responses/alertresource_ListItemFilterOutput'
- summary: 列表
- tags:
- - alertresource
- post:
- description: 新建
- operationId: alertresource_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- alertresource:
- $ref: '#/definitions/StandaloneResourceCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertresource_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - alertresource
- /alertresources/{id}:
- delete:
- description: 删除
- operationId: alertresource_CustomizeDelete
- parameters:
- - description: The Id or Name of alertresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertresource_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - alertresource
- get:
- description: 获取详情
- operationId: alertresource_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of alertresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertresource_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - alertresource
- put:
- description: 更新
- operationId: alertresource_ValidateUpdateData
- parameters:
- - description: The Id or Name of alertresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alertresource:
- $ref: '#/definitions/StandaloneResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alertresource_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - alertresource
- /alertresources/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: alertresource_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of alertresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alertresource_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - alertresource
- /alerts:
- get:
- description: 列表
- operationId: alert_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: |-
- 以报警是否启用/禁用过滤列表
- Enabled *bool `json:"enabled"`
- in: query
- items:
- type: string
- name: monitor_resource_id
- type: array
- x-go-name: MonitorResourceId
- responses:
- "200":
- $ref: '#/responses/alert_ListItemFilterOutput'
- summary: 列表
- tags:
- - alert
- post:
- description: 新建
- operationId: alert_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - alert
- /alerts/{id}:
- delete:
- description: 删除
- operationId: alert_CustomizeDelete
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - alert
- get:
- description: 获取详情
- operationId: alert_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - alert
- put:
- description: 更新
- operationId: alert_ValidateUpdateData
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - alert
- /alerts/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: alert_PerformDisable
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alert:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_PerformDisableOutput'
- summary: 执行操作Disable
- tags:
- - alert
- /alerts/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: alert_PerformEnable
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alert:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_PerformEnableOutput'
- summary: 执行操作Enable
- tags:
- - alert
- /alerts/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: alert_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - alert
- /alerts/{id}/pause:
- post:
- description: 执行操作Pause
- operationId: alert_PerformPause
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertPauseInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_PerformPauseOutput'
- summary: 执行操作Pause
- tags:
- - alert
- /alerts/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: alert_GetDetailsStatus
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/alert_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - alert
- /alerts/{id}/test-run:
- post:
- description: 执行操作TestRun
- operationId: alert_PerformTestRun
- parameters:
- - description: The Id or Name of alert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertTestRunInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/alert_PerformTestRunOutput'
- summary: 执行操作TestRun
- tags:
- - alert
- /commonalerts:
- get:
- description: 列表
- operationId: commonalert_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: |-
- 以报警是否启用/禁用过滤列表
- Enabled *bool `json:"enabled"`
- in: query
- items:
- type: string
- name: monitor_resource_id
- type: array
- x-go-name: MonitorResourceId
- - description: 查询时间段开始时间
- format: date-time
- in: query
- name: start_time
- type: string
- x-go-name: StartTime
- - description: 查询时间段结束时间
- format: date-time
- in: query
- name: end_time
- type: string
- x-go-name: EndTime
- - description: 返回 top N(默认 5)
- format: int64
- in: query
- name: top
- type: integer
- x-go-name: Top
- - description: |-
- V1AlertListInput
- 报警类型
- in: query
- name: alert_type
- type: string
- x-go-name: AlertType
- - description: 监控指标名称
- in: query
- name: metric
- type: string
- x-go-name: Metric
- - in: query
- name: level
- type: string
- x-go-name: Level
- - in: query
- items:
- type: string
- name: res_type
- type: array
- x-go-name: ResType
- - in: query
- name: used_by
- type: string
- x-go-name: UsedBy
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: string
- x-go-name: Name
- responses:
- "200":
- $ref: '#/responses/commonalert_ListItemFilterOutput'
- summary: 列表
- tags:
- - commonalert
- post:
- description: 新建
- operationId: commonalert_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/CommonAlertCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/commonalert_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - commonalert
- /commonalerts/{id}:
- delete:
- description: 删除
- operationId: commonalert_CustomizeDelete
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/commonalert_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - commonalert
- get:
- description: 获取详情
- operationId: commonalert_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/commonalert_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - commonalert
- put:
- description: 更新
- operationId: commonalert_ValidateUpdateData
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/commonalert_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - commonalert
- /commonalerts/{id}/config:
- post:
- description: 执行操作Config
- operationId: commonalert_PerformConfig
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/commonalert_PerformConfigOutput'
- summary: 执行操作Config
- tags:
- - commonalert
- /commonalerts/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: commonalert_PerformDisable
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/commonalert_PerformDisableOutput'
- summary: 执行操作Disable
- tags:
- - commonalert
- /commonalerts/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: commonalert_PerformEnable
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/commonalert_PerformEnableOutput'
- summary: 执行操作Enable
- tags:
- - commonalert
- /commonalerts/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: commonalert_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/commonalert_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - commonalert
- /commonalerts/{id}/pause:
- post:
- description: 执行操作Pause
- operationId: commonalert_PerformPause
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/AlertPauseInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/commonalert_PerformPauseOutput'
- summary: 执行操作Pause
- tags:
- - commonalert
- /commonalerts/{id}/set-scope:
- post:
- description: 执行操作SetScope
- operationId: commonalert_PerformSetScope
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/commonalert_PerformSetScopeOutput'
- summary: 执行操作SetScope
- tags:
- - commonalert
- /commonalerts/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: commonalert_GetDetailsStatus
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/commonalert_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - commonalert
- /commonalerts/{id}/test-run:
- post:
- description: 执行操作TestRun
- operationId: commonalert_PerformTestRun
- parameters:
- - description: The Id or Name of commonalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/AlertTestRunInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/commonalert_PerformTestRunOutput'
- summary: 执行操作TestRun
- tags:
- - commonalert
- /datasources:
- get:
- description: 列表
- operationId: datasource_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- responses:
- "200":
- $ref: '#/responses/datasource_ListItemFilterOutput'
- summary: 列表
- tags:
- - datasource
- post:
- description: 新建
- operationId: datasource_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- datasource:
- $ref: '#/definitions/StandaloneResourceCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/datasource_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - datasource
- /datasources/{id}:
- delete:
- description: 删除
- operationId: datasource_CustomizeDelete
- parameters:
- - description: The Id or Name of datasource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/datasource_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - datasource
- get:
- description: 获取详情
- operationId: datasource_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of datasource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/datasource_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - datasource
- put:
- description: 更新
- operationId: datasource_ValidateUpdateData
- parameters:
- - description: The Id or Name of datasource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- datasource:
- $ref: '#/definitions/StandaloneResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/datasource_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - datasource
- /datasources/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: datasource_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of datasource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/datasource_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - datasource
- /metricfields:
- get:
- description: 列表
- operationId: metricfield_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - in: query
- name: display_name
- type: string
- x-go-name: DisplayName
- - in: query
- name: unit
- type: string
- x-go-name: Unit
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- responses:
- "200":
- $ref: '#/responses/metricfield_ListItemFilterOutput'
- summary: 列表
- tags:
- - metricfield
- post:
- description: 新建
- operationId: metricfield_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- metricfield:
- $ref: '#/definitions/MetricFieldCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/metricfield_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - metricfield
- /metricfields/{id}:
- delete:
- description: 删除
- operationId: metricfield_CustomizeDelete
- parameters:
- - description: The Id or Name of metricfield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricfield_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - metricfield
- get:
- description: 获取详情
- operationId: metricfield_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of metricfield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricfield_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - metricfield
- put:
- description: 更新
- operationId: metricfield_ValidateUpdateData
- parameters:
- - description: The Id or Name of metricfield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- metricfield:
- $ref: '#/definitions/MetricFieldUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/metricfield_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - metricfield
- /metricfields/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: metricfield_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of metricfield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricfield_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - metricfield
- /metricfields/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: metricfield_GetDetailsStatus
- parameters:
- - description: The Id or Name of metricfield
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricfield_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - metricfield
- /metricmeasurements:
- get:
- description: 列表
- operationId: metricmeasurement_ListItemFilter
- parameters:
- - $ref: '#/definitions/MetricMeasurementListInput'
- in: query
- name: measurement
- x-go-name: Measurement
- - $ref: '#/definitions/MetricFieldListInput'
- in: query
- name: metric_fields
- x-go-name: MetricFields
- - in: query
- name: scope
- type: string
- x-go-name: Scope
- responses:
- "200":
- $ref: '#/responses/metricmeasurement_ListItemFilterOutput'
- summary: 列表
- tags:
- - metricmeasurement
- post:
- description: 新建
- operationId: metricmeasurement_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- metricmeasurement:
- $ref: '#/definitions/MetricCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/metricmeasurement_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - metricmeasurement
- /metricmeasurements/{id}:
- delete:
- description: 删除
- operationId: metricmeasurement_CustomizeDelete
- parameters:
- - description: The Id or Name of metricmeasurement
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricmeasurement_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - metricmeasurement
- get:
- description: 获取详情
- operationId: metricmeasurement_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of metricmeasurement
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricmeasurement_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - metricmeasurement
- put:
- description: 更新
- operationId: metricmeasurement_ValidateUpdateData
- parameters:
- - description: The Id or Name of metricmeasurement
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- metricmeasurement:
- $ref: '#/definitions/MetricUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/metricmeasurement_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - metricmeasurement
- /metricmeasurements/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: metricmeasurement_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of metricmeasurement
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricmeasurement_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - metricmeasurement
- /metricmeasurements/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: metricmeasurement_GetDetailsStatus
- parameters:
- - description: The Id or Name of metricmeasurement
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metricmeasurement_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - metricmeasurement
- /metrics:
- get:
- description: 列表
- operationId: metric_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- responses:
- "200":
- $ref: '#/responses/metric_ListItemFilterOutput'
- summary: 列表
- tags:
- - metric
- post:
- description: 新建
- operationId: metric_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- metric:
- $ref: '#/definitions/JoinResourceBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/metric_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - metric
- /metrics/{id}:
- delete:
- description: 删除
- operationId: metric_CustomizeDelete
- parameters:
- - description: The Id or Name of metric
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metric_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - metric
- get:
- description: 获取详情
- operationId: metric_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of metric
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/metric_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - metric
- put:
- description: 更新
- operationId: metric_ValidateUpdateData
- parameters:
- - description: The Id or Name of metric
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- metric:
- $ref: '#/definitions/VirtualJointResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/metric_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - metric
- /migrationalerts:
- get:
- description: 列表
- operationId: migrationalert_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: |-
- 以报警是否启用/禁用过滤列表
- Enabled *bool `json:"enabled"`
- in: query
- items:
- type: string
- name: monitor_resource_id
- type: array
- x-go-name: MonitorResourceId
- - in: query
- name: metric_type
- type: string
- x-go-name: MetricType
- responses:
- "200":
- $ref: '#/responses/migrationalert_ListItemFilterOutput'
- summary: 列表
- tags:
- - migrationalert
- post:
- description: 新建
- operationId: migrationalert_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- migrationalert:
- $ref: '#/definitions/MigrationAlertCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/migrationalert_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - migrationalert
- /migrationalerts/{id}:
- delete:
- description: 删除
- operationId: migrationalert_CustomizeDelete
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/migrationalert_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - migrationalert
- get:
- description: 获取详情
- operationId: migrationalert_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/migrationalert_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - migrationalert
- put:
- description: 更新
- operationId: migrationalert_ValidateUpdateData
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/migrationalert_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - migrationalert
- /migrationalerts/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: migrationalert_PerformDisable
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/migrationalert_PerformDisableOutput'
- summary: 执行操作Disable
- tags:
- - migrationalert
- /migrationalerts/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: migrationalert_PerformEnable
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/migrationalert_PerformEnableOutput'
- summary: 执行操作Enable
- tags:
- - migrationalert
- /migrationalerts/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: migrationalert_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/migrationalert_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - migrationalert
- /migrationalerts/{id}/pause:
- post:
- description: 执行操作Pause
- operationId: migrationalert_PerformPause
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertPauseInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/migrationalert_PerformPauseOutput'
- summary: 执行操作Pause
- tags:
- - migrationalert
- /migrationalerts/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: migrationalert_GetDetailsStatus
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/migrationalert_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - migrationalert
- /migrationalerts/{id}/test-run:
- post:
- description: 执行操作TestRun
- operationId: migrationalert_PerformTestRun
- parameters:
- - description: The Id or Name of migrationalert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertTestRunInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/migrationalert_PerformTestRunOutput'
- summary: 执行操作TestRun
- tags:
- - migrationalert
- /monitorresourcealerts:
- get:
- description: 列表
- operationId: monitorresourcealert_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 列表中包含标记为"系统资源"的资源
- in: query
- name: system
- type: boolean
- x-go-name: System
- - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
- in: query
- name: pending_delete
- type: boolean
- x-go-name: PendingDelete
- - description: 查询时间段开始时间
- format: date-time
- in: query
- name: start_time
- type: string
- x-go-name: StartTime
- - description: 查询时间段结束时间
- format: date-time
- in: query
- name: end_time
- type: string
- x-go-name: EndTime
- - description: 返回 top N(默认 5)
- format: int64
- in: query
- name: top
- type: integer
- x-go-name: Top
- - in: query
- name: monitor_resource_id
- type: string
- x-go-name: MonitorResourceId
- - in: query
- name: alert_id
- type: string
- x-go-name: AlertId
- - in: query
- items:
- format: int64
- type: integer
- name: joint_id
- type: array
- x-go-name: JointId
- - in: query
- name: alerting
- type: boolean
- x-go-name: Alerting
- - in: query
- name: alert_state
- type: string
- x-go-name: AlertState
- - in: query
- name: send_state
- type: string
- x-go-name: SendState
- - in: query
- name: res_type
- type: string
- x-go-name: ResType
- - in: query
- name: metric
- type: string
- x-go-name: Metric
- - in: query
- name: res_name
- type: string
- x-go-name: ResName
- - in: query
- name: alert_name
- type: string
- x-go-name: AlertName
- - in: query
- name: level
- type: string
- x-go-name: Level
- - description: 查询所有状态
- in: query
- name: all_state
- type: boolean
- x-go-name: AllState
- responses:
- "200":
- $ref: '#/responses/monitorresourcealert_ListItemFilterOutput'
- summary: 列表
- tags:
- - monitorresourcealert
- post:
- description: 新建
- operationId: monitorresourcealert_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- monitorresourcealert:
- $ref: '#/definitions/JoinResourceBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/monitorresourcealert_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - monitorresourcealert
- /monitorresourcealerts/{id}:
- delete:
- description: 删除
- operationId: monitorresourcealert_CustomizeDelete
- parameters:
- - description: The Id or Name of monitorresourcealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/monitorresourcealert_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - monitorresourcealert
- get:
- description: 获取详情
- operationId: monitorresourcealert_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of monitorresourcealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/monitorresourcealert_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - monitorresourcealert
- put:
- description: 更新
- operationId: monitorresourcealert_ValidateUpdateData
- parameters:
- - description: The Id or Name of monitorresourcealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- monitorresourcealert:
- $ref: '#/definitions/JointResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/monitorresourcealert_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - monitorresourcealert
- /monitorresources:
- get:
- description: 列表
- operationId: monitorresource_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 列表中包含标记为"系统资源"的资源
- in: query
- name: system
- type: boolean
- x-go-name: System
- - description: 是否显示回收站内的资源,默认不显示(对实现了回收站的资源有效,例如主机,磁盘,镜像)
- in: query
- name: pending_delete
- type: boolean
- x-go-name: PendingDelete
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: |-
- 列出指定云平台的资源,支持的云平台如下
- Provider | 开始支持版本 | 平台 |
- -----------|------------|-------------------------------------|
- OneCloud | 0.0 | OneCloud内置私有云,包括KVM和裸金属管理 |
- VMware | 1.2 | VMware vCenter |
- OpenStack | 2.6 | OpenStack M版本以上私有云 |
- ZStack | 2.10 | ZStack私有云 |
- Aliyun | 2.0 | 阿里云 |
- Aws | 2.3 | Amazon AWS |
- Azure | 2.2 | Microsoft Azure |
- Google | 2.13 | Google Cloud Platform |
- Qcloud | 2.3 | 腾讯云 |
- Huawei | 2.5 | 华为公有云 |
- Ucloud | 2.7 | UCLOUD |
- Ctyun | 2.13 | 天翼云 |
- S3 | 2.11 | 通用s3对象存储 |
- Ceph | 2.11 | Ceph对象存储 |
- Xsky | 2.11 | XSKY启明星辰Ceph对象存储 |
- enum:
- - OneCloud
- - VMware
- - Aliyun
- - Qcloud
- - Azure
- - Aws
- - Huawei
- - OpenStack
- - Ucloud
- - ZStack
- - Google
- - Ctyun
- - S3
- - Ceph
- - Xsky
- in: query
- items:
- type: string
- name: providers
- type: array
- x-go-name: Providers
- - in: query
- items:
- type: string
- name: brands
- type: array
- x-go-name: Brands
- - description: |-
- 列出指定云环境的资源,支持云环境如下:
- CloudEnv | 说明 |
- -----------|--------|
- public | 公有云 |
- private | 私有云 |
- onpremise | 本地IDC |
- enum:
- - public
- - private
- - onpremise
- in: query
- name: cloud_env
- type: string
- x-go-name: CloudEnv
- - description: 以平台名称排序
- in: query
- name: order_by_provider
- pattern: asc|desc
- type: string
- x-go-name: OrderByProvider
- - description: 以平台品牌排序
- in: query
- name: order_by_brand
- pattern: asc|desc
- type: string
- x-go-name: OrderByBrand
- - description: 列出关联指定云订阅(ID或Name)的资源
- in: query
- items:
- type: string
- name: cloudprovider_id
- type: array
- x-go-name: CloudproviderId
- - description: 列出关联指定云账号(ID或Name)的资源
- in: query
- items:
- type: string
- name: cloudaccount_id
- type: array
- x-go-name: CloudaccountId
- - default: false
- description: 过滤资源,是否为非OneCloud内置私有云管理的资源
- in: query
- name: is_managed
- type: boolean
- x-go-name: IsManaged
- - description: 以云账号名称排序
- in: query
- name: order_by_account
- pattern: asc|desc
- type: string
- x-go-name: OrderByAccount
- - description: 以云订阅名称排序
- in: query
- name: order_by_manager
- pattern: asc|desc
- type: string
- x-go-name: OrderByManager
- - description: 查询时间段开始时间
- format: date-time
- in: query
- name: start_time
- type: string
- x-go-name: StartTime
- - description: 查询时间段结束时间
- format: date-time
- in: query
- name: end_time
- type: string
- x-go-name: EndTime
- - description: 返回 top N(默认 5)
- format: int64
- in: query
- name: top
- type: integer
- x-go-name: Top
- - in: query
- items:
- type: string
- name: res_id
- type: array
- x-go-name: ResId
- - in: query
- name: res_type
- type: string
- x-go-name: ResType
- - in: query
- name: only_res_id
- type: boolean
- x-go-name: OnlyResId
- - in: query
- items:
- type: string
- name: alert_states
- type: array
- x-go-name: AlertStates
- - in: query
- name: res_name
- type: string
- x-go-name: ResName
- responses:
- "200":
- $ref: '#/responses/monitorresource_ListItemFilterOutput'
- summary: 列表
- tags:
- - monitorresource
- post:
- description: 新建
- operationId: monitorresource_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- monitorresource:
- $ref: '#/definitions/MonitorResourceCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/monitorresource_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - monitorresource
- /monitorresources/{id}:
- delete:
- description: 删除
- operationId: monitorresource_CustomizeDelete
- parameters:
- - description: The Id or Name of monitorresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/monitorresource_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - monitorresource
- get:
- description: 获取详情
- operationId: monitorresource_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of monitorresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/monitorresource_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - monitorresource
- put:
- description: 更新
- operationId: monitorresource_ValidateUpdateData
- parameters:
- - description: The Id or Name of monitorresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/VirtualResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/monitorresource_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - monitorresource
- /monitorresources/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: monitorresource_PerformChangeOwner
- parameters:
- - description: The Id or Name of monitorresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/PerformChangeProjectOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/monitorresource_PerformChangeOwnerOutput'
- summary: 更改项目
- tags:
- - monitorresource
- /monitorresources/{id}/do-action:
- post:
- description: 执行操作DoAction
- operationId: monitorresource_PerformDoAction
- parameters:
- - description: The Id or Name of monitorresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/MonitorResourceDoActionInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/monitorresource_PerformDoActionOutput'
- summary: 执行操作DoAction
- tags:
- - monitorresource
- /monitorresources/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: monitorresource_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of monitorresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/monitorresource_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - monitorresource
- /monitorresources/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: monitorresource_GetDetailsStatus
- parameters:
- - description: The Id or Name of monitorresource
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/monitorresource_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - monitorresource
- /monitorresources/alert:
- get:
- description: 获取指定资源类的信息Alert
- operationId: monitorresource_GetPropertyAlert
- responses:
- "200":
- $ref: '#/responses/monitorresource_GetPropertyAlertOutput'
- summary: 获取指定资源类的信息Alert
- tags:
- - monitorresource
- /nodealerts:
- get:
- description: 列表
- operationId: nodealert_ListItemFilter
- parameters:
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 指定项目的名称或ID
- in: query
- name: project_id
- type: string
- x-go-name: ProjectId
- - description: 对具有项目属性的资源,严格匹配项目ID
- in: query
- items:
- type: string
- name: project_ids
- type: array
- x-go-name: ProjectIds
- - description: 按project名称排序,可能值为asc|desc
- in: query
- name: order_by_project
- pattern: asc|desc
- type: string
- x-go-name: OrderByProject
- - $ref: '#/definitions/TTagSetList'
- description: filter by project tags
- in: query
- name: project_tags
- x-go-name: ProjectTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by no project tags
- in: query
- name: no_project_tags
- x-go-name: NoProjectTags
- - description: filter by project organizations
- in: query
- items:
- type: string
- name: project_organizations
- type: array
- x-go-name: ProjectOrganizations
- - $ref: '#/definitions/TTagSetList'
- description: |-
- ignore
- project tag fitlers imposed by policy
- in: query
- name: policy_project_tags
- x-go-name: PolicyProjectTags
- - description: 指定匹配的范围,可能值为project, domain or system
- in: query
- name: belong_scope
- type: string
- x-go-name: BelongScope
- - description: 以资源是否启用/禁用过滤列表
- in: query
- name: enabled
- type: boolean
- x-go-name: Enabled
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: |-
- 以报警是否启用/禁用过滤列表
- Enabled *bool `json:"enabled"`
- in: query
- items:
- type: string
- name: monitor_resource_id
- type: array
- x-go-name: MonitorResourceId
- - description: 监控指标名称
- in: query
- name: metric
- type: string
- x-go-name: Metric
- - description: '监控资源类型, 比如: guest, host'
- in: query
- name: type
- type: string
- x-go-name: Type
- - description: 监控资源名称
- in: query
- name: node_name
- type: string
- x-go-name: NodeName
- - description: 监控资源 Id
- in: query
- name: node_id
- type: string
- x-go-name: NodeId
- responses:
- "200":
- $ref: '#/responses/nodealert_ListItemFilterOutput'
- summary: 列表
- tags:
- - nodealert
- post:
- description: 新建
- operationId: nodealert_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- nodealert:
- $ref: '#/definitions/NodeAlertCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/nodealert_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - nodealert
- /nodealerts/{id}:
- delete:
- description: 删除
- operationId: nodealert_CustomizeDelete
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/nodealert_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - nodealert
- get:
- description: 获取详情
- operationId: nodealert_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/nodealert_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - nodealert
- put:
- description: 更新
- operationId: nodealert_ValidateUpdateData
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/NodeAlertUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/nodealert_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - nodealert
- /nodealerts/{id}/config:
- post:
- description: 执行操作Config
- operationId: nodealert_PerformConfig
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/nodealert_PerformConfigOutput'
- summary: 执行操作Config
- tags:
- - nodealert
- /nodealerts/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: nodealert_PerformDisable
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/nodealert_PerformDisableOutput'
- summary: 执行操作Disable
- tags:
- - nodealert
- /nodealerts/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: nodealert_PerformEnable
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/nodealert_PerformEnableOutput'
- summary: 执行操作Enable
- tags:
- - nodealert
- /nodealerts/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: nodealert_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/nodealert_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - nodealert
- /nodealerts/{id}/pause:
- post:
- description: 执行操作Pause
- operationId: nodealert_PerformPause
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/AlertPauseInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/nodealert_PerformPauseOutput'
- summary: 执行操作Pause
- tags:
- - nodealert
- /nodealerts/{id}/set-scope:
- post:
- description: 执行操作SetScope
- operationId: nodealert_PerformSetScope
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/nodealert_PerformSetScopeOutput'
- summary: 执行操作SetScope
- tags:
- - nodealert
- /nodealerts/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: nodealert_GetDetailsStatus
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/nodealert_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - nodealert
- /nodealerts/{id}/test-run:
- post:
- description: 执行操作TestRun
- operationId: nodealert_PerformTestRun
- parameters:
- - description: The Id or Name of nodealert
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/AlertTestRunInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/nodealert_PerformTestRunOutput'
- summary: 执行操作TestRun
- tags:
- - nodealert
- /unifiedmonitors/query:
- post:
- description: 查询监控数据接口
- operationId: models_PerformQuery
- parameters:
- - in: body
- name: body
- schema:
- $ref: '#/definitions/MetricQueryInput'
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/models_PerformQueryOutput'
- summary: 查询监控数据接口
- tags:
- - unifiedmonitor
- produces:
- - application/json
- responses:
- alert_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertDetails'
- type: object
- alert_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertDetails'
- type: object
- alert_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- alert:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- alert_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- alert:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- alert_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- alerts:
- items:
- $ref: '#/definitions/AlertDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- alert_PerformDisableOutput:
- description: ""
- alert_PerformEnableOutput:
- description: ""
- alert_PerformPauseOutput:
- description: ""
- alert_PerformTestRunOutput:
- description: ""
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertTestRunOutput'
- type: object
- alert_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertDetails'
- type: object
- alert_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- alert:
- $ref: '#/definitions/AlertDetails'
- type: object
- alert_notification_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/VirtualResourceDetails'
- type: object
- alert_notification_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/VirtualResourceDetails'
- type: object
- alert_notification_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- alert_notification:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- alert_notification_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- alert_notification_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- alert_notifications:
- items:
- $ref: '#/definitions/VirtualResourceDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- alert_notification_PerformChangeOwnerOutput:
- description: ""
- alert_notification_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/VirtualResourceDetails'
- type: object
- alert_notification_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- alert_notification:
- $ref: '#/definitions/VirtualResourceDetails'
- type: object
- alertdashboard_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertDashBoardDetails'
- type: object
- alertdashboard_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertDashBoardDetails'
- type: object
- alertdashboard_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- alertdashboard:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- alertdashboard_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- alertdashboard_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- alertdashboards:
- items:
- $ref: '#/definitions/AlertDashBoardDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- alertdashboard_PerformCloneDashboardOutput:
- description: ""
- alertdashboard_PerformClonePanelOutput:
- description: ""
- alertdashboard_PerformSetPanelOrderOutput:
- description: ""
- alertdashboard_PerformSetScopeOutput:
- description: ""
- alertdashboard_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertDashBoardDetails'
- type: object
- alertdashboard_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- alertdashboard:
- $ref: '#/definitions/AlertDashBoardDetails'
- type: object
- alertpanel_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- alertpanel:
- $ref: '#/definitions/PanelDetails'
- type: object
- alertpanel_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- alertpanel:
- $ref: '#/definitions/PanelDetails'
- type: object
- alertpanel_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- alertpanel:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- alertpanel_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- alertpanel:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- alertpanel_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- alertpanels:
- items:
- $ref: '#/definitions/PanelDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- alertpanel_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- alertpanel:
- $ref: '#/definitions/PanelDetails'
- type: object
- alertpanel_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- alertpanel:
- $ref: '#/definitions/PanelDetails'
- type: object
- alertrecord_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/AlertRecordDetails'
- type: object
- alertrecord_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/AlertRecordDetails'
- type: object
- alertrecord_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- alertrecord:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- alertrecord_GetPropertyHistoryAlertOutput:
- description: ""
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/AlertRecordHistoryAlert'
- type: object
- alertrecord_GetPropertyProjectAlertResourceCountOutput:
- description: ""
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/ProjectAlertResourceCount'
- type: object
- alertrecord_GetPropertyTotalAlertOutput:
- description: ""
- alertrecord_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- alertrecords:
- items:
- $ref: '#/definitions/AlertRecordDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- alertrecord_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/AlertRecordDetails'
- type: object
- alertrecord_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- alertrecord:
- $ref: '#/definitions/AlertRecordDetails'
- type: object
- alertrecordshield_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- alertrecordshield:
- $ref: '#/definitions/AlertRecordShieldDetails'
- type: object
- alertrecordshield_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- alertrecordshield:
- $ref: '#/definitions/AlertRecordShieldDetails'
- type: object
- alertrecordshield_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- alertrecordshield:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- alertrecordshield_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- alertrecordshield:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- alertrecordshield_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- alertrecordshields:
- items:
- $ref: '#/definitions/AlertRecordShieldDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- alertrecordshield_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- alertrecordshield:
- $ref: '#/definitions/AlertRecordShieldDetails'
- type: object
- alertrecordshield_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- alertrecordshield:
- $ref: '#/definitions/AlertRecordShieldDetails'
- type: object
- alertresource_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- alertresource:
- $ref: '#/definitions/AlertResourceDetails'
- type: object
- alertresource_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- alertresource:
- $ref: '#/definitions/AlertResourceDetails'
- type: object
- alertresource_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- alertresource:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- alertresource_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- alertresources:
- items:
- $ref: '#/definitions/AlertResourceDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- alertresource_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- alertresource:
- $ref: '#/definitions/AlertResourceDetails'
- type: object
- alertresource_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- alertresource:
- $ref: '#/definitions/AlertResourceDetails'
- type: object
- commonalert_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/CommonAlertDetails'
- type: object
- commonalert_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/CommonAlertDetails'
- type: object
- commonalert_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- commonalert:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- commonalert_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- commonalert_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- commonalerts:
- items:
- $ref: '#/definitions/CommonAlertDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- commonalert_PerformConfigOutput:
- description: ""
- commonalert_PerformDisableOutput:
- description: ""
- commonalert_PerformEnableOutput:
- description: ""
- commonalert_PerformPauseOutput:
- description: ""
- commonalert_PerformSetScopeOutput:
- description: ""
- commonalert_PerformTestRunOutput:
- description: ""
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/AlertTestRunOutput'
- type: object
- commonalert_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/CommonAlertDetails'
- type: object
- commonalert_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- commonalert:
- $ref: '#/definitions/CommonAlertDetails'
- type: object
- datasource_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- datasource:
- $ref: '#/definitions/StandaloneResourceDetails'
- type: object
- datasource_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- datasource:
- $ref: '#/definitions/StandaloneResourceDetails'
- type: object
- datasource_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- datasource:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- datasource_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- datasources:
- items:
- $ref: '#/definitions/StandaloneResourceDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- datasource_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- datasource:
- $ref: '#/definitions/StandaloneResourceDetails'
- type: object
- datasource_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- datasource:
- $ref: '#/definitions/StandaloneResourceDetails'
- type: object
- metric_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- metric:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- metric_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- metric:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- metric_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- metrics:
- items:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- metric_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- metric:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- metric_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- metric:
- $ref: '#/definitions/JointResourceBaseDetails'
- type: object
- metricfield_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- metricfield:
- $ref: '#/definitions/MetricFieldDetail'
- type: object
- metricfield_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- metricfield:
- $ref: '#/definitions/MetricFieldDetail'
- type: object
- metricfield_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- metricfield:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- metricfield_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- metricfield:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- metricfield_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- metricfields:
- items:
- $ref: '#/definitions/MetricFieldDetail'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- metricfield_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- metricfield:
- $ref: '#/definitions/MetricFieldDetail'
- type: object
- metricfield_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- metricfield:
- $ref: '#/definitions/MetricFieldDetail'
- type: object
- metricmeasurement_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- metricmeasurement:
- $ref: '#/definitions/MetricDetails'
- type: object
- metricmeasurement_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- metricmeasurement:
- $ref: '#/definitions/MetricDetails'
- type: object
- metricmeasurement_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- metricmeasurement:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- metricmeasurement_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- metricmeasurement:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- metricmeasurement_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- metricmeasurements:
- items:
- $ref: '#/definitions/MetricDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- metricmeasurement_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- metricmeasurement:
- $ref: '#/definitions/MetricDetails'
- type: object
- metricmeasurement_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- metricmeasurement:
- $ref: '#/definitions/MetricDetails'
- type: object
- migrationalert_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertDetails'
- type: object
- migrationalert_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertDetails'
- type: object
- migrationalert_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- migrationalert:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- migrationalert_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- migrationalert_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- migrationalerts:
- items:
- $ref: '#/definitions/AlertDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- migrationalert_PerformDisableOutput:
- description: ""
- migrationalert_PerformEnableOutput:
- description: ""
- migrationalert_PerformPauseOutput:
- description: ""
- migrationalert_PerformTestRunOutput:
- description: ""
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertTestRunOutput'
- type: object
- migrationalert_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertDetails'
- type: object
- migrationalert_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- migrationalert:
- $ref: '#/definitions/AlertDetails'
- type: object
- models_PerformQueryOutput:
- description: ""
- schema:
- properties:
- unifiedmonitor:
- $ref: '#/definitions/MetricsQueryResult'
- type: object
- monitorresource_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/MonitorResourceDetails'
- type: object
- monitorresource_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/MonitorResourceDetails'
- type: object
- monitorresource_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- monitorresource:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- monitorresource_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- monitorresource_GetPropertyAlertOutput:
- description: ""
- monitorresource_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- monitorresources:
- items:
- $ref: '#/definitions/MonitorResourceDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- monitorresource_PerformChangeOwnerOutput:
- description: ""
- monitorresource_PerformDoActionOutput:
- description: ""
- monitorresource_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/MonitorResourceDetails'
- type: object
- monitorresource_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- monitorresource:
- $ref: '#/definitions/MonitorResourceDetails'
- type: object
- monitorresourcealert_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- monitorresourcealert:
- $ref: '#/definitions/MonitorResourceJointDetails'
- type: object
- monitorresourcealert_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- monitorresourcealert:
- $ref: '#/definitions/MonitorResourceJointDetails'
- type: object
- monitorresourcealert_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- monitorresourcealerts:
- items:
- $ref: '#/definitions/MonitorResourceJointDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- monitorresourcealert_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- monitorresourcealert:
- $ref: '#/definitions/MonitorResourceJointDetails'
- type: object
- monitorresourcealert_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- monitorresourcealert:
- $ref: '#/definitions/MonitorResourceJointDetails'
- type: object
- nodealert_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/NodeAlertDetails'
- type: object
- nodealert_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/NodeAlertDetails'
- type: object
- nodealert_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- nodealert:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- nodealert_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- nodealert_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- nodealerts:
- items:
- $ref: '#/definitions/NodeAlertDetails'
- type: array
- x-go-name: Output
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- nodealert_PerformConfigOutput:
- description: ""
- nodealert_PerformDisableOutput:
- description: ""
- nodealert_PerformEnableOutput:
- description: ""
- nodealert_PerformPauseOutput:
- description: ""
- nodealert_PerformSetScopeOutput:
- description: ""
- nodealert_PerformTestRunOutput:
- description: ""
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/AlertTestRunOutput'
- type: object
- nodealert_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/NodeAlertDetails'
- type: object
- nodealert_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- nodealert:
- $ref: '#/definitions/NodeAlertDetails'
- type: object
- schemes:
- - https
- - http
- securityDefinitions:
- keystone:
- in: header
- name: X-Auth-Token
- type: apiKey
- swagger: "2.0"
|