swagger_identity.yaml 495 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576
  1. basePath: /
  2. consumes:
  3. - application/json
  4. definitions:
  5. CredentialCreateInput:
  6. properties:
  7. __meta__:
  8. additionalProperties:
  9. type: string
  10. description: 标签列表,最多支持20个
  11. example:
  12. user:rd: op
  13. type: object
  14. x-go-name: Metadata
  15. blob:
  16. type: string
  17. x-go-name: Blob
  18. description:
  19. description: 资源描述
  20. example: test create network
  21. type: string
  22. x-go-name: Description
  23. dry_run:
  24. default: false
  25. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  26. type: boolean
  27. x-go-name: DryRun
  28. encrypted_blob:
  29. description: Ignore
  30. type: string
  31. x-go-name: EncryptedBlob
  32. generate_name:
  33. description: |-
  34. 生成资源名称的模板,如果name为空,则为必填项
  35. description: generated resource name, given a pattern to generate name, required if name is not given
  36. example: test###
  37. type: string
  38. x-go-name: GenerateName
  39. is_emulated:
  40. description: |-
  41. 资源是否为模拟资源
  42. description: the resource is an emulated resource
  43. type: boolean
  44. x-go-name: IsEmulated
  45. key_hash:
  46. description: Ignore
  47. type: string
  48. x-go-name: KeyHash
  49. name:
  50. description: |-
  51. 资源名称,如果generate_name为空,则为必填项
  52. description: resource name, required if generated_name is not given
  53. example: test-network
  54. type: string
  55. uniqueItems: true
  56. x-go-name: Name
  57. project_id:
  58. type: string
  59. x-go-name: ProjectId
  60. type:
  61. type: string
  62. x-go-name: Type
  63. user_id:
  64. type: string
  65. x-go-name: UserId
  66. required:
  67. - name
  68. type: object
  69. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  70. CredentialDetails:
  71. properties:
  72. blob:
  73. type: string
  74. x-go-name: Blob
  75. can_delete:
  76. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  77. example: true
  78. type: boolean
  79. x-go-name: CanDelete
  80. can_update:
  81. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  82. example: true
  83. type: boolean
  84. x-go-name: CanUpdate
  85. created_at:
  86. description: 资源创建时间
  87. format: date-time
  88. type: string
  89. x-go-name: CreatedAt
  90. delete_fail_reason:
  91. $ref: '#/definitions/Error'
  92. deleted:
  93. description: 资源是否被删除
  94. type: boolean
  95. x-go-name: Deleted
  96. deleted_at:
  97. description: 资源删除时间
  98. format: date-time
  99. type: string
  100. x-go-name: DeletedAt
  101. description:
  102. description: 资源描述信息
  103. type: string
  104. x-go-name: Description
  105. domain:
  106. type: string
  107. x-go-name: Domain
  108. domain_id:
  109. type: string
  110. x-go-name: DomainId
  111. enabled:
  112. type: boolean
  113. x-go-name: Enabled
  114. encrypted_blob:
  115. type: string
  116. x-go-name: EncryptedBlob
  117. extra:
  118. type: object
  119. x-go-name: Extra
  120. id:
  121. description: 资源UUID
  122. type: string
  123. x-go-name: Id
  124. is_emulated:
  125. description: |-
  126. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  127. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  128. type: boolean
  129. x-go-name: IsEmulated
  130. key_hash:
  131. type: string
  132. x-go-name: KeyHash
  133. metadata:
  134. additionalProperties:
  135. type: string
  136. description: 标签
  137. type: object
  138. x-go-name: Metadata
  139. name:
  140. description: 资源名称
  141. type: string
  142. x-go-name: Name
  143. org_node_md5:
  144. description: 用以组织架构变更通知其他服务权限变更
  145. type: string
  146. x-go-name: OrgNodeMd5
  147. project_id:
  148. type: string
  149. x-go-name: ProjectId
  150. type:
  151. type: string
  152. x-go-name: Type
  153. update_fail_reason:
  154. $ref: '#/definitions/Error'
  155. update_version:
  156. description: 资源被更新次数
  157. format: int64
  158. type: integer
  159. x-go-name: UpdateVersion
  160. updated_at:
  161. description: 资源更新时间
  162. format: date-time
  163. type: string
  164. x-go-name: UpdatedAt
  165. user:
  166. type: string
  167. x-go-name: User
  168. user_id:
  169. type: string
  170. x-go-name: UserId
  171. type: object
  172. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  173. CredentialUpdateInput:
  174. properties:
  175. blob:
  176. description: 更新 blob 内容(明文,服务端加密后写入 encrypted_blob)
  177. type: string
  178. x-go-name: Blob
  179. description:
  180. description: 资源描述
  181. type: string
  182. x-go-name: Description
  183. enabled:
  184. description: enabled
  185. type: boolean
  186. x-go-name: Enabled
  187. encrypted_blob:
  188. description: 由 ValidateUpdateData 在提供 blob 时填充,不允许客户端直接传入
  189. type: string
  190. x-go-name: EncryptedBlob
  191. key_hash:
  192. type: string
  193. x-go-name: KeyHash
  194. name:
  195. description: 资源名称
  196. type: string
  197. x-go-name: Name
  198. type: object
  199. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  200. DomainCreateInput:
  201. properties:
  202. __meta__:
  203. additionalProperties:
  204. type: string
  205. description: 标签列表,最多支持20个
  206. example:
  207. user:rd: op
  208. type: object
  209. x-go-name: Metadata
  210. description:
  211. description: 资源描述
  212. example: test create network
  213. type: string
  214. x-go-name: Description
  215. displayname:
  216. description: 显示名
  217. type: string
  218. x-go-name: Displayname
  219. dry_run:
  220. default: false
  221. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  222. type: boolean
  223. x-go-name: DryRun
  224. enabled:
  225. description: 是否启用
  226. type: boolean
  227. x-go-name: Enabled
  228. generate_name:
  229. description: |-
  230. 生成资源名称的模板,如果name为空,则为必填项
  231. description: generated resource name, given a pattern to generate name, required if name is not given
  232. example: test###
  233. type: string
  234. x-go-name: GenerateName
  235. is_emulated:
  236. description: |-
  237. 资源是否为模拟资源
  238. description: the resource is an emulated resource
  239. type: boolean
  240. x-go-name: IsEmulated
  241. name:
  242. description: |-
  243. 资源名称,如果generate_name为空,则为必填项
  244. description: resource name, required if generated_name is not given
  245. example: test-network
  246. type: string
  247. uniqueItems: true
  248. x-go-name: Name
  249. required:
  250. - name
  251. type: object
  252. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  253. DomainDetails:
  254. properties:
  255. admin_id:
  256. type: string
  257. x-go-name: AdminId
  258. can_delete:
  259. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  260. example: true
  261. type: boolean
  262. x-go-name: CanDelete
  263. can_update:
  264. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  265. example: true
  266. type: boolean
  267. x-go-name: CanUpdate
  268. created_at:
  269. description: 资源创建时间
  270. format: date-time
  271. type: string
  272. x-go-name: CreatedAt
  273. delete_fail_reason:
  274. $ref: '#/definitions/Error'
  275. deleted:
  276. description: 资源是否被删除
  277. type: boolean
  278. x-go-name: Deleted
  279. deleted_at:
  280. description: 资源删除时间
  281. format: date-time
  282. type: string
  283. x-go-name: DeletedAt
  284. description:
  285. description: 资源描述信息
  286. type: string
  287. x-go-name: Description
  288. domain_id:
  289. type: string
  290. x-go-name: DomainId
  291. enabled:
  292. description: 改域是否启用
  293. type: boolean
  294. x-go-name: Enabled
  295. ext_resource:
  296. additionalProperties:
  297. format: int64
  298. type: integer
  299. description: 外部资源统计信息(资源类别:数量)
  300. type: object
  301. x-go-name: ExtResource
  302. ext_resources_last_update:
  303. description: 外部资源统计信息上次更新时间
  304. format: date-time
  305. type: string
  306. x-go-name: ExtResourcesLastUpdate
  307. ext_resources_next_update:
  308. description: 外部资源统计信息下次更新时间
  309. format: date-time
  310. type: string
  311. x-go-name: ExtResourcesNextUpdate
  312. extra:
  313. description: 额外信息
  314. type: object
  315. x-go-name: Extra
  316. group_count:
  317. description: 归属域的用户组数量
  318. format: int64
  319. type: integer
  320. x-go-name: GroupCount
  321. id:
  322. description: 资源UUID
  323. type: string
  324. x-go-name: Id
  325. idp:
  326. description: 认证源名称
  327. type: string
  328. x-go-name: Idp
  329. idp_count:
  330. description: 归属域的认证源数量
  331. format: int64
  332. type: integer
  333. x-go-name: IdpCount
  334. idp_driver:
  335. description: 认证源类型, 例如sql, cas, ldap等
  336. type: string
  337. x-go-name: IdpDriver
  338. idp_entity_id:
  339. description: 该资源在认证源的原始ID
  340. type: string
  341. x-go-name: IdpEntityId
  342. idp_id:
  343. description: 认证源ID
  344. type: string
  345. x-go-name: IdpId
  346. is_domain:
  347. description: 是否为域
  348. type: boolean
  349. x-go-name: IsDomain
  350. is_emulated:
  351. description: |-
  352. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  353. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  354. type: boolean
  355. x-go-name: IsEmulated
  356. is_sso:
  357. description: 是否是SSO登录方式
  358. type: boolean
  359. x-go-name: IsSso
  360. metadata:
  361. additionalProperties:
  362. type: string
  363. description: 标签
  364. type: object
  365. x-go-name: Metadata
  366. name:
  367. description: 资源名称
  368. type: string
  369. x-go-name: Name
  370. org_node_md5:
  371. description: 用以组织架构变更通知其他服务权限变更
  372. type: string
  373. x-go-name: OrgNodeMd5
  374. parent_id:
  375. type: string
  376. x-go-name: ParentId
  377. pending_deleted:
  378. description: 资源是否处于回收站中
  379. type: boolean
  380. x-go-name: PendingDeleted
  381. pending_deleted_at:
  382. description: 资源放入回收站时间
  383. format: date-time
  384. type: string
  385. x-go-name: PendingDeletedAt
  386. policy_count:
  387. description: 归属域的权限策略数量
  388. format: int64
  389. type: integer
  390. x-go-name: PolicyCount
  391. project_count:
  392. description: 归属域的项目数量
  393. format: int64
  394. type: integer
  395. x-go-name: ProjectCount
  396. role_count:
  397. description: 归属域的角色数量
  398. format: int64
  399. type: integer
  400. x-go-name: RoleCount
  401. template:
  402. description: 认证源模板
  403. type: string
  404. x-go-name: Template
  405. update_fail_reason:
  406. $ref: '#/definitions/Error'
  407. update_version:
  408. description: 资源被更新次数
  409. format: int64
  410. type: integer
  411. x-go-name: UpdateVersion
  412. updated_at:
  413. description: 资源更新时间
  414. format: date-time
  415. type: string
  416. x-go-name: UpdatedAt
  417. user_count:
  418. description: 归属域的用户数量
  419. format: int64
  420. type: integer
  421. x-go-name: UserCount
  422. type: object
  423. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  424. DomainUpdateInput:
  425. properties:
  426. description:
  427. description: 资源描述
  428. type: string
  429. x-go-name: Description
  430. displayname:
  431. description: 显示名
  432. type: string
  433. x-go-name: Displayname
  434. enabled:
  435. description: 是否启用
  436. type: boolean
  437. x-go-name: Enabled
  438. name:
  439. description: 资源名称
  440. type: string
  441. x-go-name: Name
  442. type: object
  443. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  444. EndpointDetails:
  445. properties:
  446. ca_certificate:
  447. type: string
  448. x-go-name: CaCertificate
  449. ca_private_key:
  450. type: string
  451. x-go-name: CaPrivateKey
  452. can_delete:
  453. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  454. example: true
  455. type: boolean
  456. x-go-name: CanDelete
  457. can_update:
  458. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  459. example: true
  460. type: boolean
  461. x-go-name: CanUpdate
  462. cert_id:
  463. type: string
  464. x-go-name: CertId
  465. cert_name:
  466. type: string
  467. x-go-name: CertName
  468. certificate:
  469. type: string
  470. x-go-name: Certificate
  471. common_name:
  472. type: string
  473. x-go-name: CommonName
  474. created_at:
  475. description: 资源创建时间
  476. format: date-time
  477. type: string
  478. x-go-name: CreatedAt
  479. delete_fail_reason:
  480. $ref: '#/definitions/Error'
  481. deleted:
  482. description: 资源是否被删除
  483. type: boolean
  484. x-go-name: Deleted
  485. deleted_at:
  486. description: 资源删除时间
  487. format: date-time
  488. type: string
  489. x-go-name: DeletedAt
  490. description:
  491. description: 资源描述信息
  492. type: string
  493. x-go-name: Description
  494. enabled:
  495. type: boolean
  496. x-go-name: Enabled
  497. extra:
  498. type: object
  499. x-go-name: Extra
  500. fingerprint:
  501. type: string
  502. x-go-name: Fingerprint
  503. id:
  504. description: 资源UUID
  505. type: string
  506. x-go-name: Id
  507. interface:
  508. type: string
  509. x-go-name: Interface
  510. is_emulated:
  511. description: |-
  512. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  513. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  514. type: boolean
  515. x-go-name: IsEmulated
  516. legacy_endpoint_id:
  517. type: string
  518. x-go-name: LegacyEndpointId
  519. metadata:
  520. additionalProperties:
  521. type: string
  522. description: 标签
  523. type: object
  524. x-go-name: Metadata
  525. name:
  526. description: 资源名称
  527. type: string
  528. x-go-name: Name
  529. not_after:
  530. format: date-time
  531. type: string
  532. x-go-name: NotAfter
  533. not_before:
  534. format: date-time
  535. type: string
  536. x-go-name: NotBefore
  537. org_node_md5:
  538. description: 用以组织架构变更通知其他服务权限变更
  539. type: string
  540. x-go-name: OrgNodeMd5
  541. private_key:
  542. type: string
  543. x-go-name: PrivateKey
  544. public_key_algorithm:
  545. description: derived attributes
  546. type: string
  547. x-go-name: PublicKeyAlgorithm
  548. public_key_bit_len:
  549. format: int64
  550. type: integer
  551. x-go-name: PublicKeyBitLen
  552. region_id:
  553. type: string
  554. x-go-name: RegionId
  555. service_certificate_id:
  556. type: string
  557. x-go-name: ServiceCertificateId
  558. service_id:
  559. type: string
  560. x-go-name: ServiceId
  561. service_name:
  562. description: 服务名称,例如keystone, glance, region等
  563. type: string
  564. x-go-name: ServiceName
  565. service_type:
  566. description: 服务类型,例如identity, image, compute等
  567. type: string
  568. x-go-name: ServiceType
  569. signature_algorithm:
  570. type: string
  571. x-go-name: SignatureAlgorithm
  572. subject_alternative_names:
  573. type: string
  574. x-go-name: SubjectAlternativeNames
  575. update_fail_reason:
  576. $ref: '#/definitions/Error'
  577. update_version:
  578. description: 资源被更新次数
  579. format: int64
  580. type: integer
  581. x-go-name: UpdateVersion
  582. updated_at:
  583. description: 资源更新时间
  584. format: date-time
  585. type: string
  586. x-go-name: UpdatedAt
  587. url:
  588. type: string
  589. x-go-name: Url
  590. type: object
  591. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  592. Error:
  593. properties:
  594. class:
  595. type: string
  596. x-go-name: Class
  597. code:
  598. format: int64
  599. type: integer
  600. x-go-name: Code
  601. details:
  602. type: string
  603. x-go-name: Details
  604. type: object
  605. x-go-package: yunion.io/x/onecloud/pkg/httperrors
  606. GetDetailsStatusOutput:
  607. properties:
  608. status:
  609. description: 状态
  610. type: string
  611. x-go-name: Status
  612. type: object
  613. x-go-package: yunion.io/x/onecloud/pkg/apis
  614. GetIdpSamlMetadataOutput:
  615. properties:
  616. metadata:
  617. description: SAML 2.0 SP metadata
  618. type: string
  619. x-go-name: Metadata
  620. type: object
  621. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  622. GetIdpSsoCallbackUriOutput:
  623. properties:
  624. driver:
  625. description: Driver
  626. type: string
  627. x-go-name: Driver
  628. redirect_uri:
  629. description: SSO回调地址
  630. type: string
  631. x-go-name: RedirectUri
  632. type: object
  633. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  634. GetIdpSsoRedirectUriOutput:
  635. properties:
  636. driver:
  637. description: Driver
  638. type: string
  639. x-go-name: Driver
  640. uri:
  641. description: SSO跳转URI
  642. type: string
  643. x-go-name: Uri
  644. type: object
  645. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  646. GroupCreateInput:
  647. properties:
  648. __meta__:
  649. additionalProperties:
  650. type: string
  651. description: 标签列表,最多支持20个
  652. example:
  653. user:rd: op
  654. type: object
  655. x-go-name: Metadata
  656. description:
  657. description: 资源描述
  658. example: test create network
  659. type: string
  660. x-go-name: Description
  661. displayname:
  662. description: display name
  663. type: string
  664. x-go-name: Displayname
  665. dry_run:
  666. default: false
  667. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  668. type: boolean
  669. x-go-name: DryRun
  670. generate_name:
  671. description: |-
  672. 生成资源名称的模板,如果name为空,则为必填项
  673. description: generated resource name, given a pattern to generate name, required if name is not given
  674. example: test###
  675. type: string
  676. x-go-name: GenerateName
  677. is_emulated:
  678. description: |-
  679. 资源是否为模拟资源
  680. description: the resource is an emulated resource
  681. type: boolean
  682. x-go-name: IsEmulated
  683. name:
  684. description: |-
  685. 资源名称,如果generate_name为空,则为必填项
  686. description: resource name, required if generated_name is not given
  687. example: test-network
  688. type: string
  689. uniqueItems: true
  690. x-go-name: Name
  691. project_domain_id:
  692. description: 指定项目归属域名称或ID
  693. type: string
  694. x-go-name: ProjectDomainId
  695. required:
  696. - name
  697. type: object
  698. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  699. GroupDetails:
  700. properties:
  701. can_delete:
  702. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  703. example: true
  704. type: boolean
  705. x-go-name: CanDelete
  706. can_update:
  707. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  708. example: true
  709. type: boolean
  710. x-go-name: CanUpdate
  711. created_at:
  712. description: 资源创建时间
  713. format: date-time
  714. type: string
  715. x-go-name: CreatedAt
  716. delete_fail_reason:
  717. $ref: '#/definitions/Error'
  718. deleted:
  719. description: 资源是否被删除
  720. type: boolean
  721. x-go-name: Deleted
  722. deleted_at:
  723. description: 资源删除时间
  724. format: date-time
  725. type: string
  726. x-go-name: DeletedAt
  727. description:
  728. description: 资源描述信息
  729. type: string
  730. x-go-name: Description
  731. displayname:
  732. description: 用户组的显示名称
  733. type: string
  734. x-go-name: Displayname
  735. domain_id:
  736. description: 域Id
  737. type: string
  738. x-go-name: DomainId
  739. extra:
  740. description: 额外信息
  741. type: object
  742. x-go-name: Extra
  743. id:
  744. description: 资源UUID
  745. type: string
  746. x-go-name: Id
  747. idp:
  748. description: 认证源名称
  749. type: string
  750. x-go-name: Idp
  751. idp_driver:
  752. description: 认证源类型, 例如sql, cas, ldap等
  753. type: string
  754. x-go-name: IdpDriver
  755. idp_entity_id:
  756. description: 该资源在认证源的原始ID
  757. type: string
  758. x-go-name: IdpEntityId
  759. idp_id:
  760. description: 认证源ID
  761. type: string
  762. x-go-name: IdpId
  763. is_emulated:
  764. description: |-
  765. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  766. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  767. type: boolean
  768. x-go-name: IsEmulated
  769. is_sso:
  770. description: 是否是SSO登录方式
  771. type: boolean
  772. x-go-name: IsSso
  773. metadata:
  774. additionalProperties:
  775. type: string
  776. description: 标签
  777. type: object
  778. x-go-name: Metadata
  779. name:
  780. description: 资源名称
  781. type: string
  782. x-go-name: Name
  783. org_node_md5:
  784. description: 用以组织架构变更通知其他服务权限变更
  785. type: string
  786. x-go-name: OrgNodeMd5
  787. pending_deleted:
  788. description: 资源是否处于回收站中
  789. type: boolean
  790. x-go-name: PendingDeleted
  791. pending_deleted_at:
  792. description: 资源放入回收站时间
  793. format: date-time
  794. type: string
  795. x-go-name: PendingDeletedAt
  796. project_count:
  797. description: 项目数量
  798. format: int64
  799. type: integer
  800. x-go-name: ProjectCount
  801. project_domain:
  802. description: 资源归属项目的域名称
  803. type: string
  804. x-go-name: ProjectDomain
  805. template:
  806. description: 认证源模板
  807. type: string
  808. x-go-name: Template
  809. update_fail_reason:
  810. $ref: '#/definitions/Error'
  811. update_version:
  812. description: 资源被更新次数
  813. format: int64
  814. type: integer
  815. x-go-name: UpdateVersion
  816. updated_at:
  817. description: 资源更新时间
  818. format: date-time
  819. type: string
  820. x-go-name: UpdatedAt
  821. user_count:
  822. description: 用户数量
  823. format: int64
  824. type: integer
  825. x-go-name: UserCount
  826. type: object
  827. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  828. GroupUpdateInput:
  829. properties:
  830. description:
  831. description: 资源描述
  832. type: string
  833. x-go-name: Description
  834. displayname:
  835. description: display name
  836. type: string
  837. x-go-name: Displayname
  838. name:
  839. description: 资源名称
  840. type: string
  841. x-go-name: Name
  842. type: object
  843. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  844. IdentityProviderCreateInput:
  845. properties:
  846. __meta__:
  847. additionalProperties:
  848. type: string
  849. description: 标签列表,最多支持20个
  850. example:
  851. user:rd: op
  852. type: object
  853. x-go-name: Metadata
  854. auto_create_project:
  855. description: 新建域的时候是否自动新建第一个项目
  856. type: boolean
  857. x-go-name: AutoCreateProject
  858. auto_create_user:
  859. description: 当用户不存在时,是否自动新建用户
  860. type: boolean
  861. x-go-name: AutoCreateUser
  862. config:
  863. $ref: '#/definitions/TConfigs'
  864. description:
  865. description: 资源描述
  866. example: test create network
  867. type: string
  868. x-go-name: Description
  869. disabled:
  870. description: 该资源是否被管理员*人为*禁用, 和enabled互斥
  871. type: boolean
  872. x-go-name: Disabled
  873. driver:
  874. description: 后端驱动名称
  875. type: string
  876. x-go-name: Driver
  877. dry_run:
  878. default: false
  879. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  880. type: boolean
  881. x-go-name: DryRun
  882. enabled:
  883. description: 该资源是否被管理员*人为*启用或者禁用
  884. type: boolean
  885. x-go-name: Enabled
  886. generate_name:
  887. description: |-
  888. 生成资源名称的模板,如果name为空,则为必填项
  889. description: generated resource name, given a pattern to generate name, required if name is not given
  890. example: test###
  891. type: string
  892. x-go-name: GenerateName
  893. icon_uri:
  894. description: 图标URL
  895. type: string
  896. x-go-name: IconUri
  897. is_emulated:
  898. description: |-
  899. 资源是否为模拟资源
  900. description: the resource is an emulated resource
  901. type: boolean
  902. x-go-name: IsEmulated
  903. name:
  904. description: |-
  905. 资源名称,如果generate_name为空,则为必填项
  906. description: resource name, required if generated_name is not given
  907. example: test-network
  908. type: string
  909. uniqueItems: true
  910. x-go-name: Name
  911. owner_domain_id:
  912. description: 归属域
  913. type: string
  914. x-go-name: OwnerDomainId
  915. status:
  916. description: 用来存储资源的状态
  917. type: string
  918. x-go-name: Status
  919. sync_interval_seconds:
  920. description: 自动同步间隔,单位:秒
  921. format: int64
  922. type: integer
  923. x-go-name: SyncIntervalSeconds
  924. target_domain_id:
  925. description: 默认导入用户和组的域
  926. type: string
  927. x-go-name: TargetDomainId
  928. template:
  929. description: 模板名称
  930. type: string
  931. x-go-name: Template
  932. required:
  933. - name
  934. type: object
  935. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  936. IdentityProviderDetails:
  937. properties:
  938. auto_create_project:
  939. description: 是否自动创建项目
  940. type: boolean
  941. x-go-name: AutoCreateProject
  942. auto_create_user:
  943. description: 是否自动创建用户
  944. type: boolean
  945. x-go-name: AutoCreateUser
  946. can_delete:
  947. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  948. example: true
  949. type: boolean
  950. x-go-name: CanDelete
  951. can_update:
  952. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  953. example: true
  954. type: boolean
  955. x-go-name: CanUpdate
  956. created_at:
  957. description: 资源创建时间
  958. format: date-time
  959. type: string
  960. x-go-name: CreatedAt
  961. delete_fail_reason:
  962. $ref: '#/definitions/Error'
  963. deleted:
  964. description: 资源是否被删除
  965. type: boolean
  966. x-go-name: Deleted
  967. deleted_at:
  968. description: 资源删除时间
  969. format: date-time
  970. type: string
  971. x-go-name: DeletedAt
  972. description:
  973. description: 资源描述信息
  974. type: string
  975. x-go-name: Description
  976. domain_count:
  977. description: 该认证源关联的所有域的数量
  978. format: int64
  979. type: integer
  980. x-go-name: DomainCount
  981. domain_id:
  982. description: 域Id
  983. type: string
  984. x-go-name: DomainId
  985. driver:
  986. type: string
  987. x-go-name: Driver
  988. enabled:
  989. description: 资源是否启用
  990. type: boolean
  991. x-go-name: Enabled
  992. error_count:
  993. format: int64
  994. type: integer
  995. x-go-name: ErrorCount
  996. group_count:
  997. description: 该认证源关联的所有域的组数量
  998. format: int64
  999. type: integer
  1000. x-go-name: GroupCount
  1001. icon_uri:
  1002. description: 认证源图标
  1003. type: string
  1004. x-go-name: IconUri
  1005. id:
  1006. description: 资源UUID
  1007. type: string
  1008. x-go-name: Id
  1009. is_default:
  1010. description: 是否是缺省SSO登录方式
  1011. type: boolean
  1012. x-go-name: IsDefault
  1013. is_emulated:
  1014. description: |-
  1015. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1016. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1017. type: boolean
  1018. x-go-name: IsEmulated
  1019. is_sso:
  1020. description: 是否是SSO登录方式
  1021. type: boolean
  1022. x-go-name: IsSso
  1023. last_sync:
  1024. format: date-time
  1025. type: string
  1026. x-go-name: LastSync
  1027. last_sync_end_at:
  1028. description: = Column(DateTime, nullable=True)
  1029. format: date-time
  1030. type: string
  1031. x-go-name: LastSyncEndAt
  1032. metadata:
  1033. additionalProperties:
  1034. type: string
  1035. description: 标签
  1036. type: object
  1037. x-go-name: Metadata
  1038. name:
  1039. description: 资源名称
  1040. type: string
  1041. x-go-name: Name
  1042. org_node_md5:
  1043. description: 用以组织架构变更通知其他服务权限变更
  1044. type: string
  1045. x-go-name: OrgNodeMd5
  1046. policy_count:
  1047. description: 该认证源关联的所有域的权限策略数量
  1048. format: int64
  1049. type: integer
  1050. x-go-name: PolicyCount
  1051. progress:
  1052. description: 操作进度0-100
  1053. format: float
  1054. type: number
  1055. x-go-name: Progress
  1056. project_count:
  1057. description: 该认证源关联的所有域的项目数量
  1058. format: int64
  1059. type: integer
  1060. x-go-name: ProjectCount
  1061. project_domain:
  1062. description: 资源归属项目的域名称
  1063. type: string
  1064. x-go-name: ProjectDomain
  1065. role_count:
  1066. description: 该认证源关联的所有域的角色数量
  1067. format: int64
  1068. type: integer
  1069. x-go-name: RoleCount
  1070. status:
  1071. description: 资源状态
  1072. type: string
  1073. x-go-name: Status
  1074. sync_interval_seconds:
  1075. description: 认证源账号信息同步周期
  1076. format: int64
  1077. type: integer
  1078. x-go-name: SyncIntervalSeconds
  1079. sync_status:
  1080. type: string
  1081. x-go-name: SyncStatus
  1082. target_domain:
  1083. description: 认证源的目标域名称
  1084. type: string
  1085. x-go-name: TargetDomain
  1086. target_domain_id:
  1087. type: string
  1088. x-go-name: TargetDomainId
  1089. template:
  1090. type: string
  1091. x-go-name: Template
  1092. update_fail_reason:
  1093. $ref: '#/definitions/Error'
  1094. update_version:
  1095. description: 资源被更新次数
  1096. format: int64
  1097. type: integer
  1098. x-go-name: UpdateVersion
  1099. updated_at:
  1100. description: 资源更新时间
  1101. format: date-time
  1102. type: string
  1103. x-go-name: UpdatedAt
  1104. url:
  1105. description: 该认证源的URL, 可以区分ladp是否使用TLS
  1106. example: ldaps://192.168.100.10, ldap://192.168.100.10
  1107. type: string
  1108. x-go-name: URL
  1109. user_count:
  1110. description: 该认证源关联的所有域的用户数量
  1111. format: int64
  1112. type: integer
  1113. x-go-name: UserCount
  1114. type: object
  1115. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1116. IdentityProviderUpdateInput:
  1117. properties:
  1118. auto_create_project:
  1119. description: 当认证后用户加入项目不存在时是否自动创建项目
  1120. type: boolean
  1121. x-go-name: AutoCreateProject
  1122. auto_create_user:
  1123. description: 当认证后用户不存在时是否自动创建用户
  1124. type: boolean
  1125. x-go-name: AutoCreateUser
  1126. description:
  1127. description: 资源描述
  1128. type: string
  1129. x-go-name: Description
  1130. icon_uri:
  1131. description: 图标URL
  1132. type: string
  1133. x-go-name: IconUri
  1134. name:
  1135. description: 资源名称
  1136. type: string
  1137. x-go-name: Name
  1138. progress:
  1139. format: float
  1140. type: number
  1141. x-go-name: Progress
  1142. sync_interval_seconds:
  1143. format: int64
  1144. type: integer
  1145. x-go-name: SyncIntervalSeconds
  1146. type: object
  1147. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1148. IdpResourceInfo:
  1149. properties:
  1150. idp:
  1151. description: 认证源名称
  1152. type: string
  1153. x-go-name: Idp
  1154. idp_driver:
  1155. description: 认证源类型, 例如sql, cas, ldap等
  1156. type: string
  1157. x-go-name: IdpDriver
  1158. idp_entity_id:
  1159. description: 该资源在认证源的原始ID
  1160. type: string
  1161. x-go-name: IdpEntityId
  1162. idp_id:
  1163. description: 认证源ID
  1164. type: string
  1165. x-go-name: IdpId
  1166. is_sso:
  1167. description: 是否是SSO登录方式
  1168. type: boolean
  1169. x-go-name: IsSso
  1170. template:
  1171. description: 认证源模板
  1172. type: string
  1173. x-go-name: Template
  1174. type: object
  1175. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1176. KeystoneDomainV3:
  1177. $ref: '#/definitions/SIdentityObject'
  1178. KeystoneEndpointV2:
  1179. properties:
  1180. admin_url:
  1181. description: 管理URL
  1182. type: string
  1183. x-go-name: AdminURL
  1184. id:
  1185. description: 接口ID
  1186. type: string
  1187. x-go-name: Id
  1188. internal_url:
  1189. description: 内部URL
  1190. type: string
  1191. x-go-name: InternalURL
  1192. public_url:
  1193. description: 外部URL
  1194. type: string
  1195. x-go-name: PublicURL
  1196. region:
  1197. description: 区域ID
  1198. type: string
  1199. x-go-name: Region
  1200. type: object
  1201. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1202. KeystoneEndpointV3:
  1203. properties:
  1204. id:
  1205. description: endpoint ID
  1206. example: 75f4e36100184a5a8a3e36cb0f12aa87
  1207. type: string
  1208. x-go-name: Id
  1209. interface:
  1210. description: |-
  1211. endpoint接口类型,目前定义了一下集中类型
  1212. interface | 说明 |
  1213. -----------|--------------------------------------------------------|
  1214. internal | 内部接口,访问服务时默认用inernal类型的接口 |
  1215. public | 外部接口 |
  1216. admin | 管理类型接口,deprecated |
  1217. console | web控制台接口,指定显示在web控制台的外部服务的接口地址 |
  1218. slave | 从节点接口,用于读取数据 |
  1219. type: string
  1220. x-go-name: Interface
  1221. name:
  1222. description: 接口名称
  1223. type: string
  1224. x-go-name: Name
  1225. region:
  1226. description: 区域名称
  1227. type: string
  1228. x-go-name: Region
  1229. region_id:
  1230. description: 区域ID
  1231. type: string
  1232. x-go-name: RegionId
  1233. url:
  1234. description: 接口URL
  1235. type: string
  1236. x-go-name: Url
  1237. type: object
  1238. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1239. KeystoneMetadataV2:
  1240. properties:
  1241. is_admin:
  1242. description: 是否为管理员
  1243. format: int64
  1244. type: integer
  1245. x-go-name: IsAdmin
  1246. roles:
  1247. description: 角色
  1248. items:
  1249. type: string
  1250. type: array
  1251. x-go-name: Roles
  1252. type: object
  1253. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1254. KeystonePolicy:
  1255. properties:
  1256. Domain:
  1257. description: 域范围的权限
  1258. items:
  1259. type: string
  1260. type: array
  1261. Project:
  1262. description: 项目范围的权限
  1263. items:
  1264. type: string
  1265. type: array
  1266. System:
  1267. description: 系统范围的权限
  1268. items:
  1269. type: string
  1270. type: array
  1271. type: object
  1272. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1273. KeystoneProjectV3:
  1274. properties:
  1275. Domain:
  1276. $ref: '#/definitions/KeystoneDomainV3'
  1277. Id:
  1278. description: 项目ID
  1279. type: string
  1280. Name:
  1281. description: 项目名称
  1282. type: string
  1283. type: object
  1284. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1285. KeystoneRoleV2:
  1286. properties:
  1287. id:
  1288. description: 角色ID
  1289. type: string
  1290. x-go-name: Id
  1291. name:
  1292. description: 角色名称
  1293. type: string
  1294. x-go-name: Name
  1295. type: object
  1296. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1297. KeystoneRoleV3:
  1298. $ref: '#/definitions/SIdentityObject'
  1299. KeystoneServiceCatalogV2:
  1300. items:
  1301. $ref: '#/definitions/KeystoneServiceV2'
  1302. type: array
  1303. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1304. KeystoneServiceCatalogV3:
  1305. items:
  1306. $ref: '#/definitions/KeystoneServiceV3'
  1307. type: array
  1308. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1309. KeystoneServiceV2:
  1310. properties:
  1311. endpoints:
  1312. description: 服务接口地址列表
  1313. items:
  1314. $ref: '#/definitions/KeystoneEndpointV2'
  1315. type: array
  1316. x-go-name: Endpoints
  1317. name:
  1318. description: 服务名称
  1319. type: string
  1320. x-go-name: Name
  1321. type:
  1322. description: 服务类型
  1323. type: string
  1324. x-go-name: Type
  1325. type: object
  1326. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1327. KeystoneServiceV3:
  1328. properties:
  1329. endpoints:
  1330. description: service的访问endpoints
  1331. items:
  1332. $ref: '#/definitions/KeystoneEndpointV3'
  1333. type: array
  1334. x-go-name: Endpoints
  1335. id:
  1336. description: service ID
  1337. type: string
  1338. x-go-name: Id
  1339. name:
  1340. description: service Name
  1341. type: string
  1342. x-go-name: Name
  1343. type:
  1344. description: service Type,例如identity, compute等
  1345. type: string
  1346. x-go-name: Type
  1347. type: object
  1348. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1349. KeystoneTenantV2:
  1350. properties:
  1351. description:
  1352. description: 描述
  1353. type: string
  1354. x-go-name: Description
  1355. domain:
  1356. description: 项目归属域信息
  1357. properties:
  1358. id:
  1359. description: 域ID
  1360. type: string
  1361. x-go-name: Id
  1362. name:
  1363. description: 域名称
  1364. type: string
  1365. x-go-name: Name
  1366. type: object
  1367. x-go-name: Domain
  1368. enabled:
  1369. description: 是否启用
  1370. type: boolean
  1371. x-go-name: Enabled
  1372. id:
  1373. description: 项目ID
  1374. type: string
  1375. x-go-name: Id
  1376. name:
  1377. description: 项目名称
  1378. type: string
  1379. x-go-name: Name
  1380. type: object
  1381. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1382. KeystoneTokenV2:
  1383. properties:
  1384. expires:
  1385. description: 过期时间(UTC)
  1386. format: date-time
  1387. type: string
  1388. x-go-name: Expires
  1389. id:
  1390. description: token
  1391. type: string
  1392. x-go-name: Id
  1393. tenant:
  1394. $ref: '#/definitions/KeystoneTenantV2'
  1395. type: object
  1396. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1397. KeystoneTokenV3:
  1398. properties:
  1399. access_key:
  1400. $ref: '#/definitions/SAccessKeySecretInfo'
  1401. catalog:
  1402. $ref: '#/definitions/KeystoneServiceCatalogV3'
  1403. context:
  1404. $ref: '#/definitions/SAuthContext'
  1405. expires_at:
  1406. description: token过期时间
  1407. format: date-time
  1408. type: string
  1409. x-go-name: ExpiresAt
  1410. is_domain:
  1411. description: 是否为域的token
  1412. type: boolean
  1413. x-go-name: IsDomain
  1414. issued_at:
  1415. description: token颁发时间
  1416. format: date-time
  1417. type: string
  1418. x-go-name: IssuedAt
  1419. methods:
  1420. description: 获取token的认证方式
  1421. items:
  1422. type: string
  1423. type: array
  1424. x-go-name: Methods
  1425. policies:
  1426. $ref: '#/definitions/KeystonePolicy'
  1427. project:
  1428. $ref: '#/definitions/KeystoneProjectV3'
  1429. projects:
  1430. description: 当用户认证时未指定scope时,会返回该用户所有的项目
  1431. items:
  1432. $ref: '#/definitions/KeystoneProjectV3'
  1433. type: array
  1434. x-go-name: Projects
  1435. role_assignments:
  1436. description: 返回用户在所有项目的所有角色信息
  1437. items:
  1438. $ref: '#/definitions/SRoleAssignment'
  1439. type: array
  1440. x-go-name: RoleAssignments
  1441. roles:
  1442. description: token的关联用户在关联项目的角色列表,只有项目scope的token才有这个属性
  1443. items:
  1444. $ref: '#/definitions/KeystoneRoleV3'
  1445. type: array
  1446. x-go-name: Roles
  1447. user:
  1448. $ref: '#/definitions/KeystoneUserV3'
  1449. type: object
  1450. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1451. KeystoneUserV2:
  1452. properties:
  1453. id:
  1454. description: 用户ID
  1455. type: string
  1456. x-go-name: Id
  1457. is_system_account:
  1458. type: boolean
  1459. x-go-name: IsSystemAccount
  1460. name:
  1461. description: 用户名
  1462. type: string
  1463. x-go-name: Name
  1464. roles:
  1465. description: 用户角色列表
  1466. items:
  1467. $ref: '#/definitions/KeystoneRoleV2'
  1468. type: array
  1469. x-go-name: Roles
  1470. username:
  1471. description: 用户username
  1472. type: string
  1473. x-go-name: Username
  1474. type: object
  1475. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1476. KeystoneUserV3:
  1477. properties:
  1478. Displayname:
  1479. description: 用户的显式名称,通常为中文名
  1480. type: string
  1481. Domain:
  1482. $ref: '#/definitions/KeystoneDomainV3'
  1483. Email:
  1484. description: 用户Email
  1485. type: string
  1486. Id:
  1487. description: 用户ID
  1488. type: string
  1489. IsSystemAccount:
  1490. description: 是否为系统账号
  1491. type: boolean
  1492. Mobile:
  1493. description: 用户手机号
  1494. type: string
  1495. Name:
  1496. description: 用户名称
  1497. type: string
  1498. PasswordExpiresAt:
  1499. description: 用户密码过期时间
  1500. format: date-time
  1501. type: string
  1502. type: object
  1503. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  1504. ModelBaseCreateInput:
  1505. type: object
  1506. x-go-package: yunion.io/x/onecloud/pkg/apis
  1507. ModelBaseDetails:
  1508. properties:
  1509. can_delete:
  1510. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1511. example: true
  1512. type: boolean
  1513. x-go-name: CanDelete
  1514. can_update:
  1515. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1516. example: true
  1517. type: boolean
  1518. x-go-name: CanUpdate
  1519. delete_fail_reason:
  1520. $ref: '#/definitions/Error'
  1521. update_fail_reason:
  1522. $ref: '#/definitions/Error'
  1523. type: object
  1524. x-go-package: yunion.io/x/onecloud/pkg/apis
  1525. ModelBaseUpdateInput:
  1526. type: object
  1527. x-go-package: yunion.io/x/onecloud/pkg/apis
  1528. OrganizationCreateInput:
  1529. properties:
  1530. __meta__:
  1531. additionalProperties:
  1532. type: string
  1533. description: 标签列表,最多支持20个
  1534. example:
  1535. user:rd: op
  1536. type: object
  1537. x-go-name: Metadata
  1538. description:
  1539. description: 资源描述
  1540. example: test create network
  1541. type: string
  1542. x-go-name: Description
  1543. dry_run:
  1544. default: false
  1545. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1546. type: boolean
  1547. x-go-name: DryRun
  1548. enabled:
  1549. type: boolean
  1550. x-go-name: Enabled
  1551. generate_name:
  1552. description: |-
  1553. 生成资源名称的模板,如果name为空,则为必填项
  1554. description: generated resource name, given a pattern to generate name, required if name is not given
  1555. example: test###
  1556. type: string
  1557. x-go-name: GenerateName
  1558. is_emulated:
  1559. description: |-
  1560. 资源是否为模拟资源
  1561. description: the resource is an emulated resource
  1562. type: boolean
  1563. x-go-name: IsEmulated
  1564. is_public:
  1565. description: 是否共享
  1566. type: boolean
  1567. x-go-name: IsPublic
  1568. key:
  1569. description: key
  1570. items:
  1571. type: string
  1572. type: array
  1573. x-go-name: Key
  1574. name:
  1575. description: |-
  1576. 资源名称,如果generate_name为空,则为必填项
  1577. description: resource name, required if generated_name is not given
  1578. example: test-network
  1579. type: string
  1580. uniqueItems: true
  1581. x-go-name: Name
  1582. project_domain_id:
  1583. description: 指定项目归属域名称或ID
  1584. type: string
  1585. x-go-name: ProjectDomainId
  1586. public_scope:
  1587. description: 共享范围
  1588. type: string
  1589. x-go-name: PublicScope
  1590. status:
  1591. description: 用来存储资源的状态
  1592. type: string
  1593. x-go-name: Status
  1594. type:
  1595. $ref: '#/definitions/TOrgType'
  1596. required:
  1597. - name
  1598. type: object
  1599. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1600. OrganizationNodePerformBindInput:
  1601. properties:
  1602. resource_type:
  1603. type: string
  1604. x-go-name: ResourceType
  1605. target_id:
  1606. items:
  1607. type: string
  1608. type: array
  1609. x-go-name: TargetId
  1610. type: object
  1611. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1612. OrganizationNodeUpdateInput:
  1613. properties:
  1614. description:
  1615. description: 资源描述
  1616. type: string
  1617. x-go-name: Description
  1618. name:
  1619. description: 资源名称
  1620. type: string
  1621. x-go-name: Name
  1622. weight:
  1623. format: int64
  1624. type: integer
  1625. x-go-name: Weight
  1626. type: object
  1627. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1628. OrganizationPerformAddLevelsInput:
  1629. properties:
  1630. description:
  1631. type: string
  1632. x-go-name: Description
  1633. key:
  1634. items:
  1635. type: string
  1636. type: array
  1637. x-go-name: Key
  1638. tags:
  1639. additionalProperties:
  1640. type: string
  1641. type: object
  1642. x-go-name: Tags
  1643. weight:
  1644. format: int64
  1645. type: integer
  1646. x-go-name: Weight
  1647. type: object
  1648. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1649. OrganizationPerformAddNodeInput:
  1650. properties:
  1651. description:
  1652. type: string
  1653. x-go-name: Description
  1654. tags:
  1655. additionalProperties:
  1656. type: string
  1657. type: object
  1658. x-go-name: Tags
  1659. weight:
  1660. format: int64
  1661. type: integer
  1662. x-go-name: Weight
  1663. type: object
  1664. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1665. OrganizationPerformCleanInput:
  1666. type: object
  1667. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1668. OrganizationPerformSyncInput:
  1669. properties:
  1670. reset:
  1671. type: boolean
  1672. x-go-name: Reset
  1673. resource_type:
  1674. type: string
  1675. x-go-name: ResourceType
  1676. type: object
  1677. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1678. OrganizationUpdateInput:
  1679. properties:
  1680. description:
  1681. description: 资源描述
  1682. type: string
  1683. x-go-name: Description
  1684. enabled:
  1685. description: 是否启用
  1686. type: boolean
  1687. x-go-name: Enabled
  1688. name:
  1689. description: 资源名称
  1690. type: string
  1691. x-go-name: Name
  1692. type: object
  1693. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1694. PerformConfigInput:
  1695. properties:
  1696. action:
  1697. description: 更新配置的方式
  1698. example: update
  1699. type: string
  1700. x-go-name: Action
  1701. config:
  1702. $ref: '#/definitions/TConfigs'
  1703. type: object
  1704. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1705. PerformDefaultSsoInput:
  1706. properties:
  1707. enable:
  1708. type: boolean
  1709. x-go-name: Enable
  1710. type: object
  1711. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1712. PerformDisableInput:
  1713. type: object
  1714. x-go-package: yunion.io/x/onecloud/pkg/apis
  1715. PerformEnableInput:
  1716. type: object
  1717. x-go-package: yunion.io/x/onecloud/pkg/apis
  1718. PerformGroupAddUsersInput:
  1719. properties:
  1720. user_ids:
  1721. description: 待添加用户列表(ID或名称)
  1722. items:
  1723. type: string
  1724. type: array
  1725. x-go-name: UserIds
  1726. type: object
  1727. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1728. PerformGroupRemoveUsersInput:
  1729. properties:
  1730. user_ids:
  1731. description: 待删除用户列表(ID或名称)
  1732. items:
  1733. type: string
  1734. type: array
  1735. x-go-name: UserIds
  1736. type: object
  1737. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1738. PerformPrivateInput:
  1739. type: object
  1740. x-go-package: yunion.io/x/onecloud/pkg/apis
  1741. PerformPublicDomainInput:
  1742. properties:
  1743. scope:
  1744. description: 共享项目资源的共享范围,可能的值为:project, domain和system
  1745. pattern: project|domain|system
  1746. type: string
  1747. x-go-name: Scope
  1748. shared_domain_ids:
  1749. description: 如果共享范围为域,则在此列表中指定共享的目标域
  1750. items:
  1751. type: string
  1752. type: array
  1753. x-go-name: SharedDomainIds
  1754. type: object
  1755. x-go-package: yunion.io/x/onecloud/pkg/apis
  1756. PolicyBindRoleInput:
  1757. properties:
  1758. ips:
  1759. description: IP白名单
  1760. items:
  1761. type: string
  1762. type: array
  1763. x-go-name: Ips
  1764. project_id:
  1765. description: 项目ID
  1766. type: string
  1767. x-go-name: ProjectId
  1768. role_id:
  1769. description: 角色ID
  1770. type: string
  1771. x-go-name: RoleId
  1772. valid_since:
  1773. description: 权限有效开始时间
  1774. format: date-time
  1775. type: string
  1776. x-go-name: ValidSince
  1777. valid_until:
  1778. description: 权限有效结束时间
  1779. format: date-time
  1780. type: string
  1781. x-go-name: ValidUntil
  1782. type: object
  1783. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1784. PolicyCreateInput:
  1785. properties:
  1786. __meta__:
  1787. additionalProperties:
  1788. type: string
  1789. description: 标签列表,最多支持20个
  1790. example:
  1791. user:rd: op
  1792. type: object
  1793. x-go-name: Metadata
  1794. blob:
  1795. description: policy
  1796. type: object
  1797. x-go-name: Blob
  1798. description:
  1799. description: 资源描述
  1800. example: test create network
  1801. type: string
  1802. x-go-name: Description
  1803. domain_tags:
  1804. $ref: '#/definitions/TTagSet'
  1805. dry_run:
  1806. default: false
  1807. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1808. type: boolean
  1809. x-go-name: DryRun
  1810. enabled:
  1811. type: boolean
  1812. x-go-name: Enabled
  1813. generate_name:
  1814. description: |-
  1815. 生成资源名称的模板,如果name为空,则为必填项
  1816. description: generated resource name, given a pattern to generate name, required if name is not given
  1817. example: test###
  1818. type: string
  1819. x-go-name: GenerateName
  1820. is_emulated:
  1821. description: |-
  1822. 资源是否为模拟资源
  1823. description: the resource is an emulated resource
  1824. type: boolean
  1825. x-go-name: IsEmulated
  1826. is_public:
  1827. description: 是否共享
  1828. type: boolean
  1829. x-go-name: IsPublic
  1830. is_system:
  1831. description: 是否为系统权限
  1832. type: boolean
  1833. x-go-name: IsSystem
  1834. name:
  1835. description: |-
  1836. 资源名称,如果generate_name为空,则为必填项
  1837. description: resource name, required if generated_name is not given
  1838. example: test-network
  1839. type: string
  1840. uniqueItems: true
  1841. x-go-name: Name
  1842. object_tags:
  1843. $ref: '#/definitions/TTagSet'
  1844. org_node_id:
  1845. description: 组织架构节点ID
  1846. items:
  1847. type: string
  1848. type: array
  1849. x-go-name: OrgNodeId
  1850. project_domain_id:
  1851. description: 指定项目归属域名称或ID
  1852. type: string
  1853. x-go-name: ProjectDomainId
  1854. project_tags:
  1855. $ref: '#/definitions/TTagSet'
  1856. public_scope:
  1857. description: 共享范围
  1858. type: string
  1859. x-go-name: PublicScope
  1860. scope:
  1861. $ref: '#/definitions/TRbacScope'
  1862. required:
  1863. - name
  1864. type: object
  1865. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  1866. PolicyDetails:
  1867. properties:
  1868. blob:
  1869. description: 权限定义
  1870. type: object
  1871. x-go-name: Blob
  1872. can_delete:
  1873. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1874. example: true
  1875. type: boolean
  1876. x-go-name: CanDelete
  1877. can_update:
  1878. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1879. example: true
  1880. type: boolean
  1881. x-go-name: CanUpdate
  1882. created_at:
  1883. description: 资源创建时间
  1884. format: date-time
  1885. type: string
  1886. x-go-name: CreatedAt
  1887. delete_fail_reason:
  1888. $ref: '#/definitions/Error'
  1889. deleted:
  1890. description: 资源是否被删除
  1891. type: boolean
  1892. x-go-name: Deleted
  1893. deleted_at:
  1894. description: 资源删除时间
  1895. format: date-time
  1896. type: string
  1897. x-go-name: DeletedAt
  1898. description:
  1899. description: 资源描述信息
  1900. type: string
  1901. x-go-name: Description
  1902. domain_id:
  1903. description: 域Id
  1904. type: string
  1905. x-go-name: DomainId
  1906. domain_tags:
  1907. description: 匹配的域标签
  1908. items:
  1909. $ref: '#/definitions/STag'
  1910. type: array
  1911. x-go-name: DomainTags
  1912. enabled:
  1913. description: 资源是否启用
  1914. type: boolean
  1915. x-go-name: Enabled
  1916. extra:
  1917. description: 额外信息
  1918. type: object
  1919. x-go-name: Extra
  1920. id:
  1921. description: 资源UUID
  1922. type: string
  1923. x-go-name: Id
  1924. is_emulated:
  1925. description: |-
  1926. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1927. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1928. type: boolean
  1929. x-go-name: IsEmulated
  1930. is_public:
  1931. description: 是否共享
  1932. type: boolean
  1933. x-go-name: IsPublic
  1934. is_system:
  1935. description: 是否为系统权限
  1936. type: boolean
  1937. x-go-name: IsSystem
  1938. metadata:
  1939. additionalProperties:
  1940. type: string
  1941. description: 标签
  1942. type: object
  1943. x-go-name: Metadata
  1944. name:
  1945. description: 资源名称
  1946. type: string
  1947. x-go-name: Name
  1948. object_tags:
  1949. description: 匹配的资源标签
  1950. items:
  1951. $ref: '#/definitions/STag'
  1952. type: array
  1953. x-go-name: ObjectTags
  1954. org_node_id:
  1955. description: 匹配的组织架构节点
  1956. items:
  1957. type: string
  1958. type: array
  1959. x-go-name: OrgNodeId
  1960. org_node_md5:
  1961. description: 用以组织架构变更通知其他服务权限变更
  1962. type: string
  1963. x-go-name: OrgNodeMd5
  1964. org_nodes:
  1965. items:
  1966. $ref: '#/definitions/SOrganizationNodeInfo'
  1967. type: array
  1968. x-go-name: OrgNodes
  1969. pending_deleted:
  1970. description: 资源是否处于回收站中
  1971. type: boolean
  1972. x-go-name: PendingDeleted
  1973. pending_deleted_at:
  1974. description: 资源放入回收站时间
  1975. format: date-time
  1976. type: string
  1977. x-go-name: PendingDeletedAt
  1978. project_domain:
  1979. description: 资源归属项目的域名称
  1980. type: string
  1981. x-go-name: ProjectDomain
  1982. project_tags:
  1983. description: 匹配的项目标签
  1984. items:
  1985. $ref: '#/definitions/STag'
  1986. type: array
  1987. x-go-name: ProjectTags
  1988. public_scope:
  1989. description: 默认共享范围
  1990. type: string
  1991. x-go-name: PublicScope
  1992. public_src:
  1993. description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
  1994. example: local
  1995. type: string
  1996. x-go-name: PublicSrc
  1997. scope:
  1998. description: 权限范围
  1999. type: string
  2000. x-go-name: Scope
  2001. shared_domains:
  2002. description: 共享的域列表
  2003. items:
  2004. $ref: '#/definitions/SharedDomain'
  2005. type: array
  2006. x-go-name: SharedDomains
  2007. shared_projects:
  2008. description: 共享的项目列表
  2009. items:
  2010. $ref: '#/definitions/SharedProject'
  2011. type: array
  2012. x-go-name: SharedProjects
  2013. update_fail_reason:
  2014. $ref: '#/definitions/Error'
  2015. update_version:
  2016. description: 资源被更新次数
  2017. format: int64
  2018. type: integer
  2019. x-go-name: UpdateVersion
  2020. updated_at:
  2021. description: 资源更新时间
  2022. format: date-time
  2023. type: string
  2024. x-go-name: UpdatedAt
  2025. type: object
  2026. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2027. PolicyUpdateInput:
  2028. properties:
  2029. blob:
  2030. description: Policy内容
  2031. type: object
  2032. x-go-name: Blob
  2033. description:
  2034. description: 资源描述
  2035. type: string
  2036. x-go-name: Description
  2037. domain_tags:
  2038. $ref: '#/definitions/TTagSet'
  2039. enabled:
  2040. description: 是否启用
  2041. type: boolean
  2042. x-go-name: Enabled
  2043. is_system:
  2044. description: 是否为系统权限
  2045. type: boolean
  2046. x-go-name: IsSystem
  2047. name:
  2048. description: 资源名称
  2049. type: string
  2050. x-go-name: Name
  2051. object_tags:
  2052. $ref: '#/definitions/TTagSet'
  2053. org_node_id:
  2054. description: 组织架构节点ID
  2055. items:
  2056. type: string
  2057. type: array
  2058. x-go-name: OrgNodeId
  2059. project_tags:
  2060. $ref: '#/definitions/TTagSet'
  2061. scope:
  2062. $ref: '#/definitions/TRbacScope'
  2063. tag_update_policy:
  2064. description: Policy tag更新策略,可能的值为:add|remove|remove,默认为add
  2065. type: string
  2066. x-go-name: TagUpdatePolicy
  2067. type: object
  2068. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2069. ProjectCleanInput:
  2070. type: object
  2071. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2072. ProjectCreateInput:
  2073. properties:
  2074. __meta__:
  2075. additionalProperties:
  2076. type: string
  2077. description: 标签列表,最多支持20个
  2078. example:
  2079. user:rd: op
  2080. type: object
  2081. x-go-name: Metadata
  2082. description:
  2083. description: 资源描述
  2084. example: test create network
  2085. type: string
  2086. x-go-name: Description
  2087. displayname:
  2088. description: 显示名称
  2089. type: string
  2090. x-go-name: Displayname
  2091. dry_run:
  2092. default: false
  2093. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  2094. type: boolean
  2095. x-go-name: DryRun
  2096. generate_name:
  2097. description: |-
  2098. 生成资源名称的模板,如果name为空,则为必填项
  2099. description: generated resource name, given a pattern to generate name, required if name is not given
  2100. example: test###
  2101. type: string
  2102. x-go-name: GenerateName
  2103. is_emulated:
  2104. description: |-
  2105. 资源是否为模拟资源
  2106. description: the resource is an emulated resource
  2107. type: boolean
  2108. x-go-name: IsEmulated
  2109. name:
  2110. description: |-
  2111. 资源名称,如果generate_name为空,则为必填项
  2112. description: resource name, required if generated_name is not given
  2113. example: test-network
  2114. type: string
  2115. uniqueItems: true
  2116. x-go-name: Name
  2117. project_domain_id:
  2118. description: 指定项目归属域名称或ID
  2119. type: string
  2120. x-go-name: ProjectDomainId
  2121. required:
  2122. - name
  2123. type: object
  2124. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2125. ProjectDetails:
  2126. properties:
  2127. Organization:
  2128. $ref: '#/definitions/SProjectOrganization'
  2129. admin:
  2130. description: 项目管理员名称
  2131. type: string
  2132. x-go-name: Admin
  2133. admin_domain:
  2134. description: 项目管理员域名称
  2135. type: string
  2136. x-go-name: AdminDomain
  2137. admin_domain_id:
  2138. description: 项目管理员域ID
  2139. type: string
  2140. x-go-name: AdminDomainId
  2141. admin_id:
  2142. type: string
  2143. x-go-name: AdminId
  2144. can_delete:
  2145. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  2146. example: true
  2147. type: boolean
  2148. x-go-name: CanDelete
  2149. can_update:
  2150. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  2151. example: true
  2152. type: boolean
  2153. x-go-name: CanUpdate
  2154. created_at:
  2155. description: 资源创建时间
  2156. format: date-time
  2157. type: string
  2158. x-go-name: CreatedAt
  2159. delete_fail_reason:
  2160. $ref: '#/definitions/Error'
  2161. deleted:
  2162. description: 资源是否被删除
  2163. type: boolean
  2164. x-go-name: Deleted
  2165. deleted_at:
  2166. description: 资源删除时间
  2167. format: date-time
  2168. type: string
  2169. x-go-name: DeletedAt
  2170. description:
  2171. description: 资源描述信息
  2172. type: string
  2173. x-go-name: Description
  2174. domain_id:
  2175. description: 域Id
  2176. type: string
  2177. x-go-name: DomainId
  2178. ext_resource:
  2179. additionalProperties:
  2180. format: int64
  2181. type: integer
  2182. description: 外部资源统计信息(资源类别:数量)
  2183. type: object
  2184. x-go-name: ExtResource
  2185. ext_resources_last_update:
  2186. description: 外部资源统计信息上次更新时间
  2187. format: date-time
  2188. type: string
  2189. x-go-name: ExtResourcesLastUpdate
  2190. ext_resources_next_update:
  2191. description: 外部资源统计信息下次更新时间
  2192. format: date-time
  2193. type: string
  2194. x-go-name: ExtResourcesNextUpdate
  2195. extra:
  2196. description: 额外信息
  2197. type: object
  2198. x-go-name: Extra
  2199. group_count:
  2200. description: 加入项目的用户组数量
  2201. format: int64
  2202. type: integer
  2203. x-go-name: GroupCount
  2204. id:
  2205. description: 资源UUID
  2206. type: string
  2207. x-go-name: Id
  2208. is_domain:
  2209. description: 该项目是否为域(domain)
  2210. type: boolean
  2211. x-go-name: IsDomain
  2212. is_emulated:
  2213. description: |-
  2214. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  2215. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  2216. type: boolean
  2217. x-go-name: IsEmulated
  2218. metadata:
  2219. additionalProperties:
  2220. type: string
  2221. description: 标签
  2222. type: object
  2223. x-go-name: Metadata
  2224. name:
  2225. description: 资源名称
  2226. type: string
  2227. x-go-name: Name
  2228. org_node_md5:
  2229. description: 用以组织架构变更通知其他服务权限变更
  2230. type: string
  2231. x-go-name: OrgNodeMd5
  2232. parent_id:
  2233. description: 上级项目或域的ID
  2234. type: string
  2235. x-go-name: ParentId
  2236. pending_deleted:
  2237. description: 资源是否处于回收站中
  2238. type: boolean
  2239. x-go-name: PendingDeleted
  2240. pending_deleted_at:
  2241. description: 资源放入回收站时间
  2242. format: date-time
  2243. type: string
  2244. x-go-name: PendingDeletedAt
  2245. project_domain:
  2246. description: 资源归属项目的域名称
  2247. type: string
  2248. x-go-name: ProjectDomain
  2249. update_fail_reason:
  2250. $ref: '#/definitions/Error'
  2251. update_version:
  2252. description: 资源被更新次数
  2253. format: int64
  2254. type: integer
  2255. x-go-name: UpdateVersion
  2256. updated_at:
  2257. description: 资源更新时间
  2258. format: date-time
  2259. type: string
  2260. x-go-name: UpdatedAt
  2261. user_count:
  2262. description: 加入项目的用户数量
  2263. format: int64
  2264. type: integer
  2265. x-go-name: UserCount
  2266. type: object
  2267. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2268. ProjectUpdateInput:
  2269. properties:
  2270. description:
  2271. description: 资源描述
  2272. type: string
  2273. x-go-name: Description
  2274. displayname:
  2275. description: 显示名称
  2276. type: string
  2277. x-go-name: Displayname
  2278. name:
  2279. description: 资源名称
  2280. type: string
  2281. x-go-name: Name
  2282. type: object
  2283. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2284. RegionDetails:
  2285. properties:
  2286. can_delete:
  2287. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  2288. example: true
  2289. type: boolean
  2290. x-go-name: CanDelete
  2291. can_update:
  2292. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  2293. example: true
  2294. type: boolean
  2295. x-go-name: CanUpdate
  2296. created_at:
  2297. description: 资源创建时间
  2298. format: date-time
  2299. type: string
  2300. x-go-name: CreatedAt
  2301. delete_fail_reason:
  2302. $ref: '#/definitions/Error'
  2303. deleted:
  2304. description: 资源是否被删除
  2305. type: boolean
  2306. x-go-name: Deleted
  2307. deleted_at:
  2308. description: 资源删除时间
  2309. format: date-time
  2310. type: string
  2311. x-go-name: DeletedAt
  2312. description:
  2313. description: 资源描述信息
  2314. type: string
  2315. x-go-name: Description
  2316. endpoint_count:
  2317. format: int64
  2318. type: integer
  2319. x-go-name: EndpointCount
  2320. extra:
  2321. type: object
  2322. x-go-name: Extra
  2323. id:
  2324. description: 资源UUID
  2325. type: string
  2326. x-go-name: Id
  2327. is_emulated:
  2328. description: |-
  2329. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  2330. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  2331. type: boolean
  2332. x-go-name: IsEmulated
  2333. metadata:
  2334. additionalProperties:
  2335. type: string
  2336. description: 标签
  2337. type: object
  2338. x-go-name: Metadata
  2339. name:
  2340. description: 资源名称
  2341. type: string
  2342. x-go-name: Name
  2343. org_node_md5:
  2344. description: 用以组织架构变更通知其他服务权限变更
  2345. type: string
  2346. x-go-name: OrgNodeMd5
  2347. parent_region_id:
  2348. type: string
  2349. x-go-name: ParentRegionId
  2350. update_fail_reason:
  2351. $ref: '#/definitions/Error'
  2352. update_version:
  2353. description: 资源被更新次数
  2354. format: int64
  2355. type: integer
  2356. x-go-name: UpdateVersion
  2357. updated_at:
  2358. description: 资源更新时间
  2359. format: date-time
  2360. type: string
  2361. x-go-name: UpdatedAt
  2362. type: object
  2363. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2364. ResetCredentialInput:
  2365. properties:
  2366. type:
  2367. description: 密钥的类型
  2368. type: string
  2369. x-go-name: Type
  2370. type: object
  2371. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2372. ResourceBaseCreateInput:
  2373. type: object
  2374. x-go-package: yunion.io/x/onecloud/pkg/apis
  2375. ResourceBaseUpdateInput:
  2376. type: object
  2377. x-go-package: yunion.io/x/onecloud/pkg/apis
  2378. RoleCreateInput:
  2379. properties:
  2380. __meta__:
  2381. additionalProperties:
  2382. type: string
  2383. description: 标签列表,最多支持20个
  2384. example:
  2385. user:rd: op
  2386. type: object
  2387. x-go-name: Metadata
  2388. description:
  2389. description: 资源描述
  2390. example: test create network
  2391. type: string
  2392. x-go-name: Description
  2393. dry_run:
  2394. default: false
  2395. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  2396. type: boolean
  2397. x-go-name: DryRun
  2398. generate_name:
  2399. description: |-
  2400. 生成资源名称的模板,如果name为空,则为必填项
  2401. description: generated resource name, given a pattern to generate name, required if name is not given
  2402. example: test###
  2403. type: string
  2404. x-go-name: GenerateName
  2405. is_emulated:
  2406. description: |-
  2407. 资源是否为模拟资源
  2408. description: the resource is an emulated resource
  2409. type: boolean
  2410. x-go-name: IsEmulated
  2411. is_public:
  2412. description: 是否共享
  2413. type: boolean
  2414. x-go-name: IsPublic
  2415. name:
  2416. description: |-
  2417. 资源名称,如果generate_name为空,则为必填项
  2418. description: resource name, required if generated_name is not given
  2419. example: test-network
  2420. type: string
  2421. uniqueItems: true
  2422. x-go-name: Name
  2423. project_domain_id:
  2424. description: 指定项目归属域名称或ID
  2425. type: string
  2426. x-go-name: ProjectDomainId
  2427. public_scope:
  2428. description: 共享范围
  2429. type: string
  2430. x-go-name: PublicScope
  2431. required:
  2432. - name
  2433. type: object
  2434. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2435. RoleDetails:
  2436. properties:
  2437. can_delete:
  2438. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  2439. example: true
  2440. type: boolean
  2441. x-go-name: CanDelete
  2442. can_update:
  2443. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  2444. example: true
  2445. type: boolean
  2446. x-go-name: CanUpdate
  2447. created_at:
  2448. description: 资源创建时间
  2449. format: date-time
  2450. type: string
  2451. x-go-name: CreatedAt
  2452. delete_fail_reason:
  2453. $ref: '#/definitions/Error'
  2454. deleted:
  2455. description: 资源是否被删除
  2456. type: boolean
  2457. x-go-name: Deleted
  2458. deleted_at:
  2459. description: 资源删除时间
  2460. format: date-time
  2461. type: string
  2462. x-go-name: DeletedAt
  2463. description:
  2464. description: 资源描述信息
  2465. type: string
  2466. x-go-name: Description
  2467. domain_id:
  2468. description: 域Id
  2469. type: string
  2470. x-go-name: DomainId
  2471. extra:
  2472. description: 额外信息
  2473. type: object
  2474. x-go-name: Extra
  2475. group_count:
  2476. description: 具有该角色的用户组数量
  2477. format: int64
  2478. type: integer
  2479. x-go-name: GroupCount
  2480. id:
  2481. description: 资源UUID
  2482. type: string
  2483. x-go-name: Id
  2484. is_emulated:
  2485. description: |-
  2486. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  2487. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  2488. type: boolean
  2489. x-go-name: IsEmulated
  2490. is_public:
  2491. description: 是否共享
  2492. type: boolean
  2493. x-go-name: IsPublic
  2494. match_policies:
  2495. description: 该角色匹配的权限的名称列表
  2496. items:
  2497. type: string
  2498. type: array
  2499. x-go-name: MatchPolicies
  2500. metadata:
  2501. additionalProperties:
  2502. type: string
  2503. description: 标签
  2504. type: object
  2505. x-go-name: Metadata
  2506. name:
  2507. description: 资源名称
  2508. type: string
  2509. x-go-name: Name
  2510. org_node_md5:
  2511. description: 用以组织架构变更通知其他服务权限变更
  2512. type: string
  2513. x-go-name: OrgNodeMd5
  2514. pending_deleted:
  2515. description: 资源是否处于回收站中
  2516. type: boolean
  2517. x-go-name: PendingDeleted
  2518. pending_deleted_at:
  2519. description: 资源放入回收站时间
  2520. format: date-time
  2521. type: string
  2522. x-go-name: PendingDeletedAt
  2523. policies:
  2524. additionalProperties:
  2525. items:
  2526. type: string
  2527. type: array
  2528. description: 不同级别的权限的名称列表
  2529. type: object
  2530. x-go-name: Policies
  2531. project_count:
  2532. description: 有该角色的用户或组的项目的数量
  2533. format: int64
  2534. type: integer
  2535. x-go-name: ProjectCount
  2536. project_domain:
  2537. description: 资源归属项目的域名称
  2538. type: string
  2539. x-go-name: ProjectDomain
  2540. public_scope:
  2541. description: 默认共享范围
  2542. type: string
  2543. x-go-name: PublicScope
  2544. public_src:
  2545. description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
  2546. example: local
  2547. type: string
  2548. x-go-name: PublicSrc
  2549. shared_domains:
  2550. description: 共享的域列表
  2551. items:
  2552. $ref: '#/definitions/SharedDomain'
  2553. type: array
  2554. x-go-name: SharedDomains
  2555. shared_projects:
  2556. description: 共享的项目列表
  2557. items:
  2558. $ref: '#/definitions/SharedProject'
  2559. type: array
  2560. x-go-name: SharedProjects
  2561. update_fail_reason:
  2562. $ref: '#/definitions/Error'
  2563. update_version:
  2564. description: 资源被更新次数
  2565. format: int64
  2566. type: integer
  2567. x-go-name: UpdateVersion
  2568. updated_at:
  2569. description: 资源更新时间
  2570. format: date-time
  2571. type: string
  2572. x-go-name: UpdatedAt
  2573. user_count:
  2574. description: 具有该角色的用户数量
  2575. format: int64
  2576. type: integer
  2577. x-go-name: UserCount
  2578. type: object
  2579. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2580. RolePerformAddPolicyInput:
  2581. properties:
  2582. ips:
  2583. items:
  2584. type: string
  2585. type: array
  2586. x-go-name: Ips
  2587. policy_id:
  2588. type: string
  2589. x-go-name: PolicyId
  2590. project_id:
  2591. type: string
  2592. x-go-name: ProjectId
  2593. valid_since:
  2594. format: date-time
  2595. type: string
  2596. x-go-name: ValidSince
  2597. valid_until:
  2598. format: date-time
  2599. type: string
  2600. x-go-name: ValidUntil
  2601. type: object
  2602. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2603. RolePerformRemovePolicyInput:
  2604. properties:
  2605. policy_id:
  2606. type: string
  2607. x-go-name: PolicyId
  2608. project_id:
  2609. type: string
  2610. x-go-name: ProjectId
  2611. type: object
  2612. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2613. RolePerformSetPoliciesInput:
  2614. properties:
  2615. action:
  2616. description: 操作:replace|update, 默认为replace
  2617. type: string
  2618. x-go-name: Action
  2619. policies:
  2620. description: 权限列表
  2621. items:
  2622. $ref: '#/definitions/RolePerformAddPolicyInput'
  2623. type: array
  2624. x-go-name: Policies
  2625. type: object
  2626. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2627. RolePolicyDetails:
  2628. properties:
  2629. auth:
  2630. description: 是否需要认证
  2631. type: boolean
  2632. x-go-name: Auth
  2633. can_delete:
  2634. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  2635. example: true
  2636. type: boolean
  2637. x-go-name: CanDelete
  2638. can_update:
  2639. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  2640. example: true
  2641. type: boolean
  2642. x-go-name: CanUpdate
  2643. created_at:
  2644. description: 资源创建时间
  2645. format: date-time
  2646. type: string
  2647. x-go-name: CreatedAt
  2648. delete_fail_reason:
  2649. $ref: '#/definitions/Error'
  2650. deleted:
  2651. description: 资源是否被删除
  2652. type: boolean
  2653. x-go-name: Deleted
  2654. deleted_at:
  2655. description: 资源删除时间
  2656. format: date-time
  2657. type: string
  2658. x-go-name: DeletedAt
  2659. description:
  2660. type: string
  2661. x-go-name: Description
  2662. id:
  2663. type: string
  2664. x-go-name: Id
  2665. ips:
  2666. description: 匹配的IP白名单
  2667. type: string
  2668. x-go-name: Ips
  2669. name:
  2670. type: string
  2671. x-go-name: Name
  2672. policy:
  2673. type: string
  2674. x-go-name: Policy
  2675. policy_id:
  2676. description: 权限ID, 主键
  2677. type: string
  2678. x-go-name: PolicyId
  2679. project:
  2680. type: string
  2681. x-go-name: Project
  2682. project_id:
  2683. description: 项目ID,主键
  2684. type: string
  2685. x-go-name: ProjectId
  2686. role:
  2687. type: string
  2688. x-go-name: Role
  2689. role_id:
  2690. description: 角色ID, 主键
  2691. type: string
  2692. x-go-name: RoleId
  2693. scope:
  2694. $ref: '#/definitions/TRbacScope'
  2695. update_fail_reason:
  2696. $ref: '#/definitions/Error'
  2697. update_version:
  2698. description: 资源被更新次数
  2699. format: int64
  2700. type: integer
  2701. x-go-name: UpdateVersion
  2702. updated_at:
  2703. description: 资源更新时间
  2704. format: date-time
  2705. type: string
  2706. x-go-name: UpdatedAt
  2707. valid_since:
  2708. description: 匹配开始时间
  2709. format: date-time
  2710. type: string
  2711. x-go-name: ValidSince
  2712. valid_until:
  2713. description: 匹配结束时间
  2714. format: date-time
  2715. type: string
  2716. x-go-name: ValidUntil
  2717. type: object
  2718. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2719. RoleUpdateInput:
  2720. properties:
  2721. description:
  2722. description: 资源描述
  2723. type: string
  2724. x-go-name: Description
  2725. name:
  2726. description: 资源名称
  2727. type: string
  2728. x-go-name: Name
  2729. type: object
  2730. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2731. SAccessKeySecretInfo:
  2732. properties:
  2733. access_key:
  2734. type: string
  2735. x-go-name: AccessKey
  2736. expire:
  2737. format: int64
  2738. type: integer
  2739. x-go-name: Expire
  2740. secret:
  2741. type: string
  2742. x-go-name: Secret
  2743. type: object
  2744. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  2745. SAuthContext:
  2746. properties:
  2747. ip:
  2748. description: 认证来源IP
  2749. type: string
  2750. x-go-name: Ip
  2751. source:
  2752. description: |-
  2753. 认证来源类型, 可能的值有:
  2754. source | 说明 |
  2755. ----------|---------------------------|
  2756. web | 通过web控制台认证 |
  2757. api | api调用认证 |
  2758. cli | climc客户端认证 |
  2759. srv | 作为服务认证 |
  2760. operator | 作为onecloud-operator认证 |
  2761. type: string
  2762. x-go-name: Source
  2763. type: object
  2764. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  2765. SAuthenticateV2ResponseBody:
  2766. properties:
  2767. access:
  2768. $ref: '#/definitions/TokenCredentialV2'
  2769. type: object
  2770. x-go-package: yunion.io/x/onecloud/pkg/keystone/tokens
  2771. SAuthenticationIdentity:
  2772. properties:
  2773. access_key_secret:
  2774. description: |-
  2775. 当认证方式为aksk时,通过该字段提供客户端AK/SK信息
  2776. 为了兼容不同版本的AK/SK认证方式,使用编码后的字符串传递该信息
  2777. type: string
  2778. x-go-name: AccessKeyRequest
  2779. assume:
  2780. description: 当认证方式为assume时,通过该字段提供目标用户信息
  2781. properties:
  2782. user:
  2783. properties:
  2784. domain:
  2785. description: 用户所属域的信息
  2786. properties:
  2787. id:
  2788. description: 域ID
  2789. type: string
  2790. x-go-name: Id
  2791. name:
  2792. description: 域名称
  2793. type: string
  2794. x-go-name: Name
  2795. type: object
  2796. x-go-name: Domain
  2797. id:
  2798. description: 用户ID
  2799. type: string
  2800. x-go-name: Id
  2801. name:
  2802. description: 用户名称
  2803. type: string
  2804. x-go-name: Name
  2805. type: object
  2806. x-go-name: User
  2807. type: object
  2808. x-go-name: Assume
  2809. cas_ticket:
  2810. description: 当认证方式为cas时,通过该字段提供CAS认证的ID
  2811. properties:
  2812. id:
  2813. type: string
  2814. x-go-name: Id
  2815. service:
  2816. type: string
  2817. x-go-name: Service
  2818. type: object
  2819. x-go-name: CASTicket
  2820. id:
  2821. description: ID of identity provider, optional
  2822. type: string
  2823. x-go-name: Id
  2824. methods:
  2825. description: |-
  2826. 认证方式列表,支持认证方式如下:
  2827. method | 说明 |
  2828. ----------|--------------------------------------------------------------------|
  2829. password | 用户名密码认证 |
  2830. token | token认证,已经通过其他方式获得token之后,可以用旧的token认证获得新的token |
  2831. aksk | Access Key/Secret key认证 |
  2832. cas | 通过SSO统一认证平台CAS认证 |
  2833. saml | 作为SAML 2.0 SP通过IDP认证 |
  2834. oidc | 作为OpenID Connect/OAuth2 Client认证 |
  2835. oauth2 | OAuth2认证 |
  2836. verify | 手机短信或邮箱认证 |
  2837. items:
  2838. type: string
  2839. type: array
  2840. x-go-name: Methods
  2841. mobile:
  2842. properties:
  2843. contact_type:
  2844. type: string
  2845. x-go-name: ContactType
  2846. uid:
  2847. type: string
  2848. x-go-name: Uid
  2849. verify_code:
  2850. type: string
  2851. x-go-name: VerifyCode
  2852. type: object
  2853. x-go-name: Verify
  2854. oauth2:
  2855. properties:
  2856. code:
  2857. type: string
  2858. x-go-name: Code
  2859. type: object
  2860. x-go-name: OAuth2
  2861. oidc_auth:
  2862. properties:
  2863. code:
  2864. type: string
  2865. x-go-name: Code
  2866. redirect_uri:
  2867. type: string
  2868. x-go-name: RedirectUri
  2869. type: object
  2870. x-go-name: OIDCAuth
  2871. password:
  2872. description: 当认证方式为password时,通过该字段提供密码认证信息
  2873. properties:
  2874. user:
  2875. properties:
  2876. Domain:
  2877. description: 用户所属域的信息
  2878. properties:
  2879. id:
  2880. description: 域ID
  2881. type: string
  2882. x-go-name: Id
  2883. name:
  2884. description: 域名称
  2885. type: string
  2886. x-go-name: Name
  2887. type: object
  2888. id:
  2889. description: 用户ID
  2890. type: string
  2891. x-go-name: Id
  2892. name:
  2893. description: 用户名称
  2894. type: string
  2895. x-go-name: Name
  2896. password:
  2897. description: 密码
  2898. type: string
  2899. x-go-name: Password
  2900. type: object
  2901. x-go-name: User
  2902. type: object
  2903. x-go-name: Password
  2904. saml_auth:
  2905. description: 当认证方式为saml时,通过该字段提供SAML认证的Response信息
  2906. properties:
  2907. response:
  2908. type: string
  2909. x-go-name: Response
  2910. type: object
  2911. x-go-name: SAMLAuth
  2912. token:
  2913. description: 当认证方式为token时,通过该字段提供token认证信息
  2914. properties:
  2915. id:
  2916. description: token
  2917. type: string
  2918. x-go-name: Id
  2919. type: object
  2920. x-go-name: Token
  2921. type: object
  2922. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  2923. SAuthenticationInputV2:
  2924. properties:
  2925. auth:
  2926. description: keystone v2 认证接口认证信息
  2927. properties:
  2928. context:
  2929. $ref: '#/definitions/SAuthContext'
  2930. passwordCredentials:
  2931. description: 如果使用用户名/密码认证,则需要设置passwordCredentials
  2932. properties:
  2933. password:
  2934. description: 用户密码
  2935. type: string
  2936. x-go-name: Password
  2937. username:
  2938. description: 用户名
  2939. type: string
  2940. x-go-name: Username
  2941. type: object
  2942. x-go-name: PasswordCredentials
  2943. tenantId:
  2944. description: 指定认证用户的所属项目ID,该字段和tenantName二选一,或者不设置。
  2945. type: string
  2946. x-go-name: TenantId
  2947. tenantName:
  2948. description: |-
  2949. 指定认证用户的所属项目名称,该字段和tenantId二选一,或者不设置。
  2950. 如果不提供tenantName和tenantId,则用户认证成功后,获得一个unscoped token
  2951. 此时,如果用户需要访问具体项目的资源,还是需要用unscoped token进行认证,获得指定项目的token
  2952. type: string
  2953. x-go-name: TenantName
  2954. token:
  2955. description: 如果使用token认证,则需要设置token.Id
  2956. properties:
  2957. id:
  2958. description: token的字符串
  2959. type: string
  2960. x-go-name: Id
  2961. type: object
  2962. x-go-name: Token
  2963. type: object
  2964. x-go-name: Auth
  2965. required:
  2966. - auth
  2967. type: object
  2968. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  2969. SAuthenticationInputV3:
  2970. properties:
  2971. auth:
  2972. description: keystone v3 认证接口认证信息
  2973. properties:
  2974. context:
  2975. $ref: '#/definitions/SAuthContext'
  2976. identity:
  2977. $ref: '#/definitions/SAuthenticationIdentity'
  2978. scope:
  2979. description: |-
  2980. 指定认证范围, 该字段可选。如果未指定scope,则用户认证成功后获得一个unscoped token,
  2981. 当用户需要访问指定项目的资源时,需要通过该unscope token进行认证,获得该项目scope的token
  2982. 目前只支持Project scope的token
  2983. properties:
  2984. domain:
  2985. description: 指定token的scope为指定的域
  2986. properties:
  2987. id:
  2988. description: 指定domain的ID,ID和Name只需要指定其中一个
  2989. type: string
  2990. x-go-name: Id
  2991. name:
  2992. description: 指定Domain的Name
  2993. type: string
  2994. x-go-name: Name
  2995. type: object
  2996. x-go-name: Domain
  2997. project:
  2998. description: 指定token的scope为指定的项目
  2999. properties:
  3000. domain:
  3001. description: 指定项目所在的域(domain)
  3002. properties:
  3003. id:
  3004. description: 指定项目所在域的ID,ID和Name只需要指定其中一个
  3005. type: string
  3006. x-go-name: Id
  3007. name:
  3008. description: 指定项目所在域的Name
  3009. type: string
  3010. x-go-name: Name
  3011. type: object
  3012. x-go-name: Domain
  3013. id:
  3014. description: 指定项目的ID,由于ID全局唯一,因此指定ID后不需要指定项目所在的域(Domain),ID和Name只需要指定其中一个
  3015. type: string
  3016. x-go-name: Id
  3017. name:
  3018. description: 指定项目的Name,指定Name时,需要指定项目所在的域(domain)
  3019. type: string
  3020. x-go-name: Name
  3021. type: object
  3022. x-go-name: Project
  3023. type: object
  3024. x-go-name: Scope
  3025. required:
  3026. - identity
  3027. type: object
  3028. x-go-name: Auth
  3029. required:
  3030. - auth
  3031. type: object
  3032. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  3033. SDomainObject:
  3034. properties:
  3035. domain:
  3036. $ref: '#/definitions/SIdentityObject'
  3037. id:
  3038. description: UUID
  3039. type: string
  3040. x-go-name: Id
  3041. name:
  3042. description: 名称
  3043. type: string
  3044. x-go-name: Name
  3045. type: object
  3046. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3047. SDomainObjectWithMetadata:
  3048. properties:
  3049. domain:
  3050. $ref: '#/definitions/SIdentityObject'
  3051. id:
  3052. description: UUID
  3053. type: string
  3054. x-go-name: Id
  3055. metadata:
  3056. additionalProperties:
  3057. type: string
  3058. description: 标签信息
  3059. type: object
  3060. x-go-name: Metadata
  3061. name:
  3062. description: 名称
  3063. type: string
  3064. x-go-name: Name
  3065. type: object
  3066. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3067. SFetchDomainObjectWithMetadata:
  3068. properties:
  3069. domain:
  3070. description: 归属域名称
  3071. type: string
  3072. x-go-name: Domain
  3073. domain_id:
  3074. description: 归属域ID
  3075. type: string
  3076. x-go-name: DomainId
  3077. id:
  3078. description: UUID
  3079. type: string
  3080. x-go-name: Id
  3081. metadata:
  3082. additionalProperties:
  3083. type: string
  3084. description: 项目标签
  3085. type: object
  3086. x-go-name: Metadata
  3087. name:
  3088. description: 名称
  3089. type: string
  3090. x-go-name: Name
  3091. type: object
  3092. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3093. SGroupRole:
  3094. properties:
  3095. group:
  3096. type: string
  3097. x-go-name: Group
  3098. role:
  3099. type: string
  3100. x-go-name: Role
  3101. type: object
  3102. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3103. SIdentityObject:
  3104. properties:
  3105. id:
  3106. description: UUID
  3107. type: string
  3108. x-go-name: Id
  3109. name:
  3110. description: 名称
  3111. type: string
  3112. x-go-name: Name
  3113. type: object
  3114. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3115. SIdentityQuotaDetail:
  3116. description: 域的认证配额详情
  3117. properties:
  3118. created_at:
  3119. description: 资源创建时间
  3120. format: date-time
  3121. type: string
  3122. x-go-name: CreatedAt
  3123. deleted:
  3124. description: 资源是否被删除
  3125. type: boolean
  3126. x-go-name: Deleted
  3127. deleted_at:
  3128. description: 资源删除时间
  3129. format: date-time
  3130. type: string
  3131. x-go-name: DeletedAt
  3132. domain:
  3133. description: 配额适用的项目的域名称
  3134. type: string
  3135. x-go-name: Domain
  3136. domain_id:
  3137. description: 配额适用的域ID
  3138. type: string
  3139. x-go-name: DomainId
  3140. group:
  3141. format: int64
  3142. type: integer
  3143. x-go-name: Group
  3144. policy:
  3145. format: int64
  3146. type: integer
  3147. x-go-name: Policy
  3148. project:
  3149. format: int64
  3150. type: integer
  3151. x-go-name: Project
  3152. role:
  3153. format: int64
  3154. type: integer
  3155. x-go-name: Role
  3156. update_version:
  3157. description: 资源被更新次数
  3158. format: int64
  3159. type: integer
  3160. x-go-name: UpdateVersion
  3161. updated_at:
  3162. description: 资源更新时间
  3163. format: date-time
  3164. type: string
  3165. x-go-name: UpdatedAt
  3166. user:
  3167. format: int64
  3168. type: integer
  3169. x-go-name: User
  3170. type: object
  3171. x-go-package: yunion.io/x/onecloud/pkg/keystone/models
  3172. SJoinProjectsInput:
  3173. properties:
  3174. enabled:
  3175. description: 启用用户, 仅用户禁用时生效
  3176. type: boolean
  3177. x-go-name: Enabled
  3178. projects:
  3179. items:
  3180. type: string
  3181. type: array
  3182. x-go-name: Projects
  3183. roles:
  3184. items:
  3185. type: string
  3186. type: array
  3187. x-go-name: Roles
  3188. type: object
  3189. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3190. SLeaveProjectsInput:
  3191. properties:
  3192. project_roles:
  3193. items:
  3194. $ref: '#/definitions/SProjectRole'
  3195. type: array
  3196. x-go-name: ProjectRoles
  3197. type: object
  3198. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3199. SOrganizationDetails:
  3200. properties:
  3201. can_delete:
  3202. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3203. example: true
  3204. type: boolean
  3205. x-go-name: CanDelete
  3206. can_update:
  3207. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3208. example: true
  3209. type: boolean
  3210. x-go-name: CanUpdate
  3211. created_at:
  3212. description: 资源创建时间
  3213. format: date-time
  3214. type: string
  3215. x-go-name: CreatedAt
  3216. delete_fail_reason:
  3217. $ref: '#/definitions/Error'
  3218. deleted:
  3219. description: 资源是否被删除
  3220. type: boolean
  3221. x-go-name: Deleted
  3222. deleted_at:
  3223. description: 资源删除时间
  3224. format: date-time
  3225. type: string
  3226. x-go-name: DeletedAt
  3227. description:
  3228. description: 资源描述信息
  3229. type: string
  3230. x-go-name: Description
  3231. domain_id:
  3232. description: 域Id
  3233. type: string
  3234. x-go-name: DomainId
  3235. enabled:
  3236. description: 资源是否启用
  3237. type: boolean
  3238. x-go-name: Enabled
  3239. extra:
  3240. description: 额外信息
  3241. type: object
  3242. x-go-name: Extra
  3243. id:
  3244. description: 资源UUID
  3245. type: string
  3246. x-go-name: Id
  3247. is_emulated:
  3248. description: |-
  3249. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  3250. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  3251. type: boolean
  3252. x-go-name: IsEmulated
  3253. is_public:
  3254. description: 是否共享
  3255. type: boolean
  3256. x-go-name: IsPublic
  3257. keys:
  3258. type: string
  3259. x-go-name: Keys
  3260. level:
  3261. format: int64
  3262. type: integer
  3263. x-go-name: Level
  3264. metadata:
  3265. additionalProperties:
  3266. type: string
  3267. description: 标签
  3268. type: object
  3269. x-go-name: Metadata
  3270. name:
  3271. description: 资源名称
  3272. type: string
  3273. x-go-name: Name
  3274. org_node_md5:
  3275. description: 用以组织架构变更通知其他服务权限变更
  3276. type: string
  3277. x-go-name: OrgNodeMd5
  3278. pending_deleted:
  3279. description: 资源是否处于回收站中
  3280. type: boolean
  3281. x-go-name: PendingDeleted
  3282. pending_deleted_at:
  3283. description: 资源放入回收站时间
  3284. format: date-time
  3285. type: string
  3286. x-go-name: PendingDeletedAt
  3287. progress:
  3288. description: 操作进度0-100
  3289. format: float
  3290. type: number
  3291. x-go-name: Progress
  3292. project_domain:
  3293. description: 资源归属项目的域名称
  3294. type: string
  3295. x-go-name: ProjectDomain
  3296. public_scope:
  3297. description: 默认共享范围
  3298. type: string
  3299. x-go-name: PublicScope
  3300. public_src:
  3301. description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
  3302. example: local
  3303. type: string
  3304. x-go-name: PublicSrc
  3305. shared_domains:
  3306. description: 共享的域列表
  3307. items:
  3308. $ref: '#/definitions/SharedDomain'
  3309. type: array
  3310. x-go-name: SharedDomains
  3311. shared_projects:
  3312. description: 共享的项目列表
  3313. items:
  3314. $ref: '#/definitions/SharedProject'
  3315. type: array
  3316. x-go-name: SharedProjects
  3317. status:
  3318. description: 资源状态
  3319. type: string
  3320. x-go-name: Status
  3321. type:
  3322. type: string
  3323. x-go-name: Type
  3324. update_fail_reason:
  3325. $ref: '#/definitions/Error'
  3326. update_version:
  3327. description: 资源被更新次数
  3328. format: int64
  3329. type: integer
  3330. x-go-name: UpdateVersion
  3331. updated_at:
  3332. description: 资源更新时间
  3333. format: date-time
  3334. type: string
  3335. x-go-name: UpdatedAt
  3336. type: object
  3337. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3338. SOrganizationNodeDetails:
  3339. properties:
  3340. can_delete:
  3341. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3342. example: true
  3343. type: boolean
  3344. x-go-name: CanDelete
  3345. can_update:
  3346. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3347. example: true
  3348. type: boolean
  3349. x-go-name: CanUpdate
  3350. created_at:
  3351. description: 资源创建时间
  3352. format: date-time
  3353. type: string
  3354. x-go-name: CreatedAt
  3355. delete_fail_reason:
  3356. $ref: '#/definitions/Error'
  3357. deleted:
  3358. description: 资源是否被删除
  3359. type: boolean
  3360. x-go-name: Deleted
  3361. deleted_at:
  3362. description: 资源删除时间
  3363. format: date-time
  3364. type: string
  3365. x-go-name: DeletedAt
  3366. description:
  3367. description: 资源描述信息
  3368. type: string
  3369. x-go-name: Description
  3370. full_label:
  3371. type: string
  3372. x-go-name: FullLabel
  3373. id:
  3374. description: 资源UUID
  3375. type: string
  3376. x-go-name: Id
  3377. is_emulated:
  3378. description: |-
  3379. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  3380. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  3381. type: boolean
  3382. x-go-name: IsEmulated
  3383. level:
  3384. format: int64
  3385. type: integer
  3386. x-go-name: Level
  3387. metadata:
  3388. additionalProperties:
  3389. type: string
  3390. description: 标签
  3391. type: object
  3392. x-go-name: Metadata
  3393. name:
  3394. description: 资源名称
  3395. type: string
  3396. x-go-name: Name
  3397. org_id:
  3398. type: string
  3399. x-go-name: OrgId
  3400. org_node_md5:
  3401. description: 用以组织架构变更通知其他服务权限变更
  3402. type: string
  3403. x-go-name: OrgNodeMd5
  3404. organization:
  3405. type: string
  3406. x-go-name: Organization
  3407. pending_deleted:
  3408. description: 资源是否处于回收站中
  3409. type: boolean
  3410. x-go-name: PendingDeleted
  3411. pending_deleted_at:
  3412. description: 资源放入回收站时间
  3413. format: date-time
  3414. type: string
  3415. x-go-name: PendingDeletedAt
  3416. tags:
  3417. $ref: '#/definitions/TTagSet'
  3418. type:
  3419. $ref: '#/definitions/TOrgType'
  3420. update_fail_reason:
  3421. $ref: '#/definitions/Error'
  3422. update_version:
  3423. description: 资源被更新次数
  3424. format: int64
  3425. type: integer
  3426. x-go-name: UpdateVersion
  3427. updated_at:
  3428. description: 资源更新时间
  3429. format: date-time
  3430. type: string
  3431. x-go-name: UpdatedAt
  3432. weight:
  3433. format: int64
  3434. type: integer
  3435. x-go-name: Weight
  3436. type: object
  3437. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3438. SOrganizationNodeInfo:
  3439. properties:
  3440. full_label:
  3441. type: string
  3442. x-go-name: FullLabel
  3443. id:
  3444. type: string
  3445. x-go-name: Id
  3446. org_id:
  3447. type: string
  3448. x-go-name: OrgId
  3449. organization:
  3450. type: string
  3451. x-go-name: Organization
  3452. tags:
  3453. $ref: '#/definitions/TTagSet'
  3454. type:
  3455. $ref: '#/definitions/TOrgType'
  3456. type: object
  3457. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3458. SProjectAddUserGroupInput:
  3459. properties:
  3460. enable_all_users:
  3461. type: boolean
  3462. x-go-name: EnableAllUsers
  3463. groups:
  3464. items:
  3465. type: string
  3466. type: array
  3467. x-go-name: Groups
  3468. roles:
  3469. items:
  3470. type: string
  3471. type: array
  3472. x-go-name: Roles
  3473. users:
  3474. items:
  3475. type: string
  3476. type: array
  3477. x-go-name: Users
  3478. type: object
  3479. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3480. SProjectOrganization:
  3481. properties:
  3482. id:
  3483. type: string
  3484. x-go-name: Id
  3485. keys:
  3486. items:
  3487. type: string
  3488. type: array
  3489. x-go-name: Keys
  3490. name:
  3491. type: string
  3492. x-go-name: Name
  3493. nodes:
  3494. items:
  3495. $ref: '#/definitions/SProjectOrganizationNode'
  3496. type: array
  3497. x-go-name: Nodes
  3498. type: object
  3499. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3500. SProjectOrganizationNode:
  3501. properties:
  3502. id:
  3503. type: string
  3504. x-go-name: Id
  3505. labels:
  3506. items:
  3507. type: string
  3508. type: array
  3509. x-go-name: Labels
  3510. type: object
  3511. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3512. SProjectRemoveUserGroupInput:
  3513. properties:
  3514. group_roles:
  3515. items:
  3516. $ref: '#/definitions/SGroupRole'
  3517. type: array
  3518. x-go-name: GroupRoles
  3519. user_roles:
  3520. items:
  3521. $ref: '#/definitions/SUserRole'
  3522. type: array
  3523. x-go-name: UserRoles
  3524. type: object
  3525. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3526. SProjectRole:
  3527. properties:
  3528. project:
  3529. type: string
  3530. x-go-name: Project
  3531. role:
  3532. type: string
  3533. x-go-name: Role
  3534. type: object
  3535. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3536. SProjectSetAdminInput:
  3537. properties:
  3538. user_id:
  3539. type: string
  3540. x-go-name: UserId
  3541. type: object
  3542. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3543. SRoleAssignment:
  3544. properties:
  3545. group:
  3546. $ref: '#/definitions/SDomainObject'
  3547. policies:
  3548. description: 用户角色关联的权限信息
  3549. properties:
  3550. domain:
  3551. description: 关联的域权限名称列表
  3552. items:
  3553. type: string
  3554. type: array
  3555. x-go-name: Domain
  3556. project:
  3557. description: 关联的项目权限名称列表
  3558. items:
  3559. type: string
  3560. type: array
  3561. x-go-name: Project
  3562. system:
  3563. description: 关联的系统权限名称列表
  3564. items:
  3565. type: string
  3566. type: array
  3567. x-go-name: System
  3568. type: object
  3569. x-go-name: Policies
  3570. role:
  3571. $ref: '#/definitions/SDomainObject'
  3572. scope:
  3573. description: 归属范围
  3574. properties:
  3575. domain:
  3576. $ref: '#/definitions/SIdentityObject'
  3577. project:
  3578. $ref: '#/definitions/SDomainObjectWithMetadata'
  3579. type: object
  3580. x-go-name: Scope
  3581. user:
  3582. $ref: '#/definitions/SDomainObject'
  3583. type: object
  3584. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3585. STag:
  3586. properties:
  3587. key:
  3588. description: 标签Kye
  3589. type: string
  3590. x-go-name: Key
  3591. value:
  3592. description: 标签Value
  3593. type: string
  3594. x-go-name: Value
  3595. type: object
  3596. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  3597. SUserGroup:
  3598. properties:
  3599. domain:
  3600. type: string
  3601. x-go-name: Domain
  3602. domain_id:
  3603. type: string
  3604. x-go-name: DomainId
  3605. id:
  3606. type: string
  3607. x-go-name: Id
  3608. name:
  3609. type: string
  3610. x-go-name: Name
  3611. type: object
  3612. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3613. SUserRole:
  3614. properties:
  3615. role:
  3616. type: string
  3617. x-go-name: Role
  3618. user:
  3619. type: string
  3620. x-go-name: User
  3621. type: object
  3622. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3623. ServiceDetails:
  3624. properties:
  3625. can_delete:
  3626. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3627. example: true
  3628. type: boolean
  3629. x-go-name: CanDelete
  3630. can_update:
  3631. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3632. example: true
  3633. type: boolean
  3634. x-go-name: CanUpdate
  3635. config_version:
  3636. format: int64
  3637. type: integer
  3638. x-go-name: ConfigVersion
  3639. created_at:
  3640. description: 资源创建时间
  3641. format: date-time
  3642. type: string
  3643. x-go-name: CreatedAt
  3644. delete_fail_reason:
  3645. $ref: '#/definitions/Error'
  3646. deleted:
  3647. description: 资源是否被删除
  3648. type: boolean
  3649. x-go-name: Deleted
  3650. deleted_at:
  3651. description: 资源删除时间
  3652. format: date-time
  3653. type: string
  3654. x-go-name: DeletedAt
  3655. description:
  3656. description: 资源描述信息
  3657. type: string
  3658. x-go-name: Description
  3659. enabled:
  3660. type: boolean
  3661. x-go-name: Enabled
  3662. endpoint_count:
  3663. format: int64
  3664. type: integer
  3665. x-go-name: EndpointCount
  3666. extra:
  3667. type: object
  3668. x-go-name: Extra
  3669. id:
  3670. description: 资源UUID
  3671. type: string
  3672. x-go-name: Id
  3673. is_emulated:
  3674. description: |-
  3675. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  3676. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  3677. type: boolean
  3678. x-go-name: IsEmulated
  3679. metadata:
  3680. additionalProperties:
  3681. type: string
  3682. description: 标签
  3683. type: object
  3684. x-go-name: Metadata
  3685. name:
  3686. description: 资源名称
  3687. type: string
  3688. x-go-name: Name
  3689. org_node_md5:
  3690. description: 用以组织架构变更通知其他服务权限变更
  3691. type: string
  3692. x-go-name: OrgNodeMd5
  3693. type:
  3694. type: string
  3695. x-go-name: Type
  3696. update_fail_reason:
  3697. $ref: '#/definitions/Error'
  3698. update_version:
  3699. description: 资源被更新次数
  3700. format: int64
  3701. type: integer
  3702. x-go-name: UpdateVersion
  3703. updated_at:
  3704. description: 资源更新时间
  3705. format: date-time
  3706. type: string
  3707. x-go-name: UpdatedAt
  3708. type: object
  3709. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3710. SetIdentityQuotaInput:
  3711. description: 设置域的认证配额输入参数
  3712. properties:
  3713. action:
  3714. description: |-
  3715. 设置配额操作
  3716. action | 说明 |
  3717. ---------|-------------------------------------------|
  3718. add | 增量增加配额 |
  3719. sub | 增量减少配额 |
  3720. reset | 重置所有配额为0 |
  3721. replace | 替换所有配额,对于不存在的配额项,设置为0 |
  3722. update | 更新存在的配额 |
  3723. delete | 删除配额 |
  3724. type: string
  3725. x-go-name: Action
  3726. created_at:
  3727. description: 资源创建时间
  3728. format: date-time
  3729. type: string
  3730. x-go-name: CreatedAt
  3731. deleted:
  3732. description: 资源是否被删除
  3733. type: boolean
  3734. x-go-name: Deleted
  3735. deleted_at:
  3736. description: 资源删除时间
  3737. format: date-time
  3738. type: string
  3739. x-go-name: DeletedAt
  3740. domain_id:
  3741. description: 配额适用的域ID
  3742. type: string
  3743. x-go-name: DomainId
  3744. group:
  3745. format: int64
  3746. type: integer
  3747. x-go-name: Group
  3748. policy:
  3749. format: int64
  3750. type: integer
  3751. x-go-name: Policy
  3752. project:
  3753. format: int64
  3754. type: integer
  3755. x-go-name: Project
  3756. role:
  3757. format: int64
  3758. type: integer
  3759. x-go-name: Role
  3760. update_version:
  3761. description: 资源被更新次数
  3762. format: int64
  3763. type: integer
  3764. x-go-name: UpdateVersion
  3765. updated_at:
  3766. description: 资源更新时间
  3767. format: date-time
  3768. type: string
  3769. x-go-name: UpdatedAt
  3770. user:
  3771. format: int64
  3772. type: integer
  3773. x-go-name: User
  3774. type: object
  3775. x-go-package: yunion.io/x/onecloud/pkg/keystone/models
  3776. SharedDomain:
  3777. properties:
  3778. id:
  3779. type: string
  3780. x-go-name: Id
  3781. name:
  3782. type: string
  3783. x-go-name: Name
  3784. type: object
  3785. x-go-package: yunion.io/x/onecloud/pkg/apis
  3786. SharedProject:
  3787. properties:
  3788. domain:
  3789. type: string
  3790. x-go-name: Domain
  3791. domain_id:
  3792. type: string
  3793. x-go-name: DomainId
  3794. id:
  3795. type: string
  3796. x-go-name: Id
  3797. name:
  3798. type: string
  3799. x-go-name: Name
  3800. type: object
  3801. x-go-package: yunion.io/x/onecloud/pkg/apis
  3802. StandaloneAnonResourceBaseUpdateInput:
  3803. properties:
  3804. description:
  3805. description: 资源描述
  3806. type: string
  3807. x-go-name: Description
  3808. type: object
  3809. x-go-package: yunion.io/x/onecloud/pkg/apis
  3810. StandaloneAnonResourceCreateInput:
  3811. properties:
  3812. __meta__:
  3813. additionalProperties:
  3814. type: string
  3815. description: 标签列表,最多支持20个
  3816. example:
  3817. user:rd: op
  3818. type: object
  3819. x-go-name: Metadata
  3820. description:
  3821. description: 资源描述
  3822. example: test create network
  3823. type: string
  3824. x-go-name: Description
  3825. dry_run:
  3826. default: false
  3827. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  3828. type: boolean
  3829. x-go-name: DryRun
  3830. is_emulated:
  3831. description: |-
  3832. 资源是否为模拟资源
  3833. description: the resource is an emulated resource
  3834. type: boolean
  3835. x-go-name: IsEmulated
  3836. type: object
  3837. x-go-package: yunion.io/x/onecloud/pkg/apis
  3838. StandaloneAnonResourceDetails:
  3839. properties:
  3840. can_delete:
  3841. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3842. example: true
  3843. type: boolean
  3844. x-go-name: CanDelete
  3845. can_update:
  3846. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3847. example: true
  3848. type: boolean
  3849. x-go-name: CanUpdate
  3850. delete_fail_reason:
  3851. $ref: '#/definitions/Error'
  3852. metadata:
  3853. additionalProperties:
  3854. type: string
  3855. description: 标签
  3856. type: object
  3857. x-go-name: Metadata
  3858. update_fail_reason:
  3859. $ref: '#/definitions/Error'
  3860. type: object
  3861. x-go-package: yunion.io/x/onecloud/pkg/apis
  3862. StandaloneResourceBaseUpdateInput:
  3863. properties:
  3864. description:
  3865. description: 资源描述
  3866. type: string
  3867. x-go-name: Description
  3868. name:
  3869. description: 资源名称
  3870. type: string
  3871. x-go-name: Name
  3872. type: object
  3873. x-go-package: yunion.io/x/onecloud/pkg/apis
  3874. StandaloneResourceCreateInput:
  3875. properties:
  3876. __meta__:
  3877. additionalProperties:
  3878. type: string
  3879. description: 标签列表,最多支持20个
  3880. example:
  3881. user:rd: op
  3882. type: object
  3883. x-go-name: Metadata
  3884. description:
  3885. description: 资源描述
  3886. example: test create network
  3887. type: string
  3888. x-go-name: Description
  3889. dry_run:
  3890. default: false
  3891. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  3892. type: boolean
  3893. x-go-name: DryRun
  3894. generate_name:
  3895. description: |-
  3896. 生成资源名称的模板,如果name为空,则为必填项
  3897. description: generated resource name, given a pattern to generate name, required if name is not given
  3898. example: test###
  3899. type: string
  3900. x-go-name: GenerateName
  3901. is_emulated:
  3902. description: |-
  3903. 资源是否为模拟资源
  3904. description: the resource is an emulated resource
  3905. type: boolean
  3906. x-go-name: IsEmulated
  3907. name:
  3908. description: |-
  3909. 资源名称,如果generate_name为空,则为必填项
  3910. description: resource name, required if generated_name is not given
  3911. example: test-network
  3912. type: string
  3913. uniqueItems: true
  3914. x-go-name: Name
  3915. required:
  3916. - name
  3917. type: object
  3918. x-go-package: yunion.io/x/onecloud/pkg/apis
  3919. StandaloneResourceDetails:
  3920. properties:
  3921. can_delete:
  3922. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  3923. example: true
  3924. type: boolean
  3925. x-go-name: CanDelete
  3926. can_update:
  3927. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  3928. example: true
  3929. type: boolean
  3930. x-go-name: CanUpdate
  3931. delete_fail_reason:
  3932. $ref: '#/definitions/Error'
  3933. metadata:
  3934. additionalProperties:
  3935. type: string
  3936. description: 标签
  3937. type: object
  3938. x-go-name: Metadata
  3939. update_fail_reason:
  3940. $ref: '#/definitions/Error'
  3941. type: object
  3942. x-go-package: yunion.io/x/onecloud/pkg/apis
  3943. TConfigs:
  3944. additionalProperties:
  3945. additionalProperties:
  3946. type: object
  3947. type: object
  3948. type: object
  3949. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3950. TOrgType:
  3951. type: string
  3952. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  3953. TRbacScope:
  3954. type: string
  3955. x-go-package: yunion.io/x/pkg/util/rbacscope
  3956. TTagSet:
  3957. items:
  3958. $ref: '#/definitions/STag'
  3959. type: array
  3960. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  3961. TTagSetList:
  3962. items:
  3963. $ref: '#/definitions/TTagSet'
  3964. type: array
  3965. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  3966. TokenCredentialV2:
  3967. description: Keystone token信息V2
  3968. properties:
  3969. context:
  3970. $ref: '#/definitions/SAuthContext'
  3971. metadata:
  3972. $ref: '#/definitions/KeystoneMetadataV2'
  3973. service_catalog:
  3974. $ref: '#/definitions/KeystoneServiceCatalogV2'
  3975. tenants:
  3976. description: 用户所属项目列表
  3977. items:
  3978. $ref: '#/definitions/KeystoneTenantV2'
  3979. type: array
  3980. x-go-name: Tenants
  3981. token:
  3982. $ref: '#/definitions/KeystoneTokenV2'
  3983. user:
  3984. $ref: '#/definitions/KeystoneUserV2'
  3985. type: object
  3986. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  3987. TokenCredentialV3:
  3988. properties:
  3989. token:
  3990. $ref: '#/definitions/KeystoneTokenV3'
  3991. type: object
  3992. x-go-package: yunion.io/x/onecloud/pkg/mcclient
  3993. UserCreateInput:
  3994. properties:
  3995. __meta__:
  3996. additionalProperties:
  3997. type: string
  3998. description: 标签列表,最多支持20个
  3999. example:
  4000. user:rd: op
  4001. type: object
  4002. x-go-name: Metadata
  4003. allow_web_console:
  4004. type: boolean
  4005. x-go-name: AllowWebConsole
  4006. description:
  4007. description: 资源描述
  4008. example: test create network
  4009. type: string
  4010. x-go-name: Description
  4011. displayname:
  4012. type: string
  4013. x-go-name: Displayname
  4014. dry_run:
  4015. default: false
  4016. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  4017. type: boolean
  4018. x-go-name: DryRun
  4019. email:
  4020. type: string
  4021. x-go-name: Email
  4022. enable_mfa:
  4023. type: boolean
  4024. x-go-name: EnableMfa
  4025. enabled:
  4026. type: boolean
  4027. x-go-name: Enabled
  4028. expired_at:
  4029. format: date-time
  4030. type: string
  4031. x-go-name: ExpiredAt
  4032. generate_name:
  4033. description: |-
  4034. 生成资源名称的模板,如果name为空,则为必填项
  4035. description: generated resource name, given a pattern to generate name, required if name is not given
  4036. example: test###
  4037. type: string
  4038. x-go-name: GenerateName
  4039. idp_entity_id:
  4040. type: string
  4041. x-go-name: IdpEntityId
  4042. idp_id:
  4043. type: string
  4044. x-go-name: IdpId
  4045. is_emulated:
  4046. description: |-
  4047. 资源是否为模拟资源
  4048. description: the resource is an emulated resource
  4049. type: boolean
  4050. x-go-name: IsEmulated
  4051. is_system_account:
  4052. type: boolean
  4053. x-go-name: IsSystemAccount
  4054. lang:
  4055. type: string
  4056. x-go-name: Lang
  4057. mobile:
  4058. type: string
  4059. x-go-name: Mobile
  4060. name:
  4061. description: |-
  4062. 资源名称,如果generate_name为空,则为必填项
  4063. description: resource name, required if generated_name is not given
  4064. example: test-network
  4065. type: string
  4066. uniqueItems: true
  4067. x-go-name: Name
  4068. password:
  4069. type: string
  4070. x-go-name: Password
  4071. project_domain_id:
  4072. description: 指定项目归属域名称或ID
  4073. type: string
  4074. x-go-name: ProjectDomainId
  4075. skip_password_complexity_check:
  4076. type: boolean
  4077. x-go-name: SkipPasswordComplexityCheck
  4078. required:
  4079. - name
  4080. type: object
  4081. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  4082. UserDetails:
  4083. properties:
  4084. allow_web_console:
  4085. description: 是否允许登录Web控制台,如果是用于API访问的用户,可禁用web控制台登录
  4086. type: boolean
  4087. x-go-name: AllowWebConsole
  4088. can_delete:
  4089. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  4090. example: true
  4091. type: boolean
  4092. x-go-name: CanDelete
  4093. can_update:
  4094. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  4095. example: true
  4096. type: boolean
  4097. x-go-name: CanUpdate
  4098. created_at:
  4099. description: 资源创建时间
  4100. format: date-time
  4101. type: string
  4102. x-go-name: CreatedAt
  4103. credential_count:
  4104. description: 归属该用户的密钥凭证(含AKSK,TOTP,Secret等)的数量
  4105. format: int64
  4106. type: integer
  4107. x-go-name: CredentialCount
  4108. default_project_id:
  4109. description: deprecated
  4110. type: string
  4111. x-go-name: DefaultProjectId
  4112. delete_fail_reason:
  4113. $ref: '#/definitions/Error'
  4114. deleted:
  4115. description: 资源是否被删除
  4116. type: boolean
  4117. x-go-name: Deleted
  4118. deleted_at:
  4119. description: 资源删除时间
  4120. format: date-time
  4121. type: string
  4122. x-go-name: DeletedAt
  4123. description:
  4124. description: 资源描述信息
  4125. type: string
  4126. x-go-name: Description
  4127. displayname:
  4128. description: 显示名称,用户登录后显示在右上角菜单入口
  4129. type: string
  4130. x-go-name: Displayname
  4131. domain_id:
  4132. description: 域Id
  4133. type: string
  4134. x-go-name: DomainId
  4135. email:
  4136. description: 用户邮箱
  4137. type: string
  4138. x-go-name: Email
  4139. enable_mfa:
  4140. description: 是否开启MFA
  4141. type: boolean
  4142. x-go-name: EnableMfa
  4143. enabled:
  4144. description: 资源是否启用
  4145. type: boolean
  4146. x-go-name: Enabled
  4147. expired_at:
  4148. description: 过期时间
  4149. format: date-time
  4150. type: string
  4151. x-go-name: ExpiredAt
  4152. ext_resource:
  4153. additionalProperties:
  4154. format: int64
  4155. type: integer
  4156. description: 外部资源统计信息(资源类别:数量)
  4157. type: object
  4158. x-go-name: ExtResource
  4159. ext_resources_last_update:
  4160. description: 外部资源统计信息上次更新时间
  4161. format: date-time
  4162. type: string
  4163. x-go-name: ExtResourcesLastUpdate
  4164. ext_resources_next_update:
  4165. description: 外部资源统计信息下次更新时间
  4166. format: date-time
  4167. type: string
  4168. x-go-name: ExtResourcesNextUpdate
  4169. extra:
  4170. description: 额外信息
  4171. type: object
  4172. x-go-name: Extra
  4173. failed_auth_at:
  4174. description: 上传登录失败的时间
  4175. format: date-time
  4176. type: string
  4177. x-go-name: FailedAuthAt
  4178. failed_auth_count:
  4179. description: 连续登录失败的次数
  4180. format: int64
  4181. type: integer
  4182. x-go-name: FailedAuthCount
  4183. group_count:
  4184. description: 用户归属用户组的数量
  4185. format: int64
  4186. type: integer
  4187. x-go-name: GroupCount
  4188. groups:
  4189. description: 用户归属的组
  4190. items:
  4191. $ref: '#/definitions/SUserGroup'
  4192. type: array
  4193. x-go-name: Groups
  4194. id:
  4195. description: 资源UUID
  4196. type: string
  4197. x-go-name: Id
  4198. idps:
  4199. description: 该用户关联的外部认证源的认证信息
  4200. items:
  4201. $ref: '#/definitions/IdpResourceInfo'
  4202. type: array
  4203. x-go-name: Idps
  4204. is_emulated:
  4205. description: |-
  4206. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  4207. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  4208. type: boolean
  4209. x-go-name: IsEmulated
  4210. is_local:
  4211. description: 该用户是否为本地用户(SQL维护的用户)
  4212. type: boolean
  4213. x-go-name: IsLocal
  4214. is_system_account:
  4215. description: 是否为系统账号,系统账号不会检查密码复杂度,默认不在列表显示
  4216. type: boolean
  4217. x-go-name: IsSystemAccount
  4218. lang:
  4219. description: 用户的默认语言设置,默认是zh_CN
  4220. type: string
  4221. x-go-name: Lang
  4222. metadata:
  4223. additionalProperties:
  4224. type: string
  4225. description: 标签
  4226. type: object
  4227. x-go-name: Metadata
  4228. mobile:
  4229. description: 用户手机号
  4230. type: string
  4231. x-go-name: Mobile
  4232. name:
  4233. description: 资源名称
  4234. type: string
  4235. x-go-name: Name
  4236. need_reset_password:
  4237. description: 登录后是否需要重置密码
  4238. type: boolean
  4239. x-go-name: NeedResetPassword
  4240. org_node_md5:
  4241. description: 用以组织架构变更通知其他服务权限变更
  4242. type: string
  4243. x-go-name: OrgNodeMd5
  4244. password_expires_at:
  4245. description: 密码过期时间(如果开启了密码过期)
  4246. format: date-time
  4247. type: string
  4248. x-go-name: PasswordExpiresAt
  4249. password_reset_hint:
  4250. description: '重置密码原因: admin_reset|expire'
  4251. type: string
  4252. x-go-name: PasswordResetHint
  4253. pending_deleted:
  4254. description: 资源是否处于回收站中
  4255. type: boolean
  4256. x-go-name: PendingDeleted
  4257. pending_deleted_at:
  4258. description: 资源放入回收站时间
  4259. format: date-time
  4260. type: string
  4261. x-go-name: PendingDeletedAt
  4262. project_count:
  4263. description: 用户归属项目的数量
  4264. format: int64
  4265. type: integer
  4266. x-go-name: ProjectCount
  4267. project_domain:
  4268. description: 资源归属项目的域名称
  4269. type: string
  4270. x-go-name: ProjectDomain
  4271. projects:
  4272. description: 用户归属的的项目信息
  4273. items:
  4274. $ref: '#/definitions/SFetchDomainObjectWithMetadata'
  4275. type: array
  4276. x-go-name: Projects
  4277. record_checksum:
  4278. type: string
  4279. x-go-name: RecordChecksum
  4280. update_fail_reason:
  4281. $ref: '#/definitions/Error'
  4282. update_version:
  4283. description: 资源被更新次数
  4284. format: int64
  4285. type: integer
  4286. x-go-name: UpdateVersion
  4287. updated_at:
  4288. description: 资源更新时间
  4289. format: date-time
  4290. type: string
  4291. x-go-name: UpdatedAt
  4292. type: object
  4293. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  4294. UserLinkIdpInput:
  4295. properties:
  4296. idp_entity_id:
  4297. type: string
  4298. x-go-name: IdpEntityId
  4299. idp_id:
  4300. type: string
  4301. x-go-name: IdpId
  4302. type: object
  4303. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  4304. UserUnlinkIdpInput:
  4305. $ref: '#/definitions/UserLinkIdpInput'
  4306. UserUpdateInput:
  4307. properties:
  4308. allow_web_console:
  4309. type: boolean
  4310. x-go-name: AllowWebConsole
  4311. clear_expire:
  4312. description: 清除过期时间
  4313. type: boolean
  4314. x-go-name: ClearExpire
  4315. description:
  4316. description: 资源描述
  4317. type: string
  4318. x-go-name: Description
  4319. displayname:
  4320. type: string
  4321. x-go-name: Displayname
  4322. email:
  4323. type: string
  4324. x-go-name: Email
  4325. enable_mfa:
  4326. type: boolean
  4327. x-go-name: EnableMfa
  4328. enabled:
  4329. description: 是否启用
  4330. type: boolean
  4331. x-go-name: Enabled
  4332. expired_at:
  4333. description: 过期时间
  4334. format: date-time
  4335. type: string
  4336. x-go-name: ExpiredAt
  4337. is_system_account:
  4338. type: boolean
  4339. x-go-name: IsSystemAccount
  4340. lang:
  4341. type: string
  4342. x-go-name: Lang
  4343. mobile:
  4344. type: string
  4345. x-go-name: Mobile
  4346. name:
  4347. description: 资源名称
  4348. type: string
  4349. x-go-name: Name
  4350. password:
  4351. type: string
  4352. x-go-name: Password
  4353. skip_password_complexity_check:
  4354. type: boolean
  4355. x-go-name: SkipPasswordComplexityCheck
  4356. type: object
  4357. x-go-package: yunion.io/x/onecloud/pkg/apis/identity
  4358. host: '"127.0.0.1:8889"'
  4359. info:
  4360. contact:
  4361. email: lizexi@yunion.cn
  4362. name: Zexi Li
  4363. description: Cloudprovider API
  4364. license:
  4365. name: Apache 2.0
  4366. url: http://www.apache.org/licenses/LICENSE-2.0.html
  4367. version: "1.0"
  4368. paths:
  4369. /credentials:
  4370. get:
  4371. description: 列表
  4372. operationId: credential_ListItemFilter
  4373. parameters:
  4374. - default: 20
  4375. description: 查询限制量
  4376. format: int64
  4377. in: query
  4378. name: limit
  4379. type: integer
  4380. x-go-name: Limit
  4381. - default: 0
  4382. description: 查询偏移量
  4383. format: int64
  4384. in: query
  4385. name: offset
  4386. type: integer
  4387. x-go-name: Offset
  4388. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  4389. in: query
  4390. items:
  4391. type: string
  4392. name: order_by
  4393. type: array
  4394. x-go-name: OrderBy
  4395. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  4396. example: desc|asc
  4397. in: query
  4398. name: order
  4399. type: string
  4400. x-go-name: Order
  4401. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  4402. in: query
  4403. name: details
  4404. type: boolean
  4405. x-go-name: Details
  4406. - description: 模糊搜索所有字段
  4407. in: query
  4408. name: search
  4409. type: string
  4410. x-go-name: Search
  4411. - description: |-
  4412. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4413. 支持的操作符如下:
  4414. 操作符 | 参数个数 | 举例 | 说明 |
  4415. ---------------|----------|------------------------------------------------|-----------------------------|
  4416. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4417. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4418. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4419. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4420. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4421. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4422. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4423. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4424. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4425. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4426. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4427. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4428. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4429. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4430. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4431. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4432. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4433. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4434. in: query
  4435. items:
  4436. type: string
  4437. name: filter
  4438. type: array
  4439. x-go-name: Filter
  4440. - description: |-
  4441. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4442. 和其他表关联的语法如下:
  4443. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4444. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4445. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4446. 举例:
  4447. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4448. in: query
  4449. items:
  4450. type: string
  4451. name: joint_filter
  4452. type: array
  4453. x-go-name: JointFilter
  4454. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4455. in: query
  4456. name: filter_any
  4457. type: boolean
  4458. x-go-name: FilterAny
  4459. - description: 返回结果只包含指定的字段
  4460. in: query
  4461. items:
  4462. type: string
  4463. name: field
  4464. type: array
  4465. x-go-name: Field
  4466. - description: 用于数据导出,指定导出的数据字段
  4467. in: query
  4468. name: export_keys
  4469. type: string
  4470. x-go-name: ExportKeys
  4471. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4472. in: query
  4473. name: show_fail_reason
  4474. type: boolean
  4475. x-go-name: ShowFailReason
  4476. - description: 是否返回状态统计信息,默认为False
  4477. in: query
  4478. name: summary_stats
  4479. type: boolean
  4480. x-go-name: SummaryStats
  4481. - $ref: '#/definitions/TTagSet'
  4482. description: 通过标签过滤(包含这些标签)
  4483. in: query
  4484. name: tags
  4485. x-go-name: Tags
  4486. - $ref: '#/definitions/TTagSetList'
  4487. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4488. in: query
  4489. name: obj_tags
  4490. x-go-name: ObjTags
  4491. - $ref: '#/definitions/TTagSet'
  4492. description: 通过标签过滤(不包含这些标签)
  4493. in: query
  4494. name: no_tags
  4495. x-go-name: NoTags
  4496. - $ref: '#/definitions/TTagSetList'
  4497. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4498. in: query
  4499. name: no_obj_tags
  4500. x-go-name: NoObjTags
  4501. - description: 通过标签排序
  4502. in: query
  4503. name: order_by_tag
  4504. type: string
  4505. x-go-name: OrderByTag
  4506. - description: |-
  4507. deprecated
  4508. 返回资源的标签不包含用户标签
  4509. in: query
  4510. name: without_user_meta
  4511. type: boolean
  4512. x-go-name: WithoutUserMeta
  4513. - description: 返回包含用户标签的资源
  4514. in: query
  4515. name: with_user_meta
  4516. type: boolean
  4517. x-go-name: WithUserMeta
  4518. - description: 返回包含外部标签的资源
  4519. in: query
  4520. name: with_cloud_meta
  4521. type: boolean
  4522. x-go-name: WithCloudMeta
  4523. - description: 返回包含任意标签的资源
  4524. in: query
  4525. name: with_any_meta
  4526. type: boolean
  4527. x-go-name: WithAnyMeta
  4528. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4529. in: query
  4530. name: with_meta
  4531. type: boolean
  4532. x-go-name: WithMeta
  4533. - description: 显示所有的资源,包括模拟的资源
  4534. in: query
  4535. name: show_emulated
  4536. type: boolean
  4537. x-go-name: ShowEmulated
  4538. - description: 以资源ID过滤列表
  4539. in: query
  4540. items:
  4541. type: string
  4542. name: id
  4543. type: array
  4544. x-go-name: Ids
  4545. - description: 以资源名称过滤列表
  4546. in: query
  4547. items:
  4548. type: string
  4549. name: name
  4550. type: array
  4551. x-go-name: Names
  4552. - description: 用户归属域
  4553. in: query
  4554. name: user_domain_id
  4555. type: string
  4556. x-go-name: UserDomainId
  4557. - description: filter by user
  4558. in: query
  4559. name: user_id
  4560. type: string
  4561. x-go-name: UserId
  4562. - description: 项目归属域
  4563. in: query
  4564. name: project_domain_id
  4565. type: string
  4566. x-go-name: ProjectDomainId
  4567. - description: 以项目(ID或Name)过滤列表结果
  4568. in: query
  4569. name: project_id
  4570. type: string
  4571. x-go-name: ProjectId
  4572. - in: query
  4573. items:
  4574. type: string
  4575. name: type
  4576. type: array
  4577. x-go-name: Type
  4578. - in: query
  4579. name: enabled
  4580. type: boolean
  4581. x-go-name: Enabled
  4582. responses:
  4583. "200":
  4584. $ref: '#/responses/credential_ListItemFilterOutput'
  4585. summary: 用户信用凭证列表
  4586. tags:
  4587. - credential
  4588. post:
  4589. description: 新建
  4590. operationId: credential_ValidateCreateData
  4591. parameters:
  4592. - in: body
  4593. name: body
  4594. schema:
  4595. properties:
  4596. count:
  4597. default: 1
  4598. format: int64
  4599. type: integer
  4600. x-go-name: Count
  4601. credential:
  4602. $ref: '#/definitions/CredentialCreateInput'
  4603. type: object
  4604. x-go-name: Body
  4605. responses:
  4606. "200":
  4607. $ref: '#/responses/credential_ValidateCreateDataOutput'
  4608. summary: 新建
  4609. tags:
  4610. - credential
  4611. /credentials/{id}:
  4612. delete:
  4613. description: 删除
  4614. operationId: credential_CustomizeDelete
  4615. parameters:
  4616. - description: The Id or Name of credential
  4617. in: path
  4618. name: id
  4619. required: true
  4620. type: string
  4621. x-go-name: Id
  4622. responses:
  4623. "200":
  4624. $ref: '#/responses/credential_CustomizeDeleteOutput'
  4625. summary: 删除
  4626. tags:
  4627. - credential
  4628. get:
  4629. description: 获取详情
  4630. operationId: credential_FetchCustomizeColumns
  4631. parameters:
  4632. - description: The Id or Name of credential
  4633. in: path
  4634. name: id
  4635. required: true
  4636. type: string
  4637. x-go-name: Id
  4638. responses:
  4639. "200":
  4640. $ref: '#/responses/credential_FetchCustomizeColumnsOutput'
  4641. summary: 获取详情
  4642. tags:
  4643. - credential
  4644. put:
  4645. description: 更新
  4646. operationId: credential_ValidateUpdateData
  4647. parameters:
  4648. - description: The Id or Name of credential
  4649. in: path
  4650. name: id
  4651. required: true
  4652. type: string
  4653. x-go-name: Id
  4654. - in: body
  4655. name: body
  4656. schema:
  4657. properties:
  4658. credential:
  4659. $ref: '#/definitions/CredentialUpdateInput'
  4660. type: object
  4661. x-go-name: Body
  4662. responses:
  4663. "200":
  4664. $ref: '#/responses/credential_ValidateUpdateDataOutput'
  4665. summary: 更新
  4666. tags:
  4667. - credential
  4668. /credentials/{id}/metadata:
  4669. get:
  4670. description: 获取指定信息Metadata
  4671. operationId: credential_GetDetailsMetadata
  4672. parameters:
  4673. - description: |-
  4674. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  4675. 标签分为
  4676. 类型 | 说明 |
  4677. ----------|---------------------------------------------|
  4678. 系统标签 | 平台定义的标签 |
  4679. 用户标签 | key以user:为前缀,用户自定义标签 |
  4680. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  4681. in: query
  4682. items:
  4683. type: string
  4684. name: field
  4685. type: array
  4686. x-go-name: Field
  4687. - description: 按标签前缀过滤
  4688. in: query
  4689. name: prefix
  4690. type: string
  4691. x-go-name: Prefix
  4692. - description: The Id or Name of credential
  4693. in: path
  4694. name: id
  4695. required: true
  4696. type: string
  4697. x-go-name: Id
  4698. responses:
  4699. "200":
  4700. $ref: '#/responses/credential_GetDetailsMetadataOutput'
  4701. summary: 获取资源标签(元数据)
  4702. tags:
  4703. - credential
  4704. /domains:
  4705. get:
  4706. description: 列表
  4707. operationId: domain_ListItemFilter
  4708. parameters:
  4709. - default: 20
  4710. description: 查询限制量
  4711. format: int64
  4712. in: query
  4713. name: limit
  4714. type: integer
  4715. x-go-name: Limit
  4716. - default: 0
  4717. description: 查询偏移量
  4718. format: int64
  4719. in: query
  4720. name: offset
  4721. type: integer
  4722. x-go-name: Offset
  4723. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  4724. in: query
  4725. items:
  4726. type: string
  4727. name: order_by
  4728. type: array
  4729. x-go-name: OrderBy
  4730. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  4731. example: desc|asc
  4732. in: query
  4733. name: order
  4734. type: string
  4735. x-go-name: Order
  4736. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  4737. in: query
  4738. name: details
  4739. type: boolean
  4740. x-go-name: Details
  4741. - description: 模糊搜索所有字段
  4742. in: query
  4743. name: search
  4744. type: string
  4745. x-go-name: Search
  4746. - description: |-
  4747. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4748. 支持的操作符如下:
  4749. 操作符 | 参数个数 | 举例 | 说明 |
  4750. ---------------|----------|------------------------------------------------|-----------------------------|
  4751. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4752. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4753. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4754. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4755. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4756. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4757. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4758. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4759. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4760. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4761. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4762. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4763. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4764. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4765. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4766. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4767. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4768. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4769. in: query
  4770. items:
  4771. type: string
  4772. name: filter
  4773. type: array
  4774. x-go-name: Filter
  4775. - description: |-
  4776. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4777. 和其他表关联的语法如下:
  4778. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4779. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4780. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4781. 举例:
  4782. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4783. in: query
  4784. items:
  4785. type: string
  4786. name: joint_filter
  4787. type: array
  4788. x-go-name: JointFilter
  4789. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4790. in: query
  4791. name: filter_any
  4792. type: boolean
  4793. x-go-name: FilterAny
  4794. - description: 返回结果只包含指定的字段
  4795. in: query
  4796. items:
  4797. type: string
  4798. name: field
  4799. type: array
  4800. x-go-name: Field
  4801. - description: 用于数据导出,指定导出的数据字段
  4802. in: query
  4803. name: export_keys
  4804. type: string
  4805. x-go-name: ExportKeys
  4806. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4807. in: query
  4808. name: show_fail_reason
  4809. type: boolean
  4810. x-go-name: ShowFailReason
  4811. - description: 是否返回状态统计信息,默认为False
  4812. in: query
  4813. name: summary_stats
  4814. type: boolean
  4815. x-go-name: SummaryStats
  4816. - $ref: '#/definitions/TTagSet'
  4817. description: 通过标签过滤(包含这些标签)
  4818. in: query
  4819. name: tags
  4820. x-go-name: Tags
  4821. - $ref: '#/definitions/TTagSetList'
  4822. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4823. in: query
  4824. name: obj_tags
  4825. x-go-name: ObjTags
  4826. - $ref: '#/definitions/TTagSet'
  4827. description: 通过标签过滤(不包含这些标签)
  4828. in: query
  4829. name: no_tags
  4830. x-go-name: NoTags
  4831. - $ref: '#/definitions/TTagSetList'
  4832. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4833. in: query
  4834. name: no_obj_tags
  4835. x-go-name: NoObjTags
  4836. - description: 通过标签排序
  4837. in: query
  4838. name: order_by_tag
  4839. type: string
  4840. x-go-name: OrderByTag
  4841. - description: |-
  4842. deprecated
  4843. 返回资源的标签不包含用户标签
  4844. in: query
  4845. name: without_user_meta
  4846. type: boolean
  4847. x-go-name: WithoutUserMeta
  4848. - description: 返回包含用户标签的资源
  4849. in: query
  4850. name: with_user_meta
  4851. type: boolean
  4852. x-go-name: WithUserMeta
  4853. - description: 返回包含外部标签的资源
  4854. in: query
  4855. name: with_cloud_meta
  4856. type: boolean
  4857. x-go-name: WithCloudMeta
  4858. - description: 返回包含任意标签的资源
  4859. in: query
  4860. name: with_any_meta
  4861. type: boolean
  4862. x-go-name: WithAnyMeta
  4863. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4864. in: query
  4865. name: with_meta
  4866. type: boolean
  4867. x-go-name: WithMeta
  4868. - description: 显示所有的资源,包括模拟的资源
  4869. in: query
  4870. name: show_emulated
  4871. type: boolean
  4872. x-go-name: ShowEmulated
  4873. - description: 以资源ID过滤列表
  4874. in: query
  4875. items:
  4876. type: string
  4877. name: id
  4878. type: array
  4879. x-go-name: Ids
  4880. - description: 以资源名称过滤列表
  4881. in: query
  4882. items:
  4883. type: string
  4884. name: name
  4885. type: array
  4886. x-go-name: Names
  4887. - in: query
  4888. name: enabled
  4889. type: boolean
  4890. x-go-name: Enabled
  4891. - description: 按IDP过滤
  4892. in: query
  4893. name: idp_id
  4894. type: string
  4895. x-go-name: IdpId
  4896. - description: 按IDP_ENTITY_ID过滤
  4897. in: query
  4898. name: idp_entity_id
  4899. type: string
  4900. x-go-name: IdpEntityId
  4901. - $ref: '#/definitions/TTagSetList'
  4902. description: domain tags filter imposed by policy
  4903. in: query
  4904. name: policy_domain_tags
  4905. x-go-name: PolicyDomainTags
  4906. responses:
  4907. "200":
  4908. $ref: '#/responses/domain_ListItemFilterOutput'
  4909. summary: 域列表
  4910. tags:
  4911. - domain
  4912. post:
  4913. description: 新建
  4914. operationId: domain_ValidateCreateData
  4915. parameters:
  4916. - in: body
  4917. name: body
  4918. schema:
  4919. properties:
  4920. count:
  4921. default: 1
  4922. format: int64
  4923. type: integer
  4924. x-go-name: Count
  4925. domain:
  4926. $ref: '#/definitions/DomainCreateInput'
  4927. type: object
  4928. x-go-name: Body
  4929. responses:
  4930. "200":
  4931. $ref: '#/responses/domain_ValidateCreateDataOutput'
  4932. summary: 新建
  4933. tags:
  4934. - domain
  4935. /domains/{id}:
  4936. delete:
  4937. description: 删除
  4938. operationId: domain_CustomizeDelete
  4939. parameters:
  4940. - description: The Id or Name of domain
  4941. in: path
  4942. name: id
  4943. required: true
  4944. type: string
  4945. x-go-name: Id
  4946. responses:
  4947. "200":
  4948. $ref: '#/responses/domain_CustomizeDeleteOutput'
  4949. summary: 删除
  4950. tags:
  4951. - domain
  4952. get:
  4953. description: 获取详情
  4954. operationId: domain_FetchCustomizeColumns
  4955. parameters:
  4956. - description: The Id or Name of domain
  4957. in: path
  4958. name: id
  4959. required: true
  4960. type: string
  4961. x-go-name: Id
  4962. responses:
  4963. "200":
  4964. $ref: '#/responses/domain_FetchCustomizeColumnsOutput'
  4965. summary: 获取详情
  4966. tags:
  4967. - domain
  4968. put:
  4969. description: 更新
  4970. operationId: domain_ValidateUpdateData
  4971. parameters:
  4972. - description: The Id or Name of domain
  4973. in: path
  4974. name: id
  4975. required: true
  4976. type: string
  4977. x-go-name: Id
  4978. - in: body
  4979. name: body
  4980. schema:
  4981. properties:
  4982. domain:
  4983. $ref: '#/definitions/DomainUpdateInput'
  4984. type: object
  4985. x-go-name: Body
  4986. responses:
  4987. "200":
  4988. $ref: '#/responses/domain_ValidateUpdateDataOutput'
  4989. summary: 更新
  4990. tags:
  4991. - domain
  4992. /domains/{id}/metadata:
  4993. get:
  4994. description: 获取指定信息Metadata
  4995. operationId: domain_GetDetailsMetadata
  4996. parameters:
  4997. - description: |-
  4998. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  4999. 标签分为
  5000. 类型 | 说明 |
  5001. ----------|---------------------------------------------|
  5002. 系统标签 | 平台定义的标签 |
  5003. 用户标签 | key以user:为前缀,用户自定义标签 |
  5004. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  5005. in: query
  5006. items:
  5007. type: string
  5008. name: field
  5009. type: array
  5010. x-go-name: Field
  5011. - description: 按标签前缀过滤
  5012. in: query
  5013. name: prefix
  5014. type: string
  5015. x-go-name: Prefix
  5016. - description: The Id or Name of domain
  5017. in: path
  5018. name: id
  5019. required: true
  5020. type: string
  5021. x-go-name: Id
  5022. responses:
  5023. "200":
  5024. $ref: '#/responses/domain_GetDetailsMetadataOutput'
  5025. summary: 获取资源标签(元数据)
  5026. tags:
  5027. - domain
  5028. /domains/{id}/unlink-idp:
  5029. post:
  5030. description: 执行操作UnlinkIdp
  5031. operationId: domain_PerformUnlinkIdp
  5032. parameters:
  5033. - description: The Id or Name of domain
  5034. in: path
  5035. name: id
  5036. required: true
  5037. type: string
  5038. x-go-name: Id
  5039. - in: body
  5040. name: body
  5041. schema:
  5042. properties:
  5043. domain:
  5044. $ref: '#/definitions/UserUnlinkIdpInput'
  5045. type: object
  5046. x-go-name: Body
  5047. responses:
  5048. "200":
  5049. $ref: '#/responses/domain_PerformUnlinkIdpOutput'
  5050. summary: domain和IDP的指定entityId解除关联
  5051. tags:
  5052. - domain
  5053. /endpoints:
  5054. get:
  5055. description: 列表
  5056. operationId: endpoint_ListItemFilter
  5057. parameters:
  5058. - default: 20
  5059. description: 查询限制量
  5060. format: int64
  5061. in: query
  5062. name: limit
  5063. type: integer
  5064. x-go-name: Limit
  5065. - default: 0
  5066. description: 查询偏移量
  5067. format: int64
  5068. in: query
  5069. name: offset
  5070. type: integer
  5071. x-go-name: Offset
  5072. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  5073. in: query
  5074. items:
  5075. type: string
  5076. name: order_by
  5077. type: array
  5078. x-go-name: OrderBy
  5079. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  5080. example: desc|asc
  5081. in: query
  5082. name: order
  5083. type: string
  5084. x-go-name: Order
  5085. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  5086. in: query
  5087. name: details
  5088. type: boolean
  5089. x-go-name: Details
  5090. - description: 模糊搜索所有字段
  5091. in: query
  5092. name: search
  5093. type: string
  5094. x-go-name: Search
  5095. - description: |-
  5096. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  5097. 支持的操作符如下:
  5098. 操作符 | 参数个数 | 举例 | 说明 |
  5099. ---------------|----------|------------------------------------------------|-----------------------------|
  5100. in | > 0 | name.in("test", "good") | 在给定数组中 |
  5101. notin | > 0 | name.notin('test') | 不在给定数组中 |
  5102. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  5103. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  5104. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  5105. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  5106. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  5107. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  5108. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  5109. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  5110. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  5111. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  5112. notequals | 1 | name.notequals('test') | 不等于给定值 |
  5113. isnull | 0 | name.isnull() | 值为SQL的NULL |
  5114. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  5115. isempty | 0 | name.isempty('test') | 值为空字符串 |
  5116. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  5117. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  5118. in: query
  5119. items:
  5120. type: string
  5121. name: filter
  5122. type: array
  5123. x-go-name: Filter
  5124. - description: |-
  5125. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  5126. 和其他表关联的语法如下:
  5127. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  5128. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  5129. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  5130. 举例:
  5131. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  5132. in: query
  5133. items:
  5134. type: string
  5135. name: joint_filter
  5136. type: array
  5137. x-go-name: JointFilter
  5138. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  5139. in: query
  5140. name: filter_any
  5141. type: boolean
  5142. x-go-name: FilterAny
  5143. - description: 返回结果只包含指定的字段
  5144. in: query
  5145. items:
  5146. type: string
  5147. name: field
  5148. type: array
  5149. x-go-name: Field
  5150. - description: 用于数据导出,指定导出的数据字段
  5151. in: query
  5152. name: export_keys
  5153. type: string
  5154. x-go-name: ExportKeys
  5155. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  5156. in: query
  5157. name: show_fail_reason
  5158. type: boolean
  5159. x-go-name: ShowFailReason
  5160. - description: 是否返回状态统计信息,默认为False
  5161. in: query
  5162. name: summary_stats
  5163. type: boolean
  5164. x-go-name: SummaryStats
  5165. - $ref: '#/definitions/TTagSet'
  5166. description: 通过标签过滤(包含这些标签)
  5167. in: query
  5168. name: tags
  5169. x-go-name: Tags
  5170. - $ref: '#/definitions/TTagSetList'
  5171. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  5172. in: query
  5173. name: obj_tags
  5174. x-go-name: ObjTags
  5175. - $ref: '#/definitions/TTagSet'
  5176. description: 通过标签过滤(不包含这些标签)
  5177. in: query
  5178. name: no_tags
  5179. x-go-name: NoTags
  5180. - $ref: '#/definitions/TTagSetList'
  5181. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  5182. in: query
  5183. name: no_obj_tags
  5184. x-go-name: NoObjTags
  5185. - description: 通过标签排序
  5186. in: query
  5187. name: order_by_tag
  5188. type: string
  5189. x-go-name: OrderByTag
  5190. - description: |-
  5191. deprecated
  5192. 返回资源的标签不包含用户标签
  5193. in: query
  5194. name: without_user_meta
  5195. type: boolean
  5196. x-go-name: WithoutUserMeta
  5197. - description: 返回包含用户标签的资源
  5198. in: query
  5199. name: with_user_meta
  5200. type: boolean
  5201. x-go-name: WithUserMeta
  5202. - description: 返回包含外部标签的资源
  5203. in: query
  5204. name: with_cloud_meta
  5205. type: boolean
  5206. x-go-name: WithCloudMeta
  5207. - description: 返回包含任意标签的资源
  5208. in: query
  5209. name: with_any_meta
  5210. type: boolean
  5211. x-go-name: WithAnyMeta
  5212. - description: 返回列表数据中包含资源的标签数据(Metadata)
  5213. in: query
  5214. name: with_meta
  5215. type: boolean
  5216. x-go-name: WithMeta
  5217. - description: 显示所有的资源,包括模拟的资源
  5218. in: query
  5219. name: show_emulated
  5220. type: boolean
  5221. x-go-name: ShowEmulated
  5222. - description: 以资源ID过滤列表
  5223. in: query
  5224. items:
  5225. type: string
  5226. name: id
  5227. type: array
  5228. x-go-name: Ids
  5229. - description: 以资源名称过滤列表
  5230. in: query
  5231. items:
  5232. type: string
  5233. name: name
  5234. type: array
  5235. x-go-name: Names
  5236. - description: 服务类型过滤
  5237. in: query
  5238. name: service_type
  5239. type: string
  5240. x-go-name: ServiceType
  5241. - description: 服务名称或ID过滤
  5242. in: query
  5243. name: service_id
  5244. type: string
  5245. x-go-name: ServiceId
  5246. - description: 以服务名称排序
  5247. in: query
  5248. name: order_by_service
  5249. type: string
  5250. x-go-name: OrderByService
  5251. - description: 以区域名称或ID过滤
  5252. in: query
  5253. name: region_id
  5254. type: string
  5255. x-go-name: RegionId
  5256. - description: '以Endpoint接口类型过滤,可能值为: internal, internalURL, public, publicURL, admin, adminURL, console'
  5257. in: query
  5258. name: interface
  5259. type: string
  5260. x-go-name: Interface
  5261. - description: 是否启用
  5262. in: query
  5263. name: enabled
  5264. type: boolean
  5265. x-go-name: Enabled
  5266. responses:
  5267. "200":
  5268. $ref: '#/responses/endpoint_ListItemFilterOutput'
  5269. summary: 服务地址列表
  5270. tags:
  5271. - endpoint
  5272. post:
  5273. description: 新建
  5274. operationId: endpoint_ValidateCreateData
  5275. responses:
  5276. "200":
  5277. $ref: '#/responses/endpoint_ValidateCreateDataOutput'
  5278. summary: 新建
  5279. tags:
  5280. - endpoint
  5281. /endpoints/{id}:
  5282. delete:
  5283. description: 删除
  5284. operationId: endpoint_CustomizeDelete
  5285. parameters:
  5286. - description: The Id or Name of endpoint
  5287. in: path
  5288. name: id
  5289. required: true
  5290. type: string
  5291. x-go-name: Id
  5292. responses:
  5293. "200":
  5294. $ref: '#/responses/endpoint_CustomizeDeleteOutput'
  5295. summary: 删除
  5296. tags:
  5297. - endpoint
  5298. get:
  5299. description: 获取详情
  5300. operationId: endpoint_FetchCustomizeColumns
  5301. parameters:
  5302. - description: The Id or Name of endpoint
  5303. in: path
  5304. name: id
  5305. required: true
  5306. type: string
  5307. x-go-name: Id
  5308. responses:
  5309. "200":
  5310. $ref: '#/responses/endpoint_FetchCustomizeColumnsOutput'
  5311. summary: 获取详情
  5312. tags:
  5313. - endpoint
  5314. put:
  5315. description: 更新
  5316. operationId: endpoint_ValidateUpdateData
  5317. parameters:
  5318. - description: The Id or Name of endpoint
  5319. in: path
  5320. name: id
  5321. required: true
  5322. type: string
  5323. x-go-name: Id
  5324. responses:
  5325. "200":
  5326. $ref: '#/responses/endpoint_ValidateUpdateDataOutput'
  5327. summary: 更新
  5328. tags:
  5329. - endpoint
  5330. /endpoints/{id}/metadata:
  5331. get:
  5332. description: 获取指定信息Metadata
  5333. operationId: endpoint_GetDetailsMetadata
  5334. parameters:
  5335. - description: |-
  5336. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  5337. 标签分为
  5338. 类型 | 说明 |
  5339. ----------|---------------------------------------------|
  5340. 系统标签 | 平台定义的标签 |
  5341. 用户标签 | key以user:为前缀,用户自定义标签 |
  5342. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  5343. in: query
  5344. items:
  5345. type: string
  5346. name: field
  5347. type: array
  5348. x-go-name: Field
  5349. - description: 按标签前缀过滤
  5350. in: query
  5351. name: prefix
  5352. type: string
  5353. x-go-name: Prefix
  5354. - description: The Id or Name of endpoint
  5355. in: path
  5356. name: id
  5357. required: true
  5358. type: string
  5359. x-go-name: Id
  5360. responses:
  5361. "200":
  5362. $ref: '#/responses/endpoint_GetDetailsMetadataOutput'
  5363. summary: 获取资源标签(元数据)
  5364. tags:
  5365. - endpoint
  5366. /groups:
  5367. get:
  5368. description: 列表
  5369. operationId: group_ListItemFilter
  5370. parameters:
  5371. - default: 20
  5372. description: 查询限制量
  5373. format: int64
  5374. in: query
  5375. name: limit
  5376. type: integer
  5377. x-go-name: Limit
  5378. - default: 0
  5379. description: 查询偏移量
  5380. format: int64
  5381. in: query
  5382. name: offset
  5383. type: integer
  5384. x-go-name: Offset
  5385. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  5386. in: query
  5387. items:
  5388. type: string
  5389. name: order_by
  5390. type: array
  5391. x-go-name: OrderBy
  5392. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  5393. example: desc|asc
  5394. in: query
  5395. name: order
  5396. type: string
  5397. x-go-name: Order
  5398. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  5399. in: query
  5400. name: details
  5401. type: boolean
  5402. x-go-name: Details
  5403. - description: 模糊搜索所有字段
  5404. in: query
  5405. name: search
  5406. type: string
  5407. x-go-name: Search
  5408. - description: |-
  5409. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  5410. 支持的操作符如下:
  5411. 操作符 | 参数个数 | 举例 | 说明 |
  5412. ---------------|----------|------------------------------------------------|-----------------------------|
  5413. in | > 0 | name.in("test", "good") | 在给定数组中 |
  5414. notin | > 0 | name.notin('test') | 不在给定数组中 |
  5415. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  5416. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  5417. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  5418. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  5419. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  5420. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  5421. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  5422. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  5423. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  5424. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  5425. notequals | 1 | name.notequals('test') | 不等于给定值 |
  5426. isnull | 0 | name.isnull() | 值为SQL的NULL |
  5427. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  5428. isempty | 0 | name.isempty('test') | 值为空字符串 |
  5429. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  5430. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  5431. in: query
  5432. items:
  5433. type: string
  5434. name: filter
  5435. type: array
  5436. x-go-name: Filter
  5437. - description: |-
  5438. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  5439. 和其他表关联的语法如下:
  5440. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  5441. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  5442. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  5443. 举例:
  5444. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  5445. in: query
  5446. items:
  5447. type: string
  5448. name: joint_filter
  5449. type: array
  5450. x-go-name: JointFilter
  5451. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  5452. in: query
  5453. name: filter_any
  5454. type: boolean
  5455. x-go-name: FilterAny
  5456. - description: 返回结果只包含指定的字段
  5457. in: query
  5458. items:
  5459. type: string
  5460. name: field
  5461. type: array
  5462. x-go-name: Field
  5463. - description: 用于数据导出,指定导出的数据字段
  5464. in: query
  5465. name: export_keys
  5466. type: string
  5467. x-go-name: ExportKeys
  5468. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  5469. in: query
  5470. name: show_fail_reason
  5471. type: boolean
  5472. x-go-name: ShowFailReason
  5473. - description: 是否返回状态统计信息,默认为False
  5474. in: query
  5475. name: summary_stats
  5476. type: boolean
  5477. x-go-name: SummaryStats
  5478. - $ref: '#/definitions/TTagSet'
  5479. description: 通过标签过滤(包含这些标签)
  5480. in: query
  5481. name: tags
  5482. x-go-name: Tags
  5483. - $ref: '#/definitions/TTagSetList'
  5484. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  5485. in: query
  5486. name: obj_tags
  5487. x-go-name: ObjTags
  5488. - $ref: '#/definitions/TTagSet'
  5489. description: 通过标签过滤(不包含这些标签)
  5490. in: query
  5491. name: no_tags
  5492. x-go-name: NoTags
  5493. - $ref: '#/definitions/TTagSetList'
  5494. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  5495. in: query
  5496. name: no_obj_tags
  5497. x-go-name: NoObjTags
  5498. - description: 通过标签排序
  5499. in: query
  5500. name: order_by_tag
  5501. type: string
  5502. x-go-name: OrderByTag
  5503. - description: |-
  5504. deprecated
  5505. 返回资源的标签不包含用户标签
  5506. in: query
  5507. name: without_user_meta
  5508. type: boolean
  5509. x-go-name: WithoutUserMeta
  5510. - description: 返回包含用户标签的资源
  5511. in: query
  5512. name: with_user_meta
  5513. type: boolean
  5514. x-go-name: WithUserMeta
  5515. - description: 返回包含外部标签的资源
  5516. in: query
  5517. name: with_cloud_meta
  5518. type: boolean
  5519. x-go-name: WithCloudMeta
  5520. - description: 返回包含任意标签的资源
  5521. in: query
  5522. name: with_any_meta
  5523. type: boolean
  5524. x-go-name: WithAnyMeta
  5525. - description: 返回列表数据中包含资源的标签数据(Metadata)
  5526. in: query
  5527. name: with_meta
  5528. type: boolean
  5529. x-go-name: WithMeta
  5530. - description: 显示所有的资源,包括模拟的资源
  5531. in: query
  5532. name: show_emulated
  5533. type: boolean
  5534. x-go-name: ShowEmulated
  5535. - description: 以资源ID过滤列表
  5536. in: query
  5537. items:
  5538. type: string
  5539. name: id
  5540. type: array
  5541. x-go-name: Ids
  5542. - description: 以资源名称过滤列表
  5543. in: query
  5544. items:
  5545. type: string
  5546. name: name
  5547. type: array
  5548. x-go-name: Names
  5549. - description: 指定查询的权限范围,可能值为project, domain or system
  5550. in: query
  5551. name: scope
  5552. type: string
  5553. x-go-name: Scope
  5554. - description: 对具有域属性的资源,严格匹配域ID
  5555. in: query
  5556. items:
  5557. type: string
  5558. name: project_domain_ids
  5559. type: array
  5560. x-go-name: ProjectDomainIds
  5561. - description: 按domain名称排序,可能值为asc|desc
  5562. in: query
  5563. name: order_by_domain
  5564. pattern: asc|desc
  5565. type: string
  5566. x-go-name: OrderByDomain
  5567. - $ref: '#/definitions/TTagSetList'
  5568. description: filter by domain tags
  5569. in: query
  5570. name: domain_tags
  5571. x-go-name: DomainTags
  5572. - $ref: '#/definitions/TTagSetList'
  5573. description: filter by domain tags
  5574. in: query
  5575. name: no_domain_tags
  5576. x-go-name: NoDomainTags
  5577. - description: 用户归属域
  5578. in: query
  5579. name: user_domain_id
  5580. type: string
  5581. x-go-name: UserDomainId
  5582. - description: filter by user
  5583. in: query
  5584. name: user_id
  5585. type: string
  5586. x-go-name: UserId
  5587. - description: 项目归属域
  5588. in: query
  5589. name: project_domain_id
  5590. type: string
  5591. x-go-name: ProjectDomainId
  5592. - description: 以项目(ID或Name)过滤列表结果
  5593. in: query
  5594. name: project_id
  5595. type: string
  5596. x-go-name: ProjectId
  5597. - description: 名称过滤
  5598. in: query
  5599. name: displayname
  5600. type: string
  5601. x-go-name: Displayname
  5602. - description: 按IDP过滤
  5603. in: query
  5604. name: idp_id
  5605. type: string
  5606. x-go-name: IdpId
  5607. responses:
  5608. "200":
  5609. $ref: '#/responses/group_ListItemFilterOutput'
  5610. summary: 用户组列表
  5611. tags:
  5612. - group
  5613. post:
  5614. description: 新建
  5615. operationId: group_ValidateCreateData
  5616. parameters:
  5617. - in: body
  5618. name: body
  5619. schema:
  5620. properties:
  5621. count:
  5622. default: 1
  5623. format: int64
  5624. type: integer
  5625. x-go-name: Count
  5626. group:
  5627. $ref: '#/definitions/GroupCreateInput'
  5628. type: object
  5629. x-go-name: Body
  5630. responses:
  5631. "200":
  5632. $ref: '#/responses/group_ValidateCreateDataOutput'
  5633. summary: 新建
  5634. tags:
  5635. - group
  5636. /groups/{id}:
  5637. delete:
  5638. description: 删除
  5639. operationId: group_CustomizeDelete
  5640. parameters:
  5641. - description: The Id or Name of group
  5642. in: path
  5643. name: id
  5644. required: true
  5645. type: string
  5646. x-go-name: Id
  5647. responses:
  5648. "200":
  5649. $ref: '#/responses/group_CustomizeDeleteOutput'
  5650. summary: 删除
  5651. tags:
  5652. - group
  5653. get:
  5654. description: 获取详情
  5655. operationId: group_FetchCustomizeColumns
  5656. parameters:
  5657. - description: The Id or Name of group
  5658. in: path
  5659. name: id
  5660. required: true
  5661. type: string
  5662. x-go-name: Id
  5663. responses:
  5664. "200":
  5665. $ref: '#/responses/group_FetchCustomizeColumnsOutput'
  5666. summary: 获取详情
  5667. tags:
  5668. - group
  5669. put:
  5670. description: 更新
  5671. operationId: group_ValidateUpdateData
  5672. parameters:
  5673. - description: The Id or Name of group
  5674. in: path
  5675. name: id
  5676. required: true
  5677. type: string
  5678. x-go-name: Id
  5679. - in: body
  5680. name: body
  5681. schema:
  5682. properties:
  5683. group:
  5684. $ref: '#/definitions/GroupUpdateInput'
  5685. type: object
  5686. x-go-name: Body
  5687. responses:
  5688. "200":
  5689. $ref: '#/responses/group_ValidateUpdateDataOutput'
  5690. summary: 更新
  5691. tags:
  5692. - group
  5693. /groups/{id}/add-users:
  5694. post:
  5695. description: 执行操作AddUsers
  5696. operationId: group_PerformAddUsers
  5697. parameters:
  5698. - description: The Id or Name of group
  5699. in: path
  5700. name: id
  5701. required: true
  5702. type: string
  5703. x-go-name: Id
  5704. - in: body
  5705. name: body
  5706. schema:
  5707. properties:
  5708. group:
  5709. $ref: '#/definitions/PerformGroupAddUsersInput'
  5710. type: object
  5711. x-go-name: Body
  5712. responses:
  5713. "200":
  5714. $ref: '#/responses/group_PerformAddUsersOutput'
  5715. summary: 组添加用户
  5716. tags:
  5717. - group
  5718. /groups/{id}/join:
  5719. post:
  5720. description: 执行操作Join
  5721. operationId: group_PerformJoin
  5722. parameters:
  5723. - description: The Id or Name of group
  5724. in: path
  5725. name: id
  5726. required: true
  5727. type: string
  5728. x-go-name: Id
  5729. - in: body
  5730. name: body
  5731. schema:
  5732. properties:
  5733. group:
  5734. $ref: '#/definitions/SJoinProjectsInput'
  5735. type: object
  5736. x-go-name: Body
  5737. responses:
  5738. "200":
  5739. $ref: '#/responses/group_PerformJoinOutput'
  5740. summary: 组加入项目
  5741. tags:
  5742. - group
  5743. /groups/{id}/leave:
  5744. post:
  5745. description: 执行操作Leave
  5746. operationId: group_PerformLeave
  5747. parameters:
  5748. - description: The Id or Name of group
  5749. in: path
  5750. name: id
  5751. required: true
  5752. type: string
  5753. x-go-name: Id
  5754. - in: body
  5755. name: body
  5756. schema:
  5757. properties:
  5758. group:
  5759. $ref: '#/definitions/SLeaveProjectsInput'
  5760. type: object
  5761. x-go-name: Body
  5762. responses:
  5763. "200":
  5764. $ref: '#/responses/group_PerformLeaveOutput'
  5765. summary: 组退出项目
  5766. tags:
  5767. - group
  5768. /groups/{id}/metadata:
  5769. get:
  5770. description: 获取指定信息Metadata
  5771. operationId: group_GetDetailsMetadata
  5772. parameters:
  5773. - description: |-
  5774. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  5775. 标签分为
  5776. 类型 | 说明 |
  5777. ----------|---------------------------------------------|
  5778. 系统标签 | 平台定义的标签 |
  5779. 用户标签 | key以user:为前缀,用户自定义标签 |
  5780. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  5781. in: query
  5782. items:
  5783. type: string
  5784. name: field
  5785. type: array
  5786. x-go-name: Field
  5787. - description: 按标签前缀过滤
  5788. in: query
  5789. name: prefix
  5790. type: string
  5791. x-go-name: Prefix
  5792. - description: The Id or Name of group
  5793. in: path
  5794. name: id
  5795. required: true
  5796. type: string
  5797. x-go-name: Id
  5798. responses:
  5799. "200":
  5800. $ref: '#/responses/group_GetDetailsMetadataOutput'
  5801. summary: 获取资源标签(元数据)
  5802. tags:
  5803. - group
  5804. /groups/{id}/remove-users:
  5805. post:
  5806. description: 执行操作RemoveUsers
  5807. operationId: group_PerformRemoveUsers
  5808. parameters:
  5809. - description: The Id or Name of group
  5810. in: path
  5811. name: id
  5812. required: true
  5813. type: string
  5814. x-go-name: Id
  5815. - in: body
  5816. name: body
  5817. schema:
  5818. properties:
  5819. group:
  5820. $ref: '#/definitions/PerformGroupRemoveUsersInput'
  5821. type: object
  5822. x-go-name: Body
  5823. responses:
  5824. "200":
  5825. $ref: '#/responses/group_PerformRemoveUsersOutput'
  5826. summary: 组删除用户
  5827. tags:
  5828. - group
  5829. /groups/domain-tag-value-pairs:
  5830. get:
  5831. description: 获取指定资源类的信息DomainTagValuePairs
  5832. operationId: group_GetPropertyDomainTagValuePairs
  5833. responses:
  5834. "200":
  5835. $ref: '#/responses/group_GetPropertyDomainTagValuePairsOutput'
  5836. summary: 获取指定资源类的信息DomainTagValuePairs
  5837. tags:
  5838. - group
  5839. /groups/domain-tag-value-tree:
  5840. get:
  5841. description: 获取指定资源类的信息DomainTagValueTree
  5842. operationId: group_GetPropertyDomainTagValueTree
  5843. responses:
  5844. "200":
  5845. $ref: '#/responses/group_GetPropertyDomainTagValueTreeOutput'
  5846. summary: 获取指定资源类的信息DomainTagValueTree
  5847. tags:
  5848. - group
  5849. /identity_providers:
  5850. get:
  5851. description: 列表
  5852. operationId: identity_provider_ListItemFilter
  5853. parameters:
  5854. - default: 20
  5855. description: 查询限制量
  5856. format: int64
  5857. in: query
  5858. name: limit
  5859. type: integer
  5860. x-go-name: Limit
  5861. - default: 0
  5862. description: 查询偏移量
  5863. format: int64
  5864. in: query
  5865. name: offset
  5866. type: integer
  5867. x-go-name: Offset
  5868. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  5869. in: query
  5870. items:
  5871. type: string
  5872. name: order_by
  5873. type: array
  5874. x-go-name: OrderBy
  5875. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  5876. example: desc|asc
  5877. in: query
  5878. name: order
  5879. type: string
  5880. x-go-name: Order
  5881. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  5882. in: query
  5883. name: details
  5884. type: boolean
  5885. x-go-name: Details
  5886. - description: 模糊搜索所有字段
  5887. in: query
  5888. name: search
  5889. type: string
  5890. x-go-name: Search
  5891. - description: |-
  5892. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  5893. 支持的操作符如下:
  5894. 操作符 | 参数个数 | 举例 | 说明 |
  5895. ---------------|----------|------------------------------------------------|-----------------------------|
  5896. in | > 0 | name.in("test", "good") | 在给定数组中 |
  5897. notin | > 0 | name.notin('test') | 不在给定数组中 |
  5898. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  5899. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  5900. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  5901. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  5902. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  5903. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  5904. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  5905. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  5906. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  5907. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  5908. notequals | 1 | name.notequals('test') | 不等于给定值 |
  5909. isnull | 0 | name.isnull() | 值为SQL的NULL |
  5910. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  5911. isempty | 0 | name.isempty('test') | 值为空字符串 |
  5912. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  5913. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  5914. in: query
  5915. items:
  5916. type: string
  5917. name: filter
  5918. type: array
  5919. x-go-name: Filter
  5920. - description: |-
  5921. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  5922. 和其他表关联的语法如下:
  5923. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  5924. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  5925. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  5926. 举例:
  5927. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  5928. in: query
  5929. items:
  5930. type: string
  5931. name: joint_filter
  5932. type: array
  5933. x-go-name: JointFilter
  5934. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  5935. in: query
  5936. name: filter_any
  5937. type: boolean
  5938. x-go-name: FilterAny
  5939. - description: 返回结果只包含指定的字段
  5940. in: query
  5941. items:
  5942. type: string
  5943. name: field
  5944. type: array
  5945. x-go-name: Field
  5946. - description: 用于数据导出,指定导出的数据字段
  5947. in: query
  5948. name: export_keys
  5949. type: string
  5950. x-go-name: ExportKeys
  5951. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  5952. in: query
  5953. name: show_fail_reason
  5954. type: boolean
  5955. x-go-name: ShowFailReason
  5956. - description: 是否返回状态统计信息,默认为False
  5957. in: query
  5958. name: summary_stats
  5959. type: boolean
  5960. x-go-name: SummaryStats
  5961. - $ref: '#/definitions/TTagSet'
  5962. description: 通过标签过滤(包含这些标签)
  5963. in: query
  5964. name: tags
  5965. x-go-name: Tags
  5966. - $ref: '#/definitions/TTagSetList'
  5967. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  5968. in: query
  5969. name: obj_tags
  5970. x-go-name: ObjTags
  5971. - $ref: '#/definitions/TTagSet'
  5972. description: 通过标签过滤(不包含这些标签)
  5973. in: query
  5974. name: no_tags
  5975. x-go-name: NoTags
  5976. - $ref: '#/definitions/TTagSetList'
  5977. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  5978. in: query
  5979. name: no_obj_tags
  5980. x-go-name: NoObjTags
  5981. - description: 通过标签排序
  5982. in: query
  5983. name: order_by_tag
  5984. type: string
  5985. x-go-name: OrderByTag
  5986. - description: |-
  5987. deprecated
  5988. 返回资源的标签不包含用户标签
  5989. in: query
  5990. name: without_user_meta
  5991. type: boolean
  5992. x-go-name: WithoutUserMeta
  5993. - description: 返回包含用户标签的资源
  5994. in: query
  5995. name: with_user_meta
  5996. type: boolean
  5997. x-go-name: WithUserMeta
  5998. - description: 返回包含外部标签的资源
  5999. in: query
  6000. name: with_cloud_meta
  6001. type: boolean
  6002. x-go-name: WithCloudMeta
  6003. - description: 返回包含任意标签的资源
  6004. in: query
  6005. name: with_any_meta
  6006. type: boolean
  6007. x-go-name: WithAnyMeta
  6008. - description: 返回列表数据中包含资源的标签数据(Metadata)
  6009. in: query
  6010. name: with_meta
  6011. type: boolean
  6012. x-go-name: WithMeta
  6013. - description: 显示所有的资源,包括模拟的资源
  6014. in: query
  6015. name: show_emulated
  6016. type: boolean
  6017. x-go-name: ShowEmulated
  6018. - description: 以资源ID过滤列表
  6019. in: query
  6020. items:
  6021. type: string
  6022. name: id
  6023. type: array
  6024. x-go-name: Ids
  6025. - description: 以资源名称过滤列表
  6026. in: query
  6027. items:
  6028. type: string
  6029. name: name
  6030. type: array
  6031. x-go-name: Names
  6032. - description: 以资源的状态过滤列表
  6033. in: query
  6034. items:
  6035. type: string
  6036. name: status
  6037. type: array
  6038. x-go-name: Status
  6039. - description: 以资源是否启用/禁用过滤列表
  6040. in: query
  6041. name: enabled
  6042. type: boolean
  6043. x-go-name: Enabled
  6044. - description: 指定查询的权限范围,可能值为project, domain or system
  6045. in: query
  6046. name: scope
  6047. type: string
  6048. x-go-name: Scope
  6049. - description: 指定项目归属域名称或ID
  6050. in: query
  6051. name: project_domain_id
  6052. type: string
  6053. x-go-name: ProjectDomainId
  6054. - description: 对具有域属性的资源,严格匹配域ID
  6055. in: query
  6056. items:
  6057. type: string
  6058. name: project_domain_ids
  6059. type: array
  6060. x-go-name: ProjectDomainIds
  6061. - description: 按domain名称排序,可能值为asc|desc
  6062. in: query
  6063. name: order_by_domain
  6064. pattern: asc|desc
  6065. type: string
  6066. x-go-name: OrderByDomain
  6067. - $ref: '#/definitions/TTagSetList'
  6068. description: filter by domain tags
  6069. in: query
  6070. name: domain_tags
  6071. x-go-name: DomainTags
  6072. - $ref: '#/definitions/TTagSetList'
  6073. description: filter by domain tags
  6074. in: query
  6075. name: no_domain_tags
  6076. x-go-name: NoDomainTags
  6077. - description: 以驱动类型过滤
  6078. in: query
  6079. items:
  6080. type: string
  6081. name: driver
  6082. type: array
  6083. x-go-name: Driver
  6084. - description: 以模板过滤
  6085. in: query
  6086. items:
  6087. type: string
  6088. name: template
  6089. type: array
  6090. x-go-name: Template
  6091. - description: 以同步状态过滤
  6092. in: query
  6093. items:
  6094. type: string
  6095. name: sync_status
  6096. type: array
  6097. x-go-name: SyncStatus
  6098. - description: 过滤支持SSO的认证源,如果值为all,则列出所有的全局认证源,否则可出sso为域ID的域认证源
  6099. example: all
  6100. in: query
  6101. name: sso_domain
  6102. type: string
  6103. x-go-name: SsoDomain
  6104. - in: query
  6105. name: auto_create_project
  6106. type: boolean
  6107. x-go-name: AutoCreateProject
  6108. - in: query
  6109. name: auto_create_user
  6110. type: boolean
  6111. x-go-name: AutoCreateUser
  6112. responses:
  6113. "200":
  6114. $ref: '#/responses/identity_provider_ListItemFilterOutput'
  6115. summary: 列表
  6116. tags:
  6117. - identity_provider
  6118. post:
  6119. description: 新建
  6120. operationId: identity_provider_ValidateCreateData
  6121. parameters:
  6122. - in: body
  6123. name: body
  6124. schema:
  6125. properties:
  6126. count:
  6127. default: 1
  6128. format: int64
  6129. type: integer
  6130. x-go-name: Count
  6131. identity_provider:
  6132. $ref: '#/definitions/IdentityProviderCreateInput'
  6133. type: object
  6134. x-go-name: Body
  6135. responses:
  6136. "200":
  6137. $ref: '#/responses/identity_provider_ValidateCreateDataOutput'
  6138. summary: 新建
  6139. tags:
  6140. - identity_provider
  6141. /identity_providers/{id}:
  6142. delete:
  6143. description: 删除
  6144. operationId: identity_provider_CustomizeDelete
  6145. parameters:
  6146. - description: The Id or Name of identity_provider
  6147. in: path
  6148. name: id
  6149. required: true
  6150. type: string
  6151. x-go-name: Id
  6152. responses:
  6153. "200":
  6154. $ref: '#/responses/identity_provider_CustomizeDeleteOutput'
  6155. summary: 删除
  6156. tags:
  6157. - identity_provider
  6158. get:
  6159. description: 获取详情
  6160. operationId: identity_provider_FetchCustomizeColumns
  6161. parameters:
  6162. - description: The Id or Name of identity_provider
  6163. in: path
  6164. name: id
  6165. required: true
  6166. type: string
  6167. x-go-name: Id
  6168. responses:
  6169. "200":
  6170. $ref: '#/responses/identity_provider_FetchCustomizeColumnsOutput'
  6171. summary: 获取详情
  6172. tags:
  6173. - identity_provider
  6174. put:
  6175. description: 更新
  6176. operationId: identity_provider_ValidateUpdateData
  6177. parameters:
  6178. - description: The Id or Name of identity_provider
  6179. in: path
  6180. name: id
  6181. required: true
  6182. type: string
  6183. x-go-name: Id
  6184. - in: body
  6185. name: body
  6186. schema:
  6187. properties:
  6188. identity_provider:
  6189. $ref: '#/definitions/IdentityProviderUpdateInput'
  6190. type: object
  6191. x-go-name: Body
  6192. responses:
  6193. "200":
  6194. $ref: '#/responses/identity_provider_ValidateUpdateDataOutput'
  6195. summary: 更新
  6196. tags:
  6197. - identity_provider
  6198. /identity_providers/{id}/config:
  6199. get:
  6200. description: 获取指定信息Config
  6201. operationId: identity_provider_GetDetailsConfig
  6202. parameters:
  6203. - description: The Id or Name of identity_provider
  6204. in: path
  6205. name: id
  6206. required: true
  6207. type: string
  6208. x-go-name: Id
  6209. responses:
  6210. "200":
  6211. $ref: '#/responses/identity_provider_GetDetailsConfigOutput'
  6212. summary: 获取指定信息Config
  6213. tags:
  6214. - identity_provider
  6215. post:
  6216. description: 执行操作Config
  6217. operationId: identity_provider_PerformConfig
  6218. parameters:
  6219. - description: The Id or Name of identity_provider
  6220. in: path
  6221. name: id
  6222. required: true
  6223. type: string
  6224. x-go-name: Id
  6225. - in: body
  6226. name: body
  6227. schema:
  6228. properties:
  6229. identity_provider:
  6230. $ref: '#/definitions/PerformConfigInput'
  6231. type: object
  6232. x-go-name: Body
  6233. responses:
  6234. "200":
  6235. $ref: '#/responses/identity_provider_PerformConfigOutput'
  6236. summary: 配置认证源
  6237. tags:
  6238. - identity_provider
  6239. /identity_providers/{id}/default-sso:
  6240. post:
  6241. description: 执行操作DefaultSso
  6242. operationId: identity_provider_PerformDefaultSso
  6243. parameters:
  6244. - description: The Id or Name of identity_provider
  6245. in: path
  6246. name: id
  6247. required: true
  6248. type: string
  6249. x-go-name: Id
  6250. - in: body
  6251. name: body
  6252. schema:
  6253. properties:
  6254. identity_provider:
  6255. $ref: '#/definitions/PerformDefaultSsoInput'
  6256. type: object
  6257. x-go-name: Body
  6258. responses:
  6259. "200":
  6260. $ref: '#/responses/identity_provider_PerformDefaultSsoOutput'
  6261. summary: 执行操作DefaultSso
  6262. tags:
  6263. - identity_provider
  6264. /identity_providers/{id}/disable:
  6265. post:
  6266. description: 执行操作Disable
  6267. operationId: identity_provider_PerformDisable
  6268. parameters:
  6269. - description: The Id or Name of identity_provider
  6270. in: path
  6271. name: id
  6272. required: true
  6273. type: string
  6274. x-go-name: Id
  6275. - in: body
  6276. name: body
  6277. schema:
  6278. properties:
  6279. identity_provider:
  6280. $ref: '#/definitions/PerformDisableInput'
  6281. type: object
  6282. x-go-name: Body
  6283. responses:
  6284. "200":
  6285. $ref: '#/responses/identity_provider_PerformDisableOutput'
  6286. summary: 执行操作Disable
  6287. tags:
  6288. - identity_provider
  6289. /identity_providers/{id}/enable:
  6290. post:
  6291. description: 执行操作Enable
  6292. operationId: identity_provider_PerformEnable
  6293. parameters:
  6294. - description: The Id or Name of identity_provider
  6295. in: path
  6296. name: id
  6297. required: true
  6298. type: string
  6299. x-go-name: Id
  6300. - in: body
  6301. name: body
  6302. schema:
  6303. properties:
  6304. identity_provider:
  6305. $ref: '#/definitions/PerformEnableInput'
  6306. type: object
  6307. x-go-name: Body
  6308. responses:
  6309. "200":
  6310. $ref: '#/responses/identity_provider_PerformEnableOutput'
  6311. summary: 执行操作Enable
  6312. tags:
  6313. - identity_provider
  6314. /identity_providers/{id}/metadata:
  6315. get:
  6316. description: 获取指定信息Metadata
  6317. operationId: identity_provider_GetDetailsMetadata
  6318. parameters:
  6319. - description: |-
  6320. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  6321. 标签分为
  6322. 类型 | 说明 |
  6323. ----------|---------------------------------------------|
  6324. 系统标签 | 平台定义的标签 |
  6325. 用户标签 | key以user:为前缀,用户自定义标签 |
  6326. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  6327. in: query
  6328. items:
  6329. type: string
  6330. name: field
  6331. type: array
  6332. x-go-name: Field
  6333. - description: 按标签前缀过滤
  6334. in: query
  6335. name: prefix
  6336. type: string
  6337. x-go-name: Prefix
  6338. - description: The Id or Name of identity_provider
  6339. in: path
  6340. name: id
  6341. required: true
  6342. type: string
  6343. x-go-name: Id
  6344. responses:
  6345. "200":
  6346. $ref: '#/responses/identity_provider_GetDetailsMetadataOutput'
  6347. summary: 获取资源标签(元数据)
  6348. tags:
  6349. - identity_provider
  6350. /identity_providers/{id}/saml-metadata:
  6351. get:
  6352. description: 获取指定信息SamlMetadata
  6353. operationId: identity_provider_GetDetailsSamlMetadata
  6354. parameters:
  6355. - description: 缩进展示SAML sp metadata
  6356. in: query
  6357. name: pretty
  6358. type: boolean
  6359. x-go-name: Pretty
  6360. - description: AssertionConsumer callback URL
  6361. in: query
  6362. name: redirect_uri
  6363. type: string
  6364. x-go-name: RedirectUri
  6365. - description: The Id or Name of identity_provider
  6366. in: path
  6367. name: id
  6368. required: true
  6369. type: string
  6370. x-go-name: Id
  6371. responses:
  6372. "200":
  6373. $ref: '#/responses/identity_provider_GetDetailsSamlMetadataOutput'
  6374. summary: 获取指定信息SamlMetadata
  6375. tags:
  6376. - identity_provider
  6377. /identity_providers/{id}/sso-callback-uri:
  6378. get:
  6379. description: 获取指定信息SsoCallbackUri
  6380. operationId: identity_provider_GetDetailsSsoCallbackUri
  6381. parameters:
  6382. - description: SSO回调地址
  6383. in: query
  6384. name: redirect_uri
  6385. type: string
  6386. x-go-name: RedirectUri
  6387. - description: The Id or Name of identity_provider
  6388. in: path
  6389. name: id
  6390. required: true
  6391. type: string
  6392. x-go-name: Id
  6393. responses:
  6394. "200":
  6395. $ref: '#/responses/identity_provider_GetDetailsSsoCallbackUriOutput'
  6396. summary: 获取指定信息SsoCallbackUri
  6397. tags:
  6398. - identity_provider
  6399. /identity_providers/{id}/sso-redirect-uri:
  6400. get:
  6401. description: 获取指定信息SsoRedirectUri
  6402. operationId: identity_provider_GetDetailsSsoRedirectUri
  6403. parameters:
  6404. - description: SSO回调地址
  6405. in: query
  6406. name: redirect_uri
  6407. type: string
  6408. x-go-name: RedirectUri
  6409. - description: SSO状态信息
  6410. in: query
  6411. name: state
  6412. type: string
  6413. x-go-name: State
  6414. - description: The Id or Name of identity_provider
  6415. in: path
  6416. name: id
  6417. required: true
  6418. type: string
  6419. x-go-name: Id
  6420. responses:
  6421. "200":
  6422. $ref: '#/responses/identity_provider_GetDetailsSsoRedirectUriOutput'
  6423. summary: 获取指定信息SsoRedirectUri
  6424. tags:
  6425. - identity_provider
  6426. /identity_providers/{id}/status:
  6427. get:
  6428. description: 获取指定信息Status
  6429. operationId: identity_provider_GetDetailsStatus
  6430. parameters:
  6431. - description: The Id or Name of identity_provider
  6432. in: path
  6433. name: id
  6434. required: true
  6435. type: string
  6436. x-go-name: Id
  6437. responses:
  6438. "200":
  6439. $ref: '#/responses/identity_provider_GetDetailsStatusOutput'
  6440. summary: 获取资源状态
  6441. tags:
  6442. - identity_provider
  6443. /identity_providers/{id}/sync:
  6444. post:
  6445. description: 执行操作Sync
  6446. operationId: identity_provider_PerformSync
  6447. parameters:
  6448. - description: The Id or Name of identity_provider
  6449. in: path
  6450. name: id
  6451. required: true
  6452. type: string
  6453. x-go-name: Id
  6454. responses:
  6455. "200":
  6456. $ref: '#/responses/identity_provider_PerformSyncOutput'
  6457. summary: 手动同步认证源
  6458. tags:
  6459. - identity_provider
  6460. /identity_quotas/domains:
  6461. get:
  6462. description: 获取所有域的域配额
  6463. operationId: models_ListIdentityQuotas
  6464. parameters:
  6465. - description: |-
  6466. 只列出主配额
  6467. require:false
  6468. in: query
  6469. name: primary
  6470. type: boolean
  6471. x-go-name: Primary
  6472. - description: |-
  6473. 强制刷新使用量
  6474. require:false
  6475. in: query
  6476. name: refresh
  6477. type: boolean
  6478. x-go-name: Refresh
  6479. responses:
  6480. "200":
  6481. $ref: '#/responses/models_ListIdentityQuotasOutput'
  6482. summary: 获取所有域的域配额
  6483. tags:
  6484. - identity_quota
  6485. /identity_quotas/domains/{domainId}:
  6486. get:
  6487. description: 获取指定域的认证配额
  6488. operationId: models_GetIdentityQuota
  6489. parameters:
  6490. - description: |-
  6491. 只列出主配额
  6492. require:false
  6493. in: query
  6494. name: primary
  6495. type: boolean
  6496. x-go-name: Primary
  6497. - description: |-
  6498. 强制刷新使用量
  6499. require:false
  6500. in: query
  6501. name: refresh
  6502. type: boolean
  6503. x-go-name: Refresh
  6504. - description: 指定域的ID
  6505. in: path
  6506. name: domainId
  6507. required: true
  6508. type: string
  6509. x-go-name: DomainId
  6510. responses:
  6511. "200":
  6512. $ref: '#/responses/models_GetIdentityQuotaOutput'
  6513. summary: 获取指定域的认证配额
  6514. tags:
  6515. - identity_quota
  6516. post:
  6517. description: 设置域的认证配额
  6518. operationId: models_SetIdentityQuotas
  6519. parameters:
  6520. - description: 指定域的ID
  6521. in: path
  6522. name: domainId
  6523. required: true
  6524. type: string
  6525. x-go-name: DomainId
  6526. - in: body
  6527. name: body
  6528. schema:
  6529. properties:
  6530. identity_quotas:
  6531. $ref: '#/definitions/SetIdentityQuotaInput'
  6532. type: object
  6533. x-go-name: Body
  6534. responses:
  6535. "200":
  6536. $ref: '#/responses/models_SetIdentityQuotasOutput'
  6537. summary: 设置域的认证配额
  6538. tags:
  6539. - identity_quota
  6540. /organization_nodes:
  6541. get:
  6542. description: 列表
  6543. operationId: organization_node_ListItemFilter
  6544. parameters:
  6545. - default: 20
  6546. description: 查询限制量
  6547. format: int64
  6548. in: query
  6549. name: limit
  6550. type: integer
  6551. x-go-name: Limit
  6552. - default: 0
  6553. description: 查询偏移量
  6554. format: int64
  6555. in: query
  6556. name: offset
  6557. type: integer
  6558. x-go-name: Offset
  6559. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6560. in: query
  6561. items:
  6562. type: string
  6563. name: order_by
  6564. type: array
  6565. x-go-name: OrderBy
  6566. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6567. example: desc|asc
  6568. in: query
  6569. name: order
  6570. type: string
  6571. x-go-name: Order
  6572. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6573. in: query
  6574. name: details
  6575. type: boolean
  6576. x-go-name: Details
  6577. - description: 模糊搜索所有字段
  6578. in: query
  6579. name: search
  6580. type: string
  6581. x-go-name: Search
  6582. - description: |-
  6583. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6584. 支持的操作符如下:
  6585. 操作符 | 参数个数 | 举例 | 说明 |
  6586. ---------------|----------|------------------------------------------------|-----------------------------|
  6587. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6588. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6589. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6590. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6591. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6592. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6593. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6594. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6595. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6596. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6597. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6598. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6599. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6600. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6601. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6602. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6603. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6604. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6605. in: query
  6606. items:
  6607. type: string
  6608. name: filter
  6609. type: array
  6610. x-go-name: Filter
  6611. - description: |-
  6612. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6613. 和其他表关联的语法如下:
  6614. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6615. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6616. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  6617. 举例:
  6618. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  6619. in: query
  6620. items:
  6621. type: string
  6622. name: joint_filter
  6623. type: array
  6624. x-go-name: JointFilter
  6625. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  6626. in: query
  6627. name: filter_any
  6628. type: boolean
  6629. x-go-name: FilterAny
  6630. - description: 返回结果只包含指定的字段
  6631. in: query
  6632. items:
  6633. type: string
  6634. name: field
  6635. type: array
  6636. x-go-name: Field
  6637. - description: 用于数据导出,指定导出的数据字段
  6638. in: query
  6639. name: export_keys
  6640. type: string
  6641. x-go-name: ExportKeys
  6642. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  6643. in: query
  6644. name: show_fail_reason
  6645. type: boolean
  6646. x-go-name: ShowFailReason
  6647. - description: 是否返回状态统计信息,默认为False
  6648. in: query
  6649. name: summary_stats
  6650. type: boolean
  6651. x-go-name: SummaryStats
  6652. - $ref: '#/definitions/TTagSet'
  6653. description: 通过标签过滤(包含这些标签)
  6654. in: query
  6655. name: tags
  6656. x-go-name: Tags
  6657. - $ref: '#/definitions/TTagSetList'
  6658. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  6659. in: query
  6660. name: obj_tags
  6661. x-go-name: ObjTags
  6662. - $ref: '#/definitions/TTagSet'
  6663. description: 通过标签过滤(不包含这些标签)
  6664. in: query
  6665. name: no_tags
  6666. x-go-name: NoTags
  6667. - $ref: '#/definitions/TTagSetList'
  6668. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  6669. in: query
  6670. name: no_obj_tags
  6671. x-go-name: NoObjTags
  6672. - description: 通过标签排序
  6673. in: query
  6674. name: order_by_tag
  6675. type: string
  6676. x-go-name: OrderByTag
  6677. - description: |-
  6678. deprecated
  6679. 返回资源的标签不包含用户标签
  6680. in: query
  6681. name: without_user_meta
  6682. type: boolean
  6683. x-go-name: WithoutUserMeta
  6684. - description: 返回包含用户标签的资源
  6685. in: query
  6686. name: with_user_meta
  6687. type: boolean
  6688. x-go-name: WithUserMeta
  6689. - description: 返回包含外部标签的资源
  6690. in: query
  6691. name: with_cloud_meta
  6692. type: boolean
  6693. x-go-name: WithCloudMeta
  6694. - description: 返回包含任意标签的资源
  6695. in: query
  6696. name: with_any_meta
  6697. type: boolean
  6698. x-go-name: WithAnyMeta
  6699. - description: 返回列表数据中包含资源的标签数据(Metadata)
  6700. in: query
  6701. name: with_meta
  6702. type: boolean
  6703. x-go-name: WithMeta
  6704. - description: 显示所有的资源,包括模拟的资源
  6705. in: query
  6706. name: show_emulated
  6707. type: boolean
  6708. x-go-name: ShowEmulated
  6709. - description: 以资源ID过滤列表
  6710. in: query
  6711. items:
  6712. type: string
  6713. name: id
  6714. type: array
  6715. x-go-name: Ids
  6716. - description: 以资源名称过滤列表
  6717. in: query
  6718. items:
  6719. type: string
  6720. name: name
  6721. type: array
  6722. x-go-name: Names
  6723. - in: query
  6724. name: org_id
  6725. type: string
  6726. x-go-name: OrgId
  6727. - in: query
  6728. name: org_type
  6729. type: string
  6730. x-go-name: OrgType
  6731. - format: int64
  6732. in: query
  6733. name: level
  6734. type: integer
  6735. x-go-name: Level
  6736. - $ref: '#/definitions/TTagSetList'
  6737. description: domain tags filter imposed by policy
  6738. in: query
  6739. name: policy_domain_tags
  6740. x-go-name: PolicyDomainTags
  6741. - $ref: '#/definitions/TTagSetList'
  6742. description: project tags filter imposed by policy
  6743. in: query
  6744. name: policy_project_tags
  6745. x-go-name: PolicyProjectTags
  6746. - $ref: '#/definitions/TTagSetList'
  6747. description: object tags filter imposed by policy
  6748. in: query
  6749. name: policy_object_tags
  6750. x-go-name: PolicyObjectTags
  6751. responses:
  6752. "200":
  6753. $ref: '#/responses/organization_node_ListItemFilterOutput'
  6754. summary: 项目列表
  6755. tags:
  6756. - organization_node
  6757. post:
  6758. description: 新建
  6759. operationId: organization_node_ValidateCreateData
  6760. parameters:
  6761. - in: body
  6762. name: body
  6763. schema:
  6764. properties:
  6765. count:
  6766. default: 1
  6767. format: int64
  6768. type: integer
  6769. x-go-name: Count
  6770. organization_node:
  6771. $ref: '#/definitions/StandaloneResourceCreateInput'
  6772. type: object
  6773. x-go-name: Body
  6774. responses:
  6775. "200":
  6776. $ref: '#/responses/organization_node_ValidateCreateDataOutput'
  6777. summary: 新建
  6778. tags:
  6779. - organization_node
  6780. /organization_nodes/{id}:
  6781. delete:
  6782. description: 删除
  6783. operationId: organization_node_CustomizeDelete
  6784. parameters:
  6785. - description: The Id or Name of organization_node
  6786. in: path
  6787. name: id
  6788. required: true
  6789. type: string
  6790. x-go-name: Id
  6791. responses:
  6792. "200":
  6793. $ref: '#/responses/organization_node_CustomizeDeleteOutput'
  6794. summary: 删除
  6795. tags:
  6796. - organization_node
  6797. get:
  6798. description: 获取详情
  6799. operationId: organization_node_FetchCustomizeColumns
  6800. parameters:
  6801. - description: The Id or Name of organization_node
  6802. in: path
  6803. name: id
  6804. required: true
  6805. type: string
  6806. x-go-name: Id
  6807. responses:
  6808. "200":
  6809. $ref: '#/responses/organization_node_FetchCustomizeColumnsOutput'
  6810. summary: 获取详情
  6811. tags:
  6812. - organization_node
  6813. put:
  6814. description: 更新
  6815. operationId: organization_node_ValidateUpdateData
  6816. parameters:
  6817. - description: The Id or Name of organization_node
  6818. in: path
  6819. name: id
  6820. required: true
  6821. type: string
  6822. x-go-name: Id
  6823. - in: body
  6824. name: body
  6825. schema:
  6826. properties:
  6827. organization_node:
  6828. $ref: '#/definitions/OrganizationNodeUpdateInput'
  6829. type: object
  6830. x-go-name: Body
  6831. responses:
  6832. "200":
  6833. $ref: '#/responses/organization_node_ValidateUpdateDataOutput'
  6834. summary: 更新
  6835. tags:
  6836. - organization_node
  6837. /organization_nodes/{id}/bind:
  6838. post:
  6839. description: 执行操作Bind
  6840. operationId: organization_node_PerformBind
  6841. parameters:
  6842. - description: The Id or Name of organization_node
  6843. in: path
  6844. name: id
  6845. required: true
  6846. type: string
  6847. x-go-name: Id
  6848. - in: body
  6849. name: body
  6850. schema:
  6851. properties:
  6852. organization_node:
  6853. $ref: '#/definitions/OrganizationNodePerformBindInput'
  6854. type: object
  6855. x-go-name: Body
  6856. responses:
  6857. "200":
  6858. $ref: '#/responses/organization_node_PerformBindOutput'
  6859. summary: 执行操作Bind
  6860. tags:
  6861. - organization_node
  6862. /organization_nodes/{id}/metadata:
  6863. get:
  6864. description: 获取指定信息Metadata
  6865. operationId: organization_node_GetDetailsMetadata
  6866. parameters:
  6867. - description: |-
  6868. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  6869. 标签分为
  6870. 类型 | 说明 |
  6871. ----------|---------------------------------------------|
  6872. 系统标签 | 平台定义的标签 |
  6873. 用户标签 | key以user:为前缀,用户自定义标签 |
  6874. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  6875. in: query
  6876. items:
  6877. type: string
  6878. name: field
  6879. type: array
  6880. x-go-name: Field
  6881. - description: 按标签前缀过滤
  6882. in: query
  6883. name: prefix
  6884. type: string
  6885. x-go-name: Prefix
  6886. - description: The Id or Name of organization_node
  6887. in: path
  6888. name: id
  6889. required: true
  6890. type: string
  6891. x-go-name: Id
  6892. responses:
  6893. "200":
  6894. $ref: '#/responses/organization_node_GetDetailsMetadataOutput'
  6895. summary: 获取资源标签(元数据)
  6896. tags:
  6897. - organization_node
  6898. /organization_nodes/{id}/unbind:
  6899. post:
  6900. description: 执行操作Unbind
  6901. operationId: organization_node_PerformUnbind
  6902. parameters:
  6903. - description: The Id or Name of organization_node
  6904. in: path
  6905. name: id
  6906. required: true
  6907. type: string
  6908. x-go-name: Id
  6909. - in: body
  6910. name: body
  6911. schema:
  6912. properties:
  6913. organization_node:
  6914. $ref: '#/definitions/OrganizationNodePerformBindInput'
  6915. type: object
  6916. x-go-name: Body
  6917. responses:
  6918. "200":
  6919. $ref: '#/responses/organization_node_PerformUnbindOutput'
  6920. summary: 执行操作Unbind
  6921. tags:
  6922. - organization_node
  6923. /organizations:
  6924. get:
  6925. description: 列表
  6926. operationId: organization_ListItemFilter
  6927. parameters:
  6928. - default: 20
  6929. description: 查询限制量
  6930. format: int64
  6931. in: query
  6932. name: limit
  6933. type: integer
  6934. x-go-name: Limit
  6935. - default: 0
  6936. description: 查询偏移量
  6937. format: int64
  6938. in: query
  6939. name: offset
  6940. type: integer
  6941. x-go-name: Offset
  6942. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  6943. in: query
  6944. items:
  6945. type: string
  6946. name: order_by
  6947. type: array
  6948. x-go-name: OrderBy
  6949. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  6950. example: desc|asc
  6951. in: query
  6952. name: order
  6953. type: string
  6954. x-go-name: Order
  6955. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  6956. in: query
  6957. name: details
  6958. type: boolean
  6959. x-go-name: Details
  6960. - description: 模糊搜索所有字段
  6961. in: query
  6962. name: search
  6963. type: string
  6964. x-go-name: Search
  6965. - description: |-
  6966. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  6967. 支持的操作符如下:
  6968. 操作符 | 参数个数 | 举例 | 说明 |
  6969. ---------------|----------|------------------------------------------------|-----------------------------|
  6970. in | > 0 | name.in("test", "good") | 在给定数组中 |
  6971. notin | > 0 | name.notin('test') | 不在给定数组中 |
  6972. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  6973. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  6974. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  6975. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  6976. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  6977. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  6978. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  6979. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  6980. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  6981. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  6982. notequals | 1 | name.notequals('test') | 不等于给定值 |
  6983. isnull | 0 | name.isnull() | 值为SQL的NULL |
  6984. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  6985. isempty | 0 | name.isempty('test') | 值为空字符串 |
  6986. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  6987. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  6988. in: query
  6989. items:
  6990. type: string
  6991. name: filter
  6992. type: array
  6993. x-go-name: Filter
  6994. - description: |-
  6995. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  6996. 和其他表关联的语法如下:
  6997. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  6998. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  6999. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  7000. 举例:
  7001. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  7002. in: query
  7003. items:
  7004. type: string
  7005. name: joint_filter
  7006. type: array
  7007. x-go-name: JointFilter
  7008. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  7009. in: query
  7010. name: filter_any
  7011. type: boolean
  7012. x-go-name: FilterAny
  7013. - description: 返回结果只包含指定的字段
  7014. in: query
  7015. items:
  7016. type: string
  7017. name: field
  7018. type: array
  7019. x-go-name: Field
  7020. - description: 用于数据导出,指定导出的数据字段
  7021. in: query
  7022. name: export_keys
  7023. type: string
  7024. x-go-name: ExportKeys
  7025. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  7026. in: query
  7027. name: show_fail_reason
  7028. type: boolean
  7029. x-go-name: ShowFailReason
  7030. - description: 是否返回状态统计信息,默认为False
  7031. in: query
  7032. name: summary_stats
  7033. type: boolean
  7034. x-go-name: SummaryStats
  7035. - $ref: '#/definitions/TTagSet'
  7036. description: 通过标签过滤(包含这些标签)
  7037. in: query
  7038. name: tags
  7039. x-go-name: Tags
  7040. - $ref: '#/definitions/TTagSetList'
  7041. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  7042. in: query
  7043. name: obj_tags
  7044. x-go-name: ObjTags
  7045. - $ref: '#/definitions/TTagSet'
  7046. description: 通过标签过滤(不包含这些标签)
  7047. in: query
  7048. name: no_tags
  7049. x-go-name: NoTags
  7050. - $ref: '#/definitions/TTagSetList'
  7051. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  7052. in: query
  7053. name: no_obj_tags
  7054. x-go-name: NoObjTags
  7055. - description: 通过标签排序
  7056. in: query
  7057. name: order_by_tag
  7058. type: string
  7059. x-go-name: OrderByTag
  7060. - description: |-
  7061. deprecated
  7062. 返回资源的标签不包含用户标签
  7063. in: query
  7064. name: without_user_meta
  7065. type: boolean
  7066. x-go-name: WithoutUserMeta
  7067. - description: 返回包含用户标签的资源
  7068. in: query
  7069. name: with_user_meta
  7070. type: boolean
  7071. x-go-name: WithUserMeta
  7072. - description: 返回包含外部标签的资源
  7073. in: query
  7074. name: with_cloud_meta
  7075. type: boolean
  7076. x-go-name: WithCloudMeta
  7077. - description: 返回包含任意标签的资源
  7078. in: query
  7079. name: with_any_meta
  7080. type: boolean
  7081. x-go-name: WithAnyMeta
  7082. - description: 返回列表数据中包含资源的标签数据(Metadata)
  7083. in: query
  7084. name: with_meta
  7085. type: boolean
  7086. x-go-name: WithMeta
  7087. - description: 显示所有的资源,包括模拟的资源
  7088. in: query
  7089. name: show_emulated
  7090. type: boolean
  7091. x-go-name: ShowEmulated
  7092. - description: 以资源ID过滤列表
  7093. in: query
  7094. items:
  7095. type: string
  7096. name: id
  7097. type: array
  7098. x-go-name: Ids
  7099. - description: 以资源名称过滤列表
  7100. in: query
  7101. items:
  7102. type: string
  7103. name: name
  7104. type: array
  7105. x-go-name: Names
  7106. - description: 指定查询的权限范围,可能值为project, domain or system
  7107. in: query
  7108. name: scope
  7109. type: string
  7110. x-go-name: Scope
  7111. - description: 指定项目归属域名称或ID
  7112. in: query
  7113. name: project_domain_id
  7114. type: string
  7115. x-go-name: ProjectDomainId
  7116. - description: 对具有域属性的资源,严格匹配域ID
  7117. in: query
  7118. items:
  7119. type: string
  7120. name: project_domain_ids
  7121. type: array
  7122. x-go-name: ProjectDomainIds
  7123. - description: 按domain名称排序,可能值为asc|desc
  7124. in: query
  7125. name: order_by_domain
  7126. pattern: asc|desc
  7127. type: string
  7128. x-go-name: OrderByDomain
  7129. - $ref: '#/definitions/TTagSetList'
  7130. description: filter by domain tags
  7131. in: query
  7132. name: domain_tags
  7133. x-go-name: DomainTags
  7134. - $ref: '#/definitions/TTagSetList'
  7135. description: filter by domain tags
  7136. in: query
  7137. name: no_domain_tags
  7138. x-go-name: NoDomainTags
  7139. - description: 以资源是否启用/禁用过滤列表
  7140. in: query
  7141. name: enabled
  7142. type: boolean
  7143. x-go-name: Enabled
  7144. - description: 以资源是否共享过滤列表
  7145. in: query
  7146. name: is_public
  7147. type: boolean
  7148. x-go-name: IsPublic
  7149. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  7150. in: query
  7151. name: public_scope
  7152. type: string
  7153. x-go-name: PublicScope
  7154. - description: 以资源的状态过滤列表
  7155. in: query
  7156. items:
  7157. type: string
  7158. name: status
  7159. type: array
  7160. x-go-name: Status
  7161. - in: query
  7162. items:
  7163. $ref: '#/definitions/TOrgType'
  7164. name: type
  7165. type: array
  7166. x-go-name: Type
  7167. - in: query
  7168. name: key
  7169. type: string
  7170. x-go-name: Key
  7171. responses:
  7172. "200":
  7173. $ref: '#/responses/organization_ListItemFilterOutput'
  7174. summary: 组织列表
  7175. tags:
  7176. - organization
  7177. post:
  7178. description: 新建
  7179. operationId: organization_ValidateCreateData
  7180. parameters:
  7181. - in: body
  7182. name: body
  7183. schema:
  7184. properties:
  7185. count:
  7186. default: 1
  7187. format: int64
  7188. type: integer
  7189. x-go-name: Count
  7190. organization:
  7191. $ref: '#/definitions/OrganizationCreateInput'
  7192. type: object
  7193. x-go-name: Body
  7194. responses:
  7195. "200":
  7196. $ref: '#/responses/organization_ValidateCreateDataOutput'
  7197. summary: 新建
  7198. tags:
  7199. - organization
  7200. /organizations/{id}:
  7201. delete:
  7202. description: 删除
  7203. operationId: organization_CustomizeDelete
  7204. parameters:
  7205. - description: The Id or Name of organization
  7206. in: path
  7207. name: id
  7208. required: true
  7209. type: string
  7210. x-go-name: Id
  7211. responses:
  7212. "200":
  7213. $ref: '#/responses/organization_CustomizeDeleteOutput'
  7214. summary: 删除
  7215. tags:
  7216. - organization
  7217. get:
  7218. description: 获取详情
  7219. operationId: organization_FetchCustomizeColumns
  7220. parameters:
  7221. - description: The Id or Name of organization
  7222. in: path
  7223. name: id
  7224. required: true
  7225. type: string
  7226. x-go-name: Id
  7227. responses:
  7228. "200":
  7229. $ref: '#/responses/organization_FetchCustomizeColumnsOutput'
  7230. summary: 获取详情
  7231. tags:
  7232. - organization
  7233. put:
  7234. description: 更新
  7235. operationId: organization_ValidateUpdateData
  7236. parameters:
  7237. - description: The Id or Name of organization
  7238. in: path
  7239. name: id
  7240. required: true
  7241. type: string
  7242. x-go-name: Id
  7243. - in: body
  7244. name: body
  7245. schema:
  7246. properties:
  7247. organization:
  7248. $ref: '#/definitions/OrganizationUpdateInput'
  7249. type: object
  7250. x-go-name: Body
  7251. responses:
  7252. "200":
  7253. $ref: '#/responses/organization_ValidateUpdateDataOutput'
  7254. summary: 更新
  7255. tags:
  7256. - organization
  7257. /organizations/{id}/add-level:
  7258. post:
  7259. description: 执行操作AddLevel
  7260. operationId: organization_PerformAddLevel
  7261. parameters:
  7262. - description: The Id or Name of organization
  7263. in: path
  7264. name: id
  7265. required: true
  7266. type: string
  7267. x-go-name: Id
  7268. - in: body
  7269. name: body
  7270. schema:
  7271. properties:
  7272. organization:
  7273. $ref: '#/definitions/OrganizationPerformAddLevelsInput'
  7274. type: object
  7275. x-go-name: Body
  7276. responses:
  7277. "200":
  7278. $ref: '#/responses/organization_PerformAddLevelOutput'
  7279. summary: 执行操作AddLevel
  7280. tags:
  7281. - organization
  7282. /organizations/{id}/add-node:
  7283. post:
  7284. description: 执行操作AddNode
  7285. operationId: organization_PerformAddNode
  7286. parameters:
  7287. - description: The Id or Name of organization
  7288. in: path
  7289. name: id
  7290. required: true
  7291. type: string
  7292. x-go-name: Id
  7293. - in: body
  7294. name: body
  7295. schema:
  7296. properties:
  7297. organization:
  7298. $ref: '#/definitions/OrganizationPerformAddNodeInput'
  7299. type: object
  7300. x-go-name: Body
  7301. responses:
  7302. "200":
  7303. $ref: '#/responses/organization_PerformAddNodeOutput'
  7304. summary: 执行操作AddNode
  7305. tags:
  7306. - organization
  7307. /organizations/{id}/clean:
  7308. post:
  7309. description: 执行操作Clean
  7310. operationId: organization_PerformClean
  7311. parameters:
  7312. - description: The Id or Name of organization
  7313. in: path
  7314. name: id
  7315. required: true
  7316. type: string
  7317. x-go-name: Id
  7318. - in: body
  7319. name: body
  7320. schema:
  7321. properties:
  7322. organization:
  7323. $ref: '#/definitions/OrganizationPerformCleanInput'
  7324. type: object
  7325. x-go-name: Body
  7326. responses:
  7327. "200":
  7328. $ref: '#/responses/organization_PerformCleanOutput'
  7329. summary: 执行操作Clean
  7330. tags:
  7331. - organization
  7332. /organizations/{id}/disable:
  7333. post:
  7334. description: 执行操作Disable
  7335. operationId: organization_PerformDisable
  7336. parameters:
  7337. - description: The Id or Name of organization
  7338. in: path
  7339. name: id
  7340. required: true
  7341. type: string
  7342. x-go-name: Id
  7343. - in: body
  7344. name: body
  7345. schema:
  7346. properties:
  7347. organization:
  7348. $ref: '#/definitions/PerformDisableInput'
  7349. type: object
  7350. x-go-name: Body
  7351. responses:
  7352. "200":
  7353. $ref: '#/responses/organization_PerformDisableOutput'
  7354. summary: 执行操作Disable
  7355. tags:
  7356. - organization
  7357. /organizations/{id}/enable:
  7358. post:
  7359. description: 执行操作Enable
  7360. operationId: organization_PerformEnable
  7361. parameters:
  7362. - description: The Id or Name of organization
  7363. in: path
  7364. name: id
  7365. required: true
  7366. type: string
  7367. x-go-name: Id
  7368. - in: body
  7369. name: body
  7370. schema:
  7371. properties:
  7372. organization:
  7373. $ref: '#/definitions/PerformEnableInput'
  7374. type: object
  7375. x-go-name: Body
  7376. responses:
  7377. "200":
  7378. $ref: '#/responses/organization_PerformEnableOutput'
  7379. summary: 执行操作Enable
  7380. tags:
  7381. - organization
  7382. /organizations/{id}/metadata:
  7383. get:
  7384. description: 获取指定信息Metadata
  7385. operationId: organization_GetDetailsMetadata
  7386. parameters:
  7387. - description: |-
  7388. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  7389. 标签分为
  7390. 类型 | 说明 |
  7391. ----------|---------------------------------------------|
  7392. 系统标签 | 平台定义的标签 |
  7393. 用户标签 | key以user:为前缀,用户自定义标签 |
  7394. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  7395. in: query
  7396. items:
  7397. type: string
  7398. name: field
  7399. type: array
  7400. x-go-name: Field
  7401. - description: 按标签前缀过滤
  7402. in: query
  7403. name: prefix
  7404. type: string
  7405. x-go-name: Prefix
  7406. - description: The Id or Name of organization
  7407. in: path
  7408. name: id
  7409. required: true
  7410. type: string
  7411. x-go-name: Id
  7412. responses:
  7413. "200":
  7414. $ref: '#/responses/organization_GetDetailsMetadataOutput'
  7415. summary: 获取资源标签(元数据)
  7416. tags:
  7417. - organization
  7418. /organizations/{id}/status:
  7419. get:
  7420. description: 获取指定信息Status
  7421. operationId: organization_GetDetailsStatus
  7422. parameters:
  7423. - description: The Id or Name of organization
  7424. in: path
  7425. name: id
  7426. required: true
  7427. type: string
  7428. x-go-name: Id
  7429. responses:
  7430. "200":
  7431. $ref: '#/responses/organization_GetDetailsStatusOutput'
  7432. summary: 获取资源状态
  7433. tags:
  7434. - organization
  7435. /organizations/{id}/sync:
  7436. post:
  7437. description: 执行操作Sync
  7438. operationId: organization_PerformSync
  7439. parameters:
  7440. - description: The Id or Name of organization
  7441. in: path
  7442. name: id
  7443. required: true
  7444. type: string
  7445. x-go-name: Id
  7446. - in: body
  7447. name: body
  7448. schema:
  7449. properties:
  7450. organization:
  7451. $ref: '#/definitions/OrganizationPerformSyncInput'
  7452. type: object
  7453. x-go-name: Body
  7454. responses:
  7455. "200":
  7456. $ref: '#/responses/organization_PerformSyncOutput'
  7457. summary: 执行操作Sync
  7458. tags:
  7459. - organization
  7460. /organizations/domain-tag-value-pairs:
  7461. get:
  7462. description: 获取指定资源类的信息DomainTagValuePairs
  7463. operationId: organization_GetPropertyDomainTagValuePairs
  7464. responses:
  7465. "200":
  7466. $ref: '#/responses/organization_GetPropertyDomainTagValuePairsOutput'
  7467. summary: 获取指定资源类的信息DomainTagValuePairs
  7468. tags:
  7469. - organization
  7470. /organizations/domain-tag-value-tree:
  7471. get:
  7472. description: 获取指定资源类的信息DomainTagValueTree
  7473. operationId: organization_GetPropertyDomainTagValueTree
  7474. responses:
  7475. "200":
  7476. $ref: '#/responses/organization_GetPropertyDomainTagValueTreeOutput'
  7477. summary: 获取指定资源类的信息DomainTagValueTree
  7478. tags:
  7479. - organization
  7480. /policies:
  7481. get:
  7482. description: 列表
  7483. operationId: policy_ListItemFilter
  7484. parameters:
  7485. - default: 20
  7486. description: 查询限制量
  7487. format: int64
  7488. in: query
  7489. name: limit
  7490. type: integer
  7491. x-go-name: Limit
  7492. - default: 0
  7493. description: 查询偏移量
  7494. format: int64
  7495. in: query
  7496. name: offset
  7497. type: integer
  7498. x-go-name: Offset
  7499. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  7500. in: query
  7501. items:
  7502. type: string
  7503. name: order_by
  7504. type: array
  7505. x-go-name: OrderBy
  7506. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  7507. example: desc|asc
  7508. in: query
  7509. name: order
  7510. type: string
  7511. x-go-name: Order
  7512. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  7513. in: query
  7514. name: details
  7515. type: boolean
  7516. x-go-name: Details
  7517. - description: 模糊搜索所有字段
  7518. in: query
  7519. name: search
  7520. type: string
  7521. x-go-name: Search
  7522. - description: |-
  7523. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  7524. 支持的操作符如下:
  7525. 操作符 | 参数个数 | 举例 | 说明 |
  7526. ---------------|----------|------------------------------------------------|-----------------------------|
  7527. in | > 0 | name.in("test", "good") | 在给定数组中 |
  7528. notin | > 0 | name.notin('test') | 不在给定数组中 |
  7529. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  7530. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  7531. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  7532. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  7533. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  7534. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  7535. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  7536. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  7537. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  7538. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  7539. notequals | 1 | name.notequals('test') | 不等于给定值 |
  7540. isnull | 0 | name.isnull() | 值为SQL的NULL |
  7541. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  7542. isempty | 0 | name.isempty('test') | 值为空字符串 |
  7543. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  7544. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  7545. in: query
  7546. items:
  7547. type: string
  7548. name: filter
  7549. type: array
  7550. x-go-name: Filter
  7551. - description: |-
  7552. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  7553. 和其他表关联的语法如下:
  7554. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  7555. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  7556. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  7557. 举例:
  7558. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  7559. in: query
  7560. items:
  7561. type: string
  7562. name: joint_filter
  7563. type: array
  7564. x-go-name: JointFilter
  7565. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  7566. in: query
  7567. name: filter_any
  7568. type: boolean
  7569. x-go-name: FilterAny
  7570. - description: 返回结果只包含指定的字段
  7571. in: query
  7572. items:
  7573. type: string
  7574. name: field
  7575. type: array
  7576. x-go-name: Field
  7577. - description: 用于数据导出,指定导出的数据字段
  7578. in: query
  7579. name: export_keys
  7580. type: string
  7581. x-go-name: ExportKeys
  7582. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  7583. in: query
  7584. name: show_fail_reason
  7585. type: boolean
  7586. x-go-name: ShowFailReason
  7587. - description: 是否返回状态统计信息,默认为False
  7588. in: query
  7589. name: summary_stats
  7590. type: boolean
  7591. x-go-name: SummaryStats
  7592. - $ref: '#/definitions/TTagSet'
  7593. description: 通过标签过滤(包含这些标签)
  7594. in: query
  7595. name: tags
  7596. x-go-name: Tags
  7597. - $ref: '#/definitions/TTagSetList'
  7598. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  7599. in: query
  7600. name: obj_tags
  7601. x-go-name: ObjTags
  7602. - $ref: '#/definitions/TTagSet'
  7603. description: 通过标签过滤(不包含这些标签)
  7604. in: query
  7605. name: no_tags
  7606. x-go-name: NoTags
  7607. - $ref: '#/definitions/TTagSetList'
  7608. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  7609. in: query
  7610. name: no_obj_tags
  7611. x-go-name: NoObjTags
  7612. - description: 通过标签排序
  7613. in: query
  7614. name: order_by_tag
  7615. type: string
  7616. x-go-name: OrderByTag
  7617. - description: |-
  7618. deprecated
  7619. 返回资源的标签不包含用户标签
  7620. in: query
  7621. name: without_user_meta
  7622. type: boolean
  7623. x-go-name: WithoutUserMeta
  7624. - description: 返回包含用户标签的资源
  7625. in: query
  7626. name: with_user_meta
  7627. type: boolean
  7628. x-go-name: WithUserMeta
  7629. - description: 返回包含外部标签的资源
  7630. in: query
  7631. name: with_cloud_meta
  7632. type: boolean
  7633. x-go-name: WithCloudMeta
  7634. - description: 返回包含任意标签的资源
  7635. in: query
  7636. name: with_any_meta
  7637. type: boolean
  7638. x-go-name: WithAnyMeta
  7639. - description: 返回列表数据中包含资源的标签数据(Metadata)
  7640. in: query
  7641. name: with_meta
  7642. type: boolean
  7643. x-go-name: WithMeta
  7644. - description: 显示所有的资源,包括模拟的资源
  7645. in: query
  7646. name: show_emulated
  7647. type: boolean
  7648. x-go-name: ShowEmulated
  7649. - description: 以资源ID过滤列表
  7650. in: query
  7651. items:
  7652. type: string
  7653. name: id
  7654. type: array
  7655. x-go-name: Ids
  7656. - description: 以资源名称过滤列表
  7657. in: query
  7658. items:
  7659. type: string
  7660. name: name
  7661. type: array
  7662. x-go-name: Names
  7663. - description: 指定查询的权限范围,可能值为project, domain or system
  7664. in: query
  7665. name: scope
  7666. type: string
  7667. x-go-name: Scope
  7668. - description: 指定项目归属域名称或ID
  7669. in: query
  7670. name: project_domain_id
  7671. type: string
  7672. x-go-name: ProjectDomainId
  7673. - description: 对具有域属性的资源,严格匹配域ID
  7674. in: query
  7675. items:
  7676. type: string
  7677. name: project_domain_ids
  7678. type: array
  7679. x-go-name: ProjectDomainIds
  7680. - description: 按domain名称排序,可能值为asc|desc
  7681. in: query
  7682. name: order_by_domain
  7683. pattern: asc|desc
  7684. type: string
  7685. x-go-name: OrderByDomain
  7686. - $ref: '#/definitions/TTagSetList'
  7687. description: filter by domain tags
  7688. in: query
  7689. name: domain_tags
  7690. x-go-name: DomainTags
  7691. - $ref: '#/definitions/TTagSetList'
  7692. description: filter by domain tags
  7693. in: query
  7694. name: no_domain_tags
  7695. x-go-name: NoDomainTags
  7696. - description: 以资源是否启用/禁用过滤列表
  7697. in: query
  7698. name: enabled
  7699. type: boolean
  7700. x-go-name: Enabled
  7701. - description: 以资源是否共享过滤列表
  7702. in: query
  7703. name: is_public
  7704. type: boolean
  7705. x-go-name: IsPublic
  7706. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  7707. in: query
  7708. name: public_scope
  7709. type: string
  7710. x-go-name: PublicScope
  7711. - description: 以类型查询
  7712. in: query
  7713. items:
  7714. type: string
  7715. name: type
  7716. type: array
  7717. x-go-name: Type
  7718. - description: 是否显示系统权限
  7719. in: query
  7720. name: is_system
  7721. type: boolean
  7722. x-go-name: IsSystem
  7723. - description: filter policies by role id
  7724. in: query
  7725. name: role_id
  7726. type: string
  7727. x-go-name: RoleId
  7728. responses:
  7729. "200":
  7730. $ref: '#/responses/policy_ListItemFilterOutput'
  7731. summary: 权限策略列表
  7732. tags:
  7733. - policy
  7734. post:
  7735. description: 新建
  7736. operationId: policy_ValidateCreateData
  7737. parameters:
  7738. - in: body
  7739. name: body
  7740. schema:
  7741. properties:
  7742. count:
  7743. default: 1
  7744. format: int64
  7745. type: integer
  7746. x-go-name: Count
  7747. policy:
  7748. $ref: '#/definitions/PolicyCreateInput'
  7749. type: object
  7750. x-go-name: Body
  7751. responses:
  7752. "200":
  7753. $ref: '#/responses/policy_ValidateCreateDataOutput'
  7754. summary: 新建
  7755. tags:
  7756. - policy
  7757. /policies/{id}:
  7758. delete:
  7759. description: 删除
  7760. operationId: policy_CustomizeDelete
  7761. parameters:
  7762. - description: The Id or Name of policy
  7763. in: path
  7764. name: id
  7765. required: true
  7766. type: string
  7767. x-go-name: Id
  7768. responses:
  7769. "200":
  7770. $ref: '#/responses/policy_CustomizeDeleteOutput'
  7771. summary: 删除
  7772. tags:
  7773. - policy
  7774. get:
  7775. description: 获取详情
  7776. operationId: policy_FetchCustomizeColumns
  7777. parameters:
  7778. - description: The Id or Name of policy
  7779. in: path
  7780. name: id
  7781. required: true
  7782. type: string
  7783. x-go-name: Id
  7784. responses:
  7785. "200":
  7786. $ref: '#/responses/policy_FetchCustomizeColumnsOutput'
  7787. summary: 获取详情
  7788. tags:
  7789. - policy
  7790. put:
  7791. description: 更新
  7792. operationId: policy_ValidateUpdateData
  7793. parameters:
  7794. - description: The Id or Name of policy
  7795. in: path
  7796. name: id
  7797. required: true
  7798. type: string
  7799. x-go-name: Id
  7800. - in: body
  7801. name: body
  7802. schema:
  7803. properties:
  7804. policy:
  7805. $ref: '#/definitions/PolicyUpdateInput'
  7806. type: object
  7807. x-go-name: Body
  7808. responses:
  7809. "200":
  7810. $ref: '#/responses/policy_ValidateUpdateDataOutput'
  7811. summary: 更新
  7812. tags:
  7813. - policy
  7814. /policies/{id}/bind-role:
  7815. post:
  7816. description: 执行操作BindRole
  7817. operationId: policy_PerformBindRole
  7818. parameters:
  7819. - description: The Id or Name of policy
  7820. in: path
  7821. name: id
  7822. required: true
  7823. type: string
  7824. x-go-name: Id
  7825. - in: body
  7826. name: body
  7827. schema:
  7828. properties:
  7829. policy:
  7830. $ref: '#/definitions/PolicyBindRoleInput'
  7831. type: object
  7832. x-go-name: Body
  7833. responses:
  7834. "200":
  7835. $ref: '#/responses/policy_PerformBindRoleOutput'
  7836. summary: 绑定角色
  7837. tags:
  7838. - policy
  7839. /policies/{id}/disable:
  7840. post:
  7841. description: 执行操作Disable
  7842. operationId: policy_PerformDisable
  7843. parameters:
  7844. - description: The Id or Name of policy
  7845. in: path
  7846. name: id
  7847. required: true
  7848. type: string
  7849. x-go-name: Id
  7850. - in: body
  7851. name: body
  7852. schema:
  7853. properties:
  7854. policy:
  7855. $ref: '#/definitions/PerformDisableInput'
  7856. type: object
  7857. x-go-name: Body
  7858. responses:
  7859. "200":
  7860. $ref: '#/responses/policy_PerformDisableOutput'
  7861. summary: 禁用资源
  7862. tags:
  7863. - policy
  7864. /policies/{id}/enable:
  7865. post:
  7866. description: 执行操作Enable
  7867. operationId: policy_PerformEnable
  7868. parameters:
  7869. - description: The Id or Name of policy
  7870. in: path
  7871. name: id
  7872. required: true
  7873. type: string
  7874. x-go-name: Id
  7875. - in: body
  7876. name: body
  7877. schema:
  7878. properties:
  7879. policy:
  7880. $ref: '#/definitions/PerformEnableInput'
  7881. type: object
  7882. x-go-name: Body
  7883. responses:
  7884. "200":
  7885. $ref: '#/responses/policy_PerformEnableOutput'
  7886. summary: 启用资源
  7887. tags:
  7888. - policy
  7889. /policies/{id}/metadata:
  7890. get:
  7891. description: 获取指定信息Metadata
  7892. operationId: policy_GetDetailsMetadata
  7893. parameters:
  7894. - description: |-
  7895. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  7896. 标签分为
  7897. 类型 | 说明 |
  7898. ----------|---------------------------------------------|
  7899. 系统标签 | 平台定义的标签 |
  7900. 用户标签 | key以user:为前缀,用户自定义标签 |
  7901. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  7902. in: query
  7903. items:
  7904. type: string
  7905. name: field
  7906. type: array
  7907. x-go-name: Field
  7908. - description: 按标签前缀过滤
  7909. in: query
  7910. name: prefix
  7911. type: string
  7912. x-go-name: Prefix
  7913. - description: The Id or Name of policy
  7914. in: path
  7915. name: id
  7916. required: true
  7917. type: string
  7918. x-go-name: Id
  7919. responses:
  7920. "200":
  7921. $ref: '#/responses/policy_GetDetailsMetadataOutput'
  7922. summary: 获取资源标签(元数据)
  7923. tags:
  7924. - policy
  7925. /policies/{id}/private:
  7926. post:
  7927. description: 执行操作Private
  7928. operationId: policy_PerformPrivate
  7929. parameters:
  7930. - description: The Id or Name of policy
  7931. in: path
  7932. name: id
  7933. required: true
  7934. type: string
  7935. x-go-name: Id
  7936. - in: body
  7937. name: body
  7938. schema:
  7939. properties:
  7940. policy:
  7941. $ref: '#/definitions/PerformPrivateInput'
  7942. type: object
  7943. x-go-name: Body
  7944. responses:
  7945. "200":
  7946. $ref: '#/responses/policy_PerformPrivateOutput'
  7947. summary: 设置policy为私有
  7948. tags:
  7949. - policy
  7950. /policies/{id}/public:
  7951. post:
  7952. description: 执行操作Public
  7953. operationId: policy_PerformPublic
  7954. parameters:
  7955. - description: The Id or Name of policy
  7956. in: path
  7957. name: id
  7958. required: true
  7959. type: string
  7960. x-go-name: Id
  7961. - in: body
  7962. name: body
  7963. schema:
  7964. properties:
  7965. policy:
  7966. $ref: '#/definitions/PerformPublicDomainInput'
  7967. type: object
  7968. x-go-name: Body
  7969. responses:
  7970. "200":
  7971. $ref: '#/responses/policy_PerformPublicOutput'
  7972. summary: 共享Policy
  7973. tags:
  7974. - policy
  7975. /policies/domain-tag-value-pairs:
  7976. get:
  7977. description: 获取指定资源类的信息DomainTagValuePairs
  7978. operationId: policy_GetPropertyDomainTagValuePairs
  7979. responses:
  7980. "200":
  7981. $ref: '#/responses/policy_GetPropertyDomainTagValuePairsOutput'
  7982. summary: 获取指定资源类的信息DomainTagValuePairs
  7983. tags:
  7984. - policy
  7985. /policies/domain-tag-value-tree:
  7986. get:
  7987. description: 获取指定资源类的信息DomainTagValueTree
  7988. operationId: policy_GetPropertyDomainTagValueTree
  7989. responses:
  7990. "200":
  7991. $ref: '#/responses/policy_GetPropertyDomainTagValueTreeOutput'
  7992. summary: 获取指定资源类的信息DomainTagValueTree
  7993. tags:
  7994. - policy
  7995. /projects:
  7996. get:
  7997. description: 列表
  7998. operationId: project_ListItemFilter
  7999. parameters:
  8000. - default: 20
  8001. description: 查询限制量
  8002. format: int64
  8003. in: query
  8004. name: limit
  8005. type: integer
  8006. x-go-name: Limit
  8007. - default: 0
  8008. description: 查询偏移量
  8009. format: int64
  8010. in: query
  8011. name: offset
  8012. type: integer
  8013. x-go-name: Offset
  8014. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  8015. in: query
  8016. items:
  8017. type: string
  8018. name: order_by
  8019. type: array
  8020. x-go-name: OrderBy
  8021. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  8022. example: desc|asc
  8023. in: query
  8024. name: order
  8025. type: string
  8026. x-go-name: Order
  8027. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  8028. in: query
  8029. name: details
  8030. type: boolean
  8031. x-go-name: Details
  8032. - description: 模糊搜索所有字段
  8033. in: query
  8034. name: search
  8035. type: string
  8036. x-go-name: Search
  8037. - description: |-
  8038. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  8039. 支持的操作符如下:
  8040. 操作符 | 参数个数 | 举例 | 说明 |
  8041. ---------------|----------|------------------------------------------------|-----------------------------|
  8042. in | > 0 | name.in("test", "good") | 在给定数组中 |
  8043. notin | > 0 | name.notin('test') | 不在给定数组中 |
  8044. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  8045. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  8046. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  8047. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  8048. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  8049. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  8050. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  8051. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  8052. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  8053. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  8054. notequals | 1 | name.notequals('test') | 不等于给定值 |
  8055. isnull | 0 | name.isnull() | 值为SQL的NULL |
  8056. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  8057. isempty | 0 | name.isempty('test') | 值为空字符串 |
  8058. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  8059. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  8060. in: query
  8061. items:
  8062. type: string
  8063. name: filter
  8064. type: array
  8065. x-go-name: Filter
  8066. - description: |-
  8067. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  8068. 和其他表关联的语法如下:
  8069. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  8070. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  8071. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  8072. 举例:
  8073. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  8074. in: query
  8075. items:
  8076. type: string
  8077. name: joint_filter
  8078. type: array
  8079. x-go-name: JointFilter
  8080. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  8081. in: query
  8082. name: filter_any
  8083. type: boolean
  8084. x-go-name: FilterAny
  8085. - description: 返回结果只包含指定的字段
  8086. in: query
  8087. items:
  8088. type: string
  8089. name: field
  8090. type: array
  8091. x-go-name: Field
  8092. - description: 用于数据导出,指定导出的数据字段
  8093. in: query
  8094. name: export_keys
  8095. type: string
  8096. x-go-name: ExportKeys
  8097. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  8098. in: query
  8099. name: show_fail_reason
  8100. type: boolean
  8101. x-go-name: ShowFailReason
  8102. - description: 是否返回状态统计信息,默认为False
  8103. in: query
  8104. name: summary_stats
  8105. type: boolean
  8106. x-go-name: SummaryStats
  8107. - $ref: '#/definitions/TTagSet'
  8108. description: 通过标签过滤(包含这些标签)
  8109. in: query
  8110. name: tags
  8111. x-go-name: Tags
  8112. - $ref: '#/definitions/TTagSetList'
  8113. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  8114. in: query
  8115. name: obj_tags
  8116. x-go-name: ObjTags
  8117. - $ref: '#/definitions/TTagSet'
  8118. description: 通过标签过滤(不包含这些标签)
  8119. in: query
  8120. name: no_tags
  8121. x-go-name: NoTags
  8122. - $ref: '#/definitions/TTagSetList'
  8123. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  8124. in: query
  8125. name: no_obj_tags
  8126. x-go-name: NoObjTags
  8127. - description: 通过标签排序
  8128. in: query
  8129. name: order_by_tag
  8130. type: string
  8131. x-go-name: OrderByTag
  8132. - description: |-
  8133. deprecated
  8134. 返回资源的标签不包含用户标签
  8135. in: query
  8136. name: without_user_meta
  8137. type: boolean
  8138. x-go-name: WithoutUserMeta
  8139. - description: 返回包含用户标签的资源
  8140. in: query
  8141. name: with_user_meta
  8142. type: boolean
  8143. x-go-name: WithUserMeta
  8144. - description: 返回包含外部标签的资源
  8145. in: query
  8146. name: with_cloud_meta
  8147. type: boolean
  8148. x-go-name: WithCloudMeta
  8149. - description: 返回包含任意标签的资源
  8150. in: query
  8151. name: with_any_meta
  8152. type: boolean
  8153. x-go-name: WithAnyMeta
  8154. - description: 返回列表数据中包含资源的标签数据(Metadata)
  8155. in: query
  8156. name: with_meta
  8157. type: boolean
  8158. x-go-name: WithMeta
  8159. - description: 显示所有的资源,包括模拟的资源
  8160. in: query
  8161. name: show_emulated
  8162. type: boolean
  8163. x-go-name: ShowEmulated
  8164. - description: 以资源ID过滤列表
  8165. in: query
  8166. items:
  8167. type: string
  8168. name: id
  8169. type: array
  8170. x-go-name: Ids
  8171. - description: 以资源名称过滤列表
  8172. in: query
  8173. items:
  8174. type: string
  8175. name: name
  8176. type: array
  8177. x-go-name: Names
  8178. - description: 指定查询的权限范围,可能值为project, domain or system
  8179. in: query
  8180. name: scope
  8181. type: string
  8182. x-go-name: Scope
  8183. - description: 指定项目归属域名称或ID
  8184. in: query
  8185. name: project_domain_id
  8186. type: string
  8187. x-go-name: ProjectDomainId
  8188. - description: 对具有域属性的资源,严格匹配域ID
  8189. in: query
  8190. items:
  8191. type: string
  8192. name: project_domain_ids
  8193. type: array
  8194. x-go-name: ProjectDomainIds
  8195. - description: 按domain名称排序,可能值为asc|desc
  8196. in: query
  8197. name: order_by_domain
  8198. pattern: asc|desc
  8199. type: string
  8200. x-go-name: OrderByDomain
  8201. - $ref: '#/definitions/TTagSetList'
  8202. description: filter by domain tags
  8203. in: query
  8204. name: domain_tags
  8205. x-go-name: DomainTags
  8206. - $ref: '#/definitions/TTagSetList'
  8207. description: filter by domain tags
  8208. in: query
  8209. name: no_domain_tags
  8210. x-go-name: NoDomainTags
  8211. - description: 用户归属域
  8212. in: query
  8213. name: user_domain_id
  8214. type: string
  8215. x-go-name: UserDomainId
  8216. - description: filter by user
  8217. in: query
  8218. name: user_id
  8219. type: string
  8220. x-go-name: UserId
  8221. - description: 组归属域
  8222. in: query
  8223. name: group_domain_id
  8224. type: string
  8225. x-go-name: GroupDomainId
  8226. - description: filter by group
  8227. in: query
  8228. name: group_id
  8229. type: string
  8230. x-go-name: GroupId
  8231. - description: filter projects by Identity Provider
  8232. in: query
  8233. name: idp_id
  8234. type: string
  8235. x-go-name: IdpId
  8236. - description: 过滤出指定用户或者组可以加入的项目
  8237. in: query
  8238. name: jointable
  8239. type: boolean
  8240. x-go-name: Jointable
  8241. - $ref: '#/definitions/TTagSetList'
  8242. description: project tags filter imposed by policy
  8243. in: query
  8244. name: policy_project_tags
  8245. x-go-name: PolicyProjectTags
  8246. - description: 通过项目管理员id过滤
  8247. in: query
  8248. items:
  8249. type: string
  8250. name: admin_id
  8251. type: array
  8252. x-go-name: AdminId
  8253. responses:
  8254. "200":
  8255. $ref: '#/responses/project_ListItemFilterOutput'
  8256. summary: 项目列表
  8257. tags:
  8258. - project
  8259. post:
  8260. description: 新建
  8261. operationId: project_ValidateCreateData
  8262. parameters:
  8263. - in: body
  8264. name: body
  8265. schema:
  8266. properties:
  8267. count:
  8268. default: 1
  8269. format: int64
  8270. type: integer
  8271. x-go-name: Count
  8272. project:
  8273. $ref: '#/definitions/ProjectCreateInput'
  8274. type: object
  8275. x-go-name: Body
  8276. responses:
  8277. "200":
  8278. $ref: '#/responses/project_ValidateCreateDataOutput'
  8279. summary: 新建
  8280. tags:
  8281. - project
  8282. /projects/{id}:
  8283. delete:
  8284. description: 删除
  8285. operationId: project_CustomizeDelete
  8286. parameters:
  8287. - description: The Id or Name of project
  8288. in: path
  8289. name: id
  8290. required: true
  8291. type: string
  8292. x-go-name: Id
  8293. responses:
  8294. "200":
  8295. $ref: '#/responses/project_CustomizeDeleteOutput'
  8296. summary: 删除
  8297. tags:
  8298. - project
  8299. get:
  8300. description: 获取详情
  8301. operationId: project_FetchCustomizeColumns
  8302. parameters:
  8303. - description: The Id or Name of project
  8304. in: path
  8305. name: id
  8306. required: true
  8307. type: string
  8308. x-go-name: Id
  8309. responses:
  8310. "200":
  8311. $ref: '#/responses/project_FetchCustomizeColumnsOutput'
  8312. summary: 获取详情
  8313. tags:
  8314. - project
  8315. put:
  8316. description: 更新
  8317. operationId: project_ValidateUpdateData
  8318. parameters:
  8319. - description: The Id or Name of project
  8320. in: path
  8321. name: id
  8322. required: true
  8323. type: string
  8324. x-go-name: Id
  8325. - in: body
  8326. name: body
  8327. schema:
  8328. properties:
  8329. project:
  8330. $ref: '#/definitions/ProjectUpdateInput'
  8331. type: object
  8332. x-go-name: Body
  8333. responses:
  8334. "200":
  8335. $ref: '#/responses/project_ValidateUpdateDataOutput'
  8336. summary: 更新
  8337. tags:
  8338. - project
  8339. /projects/{id}/join:
  8340. post:
  8341. description: 执行操作Join
  8342. operationId: project_PerformJoin
  8343. parameters:
  8344. - description: The Id or Name of project
  8345. in: path
  8346. name: id
  8347. required: true
  8348. type: string
  8349. x-go-name: Id
  8350. - in: body
  8351. name: body
  8352. schema:
  8353. properties:
  8354. project:
  8355. $ref: '#/definitions/SProjectAddUserGroupInput'
  8356. type: object
  8357. x-go-name: Body
  8358. responses:
  8359. "200":
  8360. $ref: '#/responses/project_PerformJoinOutput'
  8361. summary: 将用户或组加入项目
  8362. tags:
  8363. - project
  8364. /projects/{id}/leave:
  8365. post:
  8366. description: 执行操作Leave
  8367. operationId: project_PerformLeave
  8368. parameters:
  8369. - description: The Id or Name of project
  8370. in: path
  8371. name: id
  8372. required: true
  8373. type: string
  8374. x-go-name: Id
  8375. - in: body
  8376. name: body
  8377. schema:
  8378. properties:
  8379. project:
  8380. $ref: '#/definitions/SProjectRemoveUserGroupInput'
  8381. type: object
  8382. x-go-name: Body
  8383. responses:
  8384. "200":
  8385. $ref: '#/responses/project_PerformLeaveOutput'
  8386. summary: 将用户或组移出项目
  8387. tags:
  8388. - project
  8389. /projects/{id}/metadata:
  8390. get:
  8391. description: 获取指定信息Metadata
  8392. operationId: project_GetDetailsMetadata
  8393. parameters:
  8394. - description: |-
  8395. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  8396. 标签分为
  8397. 类型 | 说明 |
  8398. ----------|---------------------------------------------|
  8399. 系统标签 | 平台定义的标签 |
  8400. 用户标签 | key以user:为前缀,用户自定义标签 |
  8401. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  8402. in: query
  8403. items:
  8404. type: string
  8405. name: field
  8406. type: array
  8407. x-go-name: Field
  8408. - description: 按标签前缀过滤
  8409. in: query
  8410. name: prefix
  8411. type: string
  8412. x-go-name: Prefix
  8413. - description: The Id or Name of project
  8414. in: path
  8415. name: id
  8416. required: true
  8417. type: string
  8418. x-go-name: Id
  8419. responses:
  8420. "200":
  8421. $ref: '#/responses/project_GetDetailsMetadataOutput'
  8422. summary: 获取资源标签(元数据)
  8423. tags:
  8424. - project
  8425. /projects/{id}/set-admin:
  8426. post:
  8427. description: 执行操作SetAdmin
  8428. operationId: project_PerformSetAdmin
  8429. parameters:
  8430. - description: The Id or Name of project
  8431. in: path
  8432. name: id
  8433. required: true
  8434. type: string
  8435. x-go-name: Id
  8436. - in: body
  8437. name: body
  8438. schema:
  8439. properties:
  8440. project:
  8441. $ref: '#/definitions/SProjectSetAdminInput'
  8442. type: object
  8443. x-go-name: Body
  8444. responses:
  8445. "200":
  8446. $ref: '#/responses/project_PerformSetAdminOutput'
  8447. summary: 执行操作SetAdmin
  8448. tags:
  8449. - project
  8450. /projects/clean:
  8451. post:
  8452. description: 执行操作Clean
  8453. operationId: project_PerformClean
  8454. parameters:
  8455. - in: body
  8456. name: body
  8457. schema:
  8458. properties:
  8459. project:
  8460. $ref: '#/definitions/ProjectCleanInput'
  8461. type: object
  8462. x-go-name: Body
  8463. responses:
  8464. "200":
  8465. $ref: '#/responses/project_PerformCleanOutput'
  8466. summary: 执行操作Clean
  8467. tags:
  8468. - project
  8469. /projects/domain-tag-value-pairs:
  8470. get:
  8471. description: 获取指定资源类的信息DomainTagValuePairs
  8472. operationId: project_GetPropertyDomainTagValuePairs
  8473. responses:
  8474. "200":
  8475. $ref: '#/responses/project_GetPropertyDomainTagValuePairsOutput'
  8476. summary: 获取指定资源类的信息DomainTagValuePairs
  8477. tags:
  8478. - project
  8479. /projects/domain-tag-value-tree:
  8480. get:
  8481. description: 获取指定资源类的信息DomainTagValueTree
  8482. operationId: project_GetPropertyDomainTagValueTree
  8483. responses:
  8484. "200":
  8485. $ref: '#/responses/project_GetPropertyDomainTagValueTreeOutput'
  8486. summary: 获取指定资源类的信息DomainTagValueTree
  8487. tags:
  8488. - project
  8489. /regions:
  8490. get:
  8491. description: 列表
  8492. operationId: region_ListItemFilter
  8493. parameters:
  8494. - default: 20
  8495. description: 查询限制量
  8496. format: int64
  8497. in: query
  8498. name: limit
  8499. type: integer
  8500. x-go-name: Limit
  8501. - default: 0
  8502. description: 查询偏移量
  8503. format: int64
  8504. in: query
  8505. name: offset
  8506. type: integer
  8507. x-go-name: Offset
  8508. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  8509. in: query
  8510. items:
  8511. type: string
  8512. name: order_by
  8513. type: array
  8514. x-go-name: OrderBy
  8515. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  8516. example: desc|asc
  8517. in: query
  8518. name: order
  8519. type: string
  8520. x-go-name: Order
  8521. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  8522. in: query
  8523. name: details
  8524. type: boolean
  8525. x-go-name: Details
  8526. - description: 模糊搜索所有字段
  8527. in: query
  8528. name: search
  8529. type: string
  8530. x-go-name: Search
  8531. - description: |-
  8532. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  8533. 支持的操作符如下:
  8534. 操作符 | 参数个数 | 举例 | 说明 |
  8535. ---------------|----------|------------------------------------------------|-----------------------------|
  8536. in | > 0 | name.in("test", "good") | 在给定数组中 |
  8537. notin | > 0 | name.notin('test') | 不在给定数组中 |
  8538. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  8539. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  8540. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  8541. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  8542. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  8543. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  8544. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  8545. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  8546. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  8547. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  8548. notequals | 1 | name.notequals('test') | 不等于给定值 |
  8549. isnull | 0 | name.isnull() | 值为SQL的NULL |
  8550. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  8551. isempty | 0 | name.isempty('test') | 值为空字符串 |
  8552. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  8553. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  8554. in: query
  8555. items:
  8556. type: string
  8557. name: filter
  8558. type: array
  8559. x-go-name: Filter
  8560. - description: |-
  8561. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  8562. 和其他表关联的语法如下:
  8563. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  8564. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  8565. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  8566. 举例:
  8567. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  8568. in: query
  8569. items:
  8570. type: string
  8571. name: joint_filter
  8572. type: array
  8573. x-go-name: JointFilter
  8574. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  8575. in: query
  8576. name: filter_any
  8577. type: boolean
  8578. x-go-name: FilterAny
  8579. - description: 返回结果只包含指定的字段
  8580. in: query
  8581. items:
  8582. type: string
  8583. name: field
  8584. type: array
  8585. x-go-name: Field
  8586. - description: 用于数据导出,指定导出的数据字段
  8587. in: query
  8588. name: export_keys
  8589. type: string
  8590. x-go-name: ExportKeys
  8591. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  8592. in: query
  8593. name: show_fail_reason
  8594. type: boolean
  8595. x-go-name: ShowFailReason
  8596. - description: 是否返回状态统计信息,默认为False
  8597. in: query
  8598. name: summary_stats
  8599. type: boolean
  8600. x-go-name: SummaryStats
  8601. - $ref: '#/definitions/TTagSet'
  8602. description: 通过标签过滤(包含这些标签)
  8603. in: query
  8604. name: tags
  8605. x-go-name: Tags
  8606. - $ref: '#/definitions/TTagSetList'
  8607. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  8608. in: query
  8609. name: obj_tags
  8610. x-go-name: ObjTags
  8611. - $ref: '#/definitions/TTagSet'
  8612. description: 通过标签过滤(不包含这些标签)
  8613. in: query
  8614. name: no_tags
  8615. x-go-name: NoTags
  8616. - $ref: '#/definitions/TTagSetList'
  8617. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  8618. in: query
  8619. name: no_obj_tags
  8620. x-go-name: NoObjTags
  8621. - description: 通过标签排序
  8622. in: query
  8623. name: order_by_tag
  8624. type: string
  8625. x-go-name: OrderByTag
  8626. - description: |-
  8627. deprecated
  8628. 返回资源的标签不包含用户标签
  8629. in: query
  8630. name: without_user_meta
  8631. type: boolean
  8632. x-go-name: WithoutUserMeta
  8633. - description: 返回包含用户标签的资源
  8634. in: query
  8635. name: with_user_meta
  8636. type: boolean
  8637. x-go-name: WithUserMeta
  8638. - description: 返回包含外部标签的资源
  8639. in: query
  8640. name: with_cloud_meta
  8641. type: boolean
  8642. x-go-name: WithCloudMeta
  8643. - description: 返回包含任意标签的资源
  8644. in: query
  8645. name: with_any_meta
  8646. type: boolean
  8647. x-go-name: WithAnyMeta
  8648. - description: 返回列表数据中包含资源的标签数据(Metadata)
  8649. in: query
  8650. name: with_meta
  8651. type: boolean
  8652. x-go-name: WithMeta
  8653. - description: 显示所有的资源,包括模拟的资源
  8654. in: query
  8655. name: show_emulated
  8656. type: boolean
  8657. x-go-name: ShowEmulated
  8658. - description: 以资源ID过滤列表
  8659. in: query
  8660. items:
  8661. type: string
  8662. name: id
  8663. type: array
  8664. x-go-name: Ids
  8665. - description: 以资源名称过滤列表
  8666. in: query
  8667. items:
  8668. type: string
  8669. name: name
  8670. type: array
  8671. x-go-name: Names
  8672. responses:
  8673. "200":
  8674. $ref: '#/responses/region_ListItemFilterOutput'
  8675. summary: 区域列表
  8676. tags:
  8677. - region
  8678. post:
  8679. description: 新建
  8680. operationId: region_ValidateCreateData
  8681. responses:
  8682. "200":
  8683. $ref: '#/responses/region_ValidateCreateDataOutput'
  8684. summary: 新建
  8685. tags:
  8686. - region
  8687. /regions/{id}:
  8688. delete:
  8689. description: 删除
  8690. operationId: region_CustomizeDelete
  8691. parameters:
  8692. - description: The Id or Name of region
  8693. in: path
  8694. name: id
  8695. required: true
  8696. type: string
  8697. x-go-name: Id
  8698. responses:
  8699. "200":
  8700. $ref: '#/responses/region_CustomizeDeleteOutput'
  8701. summary: 删除
  8702. tags:
  8703. - region
  8704. get:
  8705. description: 获取详情
  8706. operationId: region_FetchCustomizeColumns
  8707. parameters:
  8708. - description: The Id or Name of region
  8709. in: path
  8710. name: id
  8711. required: true
  8712. type: string
  8713. x-go-name: Id
  8714. responses:
  8715. "200":
  8716. $ref: '#/responses/region_FetchCustomizeColumnsOutput'
  8717. summary: 获取详情
  8718. tags:
  8719. - region
  8720. put:
  8721. description: 更新
  8722. operationId: region_ValidateUpdateData
  8723. parameters:
  8724. - description: The Id or Name of region
  8725. in: path
  8726. name: id
  8727. required: true
  8728. type: string
  8729. x-go-name: Id
  8730. - in: body
  8731. name: body
  8732. schema:
  8733. properties:
  8734. region:
  8735. $ref: '#/definitions/StandaloneResourceBaseUpdateInput'
  8736. type: object
  8737. x-go-name: Body
  8738. responses:
  8739. "200":
  8740. $ref: '#/responses/region_ValidateUpdateDataOutput'
  8741. summary: 更新
  8742. tags:
  8743. - region
  8744. /regions/{id}/metadata:
  8745. get:
  8746. description: 获取指定信息Metadata
  8747. operationId: region_GetDetailsMetadata
  8748. parameters:
  8749. - description: |-
  8750. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  8751. 标签分为
  8752. 类型 | 说明 |
  8753. ----------|---------------------------------------------|
  8754. 系统标签 | 平台定义的标签 |
  8755. 用户标签 | key以user:为前缀,用户自定义标签 |
  8756. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  8757. in: query
  8758. items:
  8759. type: string
  8760. name: field
  8761. type: array
  8762. x-go-name: Field
  8763. - description: 按标签前缀过滤
  8764. in: query
  8765. name: prefix
  8766. type: string
  8767. x-go-name: Prefix
  8768. - description: The Id or Name of region
  8769. in: path
  8770. name: id
  8771. required: true
  8772. type: string
  8773. x-go-name: Id
  8774. responses:
  8775. "200":
  8776. $ref: '#/responses/region_GetDetailsMetadataOutput'
  8777. summary: 获取资源标签(元数据)
  8778. tags:
  8779. - region
  8780. /role_policies:
  8781. get:
  8782. description: 列表
  8783. operationId: role_policy_ListItemFilter
  8784. parameters:
  8785. - default: 20
  8786. description: 查询限制量
  8787. format: int64
  8788. in: query
  8789. name: limit
  8790. type: integer
  8791. x-go-name: Limit
  8792. - default: 0
  8793. description: 查询偏移量
  8794. format: int64
  8795. in: query
  8796. name: offset
  8797. type: integer
  8798. x-go-name: Offset
  8799. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  8800. in: query
  8801. items:
  8802. type: string
  8803. name: order_by
  8804. type: array
  8805. x-go-name: OrderBy
  8806. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  8807. example: desc|asc
  8808. in: query
  8809. name: order
  8810. type: string
  8811. x-go-name: Order
  8812. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  8813. in: query
  8814. name: details
  8815. type: boolean
  8816. x-go-name: Details
  8817. - description: 模糊搜索所有字段
  8818. in: query
  8819. name: search
  8820. type: string
  8821. x-go-name: Search
  8822. - description: |-
  8823. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  8824. 支持的操作符如下:
  8825. 操作符 | 参数个数 | 举例 | 说明 |
  8826. ---------------|----------|------------------------------------------------|-----------------------------|
  8827. in | > 0 | name.in("test", "good") | 在给定数组中 |
  8828. notin | > 0 | name.notin('test') | 不在给定数组中 |
  8829. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  8830. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  8831. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  8832. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  8833. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  8834. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  8835. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  8836. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  8837. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  8838. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  8839. notequals | 1 | name.notequals('test') | 不等于给定值 |
  8840. isnull | 0 | name.isnull() | 值为SQL的NULL |
  8841. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  8842. isempty | 0 | name.isempty('test') | 值为空字符串 |
  8843. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  8844. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  8845. in: query
  8846. items:
  8847. type: string
  8848. name: filter
  8849. type: array
  8850. x-go-name: Filter
  8851. - description: |-
  8852. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  8853. 和其他表关联的语法如下:
  8854. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  8855. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  8856. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  8857. 举例:
  8858. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  8859. in: query
  8860. items:
  8861. type: string
  8862. name: joint_filter
  8863. type: array
  8864. x-go-name: JointFilter
  8865. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  8866. in: query
  8867. name: filter_any
  8868. type: boolean
  8869. x-go-name: FilterAny
  8870. - description: 返回结果只包含指定的字段
  8871. in: query
  8872. items:
  8873. type: string
  8874. name: field
  8875. type: array
  8876. x-go-name: Field
  8877. - description: 用于数据导出,指定导出的数据字段
  8878. in: query
  8879. name: export_keys
  8880. type: string
  8881. x-go-name: ExportKeys
  8882. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  8883. in: query
  8884. name: show_fail_reason
  8885. type: boolean
  8886. x-go-name: ShowFailReason
  8887. - description: 是否返回状态统计信息,默认为False
  8888. in: query
  8889. name: summary_stats
  8890. type: boolean
  8891. x-go-name: SummaryStats
  8892. - in: query
  8893. items:
  8894. type: string
  8895. name: role_ids
  8896. type: array
  8897. x-go-name: RoleIds
  8898. - in: query
  8899. name: project_id
  8900. type: string
  8901. x-go-name: ProjectId
  8902. - in: query
  8903. name: policy_id
  8904. type: string
  8905. x-go-name: PolicyId
  8906. - in: query
  8907. name: auth
  8908. type: boolean
  8909. x-go-name: Auth
  8910. responses:
  8911. "200":
  8912. $ref: '#/responses/role_policy_ListItemFilterOutput'
  8913. summary: 列表
  8914. tags:
  8915. - role_policy
  8916. post:
  8917. description: 新建
  8918. operationId: role_policy_ValidateCreateData
  8919. parameters:
  8920. - in: body
  8921. name: body
  8922. schema:
  8923. properties:
  8924. count:
  8925. default: 1
  8926. format: int64
  8927. type: integer
  8928. x-go-name: Count
  8929. role_policy:
  8930. $ref: '#/definitions/ResourceBaseCreateInput'
  8931. type: object
  8932. x-go-name: Body
  8933. responses:
  8934. "200":
  8935. $ref: '#/responses/role_policy_ValidateCreateDataOutput'
  8936. summary: 新建
  8937. tags:
  8938. - role_policy
  8939. /role_policies/{id}:
  8940. delete:
  8941. description: 删除
  8942. operationId: role_policy_CustomizeDelete
  8943. parameters:
  8944. - description: The Id or Name of role_policy
  8945. in: path
  8946. name: id
  8947. required: true
  8948. type: string
  8949. x-go-name: Id
  8950. responses:
  8951. "200":
  8952. $ref: '#/responses/role_policy_CustomizeDeleteOutput'
  8953. summary: 删除
  8954. tags:
  8955. - role_policy
  8956. get:
  8957. description: 获取详情
  8958. operationId: role_policy_FetchCustomizeColumns
  8959. parameters:
  8960. - description: The Id or Name of role_policy
  8961. in: path
  8962. name: id
  8963. required: true
  8964. type: string
  8965. x-go-name: Id
  8966. responses:
  8967. "200":
  8968. $ref: '#/responses/role_policy_FetchCustomizeColumnsOutput'
  8969. summary: 获取详情
  8970. tags:
  8971. - role_policy
  8972. put:
  8973. description: 更新
  8974. operationId: role_policy_ValidateUpdateData
  8975. parameters:
  8976. - description: The Id or Name of role_policy
  8977. in: path
  8978. name: id
  8979. required: true
  8980. type: string
  8981. x-go-name: Id
  8982. - in: body
  8983. name: body
  8984. schema:
  8985. properties:
  8986. role_policy:
  8987. $ref: '#/definitions/ResourceBaseUpdateInput'
  8988. type: object
  8989. x-go-name: Body
  8990. responses:
  8991. "200":
  8992. $ref: '#/responses/role_policy_ValidateUpdateDataOutput'
  8993. summary: 更新
  8994. tags:
  8995. - role_policy
  8996. /roles:
  8997. get:
  8998. description: 列表
  8999. operationId: role_ListItemFilter
  9000. parameters:
  9001. - default: 20
  9002. description: 查询限制量
  9003. format: int64
  9004. in: query
  9005. name: limit
  9006. type: integer
  9007. x-go-name: Limit
  9008. - default: 0
  9009. description: 查询偏移量
  9010. format: int64
  9011. in: query
  9012. name: offset
  9013. type: integer
  9014. x-go-name: Offset
  9015. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  9016. in: query
  9017. items:
  9018. type: string
  9019. name: order_by
  9020. type: array
  9021. x-go-name: OrderBy
  9022. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  9023. example: desc|asc
  9024. in: query
  9025. name: order
  9026. type: string
  9027. x-go-name: Order
  9028. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  9029. in: query
  9030. name: details
  9031. type: boolean
  9032. x-go-name: Details
  9033. - description: 模糊搜索所有字段
  9034. in: query
  9035. name: search
  9036. type: string
  9037. x-go-name: Search
  9038. - description: |-
  9039. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  9040. 支持的操作符如下:
  9041. 操作符 | 参数个数 | 举例 | 说明 |
  9042. ---------------|----------|------------------------------------------------|-----------------------------|
  9043. in | > 0 | name.in("test", "good") | 在给定数组中 |
  9044. notin | > 0 | name.notin('test') | 不在给定数组中 |
  9045. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  9046. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  9047. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  9048. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  9049. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  9050. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  9051. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  9052. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  9053. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  9054. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  9055. notequals | 1 | name.notequals('test') | 不等于给定值 |
  9056. isnull | 0 | name.isnull() | 值为SQL的NULL |
  9057. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  9058. isempty | 0 | name.isempty('test') | 值为空字符串 |
  9059. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  9060. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  9061. in: query
  9062. items:
  9063. type: string
  9064. name: filter
  9065. type: array
  9066. x-go-name: Filter
  9067. - description: |-
  9068. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  9069. 和其他表关联的语法如下:
  9070. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  9071. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  9072. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  9073. 举例:
  9074. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  9075. in: query
  9076. items:
  9077. type: string
  9078. name: joint_filter
  9079. type: array
  9080. x-go-name: JointFilter
  9081. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  9082. in: query
  9083. name: filter_any
  9084. type: boolean
  9085. x-go-name: FilterAny
  9086. - description: 返回结果只包含指定的字段
  9087. in: query
  9088. items:
  9089. type: string
  9090. name: field
  9091. type: array
  9092. x-go-name: Field
  9093. - description: 用于数据导出,指定导出的数据字段
  9094. in: query
  9095. name: export_keys
  9096. type: string
  9097. x-go-name: ExportKeys
  9098. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  9099. in: query
  9100. name: show_fail_reason
  9101. type: boolean
  9102. x-go-name: ShowFailReason
  9103. - description: 是否返回状态统计信息,默认为False
  9104. in: query
  9105. name: summary_stats
  9106. type: boolean
  9107. x-go-name: SummaryStats
  9108. - $ref: '#/definitions/TTagSet'
  9109. description: 通过标签过滤(包含这些标签)
  9110. in: query
  9111. name: tags
  9112. x-go-name: Tags
  9113. - $ref: '#/definitions/TTagSetList'
  9114. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  9115. in: query
  9116. name: obj_tags
  9117. x-go-name: ObjTags
  9118. - $ref: '#/definitions/TTagSet'
  9119. description: 通过标签过滤(不包含这些标签)
  9120. in: query
  9121. name: no_tags
  9122. x-go-name: NoTags
  9123. - $ref: '#/definitions/TTagSetList'
  9124. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  9125. in: query
  9126. name: no_obj_tags
  9127. x-go-name: NoObjTags
  9128. - description: 通过标签排序
  9129. in: query
  9130. name: order_by_tag
  9131. type: string
  9132. x-go-name: OrderByTag
  9133. - description: |-
  9134. deprecated
  9135. 返回资源的标签不包含用户标签
  9136. in: query
  9137. name: without_user_meta
  9138. type: boolean
  9139. x-go-name: WithoutUserMeta
  9140. - description: 返回包含用户标签的资源
  9141. in: query
  9142. name: with_user_meta
  9143. type: boolean
  9144. x-go-name: WithUserMeta
  9145. - description: 返回包含外部标签的资源
  9146. in: query
  9147. name: with_cloud_meta
  9148. type: boolean
  9149. x-go-name: WithCloudMeta
  9150. - description: 返回包含任意标签的资源
  9151. in: query
  9152. name: with_any_meta
  9153. type: boolean
  9154. x-go-name: WithAnyMeta
  9155. - description: 返回列表数据中包含资源的标签数据(Metadata)
  9156. in: query
  9157. name: with_meta
  9158. type: boolean
  9159. x-go-name: WithMeta
  9160. - description: 显示所有的资源,包括模拟的资源
  9161. in: query
  9162. name: show_emulated
  9163. type: boolean
  9164. x-go-name: ShowEmulated
  9165. - description: 以资源ID过滤列表
  9166. in: query
  9167. items:
  9168. type: string
  9169. name: id
  9170. type: array
  9171. x-go-name: Ids
  9172. - description: 以资源名称过滤列表
  9173. in: query
  9174. items:
  9175. type: string
  9176. name: name
  9177. type: array
  9178. x-go-name: Names
  9179. - description: 指定查询的权限范围,可能值为project, domain or system
  9180. in: query
  9181. name: scope
  9182. type: string
  9183. x-go-name: Scope
  9184. - description: 对具有域属性的资源,严格匹配域ID
  9185. in: query
  9186. items:
  9187. type: string
  9188. name: project_domain_ids
  9189. type: array
  9190. x-go-name: ProjectDomainIds
  9191. - description: 按domain名称排序,可能值为asc|desc
  9192. in: query
  9193. name: order_by_domain
  9194. pattern: asc|desc
  9195. type: string
  9196. x-go-name: OrderByDomain
  9197. - $ref: '#/definitions/TTagSetList'
  9198. description: filter by domain tags
  9199. in: query
  9200. name: domain_tags
  9201. x-go-name: DomainTags
  9202. - $ref: '#/definitions/TTagSetList'
  9203. description: filter by domain tags
  9204. in: query
  9205. name: no_domain_tags
  9206. x-go-name: NoDomainTags
  9207. - description: 以资源是否共享过滤列表
  9208. in: query
  9209. name: is_public
  9210. type: boolean
  9211. x-go-name: IsPublic
  9212. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  9213. in: query
  9214. name: public_scope
  9215. type: string
  9216. x-go-name: PublicScope
  9217. - description: 项目归属域
  9218. in: query
  9219. name: project_domain_id
  9220. type: string
  9221. x-go-name: ProjectDomainId
  9222. - description: 以项目(ID或Name)过滤列表结果
  9223. in: query
  9224. name: project_id
  9225. type: string
  9226. x-go-name: ProjectId
  9227. - description: 用户归属域
  9228. in: query
  9229. name: user_domain_id
  9230. type: string
  9231. x-go-name: UserDomainId
  9232. - description: filter by user
  9233. in: query
  9234. name: user_id
  9235. type: string
  9236. x-go-name: UserId
  9237. - description: 组归属域
  9238. in: query
  9239. name: group_domain_id
  9240. type: string
  9241. x-go-name: GroupDomainId
  9242. - description: filter by group
  9243. in: query
  9244. name: group_id
  9245. type: string
  9246. x-go-name: GroupId
  9247. responses:
  9248. "200":
  9249. $ref: '#/responses/role_ListItemFilterOutput'
  9250. summary: 角色列表
  9251. tags:
  9252. - role
  9253. post:
  9254. description: 新建
  9255. operationId: role_ValidateCreateData
  9256. parameters:
  9257. - in: body
  9258. name: body
  9259. schema:
  9260. properties:
  9261. count:
  9262. default: 1
  9263. format: int64
  9264. type: integer
  9265. x-go-name: Count
  9266. role:
  9267. $ref: '#/definitions/RoleCreateInput'
  9268. type: object
  9269. x-go-name: Body
  9270. responses:
  9271. "200":
  9272. $ref: '#/responses/role_ValidateCreateDataOutput'
  9273. summary: 新建
  9274. tags:
  9275. - role
  9276. /roles/{id}:
  9277. delete:
  9278. description: 删除
  9279. operationId: role_CustomizeDelete
  9280. parameters:
  9281. - description: The Id or Name of role
  9282. in: path
  9283. name: id
  9284. required: true
  9285. type: string
  9286. x-go-name: Id
  9287. responses:
  9288. "200":
  9289. $ref: '#/responses/role_CustomizeDeleteOutput'
  9290. summary: 删除
  9291. tags:
  9292. - role
  9293. get:
  9294. description: 获取详情
  9295. operationId: role_FetchCustomizeColumns
  9296. parameters:
  9297. - description: The Id or Name of role
  9298. in: path
  9299. name: id
  9300. required: true
  9301. type: string
  9302. x-go-name: Id
  9303. responses:
  9304. "200":
  9305. $ref: '#/responses/role_FetchCustomizeColumnsOutput'
  9306. summary: 获取详情
  9307. tags:
  9308. - role
  9309. put:
  9310. description: 更新
  9311. operationId: role_ValidateUpdateData
  9312. parameters:
  9313. - description: The Id or Name of role
  9314. in: path
  9315. name: id
  9316. required: true
  9317. type: string
  9318. x-go-name: Id
  9319. - in: body
  9320. name: body
  9321. schema:
  9322. properties:
  9323. role:
  9324. $ref: '#/definitions/RoleUpdateInput'
  9325. type: object
  9326. x-go-name: Body
  9327. responses:
  9328. "200":
  9329. $ref: '#/responses/role_ValidateUpdateDataOutput'
  9330. summary: 更新
  9331. tags:
  9332. - role
  9333. /roles/{id}/add-policy:
  9334. post:
  9335. description: 执行操作AddPolicy
  9336. operationId: role_PerformAddPolicy
  9337. parameters:
  9338. - description: The Id or Name of role
  9339. in: path
  9340. name: id
  9341. required: true
  9342. type: string
  9343. x-go-name: Id
  9344. - in: body
  9345. name: body
  9346. schema:
  9347. properties:
  9348. role:
  9349. $ref: '#/definitions/RolePerformAddPolicyInput'
  9350. type: object
  9351. x-go-name: Body
  9352. responses:
  9353. "200":
  9354. $ref: '#/responses/role_PerformAddPolicyOutput'
  9355. summary: 执行操作AddPolicy
  9356. tags:
  9357. - role
  9358. /roles/{id}/metadata:
  9359. get:
  9360. description: 获取指定信息Metadata
  9361. operationId: role_GetDetailsMetadata
  9362. parameters:
  9363. - description: |-
  9364. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  9365. 标签分为
  9366. 类型 | 说明 |
  9367. ----------|---------------------------------------------|
  9368. 系统标签 | 平台定义的标签 |
  9369. 用户标签 | key以user:为前缀,用户自定义标签 |
  9370. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  9371. in: query
  9372. items:
  9373. type: string
  9374. name: field
  9375. type: array
  9376. x-go-name: Field
  9377. - description: 按标签前缀过滤
  9378. in: query
  9379. name: prefix
  9380. type: string
  9381. x-go-name: Prefix
  9382. - description: The Id or Name of role
  9383. in: path
  9384. name: id
  9385. required: true
  9386. type: string
  9387. x-go-name: Id
  9388. responses:
  9389. "200":
  9390. $ref: '#/responses/role_GetDetailsMetadataOutput'
  9391. summary: 获取资源标签(元数据)
  9392. tags:
  9393. - role
  9394. /roles/{id}/private:
  9395. post:
  9396. description: 执行操作Private
  9397. operationId: role_PerformPrivate
  9398. parameters:
  9399. - description: The Id or Name of role
  9400. in: path
  9401. name: id
  9402. required: true
  9403. type: string
  9404. x-go-name: Id
  9405. - in: body
  9406. name: body
  9407. schema:
  9408. properties:
  9409. role:
  9410. $ref: '#/definitions/PerformPrivateInput'
  9411. type: object
  9412. x-go-name: Body
  9413. responses:
  9414. "200":
  9415. $ref: '#/responses/role_PerformPrivateOutput'
  9416. summary: 执行操作Private
  9417. tags:
  9418. - role
  9419. /roles/{id}/public:
  9420. post:
  9421. description: 执行操作Public
  9422. operationId: role_PerformPublic
  9423. parameters:
  9424. - description: The Id or Name of role
  9425. in: path
  9426. name: id
  9427. required: true
  9428. type: string
  9429. x-go-name: Id
  9430. - in: body
  9431. name: body
  9432. schema:
  9433. properties:
  9434. role:
  9435. $ref: '#/definitions/PerformPublicDomainInput'
  9436. type: object
  9437. x-go-name: Body
  9438. responses:
  9439. "200":
  9440. $ref: '#/responses/role_PerformPublicOutput'
  9441. summary: 执行操作Public
  9442. tags:
  9443. - role
  9444. /roles/{id}/remove-policy:
  9445. post:
  9446. description: 执行操作RemovePolicy
  9447. operationId: role_PerformRemovePolicy
  9448. parameters:
  9449. - description: The Id or Name of role
  9450. in: path
  9451. name: id
  9452. required: true
  9453. type: string
  9454. x-go-name: Id
  9455. - in: body
  9456. name: body
  9457. schema:
  9458. properties:
  9459. role:
  9460. $ref: '#/definitions/RolePerformRemovePolicyInput'
  9461. type: object
  9462. x-go-name: Body
  9463. responses:
  9464. "200":
  9465. $ref: '#/responses/role_PerformRemovePolicyOutput'
  9466. summary: 执行操作RemovePolicy
  9467. tags:
  9468. - role
  9469. /roles/{id}/set-policies:
  9470. post:
  9471. description: 执行操作SetPolicies
  9472. operationId: role_PerformSetPolicies
  9473. parameters:
  9474. - description: The Id or Name of role
  9475. in: path
  9476. name: id
  9477. required: true
  9478. type: string
  9479. x-go-name: Id
  9480. - in: body
  9481. name: body
  9482. schema:
  9483. properties:
  9484. role:
  9485. $ref: '#/definitions/RolePerformSetPoliciesInput'
  9486. type: object
  9487. x-go-name: Body
  9488. responses:
  9489. "200":
  9490. $ref: '#/responses/role_PerformSetPoliciesOutput'
  9491. summary: 执行操作SetPolicies
  9492. tags:
  9493. - role
  9494. /roles/domain-tag-value-pairs:
  9495. get:
  9496. description: 获取指定资源类的信息DomainTagValuePairs
  9497. operationId: role_GetPropertyDomainTagValuePairs
  9498. responses:
  9499. "200":
  9500. $ref: '#/responses/role_GetPropertyDomainTagValuePairsOutput'
  9501. summary: 获取指定资源类的信息DomainTagValuePairs
  9502. tags:
  9503. - role
  9504. /roles/domain-tag-value-tree:
  9505. get:
  9506. description: 获取指定资源类的信息DomainTagValueTree
  9507. operationId: role_GetPropertyDomainTagValueTree
  9508. responses:
  9509. "200":
  9510. $ref: '#/responses/role_GetPropertyDomainTagValueTreeOutput'
  9511. summary: 获取指定资源类的信息DomainTagValueTree
  9512. tags:
  9513. - role
  9514. /scope_resources:
  9515. get:
  9516. description: 列表
  9517. operationId: scope_resource_ListItemFilter
  9518. parameters:
  9519. - default: 20
  9520. description: 查询限制量
  9521. format: int64
  9522. in: query
  9523. name: limit
  9524. type: integer
  9525. x-go-name: Limit
  9526. - default: 0
  9527. description: 查询偏移量
  9528. format: int64
  9529. in: query
  9530. name: offset
  9531. type: integer
  9532. x-go-name: Offset
  9533. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  9534. in: query
  9535. items:
  9536. type: string
  9537. name: order_by
  9538. type: array
  9539. x-go-name: OrderBy
  9540. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  9541. example: desc|asc
  9542. in: query
  9543. name: order
  9544. type: string
  9545. x-go-name: Order
  9546. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  9547. in: query
  9548. name: details
  9549. type: boolean
  9550. x-go-name: Details
  9551. - description: 模糊搜索所有字段
  9552. in: query
  9553. name: search
  9554. type: string
  9555. x-go-name: Search
  9556. - description: |-
  9557. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  9558. 支持的操作符如下:
  9559. 操作符 | 参数个数 | 举例 | 说明 |
  9560. ---------------|----------|------------------------------------------------|-----------------------------|
  9561. in | > 0 | name.in("test", "good") | 在给定数组中 |
  9562. notin | > 0 | name.notin('test') | 不在给定数组中 |
  9563. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  9564. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  9565. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  9566. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  9567. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  9568. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  9569. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  9570. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  9571. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  9572. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  9573. notequals | 1 | name.notequals('test') | 不等于给定值 |
  9574. isnull | 0 | name.isnull() | 值为SQL的NULL |
  9575. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  9576. isempty | 0 | name.isempty('test') | 值为空字符串 |
  9577. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  9578. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  9579. in: query
  9580. items:
  9581. type: string
  9582. name: filter
  9583. type: array
  9584. x-go-name: Filter
  9585. - description: |-
  9586. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  9587. 和其他表关联的语法如下:
  9588. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  9589. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  9590. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  9591. 举例:
  9592. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  9593. in: query
  9594. items:
  9595. type: string
  9596. name: joint_filter
  9597. type: array
  9598. x-go-name: JointFilter
  9599. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  9600. in: query
  9601. name: filter_any
  9602. type: boolean
  9603. x-go-name: FilterAny
  9604. - description: 返回结果只包含指定的字段
  9605. in: query
  9606. items:
  9607. type: string
  9608. name: field
  9609. type: array
  9610. x-go-name: Field
  9611. - description: 用于数据导出,指定导出的数据字段
  9612. in: query
  9613. name: export_keys
  9614. type: string
  9615. x-go-name: ExportKeys
  9616. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  9617. in: query
  9618. name: show_fail_reason
  9619. type: boolean
  9620. x-go-name: ShowFailReason
  9621. - description: 是否返回状态统计信息,默认为False
  9622. in: query
  9623. name: summary_stats
  9624. type: boolean
  9625. x-go-name: SummaryStats
  9626. responses:
  9627. "200":
  9628. $ref: '#/responses/scope_resource_ListItemFilterOutput'
  9629. summary: 列表
  9630. tags:
  9631. - scope_resource
  9632. post:
  9633. description: 新建
  9634. operationId: scope_resource_ValidateCreateData
  9635. parameters:
  9636. - in: body
  9637. name: body
  9638. schema:
  9639. properties:
  9640. count:
  9641. default: 1
  9642. format: int64
  9643. type: integer
  9644. x-go-name: Count
  9645. scope_resource:
  9646. $ref: '#/definitions/ModelBaseCreateInput'
  9647. type: object
  9648. x-go-name: Body
  9649. responses:
  9650. "200":
  9651. $ref: '#/responses/scope_resource_ValidateCreateDataOutput'
  9652. summary: 新建
  9653. tags:
  9654. - scope_resource
  9655. /scope_resources/{id}:
  9656. delete:
  9657. description: 删除
  9658. operationId: scope_resource_CustomizeDelete
  9659. parameters:
  9660. - description: The Id or Name of scope_resource
  9661. in: path
  9662. name: id
  9663. required: true
  9664. type: string
  9665. x-go-name: Id
  9666. responses:
  9667. "200":
  9668. $ref: '#/responses/scope_resource_CustomizeDeleteOutput'
  9669. summary: 删除
  9670. tags:
  9671. - scope_resource
  9672. get:
  9673. description: 获取详情
  9674. operationId: scope_resource_FetchCustomizeColumns
  9675. parameters:
  9676. - description: The Id or Name of scope_resource
  9677. in: path
  9678. name: id
  9679. required: true
  9680. type: string
  9681. x-go-name: Id
  9682. responses:
  9683. "200":
  9684. $ref: '#/responses/scope_resource_FetchCustomizeColumnsOutput'
  9685. summary: 获取详情
  9686. tags:
  9687. - scope_resource
  9688. put:
  9689. description: 更新
  9690. operationId: scope_resource_ValidateUpdateData
  9691. parameters:
  9692. - description: The Id or Name of scope_resource
  9693. in: path
  9694. name: id
  9695. required: true
  9696. type: string
  9697. x-go-name: Id
  9698. - in: body
  9699. name: body
  9700. schema:
  9701. properties:
  9702. scope_resource:
  9703. $ref: '#/definitions/ModelBaseUpdateInput'
  9704. type: object
  9705. x-go-name: Body
  9706. responses:
  9707. "200":
  9708. $ref: '#/responses/scope_resource_ValidateUpdateDataOutput'
  9709. summary: 更新
  9710. tags:
  9711. - scope_resource
  9712. /service_certificates:
  9713. get:
  9714. description: 列表
  9715. operationId: service_certificate_ListItemFilter
  9716. parameters:
  9717. - default: 20
  9718. description: 查询限制量
  9719. format: int64
  9720. in: query
  9721. name: limit
  9722. type: integer
  9723. x-go-name: Limit
  9724. - default: 0
  9725. description: 查询偏移量
  9726. format: int64
  9727. in: query
  9728. name: offset
  9729. type: integer
  9730. x-go-name: Offset
  9731. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  9732. in: query
  9733. items:
  9734. type: string
  9735. name: order_by
  9736. type: array
  9737. x-go-name: OrderBy
  9738. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  9739. example: desc|asc
  9740. in: query
  9741. name: order
  9742. type: string
  9743. x-go-name: Order
  9744. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  9745. in: query
  9746. name: details
  9747. type: boolean
  9748. x-go-name: Details
  9749. - description: 模糊搜索所有字段
  9750. in: query
  9751. name: search
  9752. type: string
  9753. x-go-name: Search
  9754. - description: |-
  9755. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  9756. 支持的操作符如下:
  9757. 操作符 | 参数个数 | 举例 | 说明 |
  9758. ---------------|----------|------------------------------------------------|-----------------------------|
  9759. in | > 0 | name.in("test", "good") | 在给定数组中 |
  9760. notin | > 0 | name.notin('test') | 不在给定数组中 |
  9761. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  9762. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  9763. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  9764. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  9765. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  9766. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  9767. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  9768. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  9769. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  9770. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  9771. notequals | 1 | name.notequals('test') | 不等于给定值 |
  9772. isnull | 0 | name.isnull() | 值为SQL的NULL |
  9773. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  9774. isempty | 0 | name.isempty('test') | 值为空字符串 |
  9775. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  9776. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  9777. in: query
  9778. items:
  9779. type: string
  9780. name: filter
  9781. type: array
  9782. x-go-name: Filter
  9783. - description: |-
  9784. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  9785. 和其他表关联的语法如下:
  9786. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  9787. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  9788. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  9789. 举例:
  9790. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  9791. in: query
  9792. items:
  9793. type: string
  9794. name: joint_filter
  9795. type: array
  9796. x-go-name: JointFilter
  9797. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  9798. in: query
  9799. name: filter_any
  9800. type: boolean
  9801. x-go-name: FilterAny
  9802. - description: 返回结果只包含指定的字段
  9803. in: query
  9804. items:
  9805. type: string
  9806. name: field
  9807. type: array
  9808. x-go-name: Field
  9809. - description: 用于数据导出,指定导出的数据字段
  9810. in: query
  9811. name: export_keys
  9812. type: string
  9813. x-go-name: ExportKeys
  9814. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  9815. in: query
  9816. name: show_fail_reason
  9817. type: boolean
  9818. x-go-name: ShowFailReason
  9819. - description: 是否返回状态统计信息,默认为False
  9820. in: query
  9821. name: summary_stats
  9822. type: boolean
  9823. x-go-name: SummaryStats
  9824. - $ref: '#/definitions/TTagSet'
  9825. description: 通过标签过滤(包含这些标签)
  9826. in: query
  9827. name: tags
  9828. x-go-name: Tags
  9829. - $ref: '#/definitions/TTagSetList'
  9830. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  9831. in: query
  9832. name: obj_tags
  9833. x-go-name: ObjTags
  9834. - $ref: '#/definitions/TTagSet'
  9835. description: 通过标签过滤(不包含这些标签)
  9836. in: query
  9837. name: no_tags
  9838. x-go-name: NoTags
  9839. - $ref: '#/definitions/TTagSetList'
  9840. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  9841. in: query
  9842. name: no_obj_tags
  9843. x-go-name: NoObjTags
  9844. - description: 通过标签排序
  9845. in: query
  9846. name: order_by_tag
  9847. type: string
  9848. x-go-name: OrderByTag
  9849. - description: |-
  9850. deprecated
  9851. 返回资源的标签不包含用户标签
  9852. in: query
  9853. name: without_user_meta
  9854. type: boolean
  9855. x-go-name: WithoutUserMeta
  9856. - description: 返回包含用户标签的资源
  9857. in: query
  9858. name: with_user_meta
  9859. type: boolean
  9860. x-go-name: WithUserMeta
  9861. - description: 返回包含外部标签的资源
  9862. in: query
  9863. name: with_cloud_meta
  9864. type: boolean
  9865. x-go-name: WithCloudMeta
  9866. - description: 返回包含任意标签的资源
  9867. in: query
  9868. name: with_any_meta
  9869. type: boolean
  9870. x-go-name: WithAnyMeta
  9871. - description: 返回列表数据中包含资源的标签数据(Metadata)
  9872. in: query
  9873. name: with_meta
  9874. type: boolean
  9875. x-go-name: WithMeta
  9876. - description: 显示所有的资源,包括模拟的资源
  9877. in: query
  9878. name: show_emulated
  9879. type: boolean
  9880. x-go-name: ShowEmulated
  9881. - description: 以资源ID过滤列表
  9882. in: query
  9883. items:
  9884. type: string
  9885. name: id
  9886. type: array
  9887. x-go-name: Ids
  9888. - description: 以资源名称过滤列表
  9889. in: query
  9890. items:
  9891. type: string
  9892. name: name
  9893. type: array
  9894. x-go-name: Names
  9895. responses:
  9896. "200":
  9897. $ref: '#/responses/service_certificate_ListItemFilterOutput'
  9898. summary: 列表
  9899. tags:
  9900. - service_certificate
  9901. post:
  9902. description: 新建
  9903. operationId: service_certificate_ValidateCreateData
  9904. responses:
  9905. "200":
  9906. $ref: '#/responses/service_certificate_ValidateCreateDataOutput'
  9907. summary: 新建
  9908. tags:
  9909. - service_certificate
  9910. /service_certificates/{id}:
  9911. delete:
  9912. description: 删除
  9913. operationId: service_certificate_CustomizeDelete
  9914. parameters:
  9915. - description: The Id or Name of service_certificate
  9916. in: path
  9917. name: id
  9918. required: true
  9919. type: string
  9920. x-go-name: Id
  9921. responses:
  9922. "200":
  9923. $ref: '#/responses/service_certificate_CustomizeDeleteOutput'
  9924. summary: 删除
  9925. tags:
  9926. - service_certificate
  9927. get:
  9928. description: 获取详情
  9929. operationId: service_certificate_FetchCustomizeColumns
  9930. parameters:
  9931. - description: The Id or Name of service_certificate
  9932. in: path
  9933. name: id
  9934. required: true
  9935. type: string
  9936. x-go-name: Id
  9937. responses:
  9938. "200":
  9939. $ref: '#/responses/service_certificate_FetchCustomizeColumnsOutput'
  9940. summary: 获取详情
  9941. tags:
  9942. - service_certificate
  9943. put:
  9944. description: 更新
  9945. operationId: service_certificate_ValidateUpdateData
  9946. parameters:
  9947. - description: The Id or Name of service_certificate
  9948. in: path
  9949. name: id
  9950. required: true
  9951. type: string
  9952. x-go-name: Id
  9953. responses:
  9954. "200":
  9955. $ref: '#/responses/service_certificate_ValidateUpdateDataOutput'
  9956. summary: 更新
  9957. tags:
  9958. - service_certificate
  9959. /service_certificates/{id}/metadata:
  9960. get:
  9961. description: 获取指定信息Metadata
  9962. operationId: service_certificate_GetDetailsMetadata
  9963. parameters:
  9964. - description: |-
  9965. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  9966. 标签分为
  9967. 类型 | 说明 |
  9968. ----------|---------------------------------------------|
  9969. 系统标签 | 平台定义的标签 |
  9970. 用户标签 | key以user:为前缀,用户自定义标签 |
  9971. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  9972. in: query
  9973. items:
  9974. type: string
  9975. name: field
  9976. type: array
  9977. x-go-name: Field
  9978. - description: 按标签前缀过滤
  9979. in: query
  9980. name: prefix
  9981. type: string
  9982. x-go-name: Prefix
  9983. - description: The Id or Name of service_certificate
  9984. in: path
  9985. name: id
  9986. required: true
  9987. type: string
  9988. x-go-name: Id
  9989. responses:
  9990. "200":
  9991. $ref: '#/responses/service_certificate_GetDetailsMetadataOutput'
  9992. summary: 获取资源标签(元数据)
  9993. tags:
  9994. - service_certificate
  9995. /services:
  9996. get:
  9997. description: 列表
  9998. operationId: service_ListItemFilter
  9999. parameters:
  10000. - default: 20
  10001. description: 查询限制量
  10002. format: int64
  10003. in: query
  10004. name: limit
  10005. type: integer
  10006. x-go-name: Limit
  10007. - default: 0
  10008. description: 查询偏移量
  10009. format: int64
  10010. in: query
  10011. name: offset
  10012. type: integer
  10013. x-go-name: Offset
  10014. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  10015. in: query
  10016. items:
  10017. type: string
  10018. name: order_by
  10019. type: array
  10020. x-go-name: OrderBy
  10021. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  10022. example: desc|asc
  10023. in: query
  10024. name: order
  10025. type: string
  10026. x-go-name: Order
  10027. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  10028. in: query
  10029. name: details
  10030. type: boolean
  10031. x-go-name: Details
  10032. - description: 模糊搜索所有字段
  10033. in: query
  10034. name: search
  10035. type: string
  10036. x-go-name: Search
  10037. - description: |-
  10038. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  10039. 支持的操作符如下:
  10040. 操作符 | 参数个数 | 举例 | 说明 |
  10041. ---------------|----------|------------------------------------------------|-----------------------------|
  10042. in | > 0 | name.in("test", "good") | 在给定数组中 |
  10043. notin | > 0 | name.notin('test') | 不在给定数组中 |
  10044. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  10045. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  10046. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  10047. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  10048. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  10049. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  10050. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  10051. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  10052. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  10053. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  10054. notequals | 1 | name.notequals('test') | 不等于给定值 |
  10055. isnull | 0 | name.isnull() | 值为SQL的NULL |
  10056. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  10057. isempty | 0 | name.isempty('test') | 值为空字符串 |
  10058. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  10059. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  10060. in: query
  10061. items:
  10062. type: string
  10063. name: filter
  10064. type: array
  10065. x-go-name: Filter
  10066. - description: |-
  10067. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  10068. 和其他表关联的语法如下:
  10069. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  10070. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  10071. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  10072. 举例:
  10073. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  10074. in: query
  10075. items:
  10076. type: string
  10077. name: joint_filter
  10078. type: array
  10079. x-go-name: JointFilter
  10080. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  10081. in: query
  10082. name: filter_any
  10083. type: boolean
  10084. x-go-name: FilterAny
  10085. - description: 返回结果只包含指定的字段
  10086. in: query
  10087. items:
  10088. type: string
  10089. name: field
  10090. type: array
  10091. x-go-name: Field
  10092. - description: 用于数据导出,指定导出的数据字段
  10093. in: query
  10094. name: export_keys
  10095. type: string
  10096. x-go-name: ExportKeys
  10097. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  10098. in: query
  10099. name: show_fail_reason
  10100. type: boolean
  10101. x-go-name: ShowFailReason
  10102. - description: 是否返回状态统计信息,默认为False
  10103. in: query
  10104. name: summary_stats
  10105. type: boolean
  10106. x-go-name: SummaryStats
  10107. - $ref: '#/definitions/TTagSet'
  10108. description: 通过标签过滤(包含这些标签)
  10109. in: query
  10110. name: tags
  10111. x-go-name: Tags
  10112. - $ref: '#/definitions/TTagSetList'
  10113. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  10114. in: query
  10115. name: obj_tags
  10116. x-go-name: ObjTags
  10117. - $ref: '#/definitions/TTagSet'
  10118. description: 通过标签过滤(不包含这些标签)
  10119. in: query
  10120. name: no_tags
  10121. x-go-name: NoTags
  10122. - $ref: '#/definitions/TTagSetList'
  10123. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  10124. in: query
  10125. name: no_obj_tags
  10126. x-go-name: NoObjTags
  10127. - description: 通过标签排序
  10128. in: query
  10129. name: order_by_tag
  10130. type: string
  10131. x-go-name: OrderByTag
  10132. - description: |-
  10133. deprecated
  10134. 返回资源的标签不包含用户标签
  10135. in: query
  10136. name: without_user_meta
  10137. type: boolean
  10138. x-go-name: WithoutUserMeta
  10139. - description: 返回包含用户标签的资源
  10140. in: query
  10141. name: with_user_meta
  10142. type: boolean
  10143. x-go-name: WithUserMeta
  10144. - description: 返回包含外部标签的资源
  10145. in: query
  10146. name: with_cloud_meta
  10147. type: boolean
  10148. x-go-name: WithCloudMeta
  10149. - description: 返回包含任意标签的资源
  10150. in: query
  10151. name: with_any_meta
  10152. type: boolean
  10153. x-go-name: WithAnyMeta
  10154. - description: 返回列表数据中包含资源的标签数据(Metadata)
  10155. in: query
  10156. name: with_meta
  10157. type: boolean
  10158. x-go-name: WithMeta
  10159. - description: 显示所有的资源,包括模拟的资源
  10160. in: query
  10161. name: show_emulated
  10162. type: boolean
  10163. x-go-name: ShowEmulated
  10164. - description: 以资源ID过滤列表
  10165. in: query
  10166. items:
  10167. type: string
  10168. name: id
  10169. type: array
  10170. x-go-name: Ids
  10171. - description: 以资源名称过滤列表
  10172. in: query
  10173. items:
  10174. type: string
  10175. name: name
  10176. type: array
  10177. x-go-name: Names
  10178. - description: 以Service Type过滤
  10179. in: query
  10180. items:
  10181. type: string
  10182. name: type
  10183. type: array
  10184. x-go-name: Type
  10185. - description: 是否启用/禁用
  10186. in: query
  10187. name: enabled
  10188. type: boolean
  10189. x-go-name: Enabled
  10190. responses:
  10191. "200":
  10192. $ref: '#/responses/service_ListItemFilterOutput'
  10193. summary: 服务列表
  10194. tags:
  10195. - service
  10196. post:
  10197. description: 新建
  10198. operationId: service_ValidateCreateData
  10199. parameters:
  10200. - in: body
  10201. name: body
  10202. schema:
  10203. properties:
  10204. count:
  10205. default: 1
  10206. format: int64
  10207. type: integer
  10208. x-go-name: Count
  10209. service:
  10210. $ref: '#/definitions/StandaloneResourceCreateInput'
  10211. type: object
  10212. x-go-name: Body
  10213. responses:
  10214. "200":
  10215. $ref: '#/responses/service_ValidateCreateDataOutput'
  10216. summary: 新建
  10217. tags:
  10218. - service
  10219. /services/{id}:
  10220. delete:
  10221. description: 删除
  10222. operationId: service_CustomizeDelete
  10223. parameters:
  10224. - description: The Id or Name of service
  10225. in: path
  10226. name: id
  10227. required: true
  10228. type: string
  10229. x-go-name: Id
  10230. responses:
  10231. "200":
  10232. $ref: '#/responses/service_CustomizeDeleteOutput'
  10233. summary: 删除
  10234. tags:
  10235. - service
  10236. get:
  10237. description: 获取详情
  10238. operationId: service_FetchCustomizeColumns
  10239. parameters:
  10240. - description: The Id or Name of service
  10241. in: path
  10242. name: id
  10243. required: true
  10244. type: string
  10245. x-go-name: Id
  10246. responses:
  10247. "200":
  10248. $ref: '#/responses/service_FetchCustomizeColumnsOutput'
  10249. summary: 获取详情
  10250. tags:
  10251. - service
  10252. put:
  10253. description: 更新
  10254. operationId: service_ValidateUpdateData
  10255. parameters:
  10256. - description: The Id or Name of service
  10257. in: path
  10258. name: id
  10259. required: true
  10260. type: string
  10261. x-go-name: Id
  10262. - in: body
  10263. name: body
  10264. schema:
  10265. properties:
  10266. service:
  10267. $ref: '#/definitions/StandaloneResourceBaseUpdateInput'
  10268. type: object
  10269. x-go-name: Body
  10270. responses:
  10271. "200":
  10272. $ref: '#/responses/service_ValidateUpdateDataOutput'
  10273. summary: 更新
  10274. tags:
  10275. - service
  10276. /services/{id}/config:
  10277. get:
  10278. description: 获取指定信息Config
  10279. operationId: service_GetDetailsConfig
  10280. parameters:
  10281. - description: The Id or Name of service
  10282. in: path
  10283. name: id
  10284. required: true
  10285. type: string
  10286. x-go-name: Id
  10287. responses:
  10288. "200":
  10289. $ref: '#/responses/service_GetDetailsConfigOutput'
  10290. summary: 获取指定信息Config
  10291. tags:
  10292. - service
  10293. post:
  10294. description: 执行操作Config
  10295. operationId: service_PerformConfig
  10296. parameters:
  10297. - description: The Id or Name of service
  10298. in: path
  10299. name: id
  10300. required: true
  10301. type: string
  10302. x-go-name: Id
  10303. - in: body
  10304. name: body
  10305. schema:
  10306. properties:
  10307. service:
  10308. $ref: '#/definitions/PerformConfigInput'
  10309. type: object
  10310. x-go-name: Body
  10311. responses:
  10312. "200":
  10313. $ref: '#/responses/service_PerformConfigOutput'
  10314. summary: 执行操作Config
  10315. tags:
  10316. - service
  10317. /services/{id}/metadata:
  10318. get:
  10319. description: 获取指定信息Metadata
  10320. operationId: service_GetDetailsMetadata
  10321. parameters:
  10322. - description: |-
  10323. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  10324. 标签分为
  10325. 类型 | 说明 |
  10326. ----------|---------------------------------------------|
  10327. 系统标签 | 平台定义的标签 |
  10328. 用户标签 | key以user:为前缀,用户自定义标签 |
  10329. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  10330. in: query
  10331. items:
  10332. type: string
  10333. name: field
  10334. type: array
  10335. x-go-name: Field
  10336. - description: 按标签前缀过滤
  10337. in: query
  10338. name: prefix
  10339. type: string
  10340. x-go-name: Prefix
  10341. - description: The Id or Name of service
  10342. in: path
  10343. name: id
  10344. required: true
  10345. type: string
  10346. x-go-name: Id
  10347. responses:
  10348. "200":
  10349. $ref: '#/responses/service_GetDetailsMetadataOutput'
  10350. summary: 获取资源标签(元数据)
  10351. tags:
  10352. - service
  10353. /token_caches:
  10354. get:
  10355. description: 列表
  10356. operationId: token_cache_ListItemFilter
  10357. parameters:
  10358. - default: 20
  10359. description: 查询限制量
  10360. format: int64
  10361. in: query
  10362. name: limit
  10363. type: integer
  10364. x-go-name: Limit
  10365. - default: 0
  10366. description: 查询偏移量
  10367. format: int64
  10368. in: query
  10369. name: offset
  10370. type: integer
  10371. x-go-name: Offset
  10372. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  10373. in: query
  10374. items:
  10375. type: string
  10376. name: order_by
  10377. type: array
  10378. x-go-name: OrderBy
  10379. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  10380. example: desc|asc
  10381. in: query
  10382. name: order
  10383. type: string
  10384. x-go-name: Order
  10385. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  10386. in: query
  10387. name: details
  10388. type: boolean
  10389. x-go-name: Details
  10390. - description: 模糊搜索所有字段
  10391. in: query
  10392. name: search
  10393. type: string
  10394. x-go-name: Search
  10395. - description: |-
  10396. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  10397. 支持的操作符如下:
  10398. 操作符 | 参数个数 | 举例 | 说明 |
  10399. ---------------|----------|------------------------------------------------|-----------------------------|
  10400. in | > 0 | name.in("test", "good") | 在给定数组中 |
  10401. notin | > 0 | name.notin('test') | 不在给定数组中 |
  10402. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  10403. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  10404. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  10405. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  10406. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  10407. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  10408. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  10409. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  10410. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  10411. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  10412. notequals | 1 | name.notequals('test') | 不等于给定值 |
  10413. isnull | 0 | name.isnull() | 值为SQL的NULL |
  10414. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  10415. isempty | 0 | name.isempty('test') | 值为空字符串 |
  10416. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  10417. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  10418. in: query
  10419. items:
  10420. type: string
  10421. name: filter
  10422. type: array
  10423. x-go-name: Filter
  10424. - description: |-
  10425. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  10426. 和其他表关联的语法如下:
  10427. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  10428. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  10429. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  10430. 举例:
  10431. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  10432. in: query
  10433. items:
  10434. type: string
  10435. name: joint_filter
  10436. type: array
  10437. x-go-name: JointFilter
  10438. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  10439. in: query
  10440. name: filter_any
  10441. type: boolean
  10442. x-go-name: FilterAny
  10443. - description: 返回结果只包含指定的字段
  10444. in: query
  10445. items:
  10446. type: string
  10447. name: field
  10448. type: array
  10449. x-go-name: Field
  10450. - description: 用于数据导出,指定导出的数据字段
  10451. in: query
  10452. name: export_keys
  10453. type: string
  10454. x-go-name: ExportKeys
  10455. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  10456. in: query
  10457. name: show_fail_reason
  10458. type: boolean
  10459. x-go-name: ShowFailReason
  10460. - description: 是否返回状态统计信息,默认为False
  10461. in: query
  10462. name: summary_stats
  10463. type: boolean
  10464. x-go-name: SummaryStats
  10465. - $ref: '#/definitions/TTagSet'
  10466. description: 通过标签过滤(包含这些标签)
  10467. in: query
  10468. name: tags
  10469. x-go-name: Tags
  10470. - $ref: '#/definitions/TTagSetList'
  10471. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  10472. in: query
  10473. name: obj_tags
  10474. x-go-name: ObjTags
  10475. - $ref: '#/definitions/TTagSet'
  10476. description: 通过标签过滤(不包含这些标签)
  10477. in: query
  10478. name: no_tags
  10479. x-go-name: NoTags
  10480. - $ref: '#/definitions/TTagSetList'
  10481. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  10482. in: query
  10483. name: no_obj_tags
  10484. x-go-name: NoObjTags
  10485. - description: 通过标签排序
  10486. in: query
  10487. name: order_by_tag
  10488. type: string
  10489. x-go-name: OrderByTag
  10490. - description: |-
  10491. deprecated
  10492. 返回资源的标签不包含用户标签
  10493. in: query
  10494. name: without_user_meta
  10495. type: boolean
  10496. x-go-name: WithoutUserMeta
  10497. - description: 返回包含用户标签的资源
  10498. in: query
  10499. name: with_user_meta
  10500. type: boolean
  10501. x-go-name: WithUserMeta
  10502. - description: 返回包含外部标签的资源
  10503. in: query
  10504. name: with_cloud_meta
  10505. type: boolean
  10506. x-go-name: WithCloudMeta
  10507. - description: 返回包含任意标签的资源
  10508. in: query
  10509. name: with_any_meta
  10510. type: boolean
  10511. x-go-name: WithAnyMeta
  10512. - description: 返回列表数据中包含资源的标签数据(Metadata)
  10513. in: query
  10514. name: with_meta
  10515. type: boolean
  10516. x-go-name: WithMeta
  10517. - description: 显示所有的资源,包括模拟的资源
  10518. in: query
  10519. name: show_emulated
  10520. type: boolean
  10521. x-go-name: ShowEmulated
  10522. - description: 以资源ID过滤列表
  10523. in: query
  10524. items:
  10525. type: string
  10526. name: id
  10527. type: array
  10528. x-go-name: Ids
  10529. responses:
  10530. "200":
  10531. $ref: '#/responses/token_cache_ListItemFilterOutput'
  10532. summary: 列表
  10533. tags:
  10534. - token_cache
  10535. post:
  10536. description: 新建
  10537. operationId: token_cache_ValidateCreateData
  10538. parameters:
  10539. - in: body
  10540. name: body
  10541. schema:
  10542. properties:
  10543. count:
  10544. default: 1
  10545. format: int64
  10546. type: integer
  10547. x-go-name: Count
  10548. token_cache:
  10549. $ref: '#/definitions/StandaloneAnonResourceCreateInput'
  10550. type: object
  10551. x-go-name: Body
  10552. responses:
  10553. "200":
  10554. $ref: '#/responses/token_cache_ValidateCreateDataOutput'
  10555. summary: 新建
  10556. tags:
  10557. - token_cache
  10558. /token_caches/{id}:
  10559. delete:
  10560. description: 删除
  10561. operationId: token_cache_CustomizeDelete
  10562. parameters:
  10563. - description: The Id or Name of token_cache
  10564. in: path
  10565. name: id
  10566. required: true
  10567. type: string
  10568. x-go-name: Id
  10569. responses:
  10570. "200":
  10571. $ref: '#/responses/token_cache_CustomizeDeleteOutput'
  10572. summary: 删除
  10573. tags:
  10574. - token_cache
  10575. get:
  10576. description: 获取详情
  10577. operationId: token_cache_FetchCustomizeColumns
  10578. parameters:
  10579. - description: The Id or Name of token_cache
  10580. in: path
  10581. name: id
  10582. required: true
  10583. type: string
  10584. x-go-name: Id
  10585. responses:
  10586. "200":
  10587. $ref: '#/responses/token_cache_FetchCustomizeColumnsOutput'
  10588. summary: 获取详情
  10589. tags:
  10590. - token_cache
  10591. put:
  10592. description: 更新
  10593. operationId: token_cache_ValidateUpdateData
  10594. parameters:
  10595. - description: The Id or Name of token_cache
  10596. in: path
  10597. name: id
  10598. required: true
  10599. type: string
  10600. x-go-name: Id
  10601. - in: body
  10602. name: body
  10603. schema:
  10604. properties:
  10605. token_cache:
  10606. $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput'
  10607. type: object
  10608. x-go-name: Body
  10609. responses:
  10610. "200":
  10611. $ref: '#/responses/token_cache_ValidateUpdateDataOutput'
  10612. summary: 更新
  10613. tags:
  10614. - token_cache
  10615. /token_caches/{id}/metadata:
  10616. get:
  10617. description: 获取指定信息Metadata
  10618. operationId: token_cache_GetDetailsMetadata
  10619. parameters:
  10620. - description: |-
  10621. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  10622. 标签分为
  10623. 类型 | 说明 |
  10624. ----------|---------------------------------------------|
  10625. 系统标签 | 平台定义的标签 |
  10626. 用户标签 | key以user:为前缀,用户自定义标签 |
  10627. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  10628. in: query
  10629. items:
  10630. type: string
  10631. name: field
  10632. type: array
  10633. x-go-name: Field
  10634. - description: 按标签前缀过滤
  10635. in: query
  10636. name: prefix
  10637. type: string
  10638. x-go-name: Prefix
  10639. - description: The Id or Name of token_cache
  10640. in: path
  10641. name: id
  10642. required: true
  10643. type: string
  10644. x-go-name: Id
  10645. responses:
  10646. "200":
  10647. $ref: '#/responses/token_cache_GetDetailsMetadataOutput'
  10648. summary: 获取资源标签(元数据)
  10649. tags:
  10650. - token_cache
  10651. /users:
  10652. get:
  10653. description: 列表
  10654. operationId: user_ListItemFilter
  10655. parameters:
  10656. - default: 20
  10657. description: 查询限制量
  10658. format: int64
  10659. in: query
  10660. name: limit
  10661. type: integer
  10662. x-go-name: Limit
  10663. - default: 0
  10664. description: 查询偏移量
  10665. format: int64
  10666. in: query
  10667. name: offset
  10668. type: integer
  10669. x-go-name: Offset
  10670. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  10671. in: query
  10672. items:
  10673. type: string
  10674. name: order_by
  10675. type: array
  10676. x-go-name: OrderBy
  10677. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  10678. example: desc|asc
  10679. in: query
  10680. name: order
  10681. type: string
  10682. x-go-name: Order
  10683. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  10684. in: query
  10685. name: details
  10686. type: boolean
  10687. x-go-name: Details
  10688. - description: 模糊搜索所有字段
  10689. in: query
  10690. name: search
  10691. type: string
  10692. x-go-name: Search
  10693. - description: |-
  10694. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  10695. 支持的操作符如下:
  10696. 操作符 | 参数个数 | 举例 | 说明 |
  10697. ---------------|----------|------------------------------------------------|-----------------------------|
  10698. in | > 0 | name.in("test", "good") | 在给定数组中 |
  10699. notin | > 0 | name.notin('test') | 不在给定数组中 |
  10700. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  10701. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  10702. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  10703. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  10704. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  10705. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  10706. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  10707. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  10708. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  10709. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  10710. notequals | 1 | name.notequals('test') | 不等于给定值 |
  10711. isnull | 0 | name.isnull() | 值为SQL的NULL |
  10712. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  10713. isempty | 0 | name.isempty('test') | 值为空字符串 |
  10714. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  10715. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  10716. in: query
  10717. items:
  10718. type: string
  10719. name: filter
  10720. type: array
  10721. x-go-name: Filter
  10722. - description: |-
  10723. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  10724. 和其他表关联的语法如下:
  10725. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  10726. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  10727. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  10728. 举例:
  10729. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  10730. in: query
  10731. items:
  10732. type: string
  10733. name: joint_filter
  10734. type: array
  10735. x-go-name: JointFilter
  10736. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  10737. in: query
  10738. name: filter_any
  10739. type: boolean
  10740. x-go-name: FilterAny
  10741. - description: 返回结果只包含指定的字段
  10742. in: query
  10743. items:
  10744. type: string
  10745. name: field
  10746. type: array
  10747. x-go-name: Field
  10748. - description: 用于数据导出,指定导出的数据字段
  10749. in: query
  10750. name: export_keys
  10751. type: string
  10752. x-go-name: ExportKeys
  10753. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  10754. in: query
  10755. name: show_fail_reason
  10756. type: boolean
  10757. x-go-name: ShowFailReason
  10758. - description: 是否返回状态统计信息,默认为False
  10759. in: query
  10760. name: summary_stats
  10761. type: boolean
  10762. x-go-name: SummaryStats
  10763. - $ref: '#/definitions/TTagSet'
  10764. description: 通过标签过滤(包含这些标签)
  10765. in: query
  10766. name: tags
  10767. x-go-name: Tags
  10768. - $ref: '#/definitions/TTagSetList'
  10769. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  10770. in: query
  10771. name: obj_tags
  10772. x-go-name: ObjTags
  10773. - $ref: '#/definitions/TTagSet'
  10774. description: 通过标签过滤(不包含这些标签)
  10775. in: query
  10776. name: no_tags
  10777. x-go-name: NoTags
  10778. - $ref: '#/definitions/TTagSetList'
  10779. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  10780. in: query
  10781. name: no_obj_tags
  10782. x-go-name: NoObjTags
  10783. - description: 通过标签排序
  10784. in: query
  10785. name: order_by_tag
  10786. type: string
  10787. x-go-name: OrderByTag
  10788. - description: |-
  10789. deprecated
  10790. 返回资源的标签不包含用户标签
  10791. in: query
  10792. name: without_user_meta
  10793. type: boolean
  10794. x-go-name: WithoutUserMeta
  10795. - description: 返回包含用户标签的资源
  10796. in: query
  10797. name: with_user_meta
  10798. type: boolean
  10799. x-go-name: WithUserMeta
  10800. - description: 返回包含外部标签的资源
  10801. in: query
  10802. name: with_cloud_meta
  10803. type: boolean
  10804. x-go-name: WithCloudMeta
  10805. - description: 返回包含任意标签的资源
  10806. in: query
  10807. name: with_any_meta
  10808. type: boolean
  10809. x-go-name: WithAnyMeta
  10810. - description: 返回列表数据中包含资源的标签数据(Metadata)
  10811. in: query
  10812. name: with_meta
  10813. type: boolean
  10814. x-go-name: WithMeta
  10815. - description: 显示所有的资源,包括模拟的资源
  10816. in: query
  10817. name: show_emulated
  10818. type: boolean
  10819. x-go-name: ShowEmulated
  10820. - description: 以资源ID过滤列表
  10821. in: query
  10822. items:
  10823. type: string
  10824. name: id
  10825. type: array
  10826. x-go-name: Ids
  10827. - description: 以资源名称过滤列表
  10828. in: query
  10829. items:
  10830. type: string
  10831. name: name
  10832. type: array
  10833. x-go-name: Names
  10834. - description: 指定查询的权限范围,可能值为project, domain or system
  10835. in: query
  10836. name: scope
  10837. type: string
  10838. x-go-name: Scope
  10839. - description: 对具有域属性的资源,严格匹配域ID
  10840. in: query
  10841. items:
  10842. type: string
  10843. name: project_domain_ids
  10844. type: array
  10845. x-go-name: ProjectDomainIds
  10846. - description: 按domain名称排序,可能值为asc|desc
  10847. in: query
  10848. name: order_by_domain
  10849. pattern: asc|desc
  10850. type: string
  10851. x-go-name: OrderByDomain
  10852. - $ref: '#/definitions/TTagSetList'
  10853. description: filter by domain tags
  10854. in: query
  10855. name: domain_tags
  10856. x-go-name: DomainTags
  10857. - $ref: '#/definitions/TTagSetList'
  10858. description: filter by domain tags
  10859. in: query
  10860. name: no_domain_tags
  10861. x-go-name: NoDomainTags
  10862. - description: 以资源是否启用/禁用过滤列表
  10863. in: query
  10864. name: enabled
  10865. type: boolean
  10866. x-go-name: Enabled
  10867. - description: 组归属域
  10868. in: query
  10869. name: group_domain_id
  10870. type: string
  10871. x-go-name: GroupDomainId
  10872. - description: filter by group
  10873. in: query
  10874. name: group_id
  10875. type: string
  10876. x-go-name: GroupId
  10877. - description: 项目归属域
  10878. in: query
  10879. name: project_domain_id
  10880. type: string
  10881. x-go-name: ProjectDomainId
  10882. - description: 以项目(ID或Name)过滤列表结果
  10883. in: query
  10884. name: project_id
  10885. type: string
  10886. x-go-name: ProjectId
  10887. - description: 角色归属域
  10888. in: query
  10889. name: role_domain_id
  10890. type: string
  10891. x-go-name: RoleDomainId
  10892. - description: filter by role
  10893. in: query
  10894. name: role_id
  10895. type: string
  10896. x-go-name: RoleId
  10897. - description: 角色生效所在的域
  10898. in: query
  10899. name: role_assignment_domain_id
  10900. type: string
  10901. x-go-name: RoleAssignmentDomainId
  10902. - description: 角色生效所在的项目
  10903. in: query
  10904. name: role_assignment_project_id
  10905. type: string
  10906. x-go-name: RoleAssignmentProjectId
  10907. - description: email
  10908. in: query
  10909. items:
  10910. type: string
  10911. name: email
  10912. type: array
  10913. x-go-name: Email
  10914. - description: mobile
  10915. in: query
  10916. items:
  10917. type: string
  10918. name: mobile
  10919. type: array
  10920. x-go-name: Mobile
  10921. - description: displayname
  10922. in: query
  10923. items:
  10924. type: string
  10925. name: displayname
  10926. type: array
  10927. x-go-name: Displayname
  10928. - description: 是否允许web控制台登录
  10929. in: query
  10930. name: allow_web_console
  10931. type: boolean
  10932. x-go-name: AllowWebConsole
  10933. - description: 是否开启MFA认证
  10934. in: query
  10935. name: enable_mfa
  10936. type: boolean
  10937. x-go-name: EnableMfa
  10938. - description: 关联IDP
  10939. in: query
  10940. name: idp_id
  10941. type: string
  10942. x-go-name: IdpId
  10943. - description: 按IDP_ENTITY_ID过滤
  10944. in: query
  10945. name: idp_entity_id
  10946. type: string
  10947. x-go-name: IdpEntityId
  10948. responses:
  10949. "200":
  10950. $ref: '#/responses/user_ListItemFilterOutput'
  10951. summary: 用户列表
  10952. tags:
  10953. - user
  10954. post:
  10955. description: 新建
  10956. operationId: user_ValidateCreateData
  10957. parameters:
  10958. - in: body
  10959. name: body
  10960. schema:
  10961. properties:
  10962. count:
  10963. default: 1
  10964. format: int64
  10965. type: integer
  10966. x-go-name: Count
  10967. user:
  10968. $ref: '#/definitions/UserCreateInput'
  10969. type: object
  10970. x-go-name: Body
  10971. responses:
  10972. "200":
  10973. $ref: '#/responses/user_ValidateCreateDataOutput'
  10974. summary: 新建
  10975. tags:
  10976. - user
  10977. /users/{id}:
  10978. delete:
  10979. description: 删除
  10980. operationId: user_CustomizeDelete
  10981. parameters:
  10982. - description: The Id or Name of user
  10983. in: path
  10984. name: id
  10985. required: true
  10986. type: string
  10987. x-go-name: Id
  10988. responses:
  10989. "200":
  10990. $ref: '#/responses/user_CustomizeDeleteOutput'
  10991. summary: 删除
  10992. tags:
  10993. - user
  10994. get:
  10995. description: 获取详情
  10996. operationId: user_FetchCustomizeColumns
  10997. parameters:
  10998. - description: The Id or Name of user
  10999. in: path
  11000. name: id
  11001. required: true
  11002. type: string
  11003. x-go-name: Id
  11004. responses:
  11005. "200":
  11006. $ref: '#/responses/user_FetchCustomizeColumnsOutput'
  11007. summary: 获取详情
  11008. tags:
  11009. - user
  11010. put:
  11011. description: 更新
  11012. operationId: user_ValidateUpdateData
  11013. parameters:
  11014. - description: The Id or Name of user
  11015. in: path
  11016. name: id
  11017. required: true
  11018. type: string
  11019. x-go-name: Id
  11020. - in: body
  11021. name: body
  11022. schema:
  11023. properties:
  11024. user:
  11025. $ref: '#/definitions/UserUpdateInput'
  11026. type: object
  11027. x-go-name: Body
  11028. responses:
  11029. "200":
  11030. $ref: '#/responses/user_ValidateUpdateDataOutput'
  11031. summary: 更新
  11032. tags:
  11033. - user
  11034. /users/{id}/disable:
  11035. post:
  11036. description: 执行操作Disable
  11037. operationId: user_PerformDisable
  11038. parameters:
  11039. - description: The Id or Name of user
  11040. in: path
  11041. name: id
  11042. required: true
  11043. type: string
  11044. x-go-name: Id
  11045. - in: body
  11046. name: body
  11047. schema:
  11048. properties:
  11049. user:
  11050. $ref: '#/definitions/PerformDisableInput'
  11051. type: object
  11052. x-go-name: Body
  11053. responses:
  11054. "200":
  11055. $ref: '#/responses/user_PerformDisableOutput'
  11056. summary: 执行操作Disable
  11057. tags:
  11058. - user
  11059. /users/{id}/enable:
  11060. post:
  11061. description: 执行操作Enable
  11062. operationId: user_PerformEnable
  11063. parameters:
  11064. - description: The Id or Name of user
  11065. in: path
  11066. name: id
  11067. required: true
  11068. type: string
  11069. x-go-name: Id
  11070. - in: body
  11071. name: body
  11072. schema:
  11073. properties:
  11074. user:
  11075. $ref: '#/definitions/PerformEnableInput'
  11076. type: object
  11077. x-go-name: Body
  11078. responses:
  11079. "200":
  11080. $ref: '#/responses/user_PerformEnableOutput'
  11081. summary: 执行操作Enable
  11082. tags:
  11083. - user
  11084. /users/{id}/join:
  11085. post:
  11086. description: 执行操作Join
  11087. operationId: user_PerformJoin
  11088. parameters:
  11089. - description: The Id or Name of user
  11090. in: path
  11091. name: id
  11092. required: true
  11093. type: string
  11094. x-go-name: Id
  11095. - in: body
  11096. name: body
  11097. schema:
  11098. properties:
  11099. user:
  11100. $ref: '#/definitions/SJoinProjectsInput'
  11101. type: object
  11102. x-go-name: Body
  11103. responses:
  11104. "200":
  11105. $ref: '#/responses/user_PerformJoinOutput'
  11106. summary: 用户加入项目
  11107. tags:
  11108. - user
  11109. /users/{id}/leave:
  11110. post:
  11111. description: 执行操作Leave
  11112. operationId: user_PerformLeave
  11113. parameters:
  11114. - description: The Id or Name of user
  11115. in: path
  11116. name: id
  11117. required: true
  11118. type: string
  11119. x-go-name: Id
  11120. - in: body
  11121. name: body
  11122. schema:
  11123. properties:
  11124. user:
  11125. $ref: '#/definitions/SLeaveProjectsInput'
  11126. type: object
  11127. x-go-name: Body
  11128. responses:
  11129. "200":
  11130. $ref: '#/responses/user_PerformLeaveOutput'
  11131. summary: 用户退出项目
  11132. tags:
  11133. - user
  11134. /users/{id}/link-idp:
  11135. post:
  11136. description: 执行操作LinkIdp
  11137. operationId: user_PerformLinkIdp
  11138. parameters:
  11139. - description: The Id or Name of user
  11140. in: path
  11141. name: id
  11142. required: true
  11143. type: string
  11144. x-go-name: Id
  11145. - in: body
  11146. name: body
  11147. schema:
  11148. properties:
  11149. user:
  11150. $ref: '#/definitions/UserLinkIdpInput'
  11151. type: object
  11152. x-go-name: Body
  11153. responses:
  11154. "200":
  11155. $ref: '#/responses/user_PerformLinkIdpOutput'
  11156. summary: 用户和IDP的指定entityId关联
  11157. tags:
  11158. - user
  11159. /users/{id}/metadata:
  11160. get:
  11161. description: 获取指定信息Metadata
  11162. operationId: user_GetDetailsMetadata
  11163. parameters:
  11164. - description: |-
  11165. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  11166. 标签分为
  11167. 类型 | 说明 |
  11168. ----------|---------------------------------------------|
  11169. 系统标签 | 平台定义的标签 |
  11170. 用户标签 | key以user:为前缀,用户自定义标签 |
  11171. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  11172. in: query
  11173. items:
  11174. type: string
  11175. name: field
  11176. type: array
  11177. x-go-name: Field
  11178. - description: 按标签前缀过滤
  11179. in: query
  11180. name: prefix
  11181. type: string
  11182. x-go-name: Prefix
  11183. - description: The Id or Name of user
  11184. in: path
  11185. name: id
  11186. required: true
  11187. type: string
  11188. x-go-name: Id
  11189. responses:
  11190. "200":
  11191. $ref: '#/responses/user_GetDetailsMetadataOutput'
  11192. summary: 获取资源标签(元数据)
  11193. tags:
  11194. - user
  11195. /users/{id}/reset-credentials:
  11196. post:
  11197. description: 执行操作ResetCredentials
  11198. operationId: user_PerformResetCredentials
  11199. parameters:
  11200. - description: The Id or Name of user
  11201. in: path
  11202. name: id
  11203. required: true
  11204. type: string
  11205. x-go-name: Id
  11206. - in: body
  11207. name: body
  11208. schema:
  11209. properties:
  11210. user:
  11211. $ref: '#/definitions/ResetCredentialInput'
  11212. type: object
  11213. x-go-name: Body
  11214. responses:
  11215. "200":
  11216. $ref: '#/responses/user_PerformResetCredentialsOutput'
  11217. summary: 用户加入项目
  11218. tags:
  11219. - user
  11220. /users/{id}/unlink-idp:
  11221. post:
  11222. description: 执行操作UnlinkIdp
  11223. operationId: user_PerformUnlinkIdp
  11224. parameters:
  11225. - description: The Id or Name of user
  11226. in: path
  11227. name: id
  11228. required: true
  11229. type: string
  11230. x-go-name: Id
  11231. - in: body
  11232. name: body
  11233. schema:
  11234. properties:
  11235. user:
  11236. $ref: '#/definitions/UserUnlinkIdpInput'
  11237. type: object
  11238. x-go-name: Body
  11239. responses:
  11240. "200":
  11241. $ref: '#/responses/user_PerformUnlinkIdpOutput'
  11242. summary: 用户和IDP的指定entityId解除关联
  11243. tags:
  11244. - user
  11245. /users/domain-tag-value-pairs:
  11246. get:
  11247. description: 获取指定资源类的信息DomainTagValuePairs
  11248. operationId: user_GetPropertyDomainTagValuePairs
  11249. responses:
  11250. "200":
  11251. $ref: '#/responses/user_GetPropertyDomainTagValuePairsOutput'
  11252. summary: 获取指定资源类的信息DomainTagValuePairs
  11253. tags:
  11254. - user
  11255. /users/domain-tag-value-tree:
  11256. get:
  11257. description: 获取指定资源类的信息DomainTagValueTree
  11258. operationId: user_GetPropertyDomainTagValueTree
  11259. responses:
  11260. "200":
  11261. $ref: '#/responses/user_GetPropertyDomainTagValueTreeOutput'
  11262. summary: 获取指定资源类的信息DomainTagValueTree
  11263. tags:
  11264. - user
  11265. /v2.0/tokens:
  11266. post:
  11267. description: keystone v2 认证接口,通过用户名/密码或者 token 认证
  11268. operationId: tokens_AuthenticateV2
  11269. parameters:
  11270. - in: body
  11271. name: body
  11272. schema:
  11273. $ref: '#/definitions/SAuthenticationInputV2'
  11274. x-go-name: Body
  11275. responses:
  11276. "200":
  11277. $ref: '#/responses/tokens_AuthenticateV2Output'
  11278. summary: keystone v2 认证接口,通过用户名/密码或者 token 认证
  11279. tags:
  11280. - authentication
  11281. /v2.0/tokens/{token}:
  11282. get:
  11283. description: keystone v2验证token API
  11284. operationId: verifyTokensV2
  11285. parameters:
  11286. - description: keystone V2验证token
  11287. in: path
  11288. name: Token
  11289. required: true
  11290. type: string
  11291. responses:
  11292. "200":
  11293. $ref: '#/responses/tokens_AuthenticateV2Output'
  11294. summary: keystone v2验证token API
  11295. tags:
  11296. - authentication
  11297. /v3/auth/tokens:
  11298. delete:
  11299. description: keystone v3删除token API
  11300. operationId: invalidateTokensV3
  11301. summary: keystone v3删除token API
  11302. tags:
  11303. - authentication
  11304. get:
  11305. description: keystone v3验证token API
  11306. operationId: verifyTokensV3
  11307. parameters:
  11308. - description: keystone V3验证token
  11309. in: header
  11310. name: X-Subject-Token
  11311. required: true
  11312. type: string
  11313. x-go-name: Token
  11314. responses:
  11315. "200":
  11316. $ref: '#/responses/tokens_AuthenticateV3Output'
  11317. summary: keystone v3验证token API
  11318. tags:
  11319. - authentication
  11320. post:
  11321. description: keystone v3认证API
  11322. operationId: tokens_AuthenticateV3
  11323. parameters:
  11324. - in: body
  11325. name: body
  11326. schema:
  11327. $ref: '#/definitions/SAuthenticationInputV3'
  11328. x-go-name: Body
  11329. responses:
  11330. "200":
  11331. $ref: '#/responses/tokens_AuthenticateV3Output'
  11332. summary: keystone v3认证API
  11333. tags:
  11334. - authentication
  11335. /v3/auth/tokens/invalid:
  11336. get:
  11337. description: keystone v3获取被删除的token的列表API
  11338. operationId: fetchInvalidTokensV3
  11339. summary: keystone v3获取被删除的token的列表API
  11340. tags:
  11341. - authentication
  11342. produces:
  11343. - application/json
  11344. responses:
  11345. credential_CustomizeDeleteOutput:
  11346. description: ""
  11347. schema:
  11348. properties:
  11349. credential:
  11350. $ref: '#/definitions/CredentialDetails'
  11351. type: object
  11352. credential_FetchCustomizeColumnsOutput:
  11353. description: ""
  11354. schema:
  11355. properties:
  11356. credential:
  11357. $ref: '#/definitions/CredentialDetails'
  11358. type: object
  11359. credential_GetDetailsMetadataOutput:
  11360. description: ""
  11361. schema:
  11362. properties:
  11363. credential:
  11364. additionalProperties:
  11365. type: string
  11366. type: object
  11367. x-go-name: Output
  11368. type: object
  11369. credential_ListItemFilterOutput:
  11370. description: ""
  11371. schema:
  11372. properties:
  11373. credentials:
  11374. items:
  11375. $ref: '#/definitions/CredentialDetails'
  11376. type: array
  11377. x-go-name: Output
  11378. limit:
  11379. format: int64
  11380. type: integer
  11381. x-go-name: Limit
  11382. offset:
  11383. format: int64
  11384. type: integer
  11385. x-go-name: Offset
  11386. total:
  11387. format: int64
  11388. type: integer
  11389. x-go-name: Total
  11390. type: object
  11391. credential_ValidateCreateDataOutput:
  11392. description: ""
  11393. schema:
  11394. properties:
  11395. credential:
  11396. $ref: '#/definitions/CredentialDetails'
  11397. type: object
  11398. credential_ValidateUpdateDataOutput:
  11399. description: ""
  11400. schema:
  11401. properties:
  11402. credential:
  11403. $ref: '#/definitions/CredentialDetails'
  11404. type: object
  11405. domain_CustomizeDeleteOutput:
  11406. description: ""
  11407. schema:
  11408. properties:
  11409. domain:
  11410. $ref: '#/definitions/DomainDetails'
  11411. type: object
  11412. domain_FetchCustomizeColumnsOutput:
  11413. description: ""
  11414. schema:
  11415. properties:
  11416. domain:
  11417. $ref: '#/definitions/DomainDetails'
  11418. type: object
  11419. domain_GetDetailsMetadataOutput:
  11420. description: ""
  11421. schema:
  11422. properties:
  11423. domain:
  11424. additionalProperties:
  11425. type: string
  11426. type: object
  11427. x-go-name: Output
  11428. type: object
  11429. domain_ListItemFilterOutput:
  11430. description: ""
  11431. schema:
  11432. properties:
  11433. domains:
  11434. items:
  11435. $ref: '#/definitions/DomainDetails'
  11436. type: array
  11437. x-go-name: Output
  11438. limit:
  11439. format: int64
  11440. type: integer
  11441. x-go-name: Limit
  11442. offset:
  11443. format: int64
  11444. type: integer
  11445. x-go-name: Offset
  11446. total:
  11447. format: int64
  11448. type: integer
  11449. x-go-name: Total
  11450. type: object
  11451. domain_PerformUnlinkIdpOutput:
  11452. description: ""
  11453. domain_ValidateCreateDataOutput:
  11454. description: ""
  11455. schema:
  11456. properties:
  11457. domain:
  11458. $ref: '#/definitions/DomainDetails'
  11459. type: object
  11460. domain_ValidateUpdateDataOutput:
  11461. description: ""
  11462. schema:
  11463. properties:
  11464. domain:
  11465. $ref: '#/definitions/DomainDetails'
  11466. type: object
  11467. endpoint_CustomizeDeleteOutput:
  11468. description: ""
  11469. schema:
  11470. properties:
  11471. endpoint:
  11472. $ref: '#/definitions/EndpointDetails'
  11473. type: object
  11474. endpoint_FetchCustomizeColumnsOutput:
  11475. description: ""
  11476. schema:
  11477. properties:
  11478. endpoint:
  11479. $ref: '#/definitions/EndpointDetails'
  11480. type: object
  11481. endpoint_GetDetailsMetadataOutput:
  11482. description: ""
  11483. schema:
  11484. properties:
  11485. endpoint:
  11486. additionalProperties:
  11487. type: string
  11488. type: object
  11489. x-go-name: Output
  11490. type: object
  11491. endpoint_ListItemFilterOutput:
  11492. description: ""
  11493. schema:
  11494. properties:
  11495. endpoints:
  11496. items:
  11497. $ref: '#/definitions/EndpointDetails'
  11498. type: array
  11499. x-go-name: Output
  11500. limit:
  11501. format: int64
  11502. type: integer
  11503. x-go-name: Limit
  11504. offset:
  11505. format: int64
  11506. type: integer
  11507. x-go-name: Offset
  11508. total:
  11509. format: int64
  11510. type: integer
  11511. x-go-name: Total
  11512. type: object
  11513. endpoint_ValidateCreateDataOutput:
  11514. description: ""
  11515. schema:
  11516. properties:
  11517. endpoint:
  11518. $ref: '#/definitions/EndpointDetails'
  11519. type: object
  11520. endpoint_ValidateUpdateDataOutput:
  11521. description: ""
  11522. schema:
  11523. properties:
  11524. endpoint:
  11525. $ref: '#/definitions/EndpointDetails'
  11526. type: object
  11527. group_CustomizeDeleteOutput:
  11528. description: ""
  11529. schema:
  11530. properties:
  11531. group:
  11532. $ref: '#/definitions/GroupDetails'
  11533. type: object
  11534. group_FetchCustomizeColumnsOutput:
  11535. description: ""
  11536. schema:
  11537. properties:
  11538. group:
  11539. $ref: '#/definitions/GroupDetails'
  11540. type: object
  11541. group_GetDetailsMetadataOutput:
  11542. description: ""
  11543. schema:
  11544. properties:
  11545. group:
  11546. additionalProperties:
  11547. type: string
  11548. type: object
  11549. x-go-name: Output
  11550. type: object
  11551. group_GetPropertyDomainTagValuePairsOutput:
  11552. description: ""
  11553. group_GetPropertyDomainTagValueTreeOutput:
  11554. description: ""
  11555. group_ListItemFilterOutput:
  11556. description: ""
  11557. schema:
  11558. properties:
  11559. groups:
  11560. items:
  11561. $ref: '#/definitions/GroupDetails'
  11562. type: array
  11563. x-go-name: Output
  11564. limit:
  11565. format: int64
  11566. type: integer
  11567. x-go-name: Limit
  11568. offset:
  11569. format: int64
  11570. type: integer
  11571. x-go-name: Offset
  11572. total:
  11573. format: int64
  11574. type: integer
  11575. x-go-name: Total
  11576. type: object
  11577. group_PerformAddUsersOutput:
  11578. description: ""
  11579. group_PerformJoinOutput:
  11580. description: ""
  11581. group_PerformLeaveOutput:
  11582. description: ""
  11583. group_PerformRemoveUsersOutput:
  11584. description: ""
  11585. group_ValidateCreateDataOutput:
  11586. description: ""
  11587. schema:
  11588. properties:
  11589. group:
  11590. $ref: '#/definitions/GroupDetails'
  11591. type: object
  11592. group_ValidateUpdateDataOutput:
  11593. description: ""
  11594. schema:
  11595. properties:
  11596. group:
  11597. $ref: '#/definitions/GroupDetails'
  11598. type: object
  11599. identity_provider_CustomizeDeleteOutput:
  11600. description: ""
  11601. schema:
  11602. properties:
  11603. identity_provider:
  11604. $ref: '#/definitions/IdentityProviderDetails'
  11605. type: object
  11606. identity_provider_FetchCustomizeColumnsOutput:
  11607. description: ""
  11608. schema:
  11609. properties:
  11610. identity_provider:
  11611. $ref: '#/definitions/IdentityProviderDetails'
  11612. type: object
  11613. identity_provider_GetDetailsConfigOutput:
  11614. description: ""
  11615. identity_provider_GetDetailsMetadataOutput:
  11616. description: ""
  11617. schema:
  11618. properties:
  11619. identity_provider:
  11620. additionalProperties:
  11621. type: string
  11622. type: object
  11623. x-go-name: Output
  11624. type: object
  11625. identity_provider_GetDetailsSamlMetadataOutput:
  11626. description: ""
  11627. schema:
  11628. properties:
  11629. identity_provider:
  11630. $ref: '#/definitions/GetIdpSamlMetadataOutput'
  11631. type: object
  11632. identity_provider_GetDetailsSsoCallbackUriOutput:
  11633. description: ""
  11634. schema:
  11635. properties:
  11636. identity_provider:
  11637. $ref: '#/definitions/GetIdpSsoCallbackUriOutput'
  11638. type: object
  11639. identity_provider_GetDetailsSsoRedirectUriOutput:
  11640. description: ""
  11641. schema:
  11642. properties:
  11643. identity_provider:
  11644. $ref: '#/definitions/GetIdpSsoRedirectUriOutput'
  11645. type: object
  11646. identity_provider_GetDetailsStatusOutput:
  11647. description: ""
  11648. schema:
  11649. properties:
  11650. identity_provider:
  11651. $ref: '#/definitions/GetDetailsStatusOutput'
  11652. type: object
  11653. identity_provider_ListItemFilterOutput:
  11654. description: ""
  11655. schema:
  11656. properties:
  11657. identity_providers:
  11658. items:
  11659. $ref: '#/definitions/IdentityProviderDetails'
  11660. type: array
  11661. x-go-name: Output
  11662. limit:
  11663. format: int64
  11664. type: integer
  11665. x-go-name: Limit
  11666. offset:
  11667. format: int64
  11668. type: integer
  11669. x-go-name: Offset
  11670. total:
  11671. format: int64
  11672. type: integer
  11673. x-go-name: Total
  11674. type: object
  11675. identity_provider_PerformConfigOutput:
  11676. description: ""
  11677. identity_provider_PerformDefaultSsoOutput:
  11678. description: ""
  11679. identity_provider_PerformDisableOutput:
  11680. description: ""
  11681. identity_provider_PerformEnableOutput:
  11682. description: ""
  11683. identity_provider_PerformSyncOutput:
  11684. description: ""
  11685. identity_provider_ValidateCreateDataOutput:
  11686. description: ""
  11687. schema:
  11688. properties:
  11689. identity_provider:
  11690. $ref: '#/definitions/IdentityProviderDetails'
  11691. type: object
  11692. identity_provider_ValidateUpdateDataOutput:
  11693. description: ""
  11694. schema:
  11695. properties:
  11696. identity_provider:
  11697. $ref: '#/definitions/IdentityProviderDetails'
  11698. type: object
  11699. models_GetIdentityQuotaOutput:
  11700. description: ""
  11701. schema:
  11702. properties:
  11703. identity_quotas:
  11704. items:
  11705. $ref: '#/definitions/SIdentityQuotaDetail'
  11706. type: array
  11707. x-go-name: Output
  11708. type: object
  11709. models_ListIdentityQuotasOutput:
  11710. description: ""
  11711. schema:
  11712. properties:
  11713. identity_quotas:
  11714. items:
  11715. $ref: '#/definitions/SIdentityQuotaDetail'
  11716. type: array
  11717. x-go-name: Output
  11718. type: object
  11719. models_SetIdentityQuotasOutput:
  11720. description: ""
  11721. schema:
  11722. properties:
  11723. identity_quotas:
  11724. items:
  11725. $ref: '#/definitions/SIdentityQuotaDetail'
  11726. type: array
  11727. x-go-name: Output
  11728. type: object
  11729. organization_CustomizeDeleteOutput:
  11730. description: ""
  11731. schema:
  11732. properties:
  11733. organization:
  11734. $ref: '#/definitions/SOrganizationDetails'
  11735. type: object
  11736. organization_FetchCustomizeColumnsOutput:
  11737. description: ""
  11738. schema:
  11739. properties:
  11740. organization:
  11741. $ref: '#/definitions/SOrganizationDetails'
  11742. type: object
  11743. organization_GetDetailsMetadataOutput:
  11744. description: ""
  11745. schema:
  11746. properties:
  11747. organization:
  11748. additionalProperties:
  11749. type: string
  11750. type: object
  11751. x-go-name: Output
  11752. type: object
  11753. organization_GetDetailsStatusOutput:
  11754. description: ""
  11755. schema:
  11756. properties:
  11757. organization:
  11758. $ref: '#/definitions/GetDetailsStatusOutput'
  11759. type: object
  11760. organization_GetPropertyDomainTagValuePairsOutput:
  11761. description: ""
  11762. organization_GetPropertyDomainTagValueTreeOutput:
  11763. description: ""
  11764. organization_ListItemFilterOutput:
  11765. description: ""
  11766. schema:
  11767. properties:
  11768. limit:
  11769. format: int64
  11770. type: integer
  11771. x-go-name: Limit
  11772. offset:
  11773. format: int64
  11774. type: integer
  11775. x-go-name: Offset
  11776. organizations:
  11777. items:
  11778. $ref: '#/definitions/SOrganizationDetails'
  11779. type: array
  11780. x-go-name: Output
  11781. total:
  11782. format: int64
  11783. type: integer
  11784. x-go-name: Total
  11785. type: object
  11786. organization_PerformAddLevelOutput:
  11787. description: ""
  11788. organization_PerformAddNodeOutput:
  11789. description: ""
  11790. organization_PerformCleanOutput:
  11791. description: ""
  11792. organization_PerformDisableOutput:
  11793. description: ""
  11794. organization_PerformEnableOutput:
  11795. description: ""
  11796. organization_PerformSyncOutput:
  11797. description: ""
  11798. organization_ValidateCreateDataOutput:
  11799. description: ""
  11800. schema:
  11801. properties:
  11802. organization:
  11803. $ref: '#/definitions/SOrganizationDetails'
  11804. type: object
  11805. organization_ValidateUpdateDataOutput:
  11806. description: ""
  11807. schema:
  11808. properties:
  11809. organization:
  11810. $ref: '#/definitions/SOrganizationDetails'
  11811. type: object
  11812. organization_node_CustomizeDeleteOutput:
  11813. description: ""
  11814. schema:
  11815. properties:
  11816. organization_node:
  11817. $ref: '#/definitions/SOrganizationNodeDetails'
  11818. type: object
  11819. organization_node_FetchCustomizeColumnsOutput:
  11820. description: ""
  11821. schema:
  11822. properties:
  11823. organization_node:
  11824. $ref: '#/definitions/SOrganizationNodeDetails'
  11825. type: object
  11826. organization_node_GetDetailsMetadataOutput:
  11827. description: ""
  11828. schema:
  11829. properties:
  11830. organization_node:
  11831. additionalProperties:
  11832. type: string
  11833. type: object
  11834. x-go-name: Output
  11835. type: object
  11836. organization_node_ListItemFilterOutput:
  11837. description: ""
  11838. schema:
  11839. properties:
  11840. limit:
  11841. format: int64
  11842. type: integer
  11843. x-go-name: Limit
  11844. offset:
  11845. format: int64
  11846. type: integer
  11847. x-go-name: Offset
  11848. organization_nodes:
  11849. items:
  11850. $ref: '#/definitions/SOrganizationNodeDetails'
  11851. type: array
  11852. x-go-name: Output
  11853. total:
  11854. format: int64
  11855. type: integer
  11856. x-go-name: Total
  11857. type: object
  11858. organization_node_PerformBindOutput:
  11859. description: ""
  11860. organization_node_PerformUnbindOutput:
  11861. description: ""
  11862. organization_node_ValidateCreateDataOutput:
  11863. description: ""
  11864. schema:
  11865. properties:
  11866. organization_node:
  11867. $ref: '#/definitions/SOrganizationNodeDetails'
  11868. type: object
  11869. organization_node_ValidateUpdateDataOutput:
  11870. description: ""
  11871. schema:
  11872. properties:
  11873. organization_node:
  11874. $ref: '#/definitions/SOrganizationNodeDetails'
  11875. type: object
  11876. policy_CustomizeDeleteOutput:
  11877. description: ""
  11878. schema:
  11879. properties:
  11880. policy:
  11881. $ref: '#/definitions/PolicyDetails'
  11882. type: object
  11883. policy_FetchCustomizeColumnsOutput:
  11884. description: ""
  11885. schema:
  11886. properties:
  11887. policy:
  11888. $ref: '#/definitions/PolicyDetails'
  11889. type: object
  11890. policy_GetDetailsMetadataOutput:
  11891. description: ""
  11892. schema:
  11893. properties:
  11894. policy:
  11895. additionalProperties:
  11896. type: string
  11897. type: object
  11898. x-go-name: Output
  11899. type: object
  11900. policy_GetPropertyDomainTagValuePairsOutput:
  11901. description: ""
  11902. policy_GetPropertyDomainTagValueTreeOutput:
  11903. description: ""
  11904. policy_ListItemFilterOutput:
  11905. description: ""
  11906. schema:
  11907. properties:
  11908. limit:
  11909. format: int64
  11910. type: integer
  11911. x-go-name: Limit
  11912. offset:
  11913. format: int64
  11914. type: integer
  11915. x-go-name: Offset
  11916. policies:
  11917. items:
  11918. $ref: '#/definitions/PolicyDetails'
  11919. type: array
  11920. x-go-name: Output
  11921. total:
  11922. format: int64
  11923. type: integer
  11924. x-go-name: Total
  11925. type: object
  11926. policy_PerformBindRoleOutput:
  11927. description: ""
  11928. policy_PerformDisableOutput:
  11929. description: ""
  11930. policy_PerformEnableOutput:
  11931. description: ""
  11932. policy_PerformPrivateOutput:
  11933. description: ""
  11934. policy_PerformPublicOutput:
  11935. description: ""
  11936. policy_ValidateCreateDataOutput:
  11937. description: ""
  11938. schema:
  11939. properties:
  11940. policy:
  11941. $ref: '#/definitions/PolicyDetails'
  11942. type: object
  11943. policy_ValidateUpdateDataOutput:
  11944. description: ""
  11945. schema:
  11946. properties:
  11947. policy:
  11948. $ref: '#/definitions/PolicyDetails'
  11949. type: object
  11950. project_CustomizeDeleteOutput:
  11951. description: ""
  11952. schema:
  11953. properties:
  11954. project:
  11955. $ref: '#/definitions/ProjectDetails'
  11956. type: object
  11957. project_FetchCustomizeColumnsOutput:
  11958. description: ""
  11959. schema:
  11960. properties:
  11961. project:
  11962. $ref: '#/definitions/ProjectDetails'
  11963. type: object
  11964. project_GetDetailsMetadataOutput:
  11965. description: ""
  11966. schema:
  11967. properties:
  11968. project:
  11969. additionalProperties:
  11970. type: string
  11971. type: object
  11972. x-go-name: Output
  11973. type: object
  11974. project_GetPropertyDomainTagValuePairsOutput:
  11975. description: ""
  11976. project_GetPropertyDomainTagValueTreeOutput:
  11977. description: ""
  11978. project_ListItemFilterOutput:
  11979. description: ""
  11980. schema:
  11981. properties:
  11982. limit:
  11983. format: int64
  11984. type: integer
  11985. x-go-name: Limit
  11986. offset:
  11987. format: int64
  11988. type: integer
  11989. x-go-name: Offset
  11990. projects:
  11991. items:
  11992. $ref: '#/definitions/ProjectDetails'
  11993. type: array
  11994. x-go-name: Output
  11995. total:
  11996. format: int64
  11997. type: integer
  11998. x-go-name: Total
  11999. type: object
  12000. project_PerformCleanOutput:
  12001. description: ""
  12002. project_PerformJoinOutput:
  12003. description: ""
  12004. project_PerformLeaveOutput:
  12005. description: ""
  12006. project_PerformSetAdminOutput:
  12007. description: ""
  12008. project_ValidateCreateDataOutput:
  12009. description: ""
  12010. schema:
  12011. properties:
  12012. project:
  12013. $ref: '#/definitions/ProjectDetails'
  12014. type: object
  12015. project_ValidateUpdateDataOutput:
  12016. description: ""
  12017. schema:
  12018. properties:
  12019. project:
  12020. $ref: '#/definitions/ProjectDetails'
  12021. type: object
  12022. region_CustomizeDeleteOutput:
  12023. description: ""
  12024. schema:
  12025. properties:
  12026. region:
  12027. $ref: '#/definitions/RegionDetails'
  12028. type: object
  12029. region_FetchCustomizeColumnsOutput:
  12030. description: ""
  12031. schema:
  12032. properties:
  12033. region:
  12034. $ref: '#/definitions/RegionDetails'
  12035. type: object
  12036. region_GetDetailsMetadataOutput:
  12037. description: ""
  12038. schema:
  12039. properties:
  12040. region:
  12041. additionalProperties:
  12042. type: string
  12043. type: object
  12044. x-go-name: Output
  12045. type: object
  12046. region_ListItemFilterOutput:
  12047. description: ""
  12048. schema:
  12049. properties:
  12050. limit:
  12051. format: int64
  12052. type: integer
  12053. x-go-name: Limit
  12054. offset:
  12055. format: int64
  12056. type: integer
  12057. x-go-name: Offset
  12058. regions:
  12059. items:
  12060. $ref: '#/definitions/RegionDetails'
  12061. type: array
  12062. x-go-name: Output
  12063. total:
  12064. format: int64
  12065. type: integer
  12066. x-go-name: Total
  12067. type: object
  12068. region_ValidateCreateDataOutput:
  12069. description: ""
  12070. schema:
  12071. properties:
  12072. region:
  12073. $ref: '#/definitions/RegionDetails'
  12074. type: object
  12075. region_ValidateUpdateDataOutput:
  12076. description: ""
  12077. schema:
  12078. properties:
  12079. region:
  12080. $ref: '#/definitions/RegionDetails'
  12081. type: object
  12082. role_CustomizeDeleteOutput:
  12083. description: ""
  12084. schema:
  12085. properties:
  12086. role:
  12087. $ref: '#/definitions/RoleDetails'
  12088. type: object
  12089. role_FetchCustomizeColumnsOutput:
  12090. description: ""
  12091. schema:
  12092. properties:
  12093. role:
  12094. $ref: '#/definitions/RoleDetails'
  12095. type: object
  12096. role_GetDetailsMetadataOutput:
  12097. description: ""
  12098. schema:
  12099. properties:
  12100. role:
  12101. additionalProperties:
  12102. type: string
  12103. type: object
  12104. x-go-name: Output
  12105. type: object
  12106. role_GetPropertyDomainTagValuePairsOutput:
  12107. description: ""
  12108. role_GetPropertyDomainTagValueTreeOutput:
  12109. description: ""
  12110. role_ListItemFilterOutput:
  12111. description: ""
  12112. schema:
  12113. properties:
  12114. limit:
  12115. format: int64
  12116. type: integer
  12117. x-go-name: Limit
  12118. offset:
  12119. format: int64
  12120. type: integer
  12121. x-go-name: Offset
  12122. roles:
  12123. items:
  12124. $ref: '#/definitions/RoleDetails'
  12125. type: array
  12126. x-go-name: Output
  12127. total:
  12128. format: int64
  12129. type: integer
  12130. x-go-name: Total
  12131. type: object
  12132. role_PerformAddPolicyOutput:
  12133. description: ""
  12134. role_PerformPrivateOutput:
  12135. description: ""
  12136. role_PerformPublicOutput:
  12137. description: ""
  12138. role_PerformRemovePolicyOutput:
  12139. description: ""
  12140. role_PerformSetPoliciesOutput:
  12141. description: ""
  12142. role_ValidateCreateDataOutput:
  12143. description: ""
  12144. schema:
  12145. properties:
  12146. role:
  12147. $ref: '#/definitions/RoleDetails'
  12148. type: object
  12149. role_ValidateUpdateDataOutput:
  12150. description: ""
  12151. schema:
  12152. properties:
  12153. role:
  12154. $ref: '#/definitions/RoleDetails'
  12155. type: object
  12156. role_policy_CustomizeDeleteOutput:
  12157. description: ""
  12158. schema:
  12159. properties:
  12160. role_policy:
  12161. $ref: '#/definitions/RolePolicyDetails'
  12162. type: object
  12163. role_policy_FetchCustomizeColumnsOutput:
  12164. description: ""
  12165. schema:
  12166. properties:
  12167. role_policy:
  12168. $ref: '#/definitions/RolePolicyDetails'
  12169. type: object
  12170. role_policy_ListItemFilterOutput:
  12171. description: ""
  12172. schema:
  12173. properties:
  12174. limit:
  12175. format: int64
  12176. type: integer
  12177. x-go-name: Limit
  12178. offset:
  12179. format: int64
  12180. type: integer
  12181. x-go-name: Offset
  12182. role_policies:
  12183. items:
  12184. $ref: '#/definitions/RolePolicyDetails'
  12185. type: array
  12186. x-go-name: Output
  12187. total:
  12188. format: int64
  12189. type: integer
  12190. x-go-name: Total
  12191. type: object
  12192. role_policy_ValidateCreateDataOutput:
  12193. description: ""
  12194. schema:
  12195. properties:
  12196. role_policy:
  12197. $ref: '#/definitions/RolePolicyDetails'
  12198. type: object
  12199. role_policy_ValidateUpdateDataOutput:
  12200. description: ""
  12201. schema:
  12202. properties:
  12203. role_policy:
  12204. $ref: '#/definitions/RolePolicyDetails'
  12205. type: object
  12206. scope_resource_CustomizeDeleteOutput:
  12207. description: ""
  12208. schema:
  12209. properties:
  12210. scope_resource:
  12211. $ref: '#/definitions/ModelBaseDetails'
  12212. type: object
  12213. scope_resource_FetchCustomizeColumnsOutput:
  12214. description: ""
  12215. schema:
  12216. properties:
  12217. scope_resource:
  12218. $ref: '#/definitions/ModelBaseDetails'
  12219. type: object
  12220. scope_resource_ListItemFilterOutput:
  12221. description: ""
  12222. schema:
  12223. properties:
  12224. limit:
  12225. format: int64
  12226. type: integer
  12227. x-go-name: Limit
  12228. offset:
  12229. format: int64
  12230. type: integer
  12231. x-go-name: Offset
  12232. scope_resources:
  12233. items:
  12234. $ref: '#/definitions/ModelBaseDetails'
  12235. type: array
  12236. x-go-name: Output
  12237. total:
  12238. format: int64
  12239. type: integer
  12240. x-go-name: Total
  12241. type: object
  12242. scope_resource_ValidateCreateDataOutput:
  12243. description: ""
  12244. schema:
  12245. properties:
  12246. scope_resource:
  12247. $ref: '#/definitions/ModelBaseDetails'
  12248. type: object
  12249. scope_resource_ValidateUpdateDataOutput:
  12250. description: ""
  12251. schema:
  12252. properties:
  12253. scope_resource:
  12254. $ref: '#/definitions/ModelBaseDetails'
  12255. type: object
  12256. service_CustomizeDeleteOutput:
  12257. description: ""
  12258. schema:
  12259. properties:
  12260. service:
  12261. $ref: '#/definitions/ServiceDetails'
  12262. type: object
  12263. service_FetchCustomizeColumnsOutput:
  12264. description: ""
  12265. schema:
  12266. properties:
  12267. service:
  12268. $ref: '#/definitions/ServiceDetails'
  12269. type: object
  12270. service_GetDetailsConfigOutput:
  12271. description: ""
  12272. service_GetDetailsMetadataOutput:
  12273. description: ""
  12274. schema:
  12275. properties:
  12276. service:
  12277. additionalProperties:
  12278. type: string
  12279. type: object
  12280. x-go-name: Output
  12281. type: object
  12282. service_ListItemFilterOutput:
  12283. description: ""
  12284. schema:
  12285. properties:
  12286. limit:
  12287. format: int64
  12288. type: integer
  12289. x-go-name: Limit
  12290. offset:
  12291. format: int64
  12292. type: integer
  12293. x-go-name: Offset
  12294. services:
  12295. items:
  12296. $ref: '#/definitions/ServiceDetails'
  12297. type: array
  12298. x-go-name: Output
  12299. total:
  12300. format: int64
  12301. type: integer
  12302. x-go-name: Total
  12303. type: object
  12304. service_PerformConfigOutput:
  12305. description: ""
  12306. service_ValidateCreateDataOutput:
  12307. description: ""
  12308. schema:
  12309. properties:
  12310. service:
  12311. $ref: '#/definitions/ServiceDetails'
  12312. type: object
  12313. service_ValidateUpdateDataOutput:
  12314. description: ""
  12315. schema:
  12316. properties:
  12317. service:
  12318. $ref: '#/definitions/ServiceDetails'
  12319. type: object
  12320. service_certificate_CustomizeDeleteOutput:
  12321. description: ""
  12322. schema:
  12323. properties:
  12324. service_certificate:
  12325. $ref: '#/definitions/StandaloneResourceDetails'
  12326. type: object
  12327. service_certificate_FetchCustomizeColumnsOutput:
  12328. description: ""
  12329. schema:
  12330. properties:
  12331. service_certificate:
  12332. $ref: '#/definitions/StandaloneResourceDetails'
  12333. type: object
  12334. service_certificate_GetDetailsMetadataOutput:
  12335. description: ""
  12336. schema:
  12337. properties:
  12338. service_certificate:
  12339. additionalProperties:
  12340. type: string
  12341. type: object
  12342. x-go-name: Output
  12343. type: object
  12344. service_certificate_ListItemFilterOutput:
  12345. description: ""
  12346. schema:
  12347. properties:
  12348. limit:
  12349. format: int64
  12350. type: integer
  12351. x-go-name: Limit
  12352. offset:
  12353. format: int64
  12354. type: integer
  12355. x-go-name: Offset
  12356. service_certificates:
  12357. items:
  12358. $ref: '#/definitions/StandaloneResourceDetails'
  12359. type: array
  12360. x-go-name: Output
  12361. total:
  12362. format: int64
  12363. type: integer
  12364. x-go-name: Total
  12365. type: object
  12366. service_certificate_ValidateCreateDataOutput:
  12367. description: ""
  12368. schema:
  12369. properties:
  12370. service_certificate:
  12371. $ref: '#/definitions/StandaloneResourceDetails'
  12372. type: object
  12373. service_certificate_ValidateUpdateDataOutput:
  12374. description: ""
  12375. schema:
  12376. properties:
  12377. service_certificate:
  12378. $ref: '#/definitions/StandaloneResourceDetails'
  12379. type: object
  12380. token_cache_CustomizeDeleteOutput:
  12381. description: ""
  12382. schema:
  12383. properties:
  12384. token_cache:
  12385. $ref: '#/definitions/StandaloneAnonResourceDetails'
  12386. type: object
  12387. token_cache_FetchCustomizeColumnsOutput:
  12388. description: ""
  12389. schema:
  12390. properties:
  12391. token_cache:
  12392. $ref: '#/definitions/StandaloneAnonResourceDetails'
  12393. type: object
  12394. token_cache_GetDetailsMetadataOutput:
  12395. description: ""
  12396. schema:
  12397. properties:
  12398. token_cache:
  12399. additionalProperties:
  12400. type: string
  12401. type: object
  12402. x-go-name: Output
  12403. type: object
  12404. token_cache_ListItemFilterOutput:
  12405. description: ""
  12406. schema:
  12407. properties:
  12408. limit:
  12409. format: int64
  12410. type: integer
  12411. x-go-name: Limit
  12412. offset:
  12413. format: int64
  12414. type: integer
  12415. x-go-name: Offset
  12416. token_caches:
  12417. items:
  12418. $ref: '#/definitions/StandaloneAnonResourceDetails'
  12419. type: array
  12420. x-go-name: Output
  12421. total:
  12422. format: int64
  12423. type: integer
  12424. x-go-name: Total
  12425. type: object
  12426. token_cache_ValidateCreateDataOutput:
  12427. description: ""
  12428. schema:
  12429. properties:
  12430. token_cache:
  12431. $ref: '#/definitions/StandaloneAnonResourceDetails'
  12432. type: object
  12433. token_cache_ValidateUpdateDataOutput:
  12434. description: ""
  12435. schema:
  12436. properties:
  12437. token_cache:
  12438. $ref: '#/definitions/StandaloneAnonResourceDetails'
  12439. type: object
  12440. tokens_AuthenticateV2Output:
  12441. description: ""
  12442. schema:
  12443. $ref: '#/definitions/SAuthenticateV2ResponseBody'
  12444. tokens_AuthenticateV3Output:
  12445. description: ""
  12446. headers:
  12447. X-Subject-Token:
  12448. description: |-
  12449. 验证成功的keystone V3 token
  12450. in:header
  12451. type: string
  12452. schema:
  12453. $ref: '#/definitions/TokenCredentialV3'
  12454. user_CustomizeDeleteOutput:
  12455. description: ""
  12456. schema:
  12457. properties:
  12458. user:
  12459. $ref: '#/definitions/UserDetails'
  12460. type: object
  12461. user_FetchCustomizeColumnsOutput:
  12462. description: ""
  12463. schema:
  12464. properties:
  12465. user:
  12466. $ref: '#/definitions/UserDetails'
  12467. type: object
  12468. user_GetDetailsMetadataOutput:
  12469. description: ""
  12470. schema:
  12471. properties:
  12472. user:
  12473. additionalProperties:
  12474. type: string
  12475. type: object
  12476. x-go-name: Output
  12477. type: object
  12478. user_GetPropertyDomainTagValuePairsOutput:
  12479. description: ""
  12480. user_GetPropertyDomainTagValueTreeOutput:
  12481. description: ""
  12482. user_ListItemFilterOutput:
  12483. description: ""
  12484. schema:
  12485. properties:
  12486. limit:
  12487. format: int64
  12488. type: integer
  12489. x-go-name: Limit
  12490. offset:
  12491. format: int64
  12492. type: integer
  12493. x-go-name: Offset
  12494. total:
  12495. format: int64
  12496. type: integer
  12497. x-go-name: Total
  12498. users:
  12499. items:
  12500. $ref: '#/definitions/UserDetails'
  12501. type: array
  12502. x-go-name: Output
  12503. type: object
  12504. user_PerformDisableOutput:
  12505. description: ""
  12506. user_PerformEnableOutput:
  12507. description: ""
  12508. user_PerformJoinOutput:
  12509. description: ""
  12510. user_PerformLeaveOutput:
  12511. description: ""
  12512. user_PerformLinkIdpOutput:
  12513. description: ""
  12514. user_PerformResetCredentialsOutput:
  12515. description: ""
  12516. user_PerformUnlinkIdpOutput:
  12517. description: ""
  12518. user_ValidateCreateDataOutput:
  12519. description: ""
  12520. schema:
  12521. properties:
  12522. user:
  12523. $ref: '#/definitions/UserDetails'
  12524. type: object
  12525. user_ValidateUpdateDataOutput:
  12526. description: ""
  12527. schema:
  12528. properties:
  12529. user:
  12530. $ref: '#/definitions/UserDetails'
  12531. type: object
  12532. schemes:
  12533. - https
  12534. - http
  12535. securityDefinitions:
  12536. keystone:
  12537. in: header
  12538. name: X-Auth-Token
  12539. type: apiKey
  12540. swagger: "2.0"