swagger_cloudid.yaml 209 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327
  1. basePath: /
  2. consumes:
  3. - application/json
  4. definitions:
  5. CloudgroupAddUserInput:
  6. properties:
  7. clouduser_id:
  8. description: 用户Id
  9. type: string
  10. x-go-name: ClouduserId
  11. type: object
  12. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  13. CloudgroupAttachPolicyInput:
  14. properties:
  15. cloudpolicy_id:
  16. description: 权限Id
  17. type: string
  18. x-go-name: CloudpolicyId
  19. type: object
  20. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  21. CloudgroupCreateInput:
  22. properties:
  23. __meta__:
  24. additionalProperties:
  25. type: string
  26. description: 标签列表,最多支持20个
  27. example:
  28. user:rd: op
  29. type: object
  30. x-go-name: Metadata
  31. cloudpolicy_ids:
  32. description: 权限Id列表, 权限provider必须和权限组provider一致
  33. items:
  34. type: string
  35. type: array
  36. x-go-name: CloudpolicyIds
  37. description:
  38. description: 资源描述
  39. example: test create network
  40. type: string
  41. x-go-name: Description
  42. dry_run:
  43. default: false
  44. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  45. type: boolean
  46. x-go-name: DryRun
  47. generate_name:
  48. description: |-
  49. 生成资源名称的模板,如果name为空,则为必填项
  50. description: generated resource name, given a pattern to generate name, required if name is not given
  51. example: test###
  52. type: string
  53. x-go-name: GenerateName
  54. is_emulated:
  55. description: |-
  56. 资源是否为模拟资源
  57. description: the resource is an emulated resource
  58. type: boolean
  59. x-go-name: IsEmulated
  60. is_public:
  61. description: 是否共享
  62. type: boolean
  63. x-go-name: IsPublic
  64. manager_id:
  65. description: 子账号Id
  66. type: string
  67. x-go-name: ManagerId
  68. name:
  69. description: |-
  70. 资源名称,如果generate_name为空,则为必填项
  71. description: resource name, required if generated_name is not given
  72. example: test-network
  73. type: string
  74. uniqueItems: true
  75. x-go-name: Name
  76. project_domain_id:
  77. description: 指定项目归属域名称或ID
  78. type: string
  79. x-go-name: ProjectDomainId
  80. public_scope:
  81. description: 共享范围
  82. type: string
  83. x-go-name: PublicScope
  84. status:
  85. description: 用来存储资源的状态
  86. type: string
  87. x-go-name: Status
  88. required:
  89. - name
  90. type: object
  91. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  92. CloudgroupDetachPolicyInput:
  93. properties:
  94. cloudpolicy_id:
  95. description: 权限Id
  96. type: string
  97. x-go-name: CloudpolicyId
  98. type: object
  99. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  100. CloudgroupDetails:
  101. properties:
  102. brand:
  103. description: 品牌信息
  104. type: string
  105. x-go-name: Brand
  106. can_delete:
  107. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  108. example: true
  109. type: boolean
  110. x-go-name: CanDelete
  111. can_update:
  112. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  113. example: true
  114. type: boolean
  115. x-go-name: CanUpdate
  116. cloudaccount:
  117. description: 云账号名称
  118. type: string
  119. x-go-name: Cloudaccount
  120. cloudaccount_id:
  121. description: 云账号Id
  122. type: string
  123. x-go-name: CloudaccountId
  124. cloudpolicies:
  125. items:
  126. $ref: '#/definitions/SCloudIdBaseResource'
  127. type: array
  128. x-go-name: Cloudpolicies
  129. cloudpolicy_count:
  130. description: 权限数量
  131. format: int64
  132. type: integer
  133. x-go-name: CloudpolicyCount
  134. clouduser_count:
  135. description: 公有云子用户数量
  136. format: int64
  137. type: integer
  138. x-go-name: ClouduserCount
  139. cloudusers:
  140. items:
  141. $ref: '#/definitions/SCloudIdBaseResource'
  142. type: array
  143. x-go-name: Cloudusers
  144. created_at:
  145. description: 资源创建时间
  146. format: date-time
  147. type: string
  148. x-go-name: CreatedAt
  149. delete_fail_reason:
  150. $ref: '#/definitions/Error'
  151. deleted:
  152. description: 资源是否被删除
  153. type: boolean
  154. x-go-name: Deleted
  155. deleted_at:
  156. description: 资源删除时间
  157. format: date-time
  158. type: string
  159. x-go-name: DeletedAt
  160. description:
  161. description: 资源描述信息
  162. type: string
  163. x-go-name: Description
  164. domain_id:
  165. description: 域Id
  166. type: string
  167. x-go-name: DomainId
  168. domain_src:
  169. description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
  170. example: local
  171. type: string
  172. x-go-name: DomainSrc
  173. external_id:
  174. description: 云上Id, 对应云上资源自身Id
  175. type: string
  176. x-go-name: ExternalId
  177. iam_login_url:
  178. description: 公有云账号登录地址
  179. type: string
  180. x-go-name: IamLoginUrl
  181. id:
  182. description: 资源UUID
  183. type: string
  184. x-go-name: Id
  185. imported_at:
  186. description: 资源导入时间
  187. format: date-time
  188. type: string
  189. x-go-name: ImportedAt
  190. is_emulated:
  191. description: |-
  192. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  193. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  194. type: boolean
  195. x-go-name: IsEmulated
  196. is_public:
  197. description: 是否共享
  198. type: boolean
  199. x-go-name: IsPublic
  200. manager:
  201. description: 云订阅名称
  202. type: string
  203. x-go-name: Manager
  204. manager_id:
  205. description: 子订阅Id
  206. type: string
  207. x-go-name: ManagerId
  208. metadata:
  209. additionalProperties:
  210. type: string
  211. description: 标签
  212. type: object
  213. x-go-name: Metadata
  214. name:
  215. description: 资源名称
  216. type: string
  217. x-go-name: Name
  218. org_node_md5:
  219. description: 用以组织架构变更通知其他服务权限变更
  220. type: string
  221. x-go-name: OrgNodeMd5
  222. progress:
  223. description: 操作进度0-100
  224. format: float
  225. type: number
  226. x-go-name: Progress
  227. project_domain:
  228. description: 资源归属项目的域名称
  229. type: string
  230. x-go-name: ProjectDomain
  231. provider:
  232. description: 平台信息
  233. type: string
  234. x-go-name: Provider
  235. public_scope:
  236. description: 默认共享范围
  237. type: string
  238. x-go-name: PublicScope
  239. public_src:
  240. description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
  241. example: local
  242. type: string
  243. x-go-name: PublicSrc
  244. shared_domains:
  245. description: 共享的域列表
  246. items:
  247. $ref: '#/definitions/SharedDomain'
  248. type: array
  249. x-go-name: SharedDomains
  250. shared_projects:
  251. description: 共享的项目列表
  252. items:
  253. $ref: '#/definitions/SharedProject'
  254. type: array
  255. x-go-name: SharedProjects
  256. source:
  257. description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
  258. type: string
  259. x-go-name: Source
  260. status:
  261. description: 资源状态
  262. type: string
  263. x-go-name: Status
  264. update_fail_reason:
  265. $ref: '#/definitions/Error'
  266. update_version:
  267. description: 资源被更新次数
  268. format: int64
  269. type: integer
  270. x-go-name: UpdateVersion
  271. updated_at:
  272. description: 资源更新时间
  273. format: date-time
  274. type: string
  275. x-go-name: UpdatedAt
  276. type: object
  277. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  278. CloudgroupRemoveUserInput:
  279. properties:
  280. clouduser_id:
  281. description: 用户Id
  282. type: string
  283. x-go-name: ClouduserId
  284. type: object
  285. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  286. CloudgroupSetPoliciesInput:
  287. properties:
  288. cloudpolicy_ids:
  289. description: 权限Ids
  290. items:
  291. type: string
  292. type: array
  293. x-go-name: CloudpolicyIds
  294. type: object
  295. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  296. CloudgroupSetUsersInput:
  297. properties:
  298. clouduser_ids:
  299. description: 公有云子账号Ids
  300. items:
  301. type: string
  302. type: array
  303. x-go-name: ClouduserIds
  304. type: object
  305. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  306. CloudgroupSyncstatusInput:
  307. type: object
  308. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  309. CloudgroupUpdateInput:
  310. type: object
  311. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  312. CloudpolicyDetails:
  313. properties:
  314. brand:
  315. description: 品牌信息
  316. type: string
  317. x-go-name: Brand
  318. can_delete:
  319. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  320. example: true
  321. type: boolean
  322. x-go-name: CanDelete
  323. can_update:
  324. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  325. example: true
  326. type: boolean
  327. x-go-name: CanUpdate
  328. cloudaccount:
  329. description: 云账号名称
  330. type: string
  331. x-go-name: Cloudaccount
  332. cloudaccount_id:
  333. description: 云账号Id
  334. type: string
  335. x-go-name: CloudaccountId
  336. cloudgroup_count:
  337. format: int64
  338. type: integer
  339. x-go-name: CloudgroupCount
  340. clouduser_count:
  341. format: int64
  342. type: integer
  343. x-go-name: ClouduserCount
  344. created_at:
  345. description: 资源创建时间
  346. format: date-time
  347. type: string
  348. x-go-name: CreatedAt
  349. delete_fail_reason:
  350. $ref: '#/definitions/Error'
  351. deleted:
  352. description: 资源是否被删除
  353. type: boolean
  354. x-go-name: Deleted
  355. deleted_at:
  356. description: 资源删除时间
  357. format: date-time
  358. type: string
  359. x-go-name: DeletedAt
  360. description:
  361. description: 资源描述信息
  362. type: string
  363. x-go-name: Description
  364. document:
  365. description: 策略内容
  366. type: object
  367. x-go-name: Document
  368. domain_id:
  369. description: 域Id
  370. type: string
  371. x-go-name: DomainId
  372. domain_src:
  373. description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
  374. example: local
  375. type: string
  376. x-go-name: DomainSrc
  377. external_id:
  378. description: 云上Id, 对应云上资源自身Id
  379. type: string
  380. x-go-name: ExternalId
  381. iam_login_url:
  382. description: 公有云账号登录地址
  383. type: string
  384. x-go-name: IamLoginUrl
  385. id:
  386. description: 资源UUID
  387. type: string
  388. x-go-name: Id
  389. imported_at:
  390. description: 资源导入时间
  391. format: date-time
  392. type: string
  393. x-go-name: ImportedAt
  394. is_emulated:
  395. description: |-
  396. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  397. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  398. type: boolean
  399. x-go-name: IsEmulated
  400. is_public:
  401. description: 是否共享
  402. type: boolean
  403. x-go-name: IsPublic
  404. manager:
  405. description: 云订阅名称
  406. type: string
  407. x-go-name: Manager
  408. manager_id:
  409. description: 子订阅Id
  410. type: string
  411. x-go-name: ManagerId
  412. metadata:
  413. additionalProperties:
  414. type: string
  415. description: 标签
  416. type: object
  417. x-go-name: Metadata
  418. name:
  419. description: 资源名称
  420. type: string
  421. x-go-name: Name
  422. org_node_md5:
  423. description: 用以组织架构变更通知其他服务权限变更
  424. type: string
  425. x-go-name: OrgNodeMd5
  426. policy_type:
  427. description: |-
  428. 权限类型
  429. 权限类型 | 说明 |
  430. ---------------|----------------------|
  431. system | 平台内置权限 |
  432. custom | 用户自定义权限 |
  433. type: string
  434. x-go-name: PolicyType
  435. progress:
  436. description: 操作进度0-100
  437. format: float
  438. type: number
  439. x-go-name: Progress
  440. project_domain:
  441. description: 资源归属项目的域名称
  442. type: string
  443. x-go-name: ProjectDomain
  444. provider:
  445. description: 平台信息
  446. type: string
  447. x-go-name: Provider
  448. public_scope:
  449. description: 默认共享范围
  450. type: string
  451. x-go-name: PublicScope
  452. public_src:
  453. description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
  454. example: local
  455. type: string
  456. x-go-name: PublicSrc
  457. shared_domains:
  458. description: 共享的域列表
  459. items:
  460. $ref: '#/definitions/SharedDomain'
  461. type: array
  462. x-go-name: SharedDomains
  463. shared_projects:
  464. description: 共享的项目列表
  465. items:
  466. $ref: '#/definitions/SharedProject'
  467. type: array
  468. x-go-name: SharedProjects
  469. source:
  470. description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
  471. type: string
  472. x-go-name: Source
  473. status:
  474. description: 资源状态
  475. type: string
  476. x-go-name: Status
  477. update_fail_reason:
  478. $ref: '#/definitions/Error'
  479. update_version:
  480. description: 资源被更新次数
  481. format: int64
  482. type: integer
  483. x-go-name: UpdateVersion
  484. updated_at:
  485. description: 资源更新时间
  486. format: date-time
  487. type: string
  488. x-go-name: UpdatedAt
  489. type: object
  490. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  491. CloudroleDetails:
  492. properties:
  493. brand:
  494. description: 品牌信息
  495. type: string
  496. x-go-name: Brand
  497. can_delete:
  498. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  499. example: true
  500. type: boolean
  501. x-go-name: CanDelete
  502. can_update:
  503. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  504. example: true
  505. type: boolean
  506. x-go-name: CanUpdate
  507. cloudaccount:
  508. description: 云账号名称
  509. type: string
  510. x-go-name: Cloudaccount
  511. cloudaccount_id:
  512. description: 云账号Id
  513. type: string
  514. x-go-name: CloudaccountId
  515. cloudgroup_id:
  516. type: string
  517. x-go-name: CloudgroupId
  518. created_at:
  519. description: 资源创建时间
  520. format: date-time
  521. type: string
  522. x-go-name: CreatedAt
  523. delete_fail_reason:
  524. $ref: '#/definitions/Error'
  525. deleted:
  526. description: 资源是否被删除
  527. type: boolean
  528. x-go-name: Deleted
  529. deleted_at:
  530. description: 资源删除时间
  531. format: date-time
  532. type: string
  533. x-go-name: DeletedAt
  534. description:
  535. description: 资源描述信息
  536. type: string
  537. x-go-name: Description
  538. document:
  539. type: object
  540. x-go-name: Document
  541. domain_id:
  542. description: 域Id
  543. type: string
  544. x-go-name: DomainId
  545. domain_src:
  546. description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
  547. example: local
  548. type: string
  549. x-go-name: DomainSrc
  550. enabled:
  551. description: 资源是否启用
  552. type: boolean
  553. x-go-name: Enabled
  554. external_id:
  555. description: 云上Id, 对应云上资源自身Id
  556. type: string
  557. x-go-name: ExternalId
  558. iam_login_url:
  559. description: 公有云账号登录地址
  560. type: string
  561. x-go-name: IamLoginUrl
  562. id:
  563. description: 资源UUID
  564. type: string
  565. x-go-name: Id
  566. imported_at:
  567. description: 资源导入时间
  568. format: date-time
  569. type: string
  570. x-go-name: ImportedAt
  571. is_emulated:
  572. description: |-
  573. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  574. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  575. type: boolean
  576. x-go-name: IsEmulated
  577. is_public:
  578. description: 是否共享
  579. type: boolean
  580. x-go-name: IsPublic
  581. manager:
  582. description: 云订阅名称
  583. type: string
  584. x-go-name: Manager
  585. manager_id:
  586. description: 子订阅Id
  587. type: string
  588. x-go-name: ManagerId
  589. metadata:
  590. additionalProperties:
  591. type: string
  592. description: 标签
  593. type: object
  594. x-go-name: Metadata
  595. name:
  596. description: 资源名称
  597. type: string
  598. x-go-name: Name
  599. org_node_md5:
  600. description: 用以组织架构变更通知其他服务权限变更
  601. type: string
  602. x-go-name: OrgNodeMd5
  603. progress:
  604. description: 操作进度0-100
  605. format: float
  606. type: number
  607. x-go-name: Progress
  608. project_domain:
  609. description: 资源归属项目的域名称
  610. type: string
  611. x-go-name: ProjectDomain
  612. provider:
  613. description: 平台信息
  614. type: string
  615. x-go-name: Provider
  616. public_scope:
  617. description: 默认共享范围
  618. type: string
  619. x-go-name: PublicScope
  620. public_src:
  621. description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
  622. example: local
  623. type: string
  624. x-go-name: PublicSrc
  625. saml_provider_id:
  626. type: string
  627. x-go-name: SAMLProviderId
  628. shared_domains:
  629. description: 共享的域列表
  630. items:
  631. $ref: '#/definitions/SharedDomain'
  632. type: array
  633. x-go-name: SharedDomains
  634. shared_projects:
  635. description: 共享的项目列表
  636. items:
  637. $ref: '#/definitions/SharedProject'
  638. type: array
  639. x-go-name: SharedProjects
  640. source:
  641. description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
  642. type: string
  643. x-go-name: Source
  644. status:
  645. description: 资源状态
  646. type: string
  647. x-go-name: Status
  648. update_fail_reason:
  649. $ref: '#/definitions/Error'
  650. update_version:
  651. description: 资源被更新次数
  652. format: int64
  653. type: integer
  654. x-go-name: UpdateVersion
  655. updated_at:
  656. description: 资源更新时间
  657. format: date-time
  658. type: string
  659. x-go-name: UpdatedAt
  660. type: object
  661. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  662. ClouduserAttachPolicyInput:
  663. properties:
  664. cloudpolicy_id:
  665. description: |-
  666. 权限Id
  667. 云平台 | 说明 |
  668. ----------|---------------------------------------------|
  669. Google | 支持 |
  670. Aliyun | 支持 |
  671. Huawei | 不支持 |
  672. Azure | 支持 |
  673. 腾讯云 | 支持 |
  674. type: string
  675. x-go-name: CloudpolicyId
  676. type: object
  677. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  678. ClouduserChangeOwnerInput:
  679. properties:
  680. user_id:
  681. description: 本地用户Id
  682. type: string
  683. x-go-name: UserId
  684. type: object
  685. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  686. ClouduserCreateAccessKeyInput:
  687. properties:
  688. name:
  689. type: string
  690. x-go-name: Name
  691. type: object
  692. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  693. ClouduserCreateInput:
  694. properties:
  695. __meta__:
  696. additionalProperties:
  697. type: string
  698. description: 标签列表,最多支持20个
  699. example:
  700. user:rd: op
  701. type: object
  702. x-go-name: Metadata
  703. cloudaccount_id:
  704. description: |-
  705. 云账号ID
  706. Azure云账号需要有User administrator权限,否则删操作会出现Insufficient privileges to complete the operation错误信息
  707. type: string
  708. x-go-name: CloudaccountId
  709. cloudgroup_ids:
  710. description: 初始化权限组Id列表, 权限组必须和云账号平台属性相同
  711. items:
  712. type: string
  713. type: array
  714. x-go-name: CloudgroupIds
  715. cloudpolicy_ids:
  716. description: |-
  717. 初始的权限Id列表, 权限必须属于指定的云账号
  718. 云平台 | 说明 |
  719. ----------|---------------------------------------------|
  720. Google | 至少需要一个初始权限 |
  721. Aliyun | 支持 |
  722. Huawei | 不支持 |
  723. Azure | 支持 |
  724. 腾讯云 | 支持 |
  725. items:
  726. type: string
  727. type: array
  728. x-go-name: CloudpolicyIds
  729. description:
  730. description: 资源描述
  731. example: test create network
  732. type: string
  733. x-go-name: Description
  734. dry_run:
  735. default: false
  736. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  737. type: boolean
  738. x-go-name: DryRun
  739. email:
  740. description: 邮箱地址
  741. example: test@example.com
  742. type: string
  743. x-go-name: Email
  744. generate_name:
  745. description: |-
  746. 生成资源名称的模板,如果name为空,则为必填项
  747. description: generated resource name, given a pattern to generate name, required if name is not given
  748. example: test###
  749. type: string
  750. x-go-name: GenerateName
  751. is_console_login:
  752. default: false
  753. description: 是否可控制台登录
  754. type: boolean
  755. x-go-name: IsConsoleLogin
  756. is_emulated:
  757. description: |-
  758. 资源是否为模拟资源
  759. description: the resource is an emulated resource
  760. type: boolean
  761. x-go-name: IsEmulated
  762. manager_id:
  763. description: 云订阅ID
  764. type: string
  765. x-go-name: ManagerId
  766. mobile_phone:
  767. description: 手机号码
  768. example: 86-1868888****
  769. type: string
  770. x-go-name: MobilePhone
  771. name:
  772. description: |-
  773. 资源名称,如果generate_name为空,则为必填项
  774. description: resource name, required if generated_name is not given
  775. example: test-network
  776. type: string
  777. uniqueItems: true
  778. x-go-name: Name
  779. notify:
  780. default: false
  781. description: 是否发送邮件通知(仅设置email不为空生效)
  782. type: boolean
  783. x-go-name: Notify
  784. owner_id:
  785. description: 本地用户Id,若为空则使用当前用户Id作为此参数值
  786. type: string
  787. x-go-name: OwnerId
  788. password:
  789. description: |-
  790. 用户密码, 若is_console_login = true时, 此参数不传时会生成12位随机密码
  791. 云平台 | 说明 |
  792. ----------|---------------------------------------------|
  793. Google | 不支持此参数 |
  794. Aliyun | 支持 |
  795. Huawei | 支持 |
  796. Azure | 支持 |
  797. 腾讯云 | 支持 |
  798. type: string
  799. x-go-name: Password
  800. project_domain_id:
  801. description: 指定项目归属域名称或ID
  802. type: string
  803. x-go-name: ProjectDomainId
  804. status:
  805. description: 用来存储资源的状态
  806. type: string
  807. x-go-name: Status
  808. required:
  809. - name
  810. type: object
  811. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  812. ClouduserDeleteAccessKeyInput:
  813. properties:
  814. access_key:
  815. type: string
  816. x-go-name: AccessKey
  817. type: object
  818. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  819. ClouduserDetachPolicyInput:
  820. properties:
  821. cloudpolicy_id:
  822. description: |-
  823. 权限Id
  824. 云平台 | 说明 |
  825. ----------|---------------------------------------------|
  826. Google | 支持,但最少需要保留一个权限 |
  827. Aliyun | 支持 |
  828. Huawei | 不支持 |
  829. Azure | 不支持 |
  830. 腾讯云 | 支持 |
  831. type: string
  832. x-go-name: CloudpolicyId
  833. type: object
  834. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  835. ClouduserDetails:
  836. properties:
  837. brand:
  838. description: 品牌信息
  839. type: string
  840. x-go-name: Brand
  841. can_delete:
  842. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  843. example: true
  844. type: boolean
  845. x-go-name: CanDelete
  846. can_update:
  847. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  848. example: true
  849. type: boolean
  850. x-go-name: CanUpdate
  851. cloudaccount:
  852. description: 云账号名称
  853. type: string
  854. x-go-name: Cloudaccount
  855. cloudaccount_id:
  856. description: 云账号Id
  857. type: string
  858. x-go-name: CloudaccountId
  859. cloudgroup_count:
  860. description: 权限组数量
  861. format: int64
  862. type: integer
  863. x-go-name: CloudgroupCount
  864. cloudgroups:
  865. items:
  866. $ref: '#/definitions/SCloudIdBaseResource'
  867. type: array
  868. x-go-name: Cloudgroups
  869. cloudpolicies:
  870. items:
  871. $ref: '#/definitions/SCloudIdBaseResource'
  872. type: array
  873. x-go-name: Cloudpolicies
  874. cloudpolicy_count:
  875. description: 权限数量
  876. format: int64
  877. type: integer
  878. x-go-name: CloudpolicyCount
  879. created_at:
  880. description: 资源创建时间
  881. format: date-time
  882. type: string
  883. x-go-name: CreatedAt
  884. delete_fail_reason:
  885. $ref: '#/definitions/Error'
  886. deleted:
  887. description: 资源是否被删除
  888. type: boolean
  889. x-go-name: Deleted
  890. deleted_at:
  891. description: 资源删除时间
  892. format: date-time
  893. type: string
  894. x-go-name: DeletedAt
  895. description:
  896. description: 资源描述信息
  897. type: string
  898. x-go-name: Description
  899. domain_id:
  900. description: 域Id
  901. type: string
  902. x-go-name: DomainId
  903. domain_src:
  904. description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
  905. example: local
  906. type: string
  907. x-go-name: DomainSrc
  908. email:
  909. description: 邮箱地址
  910. type: string
  911. x-go-name: Email
  912. external_id:
  913. description: 云上Id, 对应云上资源自身Id
  914. type: string
  915. x-go-name: ExternalId
  916. iam_login_url:
  917. description: 公有云账号登录地址
  918. type: string
  919. x-go-name: IamLoginUrl
  920. id:
  921. description: 资源UUID
  922. type: string
  923. x-go-name: Id
  924. imported_at:
  925. description: 资源导入时间
  926. format: date-time
  927. type: string
  928. x-go-name: ImportedAt
  929. is_console_login:
  930. description: 是否可以控制台登录
  931. type: boolean
  932. x-go-name: IsConsoleLogin
  933. is_emulated:
  934. description: |-
  935. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  936. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  937. type: boolean
  938. x-go-name: IsEmulated
  939. manager:
  940. description: 云订阅名称
  941. type: string
  942. x-go-name: Manager
  943. manager_id:
  944. description: 子订阅Id
  945. type: string
  946. x-go-name: ManagerId
  947. metadata:
  948. additionalProperties:
  949. type: string
  950. description: 标签
  951. type: object
  952. x-go-name: Metadata
  953. mobile_phone:
  954. description: 手机号码
  955. type: string
  956. x-go-name: MobilePhone
  957. name:
  958. description: 资源名称
  959. type: string
  960. x-go-name: Name
  961. org_node_md5:
  962. description: 用以组织架构变更通知其他服务权限变更
  963. type: string
  964. x-go-name: OrgNodeMd5
  965. owner_id:
  966. description: 本地用户Id
  967. type: string
  968. x-go-name: OwnerId
  969. owner_name:
  970. description: 用户名称
  971. type: string
  972. x-go-name: OwnerName
  973. progress:
  974. description: 操作进度0-100
  975. format: float
  976. type: number
  977. x-go-name: Progress
  978. project_domain:
  979. description: 资源归属项目的域名称
  980. type: string
  981. x-go-name: ProjectDomain
  982. provider:
  983. description: 平台信息
  984. type: string
  985. x-go-name: Provider
  986. secret:
  987. type: string
  988. x-go-name: Secret
  989. source:
  990. description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
  991. type: string
  992. x-go-name: Source
  993. status:
  994. description: 资源状态
  995. type: string
  996. x-go-name: Status
  997. update_fail_reason:
  998. $ref: '#/definitions/Error'
  999. update_version:
  1000. description: 资源被更新次数
  1001. format: int64
  1002. type: integer
  1003. x-go-name: UpdateVersion
  1004. updated_at:
  1005. description: 资源更新时间
  1006. format: date-time
  1007. type: string
  1008. x-go-name: UpdatedAt
  1009. type: object
  1010. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1011. ClouduserJoinGroupInput:
  1012. properties:
  1013. cloudgroup_id:
  1014. description: 权限组Id
  1015. type: string
  1016. x-go-name: CloudgroupId
  1017. type: object
  1018. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1019. ClouduserLeaveGroupInput:
  1020. properties:
  1021. cloudgroup_id:
  1022. description: 权限组Id
  1023. type: string
  1024. x-go-name: CloudgroupId
  1025. type: object
  1026. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1027. ClouduserResetPasswordInput:
  1028. properties:
  1029. password:
  1030. description: |-
  1031. 若此参数为空, 默认会生成随机12位密码
  1032. 云平台 | 说明 |
  1033. ----------|---------------------------------------------|
  1034. Google | 不支持 |
  1035. Aliyun | 支持 |
  1036. Huawei | 支持 |
  1037. Azure | 支持 |
  1038. 腾讯云 | 支持 |
  1039. type: string
  1040. x-go-name: Password
  1041. type: object
  1042. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1043. ClouduserSetGroupsInput:
  1044. properties:
  1045. cloudgroup_ids:
  1046. description: 权限组Ids
  1047. items:
  1048. type: string
  1049. type: array
  1050. x-go-name: CloudgroupIds
  1051. type: object
  1052. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1053. ClouduserSetPoliciesInput:
  1054. properties:
  1055. cloudpolicy_ids:
  1056. description: 权限Ids
  1057. items:
  1058. type: string
  1059. type: array
  1060. x-go-name: CloudpolicyIds
  1061. type: object
  1062. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1063. ClouduserSyncstatusInput:
  1064. type: object
  1065. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1066. EnabledStatusInfrasResourceBaseUpdateInput:
  1067. properties:
  1068. description:
  1069. description: 资源描述
  1070. type: string
  1071. x-go-name: Description
  1072. name:
  1073. description: 资源名称
  1074. type: string
  1075. x-go-name: Name
  1076. type: object
  1077. x-go-package: yunion.io/x/onecloud/pkg/apis
  1078. Error:
  1079. properties:
  1080. class:
  1081. type: string
  1082. x-go-name: Class
  1083. code:
  1084. format: int64
  1085. type: integer
  1086. x-go-name: Code
  1087. details:
  1088. type: string
  1089. x-go-name: Details
  1090. type: object
  1091. x-go-package: yunion.io/x/onecloud/pkg/httperrors
  1092. GetCloudaccountSamlOutput:
  1093. properties:
  1094. entity_id:
  1095. description: cloudaccount SAML ServiceProvider entity ID
  1096. type: string
  1097. x-go-name: EntityId
  1098. init_login_url:
  1099. description: initial SAML SSO login URL for this cloudaccount
  1100. type: string
  1101. x-go-name: InitLoginUrl
  1102. metadata_url:
  1103. description: metadata URL for this cloudaccount
  1104. type: string
  1105. x-go-name: MetadataUrl
  1106. redirect_login_url:
  1107. description: redirect login URL for this cloudaccount
  1108. type: string
  1109. x-go-name: RedirectLoginUrl
  1110. redirect_logout_url:
  1111. description: redirect logout URL for this cloudaccount
  1112. type: string
  1113. x-go-name: RedirectLogoutUrl
  1114. type: object
  1115. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1116. GetDetailsStatusOutput:
  1117. properties:
  1118. status:
  1119. description: 状态
  1120. type: string
  1121. x-go-name: Status
  1122. type: object
  1123. x-go-package: yunion.io/x/onecloud/pkg/apis
  1124. PerformChangeDomainOwnerInput:
  1125. properties:
  1126. project_domain_id:
  1127. description: 指定项目归属域名称或ID
  1128. type: string
  1129. x-go-name: ProjectDomainId
  1130. type: object
  1131. x-go-package: yunion.io/x/onecloud/pkg/apis
  1132. PerformDisableInput:
  1133. type: object
  1134. x-go-package: yunion.io/x/onecloud/pkg/apis
  1135. PerformEnableInput:
  1136. type: object
  1137. x-go-package: yunion.io/x/onecloud/pkg/apis
  1138. PerformPrivateInput:
  1139. type: object
  1140. x-go-package: yunion.io/x/onecloud/pkg/apis
  1141. PerformPublicDomainInput:
  1142. properties:
  1143. scope:
  1144. description: 共享项目资源的共享范围,可能的值为:project, domain和system
  1145. pattern: project|domain|system
  1146. type: string
  1147. x-go-name: Scope
  1148. shared_domain_ids:
  1149. description: 如果共享范围为域,则在此列表中指定共享的目标域
  1150. items:
  1151. type: string
  1152. type: array
  1153. x-go-name: SharedDomainIds
  1154. type: object
  1155. x-go-package: yunion.io/x/onecloud/pkg/apis
  1156. SAMLProviderDetails:
  1157. properties:
  1158. auth_url:
  1159. type: string
  1160. x-go-name: AuthUrl
  1161. brand:
  1162. description: 品牌信息
  1163. type: string
  1164. x-go-name: Brand
  1165. can_delete:
  1166. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1167. example: true
  1168. type: boolean
  1169. x-go-name: CanDelete
  1170. can_update:
  1171. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1172. example: true
  1173. type: boolean
  1174. x-go-name: CanUpdate
  1175. cloudaccount:
  1176. description: 云账号名称
  1177. type: string
  1178. x-go-name: Cloudaccount
  1179. cloudaccount_id:
  1180. description: 云账号Id
  1181. type: string
  1182. x-go-name: CloudaccountId
  1183. created_at:
  1184. description: 资源创建时间
  1185. format: date-time
  1186. type: string
  1187. x-go-name: CreatedAt
  1188. delete_fail_reason:
  1189. $ref: '#/definitions/Error'
  1190. deleted:
  1191. description: 资源是否被删除
  1192. type: boolean
  1193. x-go-name: Deleted
  1194. deleted_at:
  1195. description: 资源删除时间
  1196. format: date-time
  1197. type: string
  1198. x-go-name: DeletedAt
  1199. description:
  1200. description: 资源描述信息
  1201. type: string
  1202. x-go-name: Description
  1203. domain_id:
  1204. description: 域Id
  1205. type: string
  1206. x-go-name: DomainId
  1207. domain_src:
  1208. description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
  1209. example: local
  1210. type: string
  1211. x-go-name: DomainSrc
  1212. entity_id:
  1213. type: string
  1214. x-go-name: EntityId
  1215. external_id:
  1216. description: 云上Id, 对应云上资源自身Id
  1217. type: string
  1218. x-go-name: ExternalId
  1219. iam_login_url:
  1220. description: 公有云账号登录地址
  1221. type: string
  1222. x-go-name: IamLoginUrl
  1223. id:
  1224. description: 资源UUID
  1225. type: string
  1226. x-go-name: Id
  1227. imported_at:
  1228. description: 资源导入时间
  1229. format: date-time
  1230. type: string
  1231. x-go-name: ImportedAt
  1232. is_emulated:
  1233. description: |-
  1234. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1235. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1236. type: boolean
  1237. x-go-name: IsEmulated
  1238. is_public:
  1239. description: 是否共享
  1240. type: boolean
  1241. x-go-name: IsPublic
  1242. manager_id:
  1243. description: 子订阅Id
  1244. type: string
  1245. x-go-name: ManagerId
  1246. metadata:
  1247. additionalProperties:
  1248. type: string
  1249. description: 标签
  1250. type: object
  1251. x-go-name: Metadata
  1252. metadata_document:
  1253. type: string
  1254. x-go-name: MetadataDocument
  1255. name:
  1256. description: 资源名称
  1257. type: string
  1258. x-go-name: Name
  1259. org_node_md5:
  1260. description: 用以组织架构变更通知其他服务权限变更
  1261. type: string
  1262. x-go-name: OrgNodeMd5
  1263. progress:
  1264. description: 操作进度0-100
  1265. format: float
  1266. type: number
  1267. x-go-name: Progress
  1268. project_domain:
  1269. description: 资源归属项目的域名称
  1270. type: string
  1271. x-go-name: ProjectDomain
  1272. provider:
  1273. description: 平台信息
  1274. type: string
  1275. x-go-name: Provider
  1276. public_scope:
  1277. description: 默认共享范围
  1278. type: string
  1279. x-go-name: PublicScope
  1280. public_src:
  1281. description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
  1282. example: local
  1283. type: string
  1284. x-go-name: PublicSrc
  1285. shared_domains:
  1286. description: 共享的域列表
  1287. items:
  1288. $ref: '#/definitions/SharedDomain'
  1289. type: array
  1290. x-go-name: SharedDomains
  1291. shared_projects:
  1292. description: 共享的项目列表
  1293. items:
  1294. $ref: '#/definitions/SharedProject'
  1295. type: array
  1296. x-go-name: SharedProjects
  1297. source:
  1298. description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
  1299. type: string
  1300. x-go-name: Source
  1301. status:
  1302. description: 资源状态
  1303. type: string
  1304. x-go-name: Status
  1305. update_fail_reason:
  1306. $ref: '#/definitions/Error'
  1307. update_version:
  1308. description: 资源被更新次数
  1309. format: int64
  1310. type: integer
  1311. x-go-name: UpdateVersion
  1312. updated_at:
  1313. description: 资源更新时间
  1314. format: date-time
  1315. type: string
  1316. x-go-name: UpdatedAt
  1317. type: object
  1318. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1319. SCloudIdBaseResource:
  1320. properties:
  1321. id:
  1322. type: string
  1323. x-go-name: Id
  1324. name:
  1325. type: string
  1326. x-go-name: Name
  1327. type: object
  1328. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1329. STag:
  1330. properties:
  1331. key:
  1332. description: 标签Kye
  1333. type: string
  1334. x-go-name: Key
  1335. value:
  1336. description: 标签Value
  1337. type: string
  1338. x-go-name: Value
  1339. type: object
  1340. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  1341. SamluserCreateInput:
  1342. properties:
  1343. __meta__:
  1344. additionalProperties:
  1345. type: string
  1346. description: 标签列表,最多支持20个
  1347. example:
  1348. user:rd: op
  1349. type: object
  1350. x-go-name: Metadata
  1351. cloudaccount_id:
  1352. description: 权限组和账号必须是同一平台
  1353. type: string
  1354. x-go-name: CloudaccountId
  1355. cloudgroup_id:
  1356. description: 权限组和账号必须是同一平台
  1357. type: string
  1358. x-go-name: CloudgroupId
  1359. description:
  1360. description: 资源描述
  1361. example: test create network
  1362. type: string
  1363. x-go-name: Description
  1364. dry_run:
  1365. default: false
  1366. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1367. type: boolean
  1368. x-go-name: DryRun
  1369. email:
  1370. type: string
  1371. x-go-name: Email
  1372. generate_name:
  1373. description: |-
  1374. 生成资源名称的模板,如果name为空,则为必填项
  1375. description: generated resource name, given a pattern to generate name, required if name is not given
  1376. example: test###
  1377. type: string
  1378. x-go-name: GenerateName
  1379. is_emulated:
  1380. description: |-
  1381. 资源是否为模拟资源
  1382. description: the resource is an emulated resource
  1383. type: boolean
  1384. x-go-name: IsEmulated
  1385. name:
  1386. description: |-
  1387. 资源名称,如果generate_name为空,则为必填项
  1388. description: resource name, required if generated_name is not given
  1389. example: test-network
  1390. type: string
  1391. uniqueItems: true
  1392. x-go-name: Name
  1393. owner_id:
  1394. description: 本地用户Id,若为空则使用当前用户Id作为此参数值
  1395. type: string
  1396. x-go-name: OwnerId
  1397. project_domain_id:
  1398. description: 指定项目归属域名称或ID
  1399. type: string
  1400. x-go-name: ProjectDomainId
  1401. status:
  1402. description: 用来存储资源的状态
  1403. type: string
  1404. x-go-name: Status
  1405. required:
  1406. - name
  1407. type: object
  1408. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1409. SamluserDetails:
  1410. properties:
  1411. brand:
  1412. description: 品牌信息
  1413. type: string
  1414. x-go-name: Brand
  1415. can_delete:
  1416. description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
  1417. example: true
  1418. type: boolean
  1419. x-go-name: CanDelete
  1420. can_update:
  1421. description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
  1422. example: true
  1423. type: boolean
  1424. x-go-name: CanUpdate
  1425. cloudaccount:
  1426. description: 云账号名称
  1427. type: string
  1428. x-go-name: Cloudaccount
  1429. cloudaccount_id:
  1430. type: string
  1431. x-go-name: CloudaccountId
  1432. cloudgroup:
  1433. description: 公有云用户名称
  1434. type: string
  1435. x-go-name: Cloudgroup
  1436. cloudgroup_id:
  1437. type: string
  1438. x-go-name: CloudgroupId
  1439. cloudrole_id:
  1440. type: string
  1441. x-go-name: CloudroleId
  1442. created_at:
  1443. description: 资源创建时间
  1444. format: date-time
  1445. type: string
  1446. x-go-name: CreatedAt
  1447. delete_fail_reason:
  1448. $ref: '#/definitions/Error'
  1449. deleted:
  1450. description: 资源是否被删除
  1451. type: boolean
  1452. x-go-name: Deleted
  1453. deleted_at:
  1454. description: 资源删除时间
  1455. format: date-time
  1456. type: string
  1457. x-go-name: DeletedAt
  1458. description:
  1459. description: 资源描述信息
  1460. type: string
  1461. x-go-name: Description
  1462. domain_id:
  1463. description: 域Id
  1464. type: string
  1465. x-go-name: DomainId
  1466. domain_src:
  1467. description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
  1468. example: local
  1469. type: string
  1470. x-go-name: DomainSrc
  1471. email:
  1472. description: 邮箱地址
  1473. type: string
  1474. x-go-name: Email
  1475. iam_login_url:
  1476. description: 公有云账号登录地址
  1477. type: string
  1478. x-go-name: IamLoginUrl
  1479. id:
  1480. description: 资源UUID
  1481. type: string
  1482. x-go-name: Id
  1483. is_emulated:
  1484. description: |-
  1485. 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
  1486. list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
  1487. type: boolean
  1488. x-go-name: IsEmulated
  1489. manager:
  1490. type: string
  1491. x-go-name: Manager
  1492. manager_id:
  1493. type: string
  1494. x-go-name: ManagerId
  1495. metadata:
  1496. additionalProperties:
  1497. type: string
  1498. description: 标签
  1499. type: object
  1500. x-go-name: Metadata
  1501. name:
  1502. description: 资源名称
  1503. type: string
  1504. x-go-name: Name
  1505. org_node_md5:
  1506. description: 用以组织架构变更通知其他服务权限变更
  1507. type: string
  1508. x-go-name: OrgNodeMd5
  1509. owner_id:
  1510. description: 本地用户Id
  1511. type: string
  1512. x-go-name: OwnerId
  1513. owner_name:
  1514. description: 用户名称
  1515. type: string
  1516. x-go-name: OwnerName
  1517. progress:
  1518. description: 操作进度0-100
  1519. format: float
  1520. type: number
  1521. x-go-name: Progress
  1522. project_domain:
  1523. description: 资源归属项目的域名称
  1524. type: string
  1525. x-go-name: ProjectDomain
  1526. provider:
  1527. description: 平台信息
  1528. type: string
  1529. x-go-name: Provider
  1530. status:
  1531. description: 资源状态
  1532. type: string
  1533. x-go-name: Status
  1534. update_fail_reason:
  1535. $ref: '#/definitions/Error'
  1536. update_version:
  1537. description: 资源被更新次数
  1538. format: int64
  1539. type: integer
  1540. x-go-name: UpdateVersion
  1541. updated_at:
  1542. description: 资源更新时间
  1543. format: date-time
  1544. type: string
  1545. x-go-name: UpdatedAt
  1546. type: object
  1547. x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
  1548. SharedDomain:
  1549. properties:
  1550. id:
  1551. type: string
  1552. x-go-name: Id
  1553. name:
  1554. type: string
  1555. x-go-name: Name
  1556. type: object
  1557. x-go-package: yunion.io/x/onecloud/pkg/apis
  1558. SharedProject:
  1559. properties:
  1560. domain:
  1561. type: string
  1562. x-go-name: Domain
  1563. domain_id:
  1564. type: string
  1565. x-go-name: DomainId
  1566. id:
  1567. type: string
  1568. x-go-name: Id
  1569. name:
  1570. type: string
  1571. x-go-name: Name
  1572. type: object
  1573. x-go-package: yunion.io/x/onecloud/pkg/apis
  1574. StatusDomainLevelResourceBaseUpdateInput:
  1575. properties:
  1576. description:
  1577. description: 资源描述
  1578. type: string
  1579. x-go-name: Description
  1580. name:
  1581. description: 资源名称
  1582. type: string
  1583. x-go-name: Name
  1584. type: object
  1585. x-go-package: yunion.io/x/onecloud/pkg/apis
  1586. StatusInfrasResourceBaseCreateInput:
  1587. properties:
  1588. __meta__:
  1589. additionalProperties:
  1590. type: string
  1591. description: 标签列表,最多支持20个
  1592. example:
  1593. user:rd: op
  1594. type: object
  1595. x-go-name: Metadata
  1596. description:
  1597. description: 资源描述
  1598. example: test create network
  1599. type: string
  1600. x-go-name: Description
  1601. dry_run:
  1602. default: false
  1603. description: 预检验参数,若为true则仅检查参数,并不真正创建变更
  1604. type: boolean
  1605. x-go-name: DryRun
  1606. generate_name:
  1607. description: |-
  1608. 生成资源名称的模板,如果name为空,则为必填项
  1609. description: generated resource name, given a pattern to generate name, required if name is not given
  1610. example: test###
  1611. type: string
  1612. x-go-name: GenerateName
  1613. is_emulated:
  1614. description: |-
  1615. 资源是否为模拟资源
  1616. description: the resource is an emulated resource
  1617. type: boolean
  1618. x-go-name: IsEmulated
  1619. is_public:
  1620. description: 是否共享
  1621. type: boolean
  1622. x-go-name: IsPublic
  1623. name:
  1624. description: |-
  1625. 资源名称,如果generate_name为空,则为必填项
  1626. description: resource name, required if generated_name is not given
  1627. example: test-network
  1628. type: string
  1629. uniqueItems: true
  1630. x-go-name: Name
  1631. project_domain_id:
  1632. description: 指定项目归属域名称或ID
  1633. type: string
  1634. x-go-name: ProjectDomainId
  1635. public_scope:
  1636. description: 共享范围
  1637. type: string
  1638. x-go-name: PublicScope
  1639. status:
  1640. description: 用来存储资源的状态
  1641. type: string
  1642. x-go-name: Status
  1643. required:
  1644. - name
  1645. type: object
  1646. x-go-package: yunion.io/x/onecloud/pkg/apis
  1647. StatusInfrasResourceBaseUpdateInput:
  1648. properties:
  1649. description:
  1650. description: 资源描述
  1651. type: string
  1652. x-go-name: Description
  1653. name:
  1654. description: 资源名称
  1655. type: string
  1656. x-go-name: Name
  1657. type: object
  1658. x-go-package: yunion.io/x/onecloud/pkg/apis
  1659. TTagSet:
  1660. items:
  1661. $ref: '#/definitions/STag'
  1662. type: array
  1663. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  1664. TTagSetList:
  1665. items:
  1666. $ref: '#/definitions/TTagSet'
  1667. type: array
  1668. x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
  1669. host: '"127.0.0.1:8889"'
  1670. info:
  1671. contact:
  1672. email: lizexi@yunion.cn
  1673. name: Zexi Li
  1674. description: Cloudid API
  1675. license:
  1676. name: Apache 2.0
  1677. url: http://www.apache.org/licenses/LICENSE-2.0.html
  1678. version: "1.0"
  1679. paths:
  1680. /cloudgroups:
  1681. get:
  1682. description: 列表
  1683. operationId: cloudgroup_ListItemFilter
  1684. parameters:
  1685. - default: 20
  1686. description: 查询限制量
  1687. format: int64
  1688. in: query
  1689. name: limit
  1690. type: integer
  1691. x-go-name: Limit
  1692. - default: 0
  1693. description: 查询偏移量
  1694. format: int64
  1695. in: query
  1696. name: offset
  1697. type: integer
  1698. x-go-name: Offset
  1699. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  1700. in: query
  1701. items:
  1702. type: string
  1703. name: order_by
  1704. type: array
  1705. x-go-name: OrderBy
  1706. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  1707. example: desc|asc
  1708. in: query
  1709. name: order
  1710. type: string
  1711. x-go-name: Order
  1712. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  1713. in: query
  1714. name: details
  1715. type: boolean
  1716. x-go-name: Details
  1717. - description: 模糊搜索所有字段
  1718. in: query
  1719. name: search
  1720. type: string
  1721. x-go-name: Search
  1722. - description: |-
  1723. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  1724. 支持的操作符如下:
  1725. 操作符 | 参数个数 | 举例 | 说明 |
  1726. ---------------|----------|------------------------------------------------|-----------------------------|
  1727. in | > 0 | name.in("test", "good") | 在给定数组中 |
  1728. notin | > 0 | name.notin('test') | 不在给定数组中 |
  1729. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  1730. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  1731. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  1732. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  1733. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  1734. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  1735. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  1736. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  1737. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  1738. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  1739. notequals | 1 | name.notequals('test') | 不等于给定值 |
  1740. isnull | 0 | name.isnull() | 值为SQL的NULL |
  1741. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  1742. isempty | 0 | name.isempty('test') | 值为空字符串 |
  1743. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  1744. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  1745. in: query
  1746. items:
  1747. type: string
  1748. name: filter
  1749. type: array
  1750. x-go-name: Filter
  1751. - description: |-
  1752. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  1753. 和其他表关联的语法如下:
  1754. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  1755. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  1756. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  1757. 举例:
  1758. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  1759. in: query
  1760. items:
  1761. type: string
  1762. name: joint_filter
  1763. type: array
  1764. x-go-name: JointFilter
  1765. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  1766. in: query
  1767. name: filter_any
  1768. type: boolean
  1769. x-go-name: FilterAny
  1770. - description: 返回结果只包含指定的字段
  1771. in: query
  1772. items:
  1773. type: string
  1774. name: field
  1775. type: array
  1776. x-go-name: Field
  1777. - description: 用于数据导出,指定导出的数据字段
  1778. in: query
  1779. name: export_keys
  1780. type: string
  1781. x-go-name: ExportKeys
  1782. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  1783. in: query
  1784. name: show_fail_reason
  1785. type: boolean
  1786. x-go-name: ShowFailReason
  1787. - description: 是否返回状态统计信息,默认为False
  1788. in: query
  1789. name: summary_stats
  1790. type: boolean
  1791. x-go-name: SummaryStats
  1792. - $ref: '#/definitions/TTagSet'
  1793. description: 通过标签过滤(包含这些标签)
  1794. in: query
  1795. name: tags
  1796. x-go-name: Tags
  1797. - $ref: '#/definitions/TTagSetList'
  1798. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  1799. in: query
  1800. name: obj_tags
  1801. x-go-name: ObjTags
  1802. - $ref: '#/definitions/TTagSet'
  1803. description: 通过标签过滤(不包含这些标签)
  1804. in: query
  1805. name: no_tags
  1806. x-go-name: NoTags
  1807. - $ref: '#/definitions/TTagSetList'
  1808. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  1809. in: query
  1810. name: no_obj_tags
  1811. x-go-name: NoObjTags
  1812. - description: 通过标签排序
  1813. in: query
  1814. name: order_by_tag
  1815. type: string
  1816. x-go-name: OrderByTag
  1817. - description: |-
  1818. deprecated
  1819. 返回资源的标签不包含用户标签
  1820. in: query
  1821. name: without_user_meta
  1822. type: boolean
  1823. x-go-name: WithoutUserMeta
  1824. - description: 返回包含用户标签的资源
  1825. in: query
  1826. name: with_user_meta
  1827. type: boolean
  1828. x-go-name: WithUserMeta
  1829. - description: 返回包含外部标签的资源
  1830. in: query
  1831. name: with_cloud_meta
  1832. type: boolean
  1833. x-go-name: WithCloudMeta
  1834. - description: 返回包含任意标签的资源
  1835. in: query
  1836. name: with_any_meta
  1837. type: boolean
  1838. x-go-name: WithAnyMeta
  1839. - description: 返回列表数据中包含资源的标签数据(Metadata)
  1840. in: query
  1841. name: with_meta
  1842. type: boolean
  1843. x-go-name: WithMeta
  1844. - description: 显示所有的资源,包括模拟的资源
  1845. in: query
  1846. name: show_emulated
  1847. type: boolean
  1848. x-go-name: ShowEmulated
  1849. - description: 以资源ID过滤列表
  1850. in: query
  1851. items:
  1852. type: string
  1853. name: id
  1854. type: array
  1855. x-go-name: Ids
  1856. - description: 以资源名称过滤列表
  1857. in: query
  1858. items:
  1859. type: string
  1860. name: name
  1861. type: array
  1862. x-go-name: Names
  1863. - description: 指定查询的权限范围,可能值为project, domain or system
  1864. in: query
  1865. name: scope
  1866. type: string
  1867. x-go-name: Scope
  1868. - description: 指定项目归属域名称或ID
  1869. in: query
  1870. name: project_domain_id
  1871. type: string
  1872. x-go-name: ProjectDomainId
  1873. - description: 对具有域属性的资源,严格匹配域ID
  1874. in: query
  1875. items:
  1876. type: string
  1877. name: project_domain_ids
  1878. type: array
  1879. x-go-name: ProjectDomainIds
  1880. - description: 按domain名称排序,可能值为asc|desc
  1881. in: query
  1882. name: order_by_domain
  1883. pattern: asc|desc
  1884. type: string
  1885. x-go-name: OrderByDomain
  1886. - $ref: '#/definitions/TTagSetList'
  1887. description: filter by domain tags
  1888. in: query
  1889. name: domain_tags
  1890. x-go-name: DomainTags
  1891. - $ref: '#/definitions/TTagSetList'
  1892. description: filter by domain tags
  1893. in: query
  1894. name: no_domain_tags
  1895. x-go-name: NoDomainTags
  1896. - description: 以资源是否共享过滤列表
  1897. in: query
  1898. name: is_public
  1899. type: boolean
  1900. x-go-name: IsPublic
  1901. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  1902. in: query
  1903. name: public_scope
  1904. type: string
  1905. x-go-name: PublicScope
  1906. - description: 以资源的状态过滤列表
  1907. in: query
  1908. items:
  1909. type: string
  1910. name: status
  1911. type: array
  1912. x-go-name: Status
  1913. - description: 根据平台过滤
  1914. in: query
  1915. items:
  1916. type: string
  1917. name: provider
  1918. type: array
  1919. x-go-name: Provider
  1920. - in: query
  1921. name: cloudaccount_id
  1922. type: string
  1923. x-go-name: CloudaccountId
  1924. - description: 根据云订阅过滤资源
  1925. in: query
  1926. name: manager_id
  1927. type: string
  1928. x-go-name: ManagerId
  1929. - description: 过滤子账号所在的权限组
  1930. in: query
  1931. name: clouduser_id
  1932. type: string
  1933. x-go-name: ClouduserId
  1934. - description: 根据权限过滤权限组
  1935. in: query
  1936. name: cloudpolicy_id
  1937. type: string
  1938. x-go-name: CloudpolicyId
  1939. responses:
  1940. "200":
  1941. $ref: '#/responses/cloudgroup_ListItemFilterOutput'
  1942. summary: 权限组列表
  1943. tags:
  1944. - cloudgroup
  1945. post:
  1946. description: 新建
  1947. operationId: cloudgroup_ValidateCreateData
  1948. parameters:
  1949. - in: body
  1950. name: body
  1951. schema:
  1952. properties:
  1953. cloudgroup:
  1954. $ref: '#/definitions/CloudgroupCreateInput'
  1955. count:
  1956. default: 1
  1957. format: int64
  1958. type: integer
  1959. x-go-name: Count
  1960. type: object
  1961. x-go-name: Body
  1962. responses:
  1963. "200":
  1964. $ref: '#/responses/cloudgroup_ValidateCreateDataOutput'
  1965. summary: 创建权限组
  1966. tags:
  1967. - cloudgroup
  1968. /cloudgroups/{id}:
  1969. delete:
  1970. description: 删除
  1971. operationId: cloudgroup_CustomizeDelete
  1972. parameters:
  1973. - description: The Id or Name of cloudgroup
  1974. in: path
  1975. name: id
  1976. required: true
  1977. type: string
  1978. x-go-name: Id
  1979. responses:
  1980. "200":
  1981. $ref: '#/responses/cloudgroup_CustomizeDeleteOutput'
  1982. summary: 删除权限组
  1983. tags:
  1984. - cloudgroup
  1985. get:
  1986. description: 获取详情
  1987. operationId: cloudgroup_FetchCustomizeColumns
  1988. parameters:
  1989. - description: The Id or Name of cloudgroup
  1990. in: path
  1991. name: id
  1992. required: true
  1993. type: string
  1994. x-go-name: Id
  1995. responses:
  1996. "200":
  1997. $ref: '#/responses/cloudgroup_FetchCustomizeColumnsOutput'
  1998. summary: 获取权限组详情
  1999. tags:
  2000. - cloudgroup
  2001. put:
  2002. description: 更新
  2003. operationId: cloudgroup_ValidateUpdateData
  2004. parameters:
  2005. - description: The Id or Name of cloudgroup
  2006. in: path
  2007. name: id
  2008. required: true
  2009. type: string
  2010. x-go-name: Id
  2011. - in: body
  2012. name: body
  2013. schema:
  2014. properties:
  2015. cloudgroup:
  2016. $ref: '#/definitions/CloudgroupUpdateInput'
  2017. type: object
  2018. x-go-name: Body
  2019. responses:
  2020. "200":
  2021. $ref: '#/responses/cloudgroup_ValidateUpdateDataOutput'
  2022. summary: 更新权限组
  2023. tags:
  2024. - cloudgroup
  2025. /cloudgroups/{id}/add-user:
  2026. post:
  2027. description: '权限组状态必须为: available'
  2028. operationId: cloudgroup_PerformAddUser
  2029. parameters:
  2030. - description: The Id or Name of cloudgroup
  2031. in: path
  2032. name: id
  2033. required: true
  2034. type: string
  2035. x-go-name: Id
  2036. - in: body
  2037. name: body
  2038. schema:
  2039. properties:
  2040. cloudgroup:
  2041. $ref: '#/definitions/CloudgroupAddUserInput'
  2042. type: object
  2043. x-go-name: Body
  2044. responses:
  2045. "200":
  2046. $ref: '#/responses/cloudgroup_PerformAddUserOutput'
  2047. summary: 向权限组加入用户
  2048. tags:
  2049. - cloudgroup
  2050. /cloudgroups/{id}/attach-policy:
  2051. post:
  2052. description: '权限组状态必须为: available'
  2053. operationId: cloudgroup_PerformAttachPolicy
  2054. parameters:
  2055. - description: The Id or Name of cloudgroup
  2056. in: path
  2057. name: id
  2058. required: true
  2059. type: string
  2060. x-go-name: Id
  2061. - in: body
  2062. name: body
  2063. schema:
  2064. properties:
  2065. cloudgroup:
  2066. $ref: '#/definitions/CloudgroupAttachPolicyInput'
  2067. type: object
  2068. x-go-name: Body
  2069. responses:
  2070. "200":
  2071. $ref: '#/responses/cloudgroup_PerformAttachPolicyOutput'
  2072. summary: 向权限组添加权限
  2073. tags:
  2074. - cloudgroup
  2075. /cloudgroups/{id}/change-owner:
  2076. post:
  2077. description: 执行操作ChangeOwner
  2078. operationId: cloudgroup_PerformChangeOwner
  2079. parameters:
  2080. - description: The Id or Name of cloudgroup
  2081. in: path
  2082. name: id
  2083. required: true
  2084. type: string
  2085. x-go-name: Id
  2086. - in: body
  2087. name: body
  2088. schema:
  2089. properties:
  2090. cloudgroup:
  2091. $ref: '#/definitions/PerformChangeDomainOwnerInput'
  2092. type: object
  2093. x-go-name: Body
  2094. responses:
  2095. "200":
  2096. $ref: '#/responses/cloudgroup_PerformChangeOwnerOutput'
  2097. summary: 执行操作ChangeOwner
  2098. tags:
  2099. - cloudgroup
  2100. /cloudgroups/{id}/detach-policy:
  2101. post:
  2102. description: '权限组状态必须为: available'
  2103. operationId: cloudgroup_PerformDetachPolicy
  2104. parameters:
  2105. - description: The Id or Name of cloudgroup
  2106. in: path
  2107. name: id
  2108. required: true
  2109. type: string
  2110. x-go-name: Id
  2111. - in: body
  2112. name: body
  2113. schema:
  2114. properties:
  2115. cloudgroup:
  2116. $ref: '#/definitions/CloudgroupDetachPolicyInput'
  2117. type: object
  2118. x-go-name: Body
  2119. responses:
  2120. "200":
  2121. $ref: '#/responses/cloudgroup_PerformDetachPolicyOutput'
  2122. summary: 从权限组移除权限
  2123. tags:
  2124. - cloudgroup
  2125. /cloudgroups/{id}/metadata:
  2126. get:
  2127. description: 获取指定信息Metadata
  2128. operationId: cloudgroup_GetDetailsMetadata
  2129. parameters:
  2130. - description: |-
  2131. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  2132. 标签分为
  2133. 类型 | 说明 |
  2134. ----------|---------------------------------------------|
  2135. 系统标签 | 平台定义的标签 |
  2136. 用户标签 | key以user:为前缀,用户自定义标签 |
  2137. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  2138. in: query
  2139. items:
  2140. type: string
  2141. name: field
  2142. type: array
  2143. x-go-name: Field
  2144. - description: 按标签前缀过滤
  2145. in: query
  2146. name: prefix
  2147. type: string
  2148. x-go-name: Prefix
  2149. - description: The Id or Name of cloudgroup
  2150. in: path
  2151. name: id
  2152. required: true
  2153. type: string
  2154. x-go-name: Id
  2155. responses:
  2156. "200":
  2157. $ref: '#/responses/cloudgroup_GetDetailsMetadataOutput'
  2158. summary: 获取资源标签(元数据)
  2159. tags:
  2160. - cloudgroup
  2161. /cloudgroups/{id}/private:
  2162. post:
  2163. description: 执行操作Private
  2164. operationId: cloudgroup_PerformPrivate
  2165. parameters:
  2166. - description: The Id or Name of cloudgroup
  2167. in: path
  2168. name: id
  2169. required: true
  2170. type: string
  2171. x-go-name: Id
  2172. - in: body
  2173. name: body
  2174. schema:
  2175. properties:
  2176. cloudgroup:
  2177. $ref: '#/definitions/PerformPrivateInput'
  2178. type: object
  2179. x-go-name: Body
  2180. responses:
  2181. "200":
  2182. $ref: '#/responses/cloudgroup_PerformPrivateOutput'
  2183. summary: 执行操作Private
  2184. tags:
  2185. - cloudgroup
  2186. /cloudgroups/{id}/public:
  2187. post:
  2188. description: 执行操作Public
  2189. operationId: cloudgroup_PerformPublic
  2190. parameters:
  2191. - description: The Id or Name of cloudgroup
  2192. in: path
  2193. name: id
  2194. required: true
  2195. type: string
  2196. x-go-name: Id
  2197. - in: body
  2198. name: body
  2199. schema:
  2200. properties:
  2201. cloudgroup:
  2202. $ref: '#/definitions/PerformPublicDomainInput'
  2203. type: object
  2204. x-go-name: Body
  2205. responses:
  2206. "200":
  2207. $ref: '#/responses/cloudgroup_PerformPublicOutput'
  2208. summary: 执行操作Public
  2209. tags:
  2210. - cloudgroup
  2211. /cloudgroups/{id}/remove-user:
  2212. post:
  2213. description: '权限组状态必须为: available'
  2214. operationId: cloudgroup_PerformRemoveUser
  2215. parameters:
  2216. - description: The Id or Name of cloudgroup
  2217. in: path
  2218. name: id
  2219. required: true
  2220. type: string
  2221. x-go-name: Id
  2222. - in: body
  2223. name: body
  2224. schema:
  2225. properties:
  2226. cloudgroup:
  2227. $ref: '#/definitions/CloudgroupRemoveUserInput'
  2228. type: object
  2229. x-go-name: Body
  2230. responses:
  2231. "200":
  2232. $ref: '#/responses/cloudgroup_PerformRemoveUserOutput'
  2233. summary: 从权限组移除用户
  2234. tags:
  2235. - cloudgroup
  2236. /cloudgroups/{id}/saml:
  2237. get:
  2238. description: 获取指定信息Saml
  2239. operationId: cloudgroup_GetDetailsSaml
  2240. parameters:
  2241. - description: The Id or Name of cloudgroup
  2242. in: path
  2243. name: id
  2244. required: true
  2245. type: string
  2246. x-go-name: Id
  2247. responses:
  2248. "200":
  2249. $ref: '#/responses/cloudgroup_GetDetailsSamlOutput'
  2250. summary: 获取指定信息Saml
  2251. tags:
  2252. - cloudgroup
  2253. /cloudgroups/{id}/set-policies:
  2254. post:
  2255. description: '权限组状态必须为: available'
  2256. operationId: cloudgroup_PerformSetPolicies
  2257. parameters:
  2258. - description: The Id or Name of cloudgroup
  2259. in: path
  2260. name: id
  2261. required: true
  2262. type: string
  2263. x-go-name: Id
  2264. - in: body
  2265. name: body
  2266. schema:
  2267. properties:
  2268. cloudgroup:
  2269. $ref: '#/definitions/CloudgroupSetPoliciesInput'
  2270. type: object
  2271. x-go-name: Body
  2272. responses:
  2273. "200":
  2274. $ref: '#/responses/cloudgroup_PerformSetPoliciesOutput'
  2275. summary: 设置权限组添权限(全量覆盖)
  2276. tags:
  2277. - cloudgroup
  2278. /cloudgroups/{id}/set-users:
  2279. post:
  2280. description: '权限组状态必须为: available'
  2281. operationId: cloudgroup_PerformSetUsers
  2282. parameters:
  2283. - description: The Id or Name of cloudgroup
  2284. in: path
  2285. name: id
  2286. required: true
  2287. type: string
  2288. x-go-name: Id
  2289. - in: body
  2290. name: body
  2291. schema:
  2292. properties:
  2293. cloudgroup:
  2294. $ref: '#/definitions/CloudgroupSetUsersInput'
  2295. type: object
  2296. x-go-name: Body
  2297. responses:
  2298. "200":
  2299. $ref: '#/responses/cloudgroup_PerformSetUsersOutput'
  2300. summary: 设置权限组用户(全量覆盖)
  2301. tags:
  2302. - cloudgroup
  2303. /cloudgroups/{id}/status:
  2304. get:
  2305. description: 获取指定信息Status
  2306. operationId: cloudgroup_GetDetailsStatus
  2307. parameters:
  2308. - description: The Id or Name of cloudgroup
  2309. in: path
  2310. name: id
  2311. required: true
  2312. type: string
  2313. x-go-name: Id
  2314. responses:
  2315. "200":
  2316. $ref: '#/responses/cloudgroup_GetDetailsStatusOutput'
  2317. summary: 获取资源状态
  2318. tags:
  2319. - cloudgroup
  2320. /cloudgroups/{id}/syncstatus:
  2321. post:
  2322. description: 执行操作Syncstatus
  2323. operationId: cloudgroup_PerformSyncstatus
  2324. parameters:
  2325. - description: The Id or Name of cloudgroup
  2326. in: path
  2327. name: id
  2328. required: true
  2329. type: string
  2330. x-go-name: Id
  2331. - in: body
  2332. name: body
  2333. schema:
  2334. properties:
  2335. cloudgroup:
  2336. $ref: '#/definitions/CloudgroupSyncstatusInput'
  2337. type: object
  2338. x-go-name: Body
  2339. responses:
  2340. "200":
  2341. $ref: '#/responses/cloudgroup_PerformSyncstatusOutput'
  2342. summary: 恢复权限组状态
  2343. tags:
  2344. - cloudgroup
  2345. /cloudpolicies:
  2346. get:
  2347. description: 列表
  2348. operationId: cloudpolicy_ListItemFilter
  2349. parameters:
  2350. - default: 20
  2351. description: 查询限制量
  2352. format: int64
  2353. in: query
  2354. name: limit
  2355. type: integer
  2356. x-go-name: Limit
  2357. - default: 0
  2358. description: 查询偏移量
  2359. format: int64
  2360. in: query
  2361. name: offset
  2362. type: integer
  2363. x-go-name: Offset
  2364. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  2365. in: query
  2366. items:
  2367. type: string
  2368. name: order_by
  2369. type: array
  2370. x-go-name: OrderBy
  2371. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  2372. example: desc|asc
  2373. in: query
  2374. name: order
  2375. type: string
  2376. x-go-name: Order
  2377. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  2378. in: query
  2379. name: details
  2380. type: boolean
  2381. x-go-name: Details
  2382. - description: 模糊搜索所有字段
  2383. in: query
  2384. name: search
  2385. type: string
  2386. x-go-name: Search
  2387. - description: |-
  2388. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  2389. 支持的操作符如下:
  2390. 操作符 | 参数个数 | 举例 | 说明 |
  2391. ---------------|----------|------------------------------------------------|-----------------------------|
  2392. in | > 0 | name.in("test", "good") | 在给定数组中 |
  2393. notin | > 0 | name.notin('test') | 不在给定数组中 |
  2394. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  2395. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  2396. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  2397. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  2398. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  2399. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  2400. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  2401. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  2402. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  2403. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  2404. notequals | 1 | name.notequals('test') | 不等于给定值 |
  2405. isnull | 0 | name.isnull() | 值为SQL的NULL |
  2406. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  2407. isempty | 0 | name.isempty('test') | 值为空字符串 |
  2408. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  2409. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  2410. in: query
  2411. items:
  2412. type: string
  2413. name: filter
  2414. type: array
  2415. x-go-name: Filter
  2416. - description: |-
  2417. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  2418. 和其他表关联的语法如下:
  2419. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  2420. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  2421. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  2422. 举例:
  2423. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  2424. in: query
  2425. items:
  2426. type: string
  2427. name: joint_filter
  2428. type: array
  2429. x-go-name: JointFilter
  2430. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  2431. in: query
  2432. name: filter_any
  2433. type: boolean
  2434. x-go-name: FilterAny
  2435. - description: 返回结果只包含指定的字段
  2436. in: query
  2437. items:
  2438. type: string
  2439. name: field
  2440. type: array
  2441. x-go-name: Field
  2442. - description: 用于数据导出,指定导出的数据字段
  2443. in: query
  2444. name: export_keys
  2445. type: string
  2446. x-go-name: ExportKeys
  2447. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  2448. in: query
  2449. name: show_fail_reason
  2450. type: boolean
  2451. x-go-name: ShowFailReason
  2452. - description: 是否返回状态统计信息,默认为False
  2453. in: query
  2454. name: summary_stats
  2455. type: boolean
  2456. x-go-name: SummaryStats
  2457. - $ref: '#/definitions/TTagSet'
  2458. description: 通过标签过滤(包含这些标签)
  2459. in: query
  2460. name: tags
  2461. x-go-name: Tags
  2462. - $ref: '#/definitions/TTagSetList'
  2463. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  2464. in: query
  2465. name: obj_tags
  2466. x-go-name: ObjTags
  2467. - $ref: '#/definitions/TTagSet'
  2468. description: 通过标签过滤(不包含这些标签)
  2469. in: query
  2470. name: no_tags
  2471. x-go-name: NoTags
  2472. - $ref: '#/definitions/TTagSetList'
  2473. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  2474. in: query
  2475. name: no_obj_tags
  2476. x-go-name: NoObjTags
  2477. - description: 通过标签排序
  2478. in: query
  2479. name: order_by_tag
  2480. type: string
  2481. x-go-name: OrderByTag
  2482. - description: |-
  2483. deprecated
  2484. 返回资源的标签不包含用户标签
  2485. in: query
  2486. name: without_user_meta
  2487. type: boolean
  2488. x-go-name: WithoutUserMeta
  2489. - description: 返回包含用户标签的资源
  2490. in: query
  2491. name: with_user_meta
  2492. type: boolean
  2493. x-go-name: WithUserMeta
  2494. - description: 返回包含外部标签的资源
  2495. in: query
  2496. name: with_cloud_meta
  2497. type: boolean
  2498. x-go-name: WithCloudMeta
  2499. - description: 返回包含任意标签的资源
  2500. in: query
  2501. name: with_any_meta
  2502. type: boolean
  2503. x-go-name: WithAnyMeta
  2504. - description: 返回列表数据中包含资源的标签数据(Metadata)
  2505. in: query
  2506. name: with_meta
  2507. type: boolean
  2508. x-go-name: WithMeta
  2509. - description: 显示所有的资源,包括模拟的资源
  2510. in: query
  2511. name: show_emulated
  2512. type: boolean
  2513. x-go-name: ShowEmulated
  2514. - description: 以资源ID过滤列表
  2515. in: query
  2516. items:
  2517. type: string
  2518. name: id
  2519. type: array
  2520. x-go-name: Ids
  2521. - description: 以资源名称过滤列表
  2522. in: query
  2523. items:
  2524. type: string
  2525. name: name
  2526. type: array
  2527. x-go-name: Names
  2528. - description: 指定查询的权限范围,可能值为project, domain or system
  2529. in: query
  2530. name: scope
  2531. type: string
  2532. x-go-name: Scope
  2533. - description: 指定项目归属域名称或ID
  2534. in: query
  2535. name: project_domain_id
  2536. type: string
  2537. x-go-name: ProjectDomainId
  2538. - description: 对具有域属性的资源,严格匹配域ID
  2539. in: query
  2540. items:
  2541. type: string
  2542. name: project_domain_ids
  2543. type: array
  2544. x-go-name: ProjectDomainIds
  2545. - description: 按domain名称排序,可能值为asc|desc
  2546. in: query
  2547. name: order_by_domain
  2548. pattern: asc|desc
  2549. type: string
  2550. x-go-name: OrderByDomain
  2551. - $ref: '#/definitions/TTagSetList'
  2552. description: filter by domain tags
  2553. in: query
  2554. name: domain_tags
  2555. x-go-name: DomainTags
  2556. - $ref: '#/definitions/TTagSetList'
  2557. description: filter by domain tags
  2558. in: query
  2559. name: no_domain_tags
  2560. x-go-name: NoDomainTags
  2561. - description: 以资源是否共享过滤列表
  2562. in: query
  2563. name: is_public
  2564. type: boolean
  2565. x-go-name: IsPublic
  2566. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  2567. in: query
  2568. name: public_scope
  2569. type: string
  2570. x-go-name: PublicScope
  2571. - description: 以资源的状态过滤列表
  2572. in: query
  2573. items:
  2574. type: string
  2575. name: status
  2576. type: array
  2577. x-go-name: Status
  2578. - in: query
  2579. name: cloudaccount_id
  2580. type: string
  2581. x-go-name: CloudaccountId
  2582. - description: 根据平台过滤
  2583. in: query
  2584. items:
  2585. type: string
  2586. name: provider
  2587. type: array
  2588. x-go-name: Provider
  2589. - description: 根据子账号过滤权限
  2590. in: query
  2591. name: clouduser_id
  2592. type: string
  2593. x-go-name: ClouduserId
  2594. - description: 根据权限组过滤权限
  2595. in: query
  2596. name: cloudgroup_id
  2597. type: string
  2598. x-go-name: CloudgroupId
  2599. - description: 根据订阅过滤权限
  2600. in: query
  2601. name: manager_id
  2602. type: string
  2603. x-go-name: ManagerId
  2604. - description: |-
  2605. 权限类型
  2606. 类型 | 说明 |
  2607. ---------| ------------ |
  2608. system | 过滤系统权限 |
  2609. custom | 过滤自定义权限 |
  2610. in: query
  2611. name: policy_type
  2612. type: string
  2613. x-go-name: PolicyType
  2614. responses:
  2615. "200":
  2616. $ref: '#/responses/cloudpolicy_ListItemFilterOutput'
  2617. summary: 公有云权限列表
  2618. tags:
  2619. - cloudpolicy
  2620. /cloudpolicies/{id}:
  2621. delete:
  2622. description: 删除
  2623. operationId: cloudpolicy_CustomizeDelete
  2624. parameters:
  2625. - description: The Id or Name of cloudpolicy
  2626. in: path
  2627. name: id
  2628. required: true
  2629. type: string
  2630. x-go-name: Id
  2631. responses:
  2632. "200":
  2633. $ref: '#/responses/cloudpolicy_CustomizeDeleteOutput'
  2634. summary: 删除
  2635. tags:
  2636. - cloudpolicy
  2637. get:
  2638. description: 获取详情
  2639. operationId: cloudpolicy_FetchCustomizeColumns
  2640. parameters:
  2641. - description: The Id or Name of cloudpolicy
  2642. in: path
  2643. name: id
  2644. required: true
  2645. type: string
  2646. x-go-name: Id
  2647. responses:
  2648. "200":
  2649. $ref: '#/responses/cloudpolicy_FetchCustomizeColumnsOutput'
  2650. summary: 获取公有云权限详情
  2651. tags:
  2652. - cloudpolicy
  2653. /cloudpolicies/{id}/change-owner:
  2654. post:
  2655. description: 执行操作ChangeOwner
  2656. operationId: cloudpolicy_PerformChangeOwner
  2657. parameters:
  2658. - description: The Id or Name of cloudpolicy
  2659. in: path
  2660. name: id
  2661. required: true
  2662. type: string
  2663. x-go-name: Id
  2664. - in: body
  2665. name: body
  2666. schema:
  2667. properties:
  2668. cloudpolicy:
  2669. $ref: '#/definitions/PerformChangeDomainOwnerInput'
  2670. type: object
  2671. x-go-name: Body
  2672. responses:
  2673. "200":
  2674. $ref: '#/responses/cloudpolicy_PerformChangeOwnerOutput'
  2675. summary: 执行操作ChangeOwner
  2676. tags:
  2677. - cloudpolicy
  2678. /cloudpolicies/{id}/metadata:
  2679. get:
  2680. description: 获取指定信息Metadata
  2681. operationId: cloudpolicy_GetDetailsMetadata
  2682. parameters:
  2683. - description: |-
  2684. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  2685. 标签分为
  2686. 类型 | 说明 |
  2687. ----------|---------------------------------------------|
  2688. 系统标签 | 平台定义的标签 |
  2689. 用户标签 | key以user:为前缀,用户自定义标签 |
  2690. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  2691. in: query
  2692. items:
  2693. type: string
  2694. name: field
  2695. type: array
  2696. x-go-name: Field
  2697. - description: 按标签前缀过滤
  2698. in: query
  2699. name: prefix
  2700. type: string
  2701. x-go-name: Prefix
  2702. - description: The Id or Name of cloudpolicy
  2703. in: path
  2704. name: id
  2705. required: true
  2706. type: string
  2707. x-go-name: Id
  2708. responses:
  2709. "200":
  2710. $ref: '#/responses/cloudpolicy_GetDetailsMetadataOutput'
  2711. summary: 获取资源标签(元数据)
  2712. tags:
  2713. - cloudpolicy
  2714. /cloudpolicies/{id}/private:
  2715. post:
  2716. description: 执行操作Private
  2717. operationId: cloudpolicy_PerformPrivate
  2718. parameters:
  2719. - description: The Id or Name of cloudpolicy
  2720. in: path
  2721. name: id
  2722. required: true
  2723. type: string
  2724. x-go-name: Id
  2725. - in: body
  2726. name: body
  2727. schema:
  2728. properties:
  2729. cloudpolicy:
  2730. $ref: '#/definitions/PerformPrivateInput'
  2731. type: object
  2732. x-go-name: Body
  2733. responses:
  2734. "200":
  2735. $ref: '#/responses/cloudpolicy_PerformPrivateOutput'
  2736. summary: 执行操作Private
  2737. tags:
  2738. - cloudpolicy
  2739. /cloudpolicies/{id}/public:
  2740. post:
  2741. description: 执行操作Public
  2742. operationId: cloudpolicy_PerformPublic
  2743. parameters:
  2744. - description: The Id or Name of cloudpolicy
  2745. in: path
  2746. name: id
  2747. required: true
  2748. type: string
  2749. x-go-name: Id
  2750. - in: body
  2751. name: body
  2752. schema:
  2753. properties:
  2754. cloudpolicy:
  2755. $ref: '#/definitions/PerformPublicDomainInput'
  2756. type: object
  2757. x-go-name: Body
  2758. responses:
  2759. "200":
  2760. $ref: '#/responses/cloudpolicy_PerformPublicOutput'
  2761. summary: 执行操作Public
  2762. tags:
  2763. - cloudpolicy
  2764. /cloudpolicies/{id}/status:
  2765. get:
  2766. description: 获取指定信息Status
  2767. operationId: cloudpolicy_GetDetailsStatus
  2768. parameters:
  2769. - description: The Id or Name of cloudpolicy
  2770. in: path
  2771. name: id
  2772. required: true
  2773. type: string
  2774. x-go-name: Id
  2775. responses:
  2776. "200":
  2777. $ref: '#/responses/cloudpolicy_GetDetailsStatusOutput'
  2778. summary: 获取资源状态
  2779. tags:
  2780. - cloudpolicy
  2781. /cloudroles:
  2782. get:
  2783. description: 列表
  2784. operationId: cloudrole_ListItemFilter
  2785. parameters:
  2786. - default: 20
  2787. description: 查询限制量
  2788. format: int64
  2789. in: query
  2790. name: limit
  2791. type: integer
  2792. x-go-name: Limit
  2793. - default: 0
  2794. description: 查询偏移量
  2795. format: int64
  2796. in: query
  2797. name: offset
  2798. type: integer
  2799. x-go-name: Offset
  2800. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  2801. in: query
  2802. items:
  2803. type: string
  2804. name: order_by
  2805. type: array
  2806. x-go-name: OrderBy
  2807. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  2808. example: desc|asc
  2809. in: query
  2810. name: order
  2811. type: string
  2812. x-go-name: Order
  2813. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  2814. in: query
  2815. name: details
  2816. type: boolean
  2817. x-go-name: Details
  2818. - description: 模糊搜索所有字段
  2819. in: query
  2820. name: search
  2821. type: string
  2822. x-go-name: Search
  2823. - description: |-
  2824. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  2825. 支持的操作符如下:
  2826. 操作符 | 参数个数 | 举例 | 说明 |
  2827. ---------------|----------|------------------------------------------------|-----------------------------|
  2828. in | > 0 | name.in("test", "good") | 在给定数组中 |
  2829. notin | > 0 | name.notin('test') | 不在给定数组中 |
  2830. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  2831. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  2832. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  2833. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  2834. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  2835. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  2836. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  2837. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  2838. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  2839. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  2840. notequals | 1 | name.notequals('test') | 不等于给定值 |
  2841. isnull | 0 | name.isnull() | 值为SQL的NULL |
  2842. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  2843. isempty | 0 | name.isempty('test') | 值为空字符串 |
  2844. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  2845. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  2846. in: query
  2847. items:
  2848. type: string
  2849. name: filter
  2850. type: array
  2851. x-go-name: Filter
  2852. - description: |-
  2853. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  2854. 和其他表关联的语法如下:
  2855. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  2856. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  2857. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  2858. 举例:
  2859. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  2860. in: query
  2861. items:
  2862. type: string
  2863. name: joint_filter
  2864. type: array
  2865. x-go-name: JointFilter
  2866. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  2867. in: query
  2868. name: filter_any
  2869. type: boolean
  2870. x-go-name: FilterAny
  2871. - description: 返回结果只包含指定的字段
  2872. in: query
  2873. items:
  2874. type: string
  2875. name: field
  2876. type: array
  2877. x-go-name: Field
  2878. - description: 用于数据导出,指定导出的数据字段
  2879. in: query
  2880. name: export_keys
  2881. type: string
  2882. x-go-name: ExportKeys
  2883. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  2884. in: query
  2885. name: show_fail_reason
  2886. type: boolean
  2887. x-go-name: ShowFailReason
  2888. - description: 是否返回状态统计信息,默认为False
  2889. in: query
  2890. name: summary_stats
  2891. type: boolean
  2892. x-go-name: SummaryStats
  2893. - $ref: '#/definitions/TTagSet'
  2894. description: 通过标签过滤(包含这些标签)
  2895. in: query
  2896. name: tags
  2897. x-go-name: Tags
  2898. - $ref: '#/definitions/TTagSetList'
  2899. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  2900. in: query
  2901. name: obj_tags
  2902. x-go-name: ObjTags
  2903. - $ref: '#/definitions/TTagSet'
  2904. description: 通过标签过滤(不包含这些标签)
  2905. in: query
  2906. name: no_tags
  2907. x-go-name: NoTags
  2908. - $ref: '#/definitions/TTagSetList'
  2909. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  2910. in: query
  2911. name: no_obj_tags
  2912. x-go-name: NoObjTags
  2913. - description: 通过标签排序
  2914. in: query
  2915. name: order_by_tag
  2916. type: string
  2917. x-go-name: OrderByTag
  2918. - description: |-
  2919. deprecated
  2920. 返回资源的标签不包含用户标签
  2921. in: query
  2922. name: without_user_meta
  2923. type: boolean
  2924. x-go-name: WithoutUserMeta
  2925. - description: 返回包含用户标签的资源
  2926. in: query
  2927. name: with_user_meta
  2928. type: boolean
  2929. x-go-name: WithUserMeta
  2930. - description: 返回包含外部标签的资源
  2931. in: query
  2932. name: with_cloud_meta
  2933. type: boolean
  2934. x-go-name: WithCloudMeta
  2935. - description: 返回包含任意标签的资源
  2936. in: query
  2937. name: with_any_meta
  2938. type: boolean
  2939. x-go-name: WithAnyMeta
  2940. - description: 返回列表数据中包含资源的标签数据(Metadata)
  2941. in: query
  2942. name: with_meta
  2943. type: boolean
  2944. x-go-name: WithMeta
  2945. - description: 显示所有的资源,包括模拟的资源
  2946. in: query
  2947. name: show_emulated
  2948. type: boolean
  2949. x-go-name: ShowEmulated
  2950. - description: 以资源ID过滤列表
  2951. in: query
  2952. items:
  2953. type: string
  2954. name: id
  2955. type: array
  2956. x-go-name: Ids
  2957. - description: 以资源名称过滤列表
  2958. in: query
  2959. items:
  2960. type: string
  2961. name: name
  2962. type: array
  2963. x-go-name: Names
  2964. - description: 指定查询的权限范围,可能值为project, domain or system
  2965. in: query
  2966. name: scope
  2967. type: string
  2968. x-go-name: Scope
  2969. - description: 指定项目归属域名称或ID
  2970. in: query
  2971. name: project_domain_id
  2972. type: string
  2973. x-go-name: ProjectDomainId
  2974. - description: 对具有域属性的资源,严格匹配域ID
  2975. in: query
  2976. items:
  2977. type: string
  2978. name: project_domain_ids
  2979. type: array
  2980. x-go-name: ProjectDomainIds
  2981. - description: 按domain名称排序,可能值为asc|desc
  2982. in: query
  2983. name: order_by_domain
  2984. pattern: asc|desc
  2985. type: string
  2986. x-go-name: OrderByDomain
  2987. - $ref: '#/definitions/TTagSetList'
  2988. description: filter by domain tags
  2989. in: query
  2990. name: domain_tags
  2991. x-go-name: DomainTags
  2992. - $ref: '#/definitions/TTagSetList'
  2993. description: filter by domain tags
  2994. in: query
  2995. name: no_domain_tags
  2996. x-go-name: NoDomainTags
  2997. - description: 以资源是否共享过滤列表
  2998. in: query
  2999. name: is_public
  3000. type: boolean
  3001. x-go-name: IsPublic
  3002. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  3003. in: query
  3004. name: public_scope
  3005. type: string
  3006. x-go-name: PublicScope
  3007. - description: 以资源的状态过滤列表
  3008. in: query
  3009. items:
  3010. type: string
  3011. name: status
  3012. type: array
  3013. x-go-name: Status
  3014. - description: 根据平台过滤
  3015. in: query
  3016. items:
  3017. type: string
  3018. name: provider
  3019. type: array
  3020. x-go-name: Provider
  3021. - in: query
  3022. name: cloudaccount_id
  3023. type: string
  3024. x-go-name: CloudaccountId
  3025. - description: 根据云订阅过滤资源
  3026. in: query
  3027. name: manager_id
  3028. type: string
  3029. x-go-name: ManagerId
  3030. - description: 根据权限组Id过滤资源
  3031. in: query
  3032. name: cloudgroup_id
  3033. type: string
  3034. x-go-name: CloudgroupId
  3035. responses:
  3036. "200":
  3037. $ref: '#/responses/cloudrole_ListItemFilterOutput'
  3038. summary: 公有云角色列表
  3039. tags:
  3040. - cloudrole
  3041. post:
  3042. description: 新建
  3043. operationId: cloudrole_ValidateCreateData
  3044. parameters:
  3045. - in: body
  3046. name: body
  3047. schema:
  3048. properties:
  3049. cloudrole:
  3050. $ref: '#/definitions/StatusInfrasResourceBaseCreateInput'
  3051. count:
  3052. default: 1
  3053. format: int64
  3054. type: integer
  3055. x-go-name: Count
  3056. type: object
  3057. x-go-name: Body
  3058. responses:
  3059. "200":
  3060. $ref: '#/responses/cloudrole_ValidateCreateDataOutput'
  3061. summary: 新建
  3062. tags:
  3063. - cloudrole
  3064. /cloudroles/{id}:
  3065. delete:
  3066. description: 删除
  3067. operationId: cloudrole_CustomizeDelete
  3068. parameters:
  3069. - description: The Id or Name of cloudrole
  3070. in: path
  3071. name: id
  3072. required: true
  3073. type: string
  3074. x-go-name: Id
  3075. responses:
  3076. "200":
  3077. $ref: '#/responses/cloudrole_CustomizeDeleteOutput'
  3078. summary: 删除公有云角色
  3079. tags:
  3080. - cloudrole
  3081. get:
  3082. description: 获取详情
  3083. operationId: cloudrole_FetchCustomizeColumns
  3084. parameters:
  3085. - description: The Id or Name of cloudrole
  3086. in: path
  3087. name: id
  3088. required: true
  3089. type: string
  3090. x-go-name: Id
  3091. responses:
  3092. "200":
  3093. $ref: '#/responses/cloudrole_FetchCustomizeColumnsOutput'
  3094. summary: 获取公有云角色详情
  3095. tags:
  3096. - cloudrole
  3097. put:
  3098. description: 更新
  3099. operationId: cloudrole_ValidateUpdateData
  3100. parameters:
  3101. - description: The Id or Name of cloudrole
  3102. in: path
  3103. name: id
  3104. required: true
  3105. type: string
  3106. x-go-name: Id
  3107. - in: body
  3108. name: body
  3109. schema:
  3110. properties:
  3111. cloudrole:
  3112. $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput'
  3113. type: object
  3114. x-go-name: Body
  3115. responses:
  3116. "200":
  3117. $ref: '#/responses/cloudrole_ValidateUpdateDataOutput'
  3118. summary: 更新
  3119. tags:
  3120. - cloudrole
  3121. /cloudroles/{id}/change-owner:
  3122. post:
  3123. description: 执行操作ChangeOwner
  3124. operationId: cloudrole_PerformChangeOwner
  3125. parameters:
  3126. - description: The Id or Name of cloudrole
  3127. in: path
  3128. name: id
  3129. required: true
  3130. type: string
  3131. x-go-name: Id
  3132. - in: body
  3133. name: body
  3134. schema:
  3135. properties:
  3136. cloudrole:
  3137. $ref: '#/definitions/PerformChangeDomainOwnerInput'
  3138. type: object
  3139. x-go-name: Body
  3140. responses:
  3141. "200":
  3142. $ref: '#/responses/cloudrole_PerformChangeOwnerOutput'
  3143. summary: 执行操作ChangeOwner
  3144. tags:
  3145. - cloudrole
  3146. /cloudroles/{id}/disable:
  3147. post:
  3148. description: 执行操作Disable
  3149. operationId: cloudrole_PerformDisable
  3150. parameters:
  3151. - description: The Id or Name of cloudrole
  3152. in: path
  3153. name: id
  3154. required: true
  3155. type: string
  3156. x-go-name: Id
  3157. - in: body
  3158. name: body
  3159. schema:
  3160. properties:
  3161. cloudrole:
  3162. $ref: '#/definitions/PerformDisableInput'
  3163. type: object
  3164. x-go-name: Body
  3165. responses:
  3166. "200":
  3167. $ref: '#/responses/cloudrole_PerformDisableOutput'
  3168. summary: 禁用资源
  3169. tags:
  3170. - cloudrole
  3171. /cloudroles/{id}/enable:
  3172. post:
  3173. description: 执行操作Enable
  3174. operationId: cloudrole_PerformEnable
  3175. parameters:
  3176. - description: The Id or Name of cloudrole
  3177. in: path
  3178. name: id
  3179. required: true
  3180. type: string
  3181. x-go-name: Id
  3182. - in: body
  3183. name: body
  3184. schema:
  3185. properties:
  3186. cloudrole:
  3187. $ref: '#/definitions/PerformEnableInput'
  3188. type: object
  3189. x-go-name: Body
  3190. responses:
  3191. "200":
  3192. $ref: '#/responses/cloudrole_PerformEnableOutput'
  3193. summary: 启用资源
  3194. tags:
  3195. - cloudrole
  3196. /cloudroles/{id}/metadata:
  3197. get:
  3198. description: 获取指定信息Metadata
  3199. operationId: cloudrole_GetDetailsMetadata
  3200. parameters:
  3201. - description: |-
  3202. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  3203. 标签分为
  3204. 类型 | 说明 |
  3205. ----------|---------------------------------------------|
  3206. 系统标签 | 平台定义的标签 |
  3207. 用户标签 | key以user:为前缀,用户自定义标签 |
  3208. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  3209. in: query
  3210. items:
  3211. type: string
  3212. name: field
  3213. type: array
  3214. x-go-name: Field
  3215. - description: 按标签前缀过滤
  3216. in: query
  3217. name: prefix
  3218. type: string
  3219. x-go-name: Prefix
  3220. - description: The Id or Name of cloudrole
  3221. in: path
  3222. name: id
  3223. required: true
  3224. type: string
  3225. x-go-name: Id
  3226. responses:
  3227. "200":
  3228. $ref: '#/responses/cloudrole_GetDetailsMetadataOutput'
  3229. summary: 获取资源标签(元数据)
  3230. tags:
  3231. - cloudrole
  3232. /cloudroles/{id}/private:
  3233. post:
  3234. description: 执行操作Private
  3235. operationId: cloudrole_PerformPrivate
  3236. parameters:
  3237. - description: The Id or Name of cloudrole
  3238. in: path
  3239. name: id
  3240. required: true
  3241. type: string
  3242. x-go-name: Id
  3243. - in: body
  3244. name: body
  3245. schema:
  3246. properties:
  3247. cloudrole:
  3248. $ref: '#/definitions/PerformPrivateInput'
  3249. type: object
  3250. x-go-name: Body
  3251. responses:
  3252. "200":
  3253. $ref: '#/responses/cloudrole_PerformPrivateOutput'
  3254. summary: 执行操作Private
  3255. tags:
  3256. - cloudrole
  3257. /cloudroles/{id}/public:
  3258. post:
  3259. description: 执行操作Public
  3260. operationId: cloudrole_PerformPublic
  3261. parameters:
  3262. - description: The Id or Name of cloudrole
  3263. in: path
  3264. name: id
  3265. required: true
  3266. type: string
  3267. x-go-name: Id
  3268. - in: body
  3269. name: body
  3270. schema:
  3271. properties:
  3272. cloudrole:
  3273. $ref: '#/definitions/PerformPublicDomainInput'
  3274. type: object
  3275. x-go-name: Body
  3276. responses:
  3277. "200":
  3278. $ref: '#/responses/cloudrole_PerformPublicOutput'
  3279. summary: 执行操作Public
  3280. tags:
  3281. - cloudrole
  3282. /cloudroles/{id}/status:
  3283. get:
  3284. description: 获取指定信息Status
  3285. operationId: cloudrole_GetDetailsStatus
  3286. parameters:
  3287. - description: The Id or Name of cloudrole
  3288. in: path
  3289. name: id
  3290. required: true
  3291. type: string
  3292. x-go-name: Id
  3293. responses:
  3294. "200":
  3295. $ref: '#/responses/cloudrole_GetDetailsStatusOutput'
  3296. summary: 获取资源状态
  3297. tags:
  3298. - cloudrole
  3299. /cloudusers:
  3300. get:
  3301. description: 列表
  3302. operationId: clouduser_ListItemFilter
  3303. parameters:
  3304. - default: 20
  3305. description: 查询限制量
  3306. format: int64
  3307. in: query
  3308. name: limit
  3309. type: integer
  3310. x-go-name: Limit
  3311. - default: 0
  3312. description: 查询偏移量
  3313. format: int64
  3314. in: query
  3315. name: offset
  3316. type: integer
  3317. x-go-name: Offset
  3318. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  3319. in: query
  3320. items:
  3321. type: string
  3322. name: order_by
  3323. type: array
  3324. x-go-name: OrderBy
  3325. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  3326. example: desc|asc
  3327. in: query
  3328. name: order
  3329. type: string
  3330. x-go-name: Order
  3331. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  3332. in: query
  3333. name: details
  3334. type: boolean
  3335. x-go-name: Details
  3336. - description: 模糊搜索所有字段
  3337. in: query
  3338. name: search
  3339. type: string
  3340. x-go-name: Search
  3341. - description: |-
  3342. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  3343. 支持的操作符如下:
  3344. 操作符 | 参数个数 | 举例 | 说明 |
  3345. ---------------|----------|------------------------------------------------|-----------------------------|
  3346. in | > 0 | name.in("test", "good") | 在给定数组中 |
  3347. notin | > 0 | name.notin('test') | 不在给定数组中 |
  3348. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  3349. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  3350. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  3351. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  3352. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  3353. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  3354. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  3355. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  3356. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  3357. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  3358. notequals | 1 | name.notequals('test') | 不等于给定值 |
  3359. isnull | 0 | name.isnull() | 值为SQL的NULL |
  3360. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  3361. isempty | 0 | name.isempty('test') | 值为空字符串 |
  3362. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  3363. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  3364. in: query
  3365. items:
  3366. type: string
  3367. name: filter
  3368. type: array
  3369. x-go-name: Filter
  3370. - description: |-
  3371. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  3372. 和其他表关联的语法如下:
  3373. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  3374. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  3375. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  3376. 举例:
  3377. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  3378. in: query
  3379. items:
  3380. type: string
  3381. name: joint_filter
  3382. type: array
  3383. x-go-name: JointFilter
  3384. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  3385. in: query
  3386. name: filter_any
  3387. type: boolean
  3388. x-go-name: FilterAny
  3389. - description: 返回结果只包含指定的字段
  3390. in: query
  3391. items:
  3392. type: string
  3393. name: field
  3394. type: array
  3395. x-go-name: Field
  3396. - description: 用于数据导出,指定导出的数据字段
  3397. in: query
  3398. name: export_keys
  3399. type: string
  3400. x-go-name: ExportKeys
  3401. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  3402. in: query
  3403. name: show_fail_reason
  3404. type: boolean
  3405. x-go-name: ShowFailReason
  3406. - description: 是否返回状态统计信息,默认为False
  3407. in: query
  3408. name: summary_stats
  3409. type: boolean
  3410. x-go-name: SummaryStats
  3411. - $ref: '#/definitions/TTagSet'
  3412. description: 通过标签过滤(包含这些标签)
  3413. in: query
  3414. name: tags
  3415. x-go-name: Tags
  3416. - $ref: '#/definitions/TTagSetList'
  3417. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  3418. in: query
  3419. name: obj_tags
  3420. x-go-name: ObjTags
  3421. - $ref: '#/definitions/TTagSet'
  3422. description: 通过标签过滤(不包含这些标签)
  3423. in: query
  3424. name: no_tags
  3425. x-go-name: NoTags
  3426. - $ref: '#/definitions/TTagSetList'
  3427. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  3428. in: query
  3429. name: no_obj_tags
  3430. x-go-name: NoObjTags
  3431. - description: 通过标签排序
  3432. in: query
  3433. name: order_by_tag
  3434. type: string
  3435. x-go-name: OrderByTag
  3436. - description: |-
  3437. deprecated
  3438. 返回资源的标签不包含用户标签
  3439. in: query
  3440. name: without_user_meta
  3441. type: boolean
  3442. x-go-name: WithoutUserMeta
  3443. - description: 返回包含用户标签的资源
  3444. in: query
  3445. name: with_user_meta
  3446. type: boolean
  3447. x-go-name: WithUserMeta
  3448. - description: 返回包含外部标签的资源
  3449. in: query
  3450. name: with_cloud_meta
  3451. type: boolean
  3452. x-go-name: WithCloudMeta
  3453. - description: 返回包含任意标签的资源
  3454. in: query
  3455. name: with_any_meta
  3456. type: boolean
  3457. x-go-name: WithAnyMeta
  3458. - description: 返回列表数据中包含资源的标签数据(Metadata)
  3459. in: query
  3460. name: with_meta
  3461. type: boolean
  3462. x-go-name: WithMeta
  3463. - description: 显示所有的资源,包括模拟的资源
  3464. in: query
  3465. name: show_emulated
  3466. type: boolean
  3467. x-go-name: ShowEmulated
  3468. - description: 以资源ID过滤列表
  3469. in: query
  3470. items:
  3471. type: string
  3472. name: id
  3473. type: array
  3474. x-go-name: Ids
  3475. - description: 以资源名称过滤列表
  3476. in: query
  3477. items:
  3478. type: string
  3479. name: name
  3480. type: array
  3481. x-go-name: Names
  3482. - description: 指定查询的权限范围,可能值为project, domain or system
  3483. in: query
  3484. name: scope
  3485. type: string
  3486. x-go-name: Scope
  3487. - description: 指定项目归属域名称或ID
  3488. in: query
  3489. name: project_domain_id
  3490. type: string
  3491. x-go-name: ProjectDomainId
  3492. - description: 对具有域属性的资源,严格匹配域ID
  3493. in: query
  3494. items:
  3495. type: string
  3496. name: project_domain_ids
  3497. type: array
  3498. x-go-name: ProjectDomainIds
  3499. - description: 按domain名称排序,可能值为asc|desc
  3500. in: query
  3501. name: order_by_domain
  3502. pattern: asc|desc
  3503. type: string
  3504. x-go-name: OrderByDomain
  3505. - $ref: '#/definitions/TTagSetList'
  3506. description: filter by domain tags
  3507. in: query
  3508. name: domain_tags
  3509. x-go-name: DomainTags
  3510. - $ref: '#/definitions/TTagSetList'
  3511. description: filter by domain tags
  3512. in: query
  3513. name: no_domain_tags
  3514. x-go-name: NoDomainTags
  3515. - description: 以资源的状态过滤列表
  3516. in: query
  3517. items:
  3518. type: string
  3519. name: status
  3520. type: array
  3521. x-go-name: Status
  3522. - description: 查询指定的用户(ID或名称)拥有的资源
  3523. in: query
  3524. name: user_id
  3525. type: string
  3526. x-go-name: UserId
  3527. - description: 根据平台过滤
  3528. in: query
  3529. items:
  3530. type: string
  3531. name: provider
  3532. type: array
  3533. x-go-name: Provider
  3534. - in: query
  3535. name: cloudaccount_id
  3536. type: string
  3537. x-go-name: CloudaccountId
  3538. - description: 根据云订阅过滤资源
  3539. in: query
  3540. name: manager_id
  3541. type: string
  3542. x-go-name: ManagerId
  3543. - description: 过滤绑定权限的子账号
  3544. in: query
  3545. name: cloudpolicy_id
  3546. type: string
  3547. x-go-name: CloudpolicyId
  3548. - description: 过滤属于指定权限组的子账号
  3549. in: query
  3550. name: cloudgroup_id
  3551. type: string
  3552. x-go-name: CloudgroupId
  3553. responses:
  3554. "200":
  3555. $ref: '#/responses/clouduser_ListItemFilterOutput'
  3556. summary: 公有云用户列表
  3557. tags:
  3558. - clouduser
  3559. post:
  3560. description: 新建
  3561. operationId: clouduser_ValidateCreateData
  3562. parameters:
  3563. - in: body
  3564. name: body
  3565. schema:
  3566. properties:
  3567. clouduser:
  3568. $ref: '#/definitions/ClouduserCreateInput'
  3569. count:
  3570. default: 1
  3571. format: int64
  3572. type: integer
  3573. x-go-name: Count
  3574. type: object
  3575. x-go-name: Body
  3576. responses:
  3577. "200":
  3578. $ref: '#/responses/clouduser_ValidateCreateDataOutput'
  3579. summary: 创建公有云用户
  3580. tags:
  3581. - clouduser
  3582. /cloudusers/{id}:
  3583. delete:
  3584. description: 删除
  3585. operationId: clouduser_CustomizeDelete
  3586. parameters:
  3587. - description: The Id or Name of clouduser
  3588. in: path
  3589. name: id
  3590. required: true
  3591. type: string
  3592. x-go-name: Id
  3593. responses:
  3594. "200":
  3595. $ref: '#/responses/clouduser_CustomizeDeleteOutput'
  3596. summary: 删除公有云用户
  3597. tags:
  3598. - clouduser
  3599. get:
  3600. description: 获取详情
  3601. operationId: clouduser_FetchCustomizeColumns
  3602. parameters:
  3603. - description: The Id or Name of clouduser
  3604. in: path
  3605. name: id
  3606. required: true
  3607. type: string
  3608. x-go-name: Id
  3609. responses:
  3610. "200":
  3611. $ref: '#/responses/clouduser_FetchCustomizeColumnsOutput'
  3612. summary: 获取公有云用户详情
  3613. tags:
  3614. - clouduser
  3615. /cloudusers/{id}/access-keys:
  3616. get:
  3617. description: 获取指定信息AccessKeys
  3618. operationId: clouduser_GetDetailsAccessKeys
  3619. parameters:
  3620. - description: The Id or Name of clouduser
  3621. in: path
  3622. name: id
  3623. required: true
  3624. type: string
  3625. x-go-name: Id
  3626. responses:
  3627. "200":
  3628. $ref: '#/responses/clouduser_GetDetailsAccessKeysOutput'
  3629. summary: 获取指定信息AccessKeys
  3630. tags:
  3631. - clouduser
  3632. /cloudusers/{id}/attach-policy:
  3633. post:
  3634. description: '用户状态必须为: available'
  3635. operationId: clouduser_PerformAttachPolicy
  3636. parameters:
  3637. - description: The Id or Name of clouduser
  3638. in: path
  3639. name: id
  3640. required: true
  3641. type: string
  3642. x-go-name: Id
  3643. - in: body
  3644. name: body
  3645. schema:
  3646. properties:
  3647. clouduser:
  3648. $ref: '#/definitions/ClouduserAttachPolicyInput'
  3649. type: object
  3650. x-go-name: Body
  3651. responses:
  3652. "200":
  3653. $ref: '#/responses/clouduser_PerformAttachPolicyOutput'
  3654. summary: 绑定用户权限
  3655. tags:
  3656. - clouduser
  3657. /cloudusers/{id}/change-owner:
  3658. post:
  3659. description: 执行操作ChangeOwner
  3660. operationId: clouduser_PerformChangeOwner
  3661. parameters:
  3662. - description: The Id or Name of clouduser
  3663. in: path
  3664. name: id
  3665. required: true
  3666. type: string
  3667. x-go-name: Id
  3668. - in: body
  3669. name: body
  3670. schema:
  3671. properties:
  3672. clouduser:
  3673. $ref: '#/definitions/ClouduserChangeOwnerInput'
  3674. type: object
  3675. x-go-name: Body
  3676. responses:
  3677. "200":
  3678. $ref: '#/responses/clouduser_PerformChangeOwnerOutput'
  3679. summary: 变更子账号所属本地用户
  3680. tags:
  3681. - clouduser
  3682. /cloudusers/{id}/create-access-key:
  3683. post:
  3684. description: 执行操作CreateAccessKey
  3685. operationId: clouduser_PerformCreateAccessKey
  3686. parameters:
  3687. - description: The Id or Name of clouduser
  3688. in: path
  3689. name: id
  3690. required: true
  3691. type: string
  3692. x-go-name: Id
  3693. - in: body
  3694. name: body
  3695. schema:
  3696. properties:
  3697. clouduser:
  3698. $ref: '#/definitions/ClouduserCreateAccessKeyInput'
  3699. type: object
  3700. x-go-name: Body
  3701. responses:
  3702. "200":
  3703. $ref: '#/responses/clouduser_PerformCreateAccessKeyOutput'
  3704. summary: 执行操作CreateAccessKey
  3705. tags:
  3706. - clouduser
  3707. /cloudusers/{id}/delete-access-key:
  3708. post:
  3709. description: 执行操作DeleteAccessKey
  3710. operationId: clouduser_PerformDeleteAccessKey
  3711. parameters:
  3712. - description: The Id or Name of clouduser
  3713. in: path
  3714. name: id
  3715. required: true
  3716. type: string
  3717. x-go-name: Id
  3718. - in: body
  3719. name: body
  3720. schema:
  3721. properties:
  3722. clouduser:
  3723. $ref: '#/definitions/ClouduserDeleteAccessKeyInput'
  3724. type: object
  3725. x-go-name: Body
  3726. responses:
  3727. "200":
  3728. $ref: '#/responses/clouduser_PerformDeleteAccessKeyOutput'
  3729. summary: 执行操作DeleteAccessKey
  3730. tags:
  3731. - clouduser
  3732. /cloudusers/{id}/detach-policy:
  3733. post:
  3734. description: '用户状态必须为: available'
  3735. operationId: clouduser_PerformDetachPolicy
  3736. parameters:
  3737. - description: The Id or Name of clouduser
  3738. in: path
  3739. name: id
  3740. required: true
  3741. type: string
  3742. x-go-name: Id
  3743. - in: body
  3744. name: body
  3745. schema:
  3746. properties:
  3747. clouduser:
  3748. $ref: '#/definitions/ClouduserDetachPolicyInput'
  3749. type: object
  3750. x-go-name: Body
  3751. responses:
  3752. "200":
  3753. $ref: '#/responses/clouduser_PerformDetachPolicyOutput'
  3754. summary: 解绑用户权限
  3755. tags:
  3756. - clouduser
  3757. /cloudusers/{id}/join-group:
  3758. post:
  3759. description: '用户状态必须为: available'
  3760. operationId: clouduser_PerformJoinGroup
  3761. parameters:
  3762. - description: The Id or Name of clouduser
  3763. in: path
  3764. name: id
  3765. required: true
  3766. type: string
  3767. x-go-name: Id
  3768. - in: body
  3769. name: body
  3770. schema:
  3771. properties:
  3772. clouduser:
  3773. $ref: '#/definitions/ClouduserJoinGroupInput'
  3774. type: object
  3775. x-go-name: Body
  3776. responses:
  3777. "200":
  3778. $ref: '#/responses/clouduser_PerformJoinGroupOutput'
  3779. summary: 将用户加入权限组
  3780. tags:
  3781. - clouduser
  3782. /cloudusers/{id}/leave-group:
  3783. post:
  3784. description: '用户状态必须为: available'
  3785. operationId: clouduser_PerformLeaveGroup
  3786. parameters:
  3787. - description: The Id or Name of clouduser
  3788. in: path
  3789. name: id
  3790. required: true
  3791. type: string
  3792. x-go-name: Id
  3793. - in: body
  3794. name: body
  3795. schema:
  3796. properties:
  3797. clouduser:
  3798. $ref: '#/definitions/ClouduserLeaveGroupInput'
  3799. type: object
  3800. x-go-name: Body
  3801. responses:
  3802. "200":
  3803. $ref: '#/responses/clouduser_PerformLeaveGroupOutput'
  3804. summary: 将用户从权限组中移除
  3805. tags:
  3806. - clouduser
  3807. /cloudusers/{id}/metadata:
  3808. get:
  3809. description: 获取指定信息Metadata
  3810. operationId: clouduser_GetDetailsMetadata
  3811. parameters:
  3812. - description: |-
  3813. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  3814. 标签分为
  3815. 类型 | 说明 |
  3816. ----------|---------------------------------------------|
  3817. 系统标签 | 平台定义的标签 |
  3818. 用户标签 | key以user:为前缀,用户自定义标签 |
  3819. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  3820. in: query
  3821. items:
  3822. type: string
  3823. name: field
  3824. type: array
  3825. x-go-name: Field
  3826. - description: 按标签前缀过滤
  3827. in: query
  3828. name: prefix
  3829. type: string
  3830. x-go-name: Prefix
  3831. - description: The Id or Name of clouduser
  3832. in: path
  3833. name: id
  3834. required: true
  3835. type: string
  3836. x-go-name: Id
  3837. responses:
  3838. "200":
  3839. $ref: '#/responses/clouduser_GetDetailsMetadataOutput'
  3840. summary: 获取资源标签(元数据)
  3841. tags:
  3842. - clouduser
  3843. /cloudusers/{id}/reset-password:
  3844. post:
  3845. description: '用户状态必须为: available'
  3846. operationId: clouduser_PerformResetPassword
  3847. parameters:
  3848. - description: The Id or Name of clouduser
  3849. in: path
  3850. name: id
  3851. required: true
  3852. type: string
  3853. x-go-name: Id
  3854. - in: body
  3855. name: body
  3856. schema:
  3857. properties:
  3858. clouduser:
  3859. $ref: '#/definitions/ClouduserResetPasswordInput'
  3860. type: object
  3861. x-go-name: Body
  3862. responses:
  3863. "200":
  3864. $ref: '#/responses/clouduser_PerformResetPasswordOutput'
  3865. summary: 重置用户密码
  3866. tags:
  3867. - clouduser
  3868. /cloudusers/{id}/set-groups:
  3869. post:
  3870. description: '用户状态必须为: available'
  3871. operationId: clouduser_PerformSetGroups
  3872. parameters:
  3873. - description: The Id or Name of clouduser
  3874. in: path
  3875. name: id
  3876. required: true
  3877. type: string
  3878. x-go-name: Id
  3879. - in: body
  3880. name: body
  3881. schema:
  3882. properties:
  3883. clouduser:
  3884. $ref: '#/definitions/ClouduserSetGroupsInput'
  3885. type: object
  3886. x-go-name: Body
  3887. responses:
  3888. "200":
  3889. $ref: '#/responses/clouduser_PerformSetGroupsOutput'
  3890. summary: 设置用户权限组列表(全量覆盖)
  3891. tags:
  3892. - clouduser
  3893. /cloudusers/{id}/set-policies:
  3894. post:
  3895. description: '用户状态必须为: available'
  3896. operationId: clouduser_PerformSetPolicies
  3897. parameters:
  3898. - description: The Id or Name of clouduser
  3899. in: path
  3900. name: id
  3901. required: true
  3902. type: string
  3903. x-go-name: Id
  3904. - in: body
  3905. name: body
  3906. schema:
  3907. properties:
  3908. clouduser:
  3909. $ref: '#/definitions/ClouduserSetPoliciesInput'
  3910. type: object
  3911. x-go-name: Body
  3912. responses:
  3913. "200":
  3914. $ref: '#/responses/clouduser_PerformSetPoliciesOutput'
  3915. summary: 设置用户权限列表(全量覆盖)
  3916. tags:
  3917. - clouduser
  3918. /cloudusers/{id}/status:
  3919. get:
  3920. description: 获取指定信息Status
  3921. operationId: clouduser_GetDetailsStatus
  3922. parameters:
  3923. - description: The Id or Name of clouduser
  3924. in: path
  3925. name: id
  3926. required: true
  3927. type: string
  3928. x-go-name: Id
  3929. responses:
  3930. "200":
  3931. $ref: '#/responses/clouduser_GetDetailsStatusOutput'
  3932. summary: 获取资源状态
  3933. tags:
  3934. - clouduser
  3935. /cloudusers/{id}/syncstatus:
  3936. post:
  3937. description: 执行操作Syncstatus
  3938. operationId: clouduser_PerformSyncstatus
  3939. parameters:
  3940. - description: The Id or Name of clouduser
  3941. in: path
  3942. name: id
  3943. required: true
  3944. type: string
  3945. x-go-name: Id
  3946. - in: body
  3947. name: body
  3948. schema:
  3949. properties:
  3950. clouduser:
  3951. $ref: '#/definitions/ClouduserSyncstatusInput'
  3952. type: object
  3953. x-go-name: Body
  3954. responses:
  3955. "200":
  3956. $ref: '#/responses/clouduser_PerformSyncstatusOutput'
  3957. summary: 同步用户状态
  3958. tags:
  3959. - clouduser
  3960. /saml_providers:
  3961. get:
  3962. description: 列表
  3963. operationId: saml_provider_ListItemFilter
  3964. parameters:
  3965. - default: 20
  3966. description: 查询限制量
  3967. format: int64
  3968. in: query
  3969. name: limit
  3970. type: integer
  3971. x-go-name: Limit
  3972. - default: 0
  3973. description: 查询偏移量
  3974. format: int64
  3975. in: query
  3976. name: offset
  3977. type: integer
  3978. x-go-name: Offset
  3979. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  3980. in: query
  3981. items:
  3982. type: string
  3983. name: order_by
  3984. type: array
  3985. x-go-name: OrderBy
  3986. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  3987. example: desc|asc
  3988. in: query
  3989. name: order
  3990. type: string
  3991. x-go-name: Order
  3992. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  3993. in: query
  3994. name: details
  3995. type: boolean
  3996. x-go-name: Details
  3997. - description: 模糊搜索所有字段
  3998. in: query
  3999. name: search
  4000. type: string
  4001. x-go-name: Search
  4002. - description: |-
  4003. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4004. 支持的操作符如下:
  4005. 操作符 | 参数个数 | 举例 | 说明 |
  4006. ---------------|----------|------------------------------------------------|-----------------------------|
  4007. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4008. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4009. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4010. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4011. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4012. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4013. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4014. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4015. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4016. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4017. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4018. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4019. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4020. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4021. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4022. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4023. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4024. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4025. in: query
  4026. items:
  4027. type: string
  4028. name: filter
  4029. type: array
  4030. x-go-name: Filter
  4031. - description: |-
  4032. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4033. 和其他表关联的语法如下:
  4034. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4035. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4036. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4037. 举例:
  4038. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4039. in: query
  4040. items:
  4041. type: string
  4042. name: joint_filter
  4043. type: array
  4044. x-go-name: JointFilter
  4045. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4046. in: query
  4047. name: filter_any
  4048. type: boolean
  4049. x-go-name: FilterAny
  4050. - description: 返回结果只包含指定的字段
  4051. in: query
  4052. items:
  4053. type: string
  4054. name: field
  4055. type: array
  4056. x-go-name: Field
  4057. - description: 用于数据导出,指定导出的数据字段
  4058. in: query
  4059. name: export_keys
  4060. type: string
  4061. x-go-name: ExportKeys
  4062. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4063. in: query
  4064. name: show_fail_reason
  4065. type: boolean
  4066. x-go-name: ShowFailReason
  4067. - description: 是否返回状态统计信息,默认为False
  4068. in: query
  4069. name: summary_stats
  4070. type: boolean
  4071. x-go-name: SummaryStats
  4072. - $ref: '#/definitions/TTagSet'
  4073. description: 通过标签过滤(包含这些标签)
  4074. in: query
  4075. name: tags
  4076. x-go-name: Tags
  4077. - $ref: '#/definitions/TTagSetList'
  4078. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4079. in: query
  4080. name: obj_tags
  4081. x-go-name: ObjTags
  4082. - $ref: '#/definitions/TTagSet'
  4083. description: 通过标签过滤(不包含这些标签)
  4084. in: query
  4085. name: no_tags
  4086. x-go-name: NoTags
  4087. - $ref: '#/definitions/TTagSetList'
  4088. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4089. in: query
  4090. name: no_obj_tags
  4091. x-go-name: NoObjTags
  4092. - description: 通过标签排序
  4093. in: query
  4094. name: order_by_tag
  4095. type: string
  4096. x-go-name: OrderByTag
  4097. - description: |-
  4098. deprecated
  4099. 返回资源的标签不包含用户标签
  4100. in: query
  4101. name: without_user_meta
  4102. type: boolean
  4103. x-go-name: WithoutUserMeta
  4104. - description: 返回包含用户标签的资源
  4105. in: query
  4106. name: with_user_meta
  4107. type: boolean
  4108. x-go-name: WithUserMeta
  4109. - description: 返回包含外部标签的资源
  4110. in: query
  4111. name: with_cloud_meta
  4112. type: boolean
  4113. x-go-name: WithCloudMeta
  4114. - description: 返回包含任意标签的资源
  4115. in: query
  4116. name: with_any_meta
  4117. type: boolean
  4118. x-go-name: WithAnyMeta
  4119. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4120. in: query
  4121. name: with_meta
  4122. type: boolean
  4123. x-go-name: WithMeta
  4124. - description: 显示所有的资源,包括模拟的资源
  4125. in: query
  4126. name: show_emulated
  4127. type: boolean
  4128. x-go-name: ShowEmulated
  4129. - description: 以资源ID过滤列表
  4130. in: query
  4131. items:
  4132. type: string
  4133. name: id
  4134. type: array
  4135. x-go-name: Ids
  4136. - description: 以资源名称过滤列表
  4137. in: query
  4138. items:
  4139. type: string
  4140. name: name
  4141. type: array
  4142. x-go-name: Names
  4143. - description: 指定查询的权限范围,可能值为project, domain or system
  4144. in: query
  4145. name: scope
  4146. type: string
  4147. x-go-name: Scope
  4148. - description: 指定项目归属域名称或ID
  4149. in: query
  4150. name: project_domain_id
  4151. type: string
  4152. x-go-name: ProjectDomainId
  4153. - description: 对具有域属性的资源,严格匹配域ID
  4154. in: query
  4155. items:
  4156. type: string
  4157. name: project_domain_ids
  4158. type: array
  4159. x-go-name: ProjectDomainIds
  4160. - description: 按domain名称排序,可能值为asc|desc
  4161. in: query
  4162. name: order_by_domain
  4163. pattern: asc|desc
  4164. type: string
  4165. x-go-name: OrderByDomain
  4166. - $ref: '#/definitions/TTagSetList'
  4167. description: filter by domain tags
  4168. in: query
  4169. name: domain_tags
  4170. x-go-name: DomainTags
  4171. - $ref: '#/definitions/TTagSetList'
  4172. description: filter by domain tags
  4173. in: query
  4174. name: no_domain_tags
  4175. x-go-name: NoDomainTags
  4176. - description: 以资源是否共享过滤列表
  4177. in: query
  4178. name: is_public
  4179. type: boolean
  4180. x-go-name: IsPublic
  4181. - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
  4182. in: query
  4183. name: public_scope
  4184. type: string
  4185. x-go-name: PublicScope
  4186. - description: 以资源的状态过滤列表
  4187. in: query
  4188. items:
  4189. type: string
  4190. name: status
  4191. type: array
  4192. x-go-name: Status
  4193. - description: 根据平台过滤
  4194. in: query
  4195. items:
  4196. type: string
  4197. name: provider
  4198. type: array
  4199. x-go-name: Provider
  4200. - in: query
  4201. name: cloudaccount_id
  4202. type: string
  4203. x-go-name: CloudaccountId
  4204. - description: 根据云订阅过滤资源
  4205. in: query
  4206. name: manager_id
  4207. type: string
  4208. x-go-name: ManagerId
  4209. responses:
  4210. "200":
  4211. $ref: '#/responses/saml_provider_ListItemFilterOutput'
  4212. summary: 公有云身份提供商列表
  4213. tags:
  4214. - saml_provider
  4215. post:
  4216. description: 新建
  4217. operationId: saml_provider_ValidateCreateData
  4218. parameters:
  4219. - in: body
  4220. name: body
  4221. schema:
  4222. properties:
  4223. count:
  4224. default: 1
  4225. format: int64
  4226. type: integer
  4227. x-go-name: Count
  4228. saml_provider:
  4229. $ref: '#/definitions/StatusInfrasResourceBaseCreateInput'
  4230. type: object
  4231. x-go-name: Body
  4232. responses:
  4233. "200":
  4234. $ref: '#/responses/saml_provider_ValidateCreateDataOutput'
  4235. summary: 新建
  4236. tags:
  4237. - saml_provider
  4238. /saml_providers/{id}:
  4239. delete:
  4240. description: 删除
  4241. operationId: saml_provider_CustomizeDelete
  4242. parameters:
  4243. - description: The Id or Name of saml_provider
  4244. in: path
  4245. name: id
  4246. required: true
  4247. type: string
  4248. x-go-name: Id
  4249. responses:
  4250. "200":
  4251. $ref: '#/responses/saml_provider_CustomizeDeleteOutput'
  4252. summary: 删除
  4253. tags:
  4254. - saml_provider
  4255. get:
  4256. description: 获取详情
  4257. operationId: saml_provider_FetchCustomizeColumns
  4258. parameters:
  4259. - description: The Id or Name of saml_provider
  4260. in: path
  4261. name: id
  4262. required: true
  4263. type: string
  4264. x-go-name: Id
  4265. responses:
  4266. "200":
  4267. $ref: '#/responses/saml_provider_FetchCustomizeColumnsOutput'
  4268. summary: 获取详情
  4269. tags:
  4270. - saml_provider
  4271. put:
  4272. description: 更新
  4273. operationId: saml_provider_ValidateUpdateData
  4274. parameters:
  4275. - description: The Id or Name of saml_provider
  4276. in: path
  4277. name: id
  4278. required: true
  4279. type: string
  4280. x-go-name: Id
  4281. - in: body
  4282. name: body
  4283. schema:
  4284. properties:
  4285. saml_provider:
  4286. $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput'
  4287. type: object
  4288. x-go-name: Body
  4289. responses:
  4290. "200":
  4291. $ref: '#/responses/saml_provider_ValidateUpdateDataOutput'
  4292. summary: 更新
  4293. tags:
  4294. - saml_provider
  4295. /saml_providers/{id}/change-owner:
  4296. post:
  4297. description: 执行操作ChangeOwner
  4298. operationId: saml_provider_PerformChangeOwner
  4299. parameters:
  4300. - description: The Id or Name of saml_provider
  4301. in: path
  4302. name: id
  4303. required: true
  4304. type: string
  4305. x-go-name: Id
  4306. - in: body
  4307. name: body
  4308. schema:
  4309. properties:
  4310. saml_provider:
  4311. $ref: '#/definitions/PerformChangeDomainOwnerInput'
  4312. type: object
  4313. x-go-name: Body
  4314. responses:
  4315. "200":
  4316. $ref: '#/responses/saml_provider_PerformChangeOwnerOutput'
  4317. summary: 执行操作ChangeOwner
  4318. tags:
  4319. - saml_provider
  4320. /saml_providers/{id}/metadata:
  4321. get:
  4322. description: 获取指定信息Metadata
  4323. operationId: saml_provider_GetDetailsMetadata
  4324. parameters:
  4325. - description: |-
  4326. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  4327. 标签分为
  4328. 类型 | 说明 |
  4329. ----------|---------------------------------------------|
  4330. 系统标签 | 平台定义的标签 |
  4331. 用户标签 | key以user:为前缀,用户自定义标签 |
  4332. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  4333. in: query
  4334. items:
  4335. type: string
  4336. name: field
  4337. type: array
  4338. x-go-name: Field
  4339. - description: 按标签前缀过滤
  4340. in: query
  4341. name: prefix
  4342. type: string
  4343. x-go-name: Prefix
  4344. - description: The Id or Name of saml_provider
  4345. in: path
  4346. name: id
  4347. required: true
  4348. type: string
  4349. x-go-name: Id
  4350. responses:
  4351. "200":
  4352. $ref: '#/responses/saml_provider_GetDetailsMetadataOutput'
  4353. summary: 获取资源标签(元数据)
  4354. tags:
  4355. - saml_provider
  4356. /saml_providers/{id}/private:
  4357. post:
  4358. description: 执行操作Private
  4359. operationId: saml_provider_PerformPrivate
  4360. parameters:
  4361. - description: The Id or Name of saml_provider
  4362. in: path
  4363. name: id
  4364. required: true
  4365. type: string
  4366. x-go-name: Id
  4367. - in: body
  4368. name: body
  4369. schema:
  4370. properties:
  4371. saml_provider:
  4372. $ref: '#/definitions/PerformPrivateInput'
  4373. type: object
  4374. x-go-name: Body
  4375. responses:
  4376. "200":
  4377. $ref: '#/responses/saml_provider_PerformPrivateOutput'
  4378. summary: 执行操作Private
  4379. tags:
  4380. - saml_provider
  4381. /saml_providers/{id}/public:
  4382. post:
  4383. description: 执行操作Public
  4384. operationId: saml_provider_PerformPublic
  4385. parameters:
  4386. - description: The Id or Name of saml_provider
  4387. in: path
  4388. name: id
  4389. required: true
  4390. type: string
  4391. x-go-name: Id
  4392. - in: body
  4393. name: body
  4394. schema:
  4395. properties:
  4396. saml_provider:
  4397. $ref: '#/definitions/PerformPublicDomainInput'
  4398. type: object
  4399. x-go-name: Body
  4400. responses:
  4401. "200":
  4402. $ref: '#/responses/saml_provider_PerformPublicOutput'
  4403. summary: 执行操作Public
  4404. tags:
  4405. - saml_provider
  4406. /saml_providers/{id}/status:
  4407. get:
  4408. description: 获取指定信息Status
  4409. operationId: saml_provider_GetDetailsStatus
  4410. parameters:
  4411. - description: The Id or Name of saml_provider
  4412. in: path
  4413. name: id
  4414. required: true
  4415. type: string
  4416. x-go-name: Id
  4417. responses:
  4418. "200":
  4419. $ref: '#/responses/saml_provider_GetDetailsStatusOutput'
  4420. summary: 获取资源状态
  4421. tags:
  4422. - saml_provider
  4423. /samlusers:
  4424. get:
  4425. description: 列表
  4426. operationId: samluser_ListItemFilter
  4427. parameters:
  4428. - default: 20
  4429. description: 查询限制量
  4430. format: int64
  4431. in: query
  4432. name: limit
  4433. type: integer
  4434. x-go-name: Limit
  4435. - default: 0
  4436. description: 查询偏移量
  4437. format: int64
  4438. in: query
  4439. name: offset
  4440. type: integer
  4441. x-go-name: Offset
  4442. - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
  4443. in: query
  4444. items:
  4445. type: string
  4446. name: order_by
  4447. type: array
  4448. x-go-name: OrderBy
  4449. - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
  4450. example: desc|asc
  4451. in: query
  4452. name: order
  4453. type: string
  4454. x-go-name: Order
  4455. - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
  4456. in: query
  4457. name: details
  4458. type: boolean
  4459. x-go-name: Details
  4460. - description: 模糊搜索所有字段
  4461. in: query
  4462. name: search
  4463. type: string
  4464. x-go-name: Search
  4465. - description: |-
  4466. 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
  4467. 支持的操作符如下:
  4468. 操作符 | 参数个数 | 举例 | 说明 |
  4469. ---------------|----------|------------------------------------------------|-----------------------------|
  4470. in | > 0 | name.in("test", "good") | 在给定数组中 |
  4471. notin | > 0 | name.notin('test') | 不在给定数组中 |
  4472. between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
  4473. ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
  4474. gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
  4475. le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
  4476. lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
  4477. like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
  4478. contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
  4479. startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
  4480. endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
  4481. equals | > 0 | name.equals('test') | 等于任意一个给定值 |
  4482. notequals | 1 | name.notequals('test') | 不等于给定值 |
  4483. isnull | 0 | name.isnull() | 值为SQL的NULL |
  4484. isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
  4485. isempty | 0 | name.isempty('test') | 值为空字符串 |
  4486. isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
  4487. isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
  4488. in: query
  4489. items:
  4490. type: string
  4491. name: filter
  4492. type: array
  4493. x-go-name: Filter
  4494. - description: |-
  4495. 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
  4496. 和其他表关联的语法如下:
  4497. joint_resources.related_key(origin_key).filter_col.filter_ops(values)
  4498. 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
  4499. 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
  4500. 举例:
  4501. guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
  4502. in: query
  4503. items:
  4504. type: string
  4505. name: joint_filter
  4506. type: array
  4507. x-go-name: JointFilter
  4508. - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
  4509. in: query
  4510. name: filter_any
  4511. type: boolean
  4512. x-go-name: FilterAny
  4513. - description: 返回结果只包含指定的字段
  4514. in: query
  4515. items:
  4516. type: string
  4517. name: field
  4518. type: array
  4519. x-go-name: Field
  4520. - description: 用于数据导出,指定导出的数据字段
  4521. in: query
  4522. name: export_keys
  4523. type: string
  4524. x-go-name: ExportKeys
  4525. - description: 返回结果携带delete_fail_reason和update_fail_reason字段
  4526. in: query
  4527. name: show_fail_reason
  4528. type: boolean
  4529. x-go-name: ShowFailReason
  4530. - description: 是否返回状态统计信息,默认为False
  4531. in: query
  4532. name: summary_stats
  4533. type: boolean
  4534. x-go-name: SummaryStats
  4535. - $ref: '#/definitions/TTagSet'
  4536. description: 通过标签过滤(包含这些标签)
  4537. in: query
  4538. name: tags
  4539. x-go-name: Tags
  4540. - $ref: '#/definitions/TTagSetList'
  4541. description: 通过一组标签过滤(还包含这些标签,OR的关系)
  4542. in: query
  4543. name: obj_tags
  4544. x-go-name: ObjTags
  4545. - $ref: '#/definitions/TTagSet'
  4546. description: 通过标签过滤(不包含这些标签)
  4547. in: query
  4548. name: no_tags
  4549. x-go-name: NoTags
  4550. - $ref: '#/definitions/TTagSetList'
  4551. description: 通过一组标签过滤(还不包含这些标签,AND的关系)
  4552. in: query
  4553. name: no_obj_tags
  4554. x-go-name: NoObjTags
  4555. - description: 通过标签排序
  4556. in: query
  4557. name: order_by_tag
  4558. type: string
  4559. x-go-name: OrderByTag
  4560. - description: |-
  4561. deprecated
  4562. 返回资源的标签不包含用户标签
  4563. in: query
  4564. name: without_user_meta
  4565. type: boolean
  4566. x-go-name: WithoutUserMeta
  4567. - description: 返回包含用户标签的资源
  4568. in: query
  4569. name: with_user_meta
  4570. type: boolean
  4571. x-go-name: WithUserMeta
  4572. - description: 返回包含外部标签的资源
  4573. in: query
  4574. name: with_cloud_meta
  4575. type: boolean
  4576. x-go-name: WithCloudMeta
  4577. - description: 返回包含任意标签的资源
  4578. in: query
  4579. name: with_any_meta
  4580. type: boolean
  4581. x-go-name: WithAnyMeta
  4582. - description: 返回列表数据中包含资源的标签数据(Metadata)
  4583. in: query
  4584. name: with_meta
  4585. type: boolean
  4586. x-go-name: WithMeta
  4587. - description: 显示所有的资源,包括模拟的资源
  4588. in: query
  4589. name: show_emulated
  4590. type: boolean
  4591. x-go-name: ShowEmulated
  4592. - description: 以资源ID过滤列表
  4593. in: query
  4594. items:
  4595. type: string
  4596. name: id
  4597. type: array
  4598. x-go-name: Ids
  4599. - description: 以资源名称过滤列表
  4600. in: query
  4601. items:
  4602. type: string
  4603. name: name
  4604. type: array
  4605. x-go-name: Names
  4606. - description: 指定查询的权限范围,可能值为project, domain or system
  4607. in: query
  4608. name: scope
  4609. type: string
  4610. x-go-name: Scope
  4611. - description: 指定项目归属域名称或ID
  4612. in: query
  4613. name: project_domain_id
  4614. type: string
  4615. x-go-name: ProjectDomainId
  4616. - description: 对具有域属性的资源,严格匹配域ID
  4617. in: query
  4618. items:
  4619. type: string
  4620. name: project_domain_ids
  4621. type: array
  4622. x-go-name: ProjectDomainIds
  4623. - description: 按domain名称排序,可能值为asc|desc
  4624. in: query
  4625. name: order_by_domain
  4626. pattern: asc|desc
  4627. type: string
  4628. x-go-name: OrderByDomain
  4629. - $ref: '#/definitions/TTagSetList'
  4630. description: filter by domain tags
  4631. in: query
  4632. name: domain_tags
  4633. x-go-name: DomainTags
  4634. - $ref: '#/definitions/TTagSetList'
  4635. description: filter by domain tags
  4636. in: query
  4637. name: no_domain_tags
  4638. x-go-name: NoDomainTags
  4639. - description: 以资源的状态过滤列表
  4640. in: query
  4641. items:
  4642. type: string
  4643. name: status
  4644. type: array
  4645. x-go-name: Status
  4646. - description: 查询指定的用户(ID或名称)拥有的资源
  4647. in: query
  4648. name: user_id
  4649. type: string
  4650. x-go-name: UserId
  4651. - description: 根据权限组Id过滤资源
  4652. in: query
  4653. name: cloudgroup_id
  4654. type: string
  4655. x-go-name: CloudgroupId
  4656. - description: 根据平台过滤
  4657. in: query
  4658. items:
  4659. type: string
  4660. name: provider
  4661. type: array
  4662. x-go-name: Provider
  4663. - in: query
  4664. name: cloudaccount_id
  4665. type: string
  4666. x-go-name: CloudaccountId
  4667. responses:
  4668. "200":
  4669. $ref: '#/responses/samluser_ListItemFilterOutput'
  4670. summary: SAML认证用户列表
  4671. tags:
  4672. - samluser
  4673. post:
  4674. description: 新建
  4675. operationId: samluser_ValidateCreateData
  4676. parameters:
  4677. - in: body
  4678. name: body
  4679. schema:
  4680. properties:
  4681. count:
  4682. default: 1
  4683. format: int64
  4684. type: integer
  4685. x-go-name: Count
  4686. samluser:
  4687. $ref: '#/definitions/SamluserCreateInput'
  4688. type: object
  4689. x-go-name: Body
  4690. responses:
  4691. "200":
  4692. $ref: '#/responses/samluser_ValidateCreateDataOutput'
  4693. summary: 创建SAML认证用户
  4694. tags:
  4695. - samluser
  4696. /samlusers/{id}:
  4697. delete:
  4698. description: 删除
  4699. operationId: samluser_CustomizeDelete
  4700. parameters:
  4701. - description: The Id or Name of samluser
  4702. in: path
  4703. name: id
  4704. required: true
  4705. type: string
  4706. x-go-name: Id
  4707. responses:
  4708. "200":
  4709. $ref: '#/responses/samluser_CustomizeDeleteOutput'
  4710. summary: 删除
  4711. tags:
  4712. - samluser
  4713. get:
  4714. description: 获取详情
  4715. operationId: samluser_FetchCustomizeColumns
  4716. parameters:
  4717. - description: The Id or Name of samluser
  4718. in: path
  4719. name: id
  4720. required: true
  4721. type: string
  4722. x-go-name: Id
  4723. responses:
  4724. "200":
  4725. $ref: '#/responses/samluser_FetchCustomizeColumnsOutput'
  4726. summary: 获取详情
  4727. tags:
  4728. - samluser
  4729. put:
  4730. description: 更新
  4731. operationId: samluser_ValidateUpdateData
  4732. parameters:
  4733. - description: The Id or Name of samluser
  4734. in: path
  4735. name: id
  4736. required: true
  4737. type: string
  4738. x-go-name: Id
  4739. - in: body
  4740. name: body
  4741. schema:
  4742. properties:
  4743. samluser:
  4744. $ref: '#/definitions/StatusDomainLevelResourceBaseUpdateInput'
  4745. type: object
  4746. x-go-name: Body
  4747. responses:
  4748. "200":
  4749. $ref: '#/responses/samluser_ValidateUpdateDataOutput'
  4750. summary: 更新
  4751. tags:
  4752. - samluser
  4753. /samlusers/{id}/change-owner:
  4754. post:
  4755. description: 执行操作ChangeOwner
  4756. operationId: samluser_PerformChangeOwner
  4757. parameters:
  4758. - description: The Id or Name of samluser
  4759. in: path
  4760. name: id
  4761. required: true
  4762. type: string
  4763. x-go-name: Id
  4764. - in: body
  4765. name: body
  4766. schema:
  4767. properties:
  4768. samluser:
  4769. $ref: '#/definitions/PerformChangeDomainOwnerInput'
  4770. type: object
  4771. x-go-name: Body
  4772. responses:
  4773. "200":
  4774. $ref: '#/responses/samluser_PerformChangeOwnerOutput'
  4775. summary: 更改项目
  4776. tags:
  4777. - samluser
  4778. /samlusers/{id}/metadata:
  4779. get:
  4780. description: 获取指定信息Metadata
  4781. operationId: samluser_GetDetailsMetadata
  4782. parameters:
  4783. - description: |-
  4784. 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
  4785. 标签分为
  4786. 类型 | 说明 |
  4787. ----------|---------------------------------------------|
  4788. 系统标签 | 平台定义的标签 |
  4789. 用户标签 | key以user:为前缀,用户自定义标签 |
  4790. 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
  4791. in: query
  4792. items:
  4793. type: string
  4794. name: field
  4795. type: array
  4796. x-go-name: Field
  4797. - description: 按标签前缀过滤
  4798. in: query
  4799. name: prefix
  4800. type: string
  4801. x-go-name: Prefix
  4802. - description: The Id or Name of samluser
  4803. in: path
  4804. name: id
  4805. required: true
  4806. type: string
  4807. x-go-name: Id
  4808. responses:
  4809. "200":
  4810. $ref: '#/responses/samluser_GetDetailsMetadataOutput'
  4811. summary: 获取资源标签(元数据)
  4812. tags:
  4813. - samluser
  4814. /samlusers/{id}/status:
  4815. get:
  4816. description: 获取指定信息Status
  4817. operationId: samluser_GetDetailsStatus
  4818. parameters:
  4819. - description: The Id or Name of samluser
  4820. in: path
  4821. name: id
  4822. required: true
  4823. type: string
  4824. x-go-name: Id
  4825. responses:
  4826. "200":
  4827. $ref: '#/responses/samluser_GetDetailsStatusOutput'
  4828. summary: 获取资源状态
  4829. tags:
  4830. - samluser
  4831. produces:
  4832. - application/json
  4833. responses:
  4834. cloudgroup_CustomizeDeleteOutput:
  4835. description: ""
  4836. schema:
  4837. properties:
  4838. cloudgroup:
  4839. $ref: '#/definitions/CloudgroupDetails'
  4840. type: object
  4841. cloudgroup_FetchCustomizeColumnsOutput:
  4842. description: ""
  4843. schema:
  4844. properties:
  4845. cloudgroup:
  4846. $ref: '#/definitions/CloudgroupDetails'
  4847. type: object
  4848. cloudgroup_GetDetailsMetadataOutput:
  4849. description: ""
  4850. schema:
  4851. properties:
  4852. cloudgroup:
  4853. additionalProperties:
  4854. type: string
  4855. type: object
  4856. x-go-name: Output
  4857. type: object
  4858. cloudgroup_GetDetailsSamlOutput:
  4859. description: ""
  4860. schema:
  4861. properties:
  4862. cloudgroup:
  4863. $ref: '#/definitions/GetCloudaccountSamlOutput'
  4864. type: object
  4865. cloudgroup_GetDetailsStatusOutput:
  4866. description: ""
  4867. schema:
  4868. properties:
  4869. cloudgroup:
  4870. $ref: '#/definitions/GetDetailsStatusOutput'
  4871. type: object
  4872. cloudgroup_ListItemFilterOutput:
  4873. description: ""
  4874. schema:
  4875. properties:
  4876. cloudgroups:
  4877. items:
  4878. $ref: '#/definitions/CloudgroupDetails'
  4879. type: array
  4880. x-go-name: Output
  4881. limit:
  4882. format: int64
  4883. type: integer
  4884. x-go-name: Limit
  4885. offset:
  4886. format: int64
  4887. type: integer
  4888. x-go-name: Offset
  4889. total:
  4890. format: int64
  4891. type: integer
  4892. x-go-name: Total
  4893. type: object
  4894. cloudgroup_PerformAddUserOutput:
  4895. description: ""
  4896. cloudgroup_PerformAttachPolicyOutput:
  4897. description: ""
  4898. cloudgroup_PerformChangeOwnerOutput:
  4899. description: ""
  4900. cloudgroup_PerformDetachPolicyOutput:
  4901. description: ""
  4902. cloudgroup_PerformPrivateOutput:
  4903. description: ""
  4904. cloudgroup_PerformPublicOutput:
  4905. description: ""
  4906. cloudgroup_PerformRemoveUserOutput:
  4907. description: ""
  4908. cloudgroup_PerformSetPoliciesOutput:
  4909. description: ""
  4910. cloudgroup_PerformSetUsersOutput:
  4911. description: ""
  4912. cloudgroup_PerformSyncstatusOutput:
  4913. description: ""
  4914. cloudgroup_ValidateCreateDataOutput:
  4915. description: ""
  4916. schema:
  4917. properties:
  4918. cloudgroup:
  4919. $ref: '#/definitions/CloudgroupDetails'
  4920. type: object
  4921. cloudgroup_ValidateUpdateDataOutput:
  4922. description: ""
  4923. schema:
  4924. properties:
  4925. cloudgroup:
  4926. $ref: '#/definitions/CloudgroupDetails'
  4927. type: object
  4928. cloudpolicy_CustomizeDeleteOutput:
  4929. description: ""
  4930. schema:
  4931. properties:
  4932. cloudpolicy:
  4933. $ref: '#/definitions/CloudpolicyDetails'
  4934. type: object
  4935. cloudpolicy_FetchCustomizeColumnsOutput:
  4936. description: ""
  4937. schema:
  4938. properties:
  4939. cloudpolicy:
  4940. $ref: '#/definitions/CloudpolicyDetails'
  4941. type: object
  4942. cloudpolicy_GetDetailsMetadataOutput:
  4943. description: ""
  4944. schema:
  4945. properties:
  4946. cloudpolicy:
  4947. additionalProperties:
  4948. type: string
  4949. type: object
  4950. x-go-name: Output
  4951. type: object
  4952. cloudpolicy_GetDetailsStatusOutput:
  4953. description: ""
  4954. schema:
  4955. properties:
  4956. cloudpolicy:
  4957. $ref: '#/definitions/GetDetailsStatusOutput'
  4958. type: object
  4959. cloudpolicy_ListItemFilterOutput:
  4960. description: ""
  4961. schema:
  4962. properties:
  4963. cloudpolicies:
  4964. items:
  4965. $ref: '#/definitions/CloudpolicyDetails'
  4966. type: array
  4967. x-go-name: Output
  4968. limit:
  4969. format: int64
  4970. type: integer
  4971. x-go-name: Limit
  4972. offset:
  4973. format: int64
  4974. type: integer
  4975. x-go-name: Offset
  4976. total:
  4977. format: int64
  4978. type: integer
  4979. x-go-name: Total
  4980. type: object
  4981. cloudpolicy_PerformChangeOwnerOutput:
  4982. description: ""
  4983. cloudpolicy_PerformPrivateOutput:
  4984. description: ""
  4985. cloudpolicy_PerformPublicOutput:
  4986. description: ""
  4987. cloudrole_CustomizeDeleteOutput:
  4988. description: ""
  4989. schema:
  4990. properties:
  4991. cloudrole:
  4992. $ref: '#/definitions/CloudroleDetails'
  4993. type: object
  4994. cloudrole_FetchCustomizeColumnsOutput:
  4995. description: ""
  4996. schema:
  4997. properties:
  4998. cloudrole:
  4999. $ref: '#/definitions/CloudroleDetails'
  5000. type: object
  5001. cloudrole_GetDetailsMetadataOutput:
  5002. description: ""
  5003. schema:
  5004. properties:
  5005. cloudrole:
  5006. additionalProperties:
  5007. type: string
  5008. type: object
  5009. x-go-name: Output
  5010. type: object
  5011. cloudrole_GetDetailsStatusOutput:
  5012. description: ""
  5013. schema:
  5014. properties:
  5015. cloudrole:
  5016. $ref: '#/definitions/GetDetailsStatusOutput'
  5017. type: object
  5018. cloudrole_ListItemFilterOutput:
  5019. description: ""
  5020. schema:
  5021. properties:
  5022. cloudroles:
  5023. items:
  5024. $ref: '#/definitions/CloudroleDetails'
  5025. type: array
  5026. x-go-name: Output
  5027. limit:
  5028. format: int64
  5029. type: integer
  5030. x-go-name: Limit
  5031. offset:
  5032. format: int64
  5033. type: integer
  5034. x-go-name: Offset
  5035. total:
  5036. format: int64
  5037. type: integer
  5038. x-go-name: Total
  5039. type: object
  5040. cloudrole_PerformChangeOwnerOutput:
  5041. description: ""
  5042. cloudrole_PerformDisableOutput:
  5043. description: ""
  5044. cloudrole_PerformEnableOutput:
  5045. description: ""
  5046. cloudrole_PerformPrivateOutput:
  5047. description: ""
  5048. cloudrole_PerformPublicOutput:
  5049. description: ""
  5050. cloudrole_ValidateCreateDataOutput:
  5051. description: ""
  5052. schema:
  5053. properties:
  5054. cloudrole:
  5055. $ref: '#/definitions/CloudroleDetails'
  5056. type: object
  5057. cloudrole_ValidateUpdateDataOutput:
  5058. description: ""
  5059. schema:
  5060. properties:
  5061. cloudrole:
  5062. $ref: '#/definitions/CloudroleDetails'
  5063. type: object
  5064. clouduser_CustomizeDeleteOutput:
  5065. description: ""
  5066. schema:
  5067. properties:
  5068. clouduser:
  5069. $ref: '#/definitions/ClouduserDetails'
  5070. type: object
  5071. clouduser_FetchCustomizeColumnsOutput:
  5072. description: ""
  5073. schema:
  5074. properties:
  5075. clouduser:
  5076. $ref: '#/definitions/ClouduserDetails'
  5077. type: object
  5078. clouduser_GetDetailsAccessKeysOutput:
  5079. description: ""
  5080. clouduser_GetDetailsMetadataOutput:
  5081. description: ""
  5082. schema:
  5083. properties:
  5084. clouduser:
  5085. additionalProperties:
  5086. type: string
  5087. type: object
  5088. x-go-name: Output
  5089. type: object
  5090. clouduser_GetDetailsStatusOutput:
  5091. description: ""
  5092. schema:
  5093. properties:
  5094. clouduser:
  5095. $ref: '#/definitions/GetDetailsStatusOutput'
  5096. type: object
  5097. clouduser_ListItemFilterOutput:
  5098. description: ""
  5099. schema:
  5100. properties:
  5101. cloudusers:
  5102. items:
  5103. $ref: '#/definitions/ClouduserDetails'
  5104. type: array
  5105. x-go-name: Output
  5106. limit:
  5107. format: int64
  5108. type: integer
  5109. x-go-name: Limit
  5110. offset:
  5111. format: int64
  5112. type: integer
  5113. x-go-name: Offset
  5114. total:
  5115. format: int64
  5116. type: integer
  5117. x-go-name: Total
  5118. type: object
  5119. clouduser_PerformAttachPolicyOutput:
  5120. description: ""
  5121. clouduser_PerformChangeOwnerOutput:
  5122. description: ""
  5123. clouduser_PerformCreateAccessKeyOutput:
  5124. description: ""
  5125. clouduser_PerformDeleteAccessKeyOutput:
  5126. description: ""
  5127. clouduser_PerformDetachPolicyOutput:
  5128. description: ""
  5129. clouduser_PerformJoinGroupOutput:
  5130. description: ""
  5131. clouduser_PerformLeaveGroupOutput:
  5132. description: ""
  5133. clouduser_PerformResetPasswordOutput:
  5134. description: ""
  5135. clouduser_PerformSetGroupsOutput:
  5136. description: ""
  5137. clouduser_PerformSetPoliciesOutput:
  5138. description: ""
  5139. clouduser_PerformSyncstatusOutput:
  5140. description: ""
  5141. clouduser_ValidateCreateDataOutput:
  5142. description: ""
  5143. schema:
  5144. properties:
  5145. clouduser:
  5146. $ref: '#/definitions/ClouduserDetails'
  5147. type: object
  5148. saml_provider_CustomizeDeleteOutput:
  5149. description: ""
  5150. schema:
  5151. properties:
  5152. saml_provider:
  5153. $ref: '#/definitions/SAMLProviderDetails'
  5154. type: object
  5155. saml_provider_FetchCustomizeColumnsOutput:
  5156. description: ""
  5157. schema:
  5158. properties:
  5159. saml_provider:
  5160. $ref: '#/definitions/SAMLProviderDetails'
  5161. type: object
  5162. saml_provider_GetDetailsMetadataOutput:
  5163. description: ""
  5164. schema:
  5165. properties:
  5166. saml_provider:
  5167. additionalProperties:
  5168. type: string
  5169. type: object
  5170. x-go-name: Output
  5171. type: object
  5172. saml_provider_GetDetailsStatusOutput:
  5173. description: ""
  5174. schema:
  5175. properties:
  5176. saml_provider:
  5177. $ref: '#/definitions/GetDetailsStatusOutput'
  5178. type: object
  5179. saml_provider_ListItemFilterOutput:
  5180. description: ""
  5181. schema:
  5182. properties:
  5183. limit:
  5184. format: int64
  5185. type: integer
  5186. x-go-name: Limit
  5187. offset:
  5188. format: int64
  5189. type: integer
  5190. x-go-name: Offset
  5191. saml_providers:
  5192. items:
  5193. $ref: '#/definitions/SAMLProviderDetails'
  5194. type: array
  5195. x-go-name: Output
  5196. total:
  5197. format: int64
  5198. type: integer
  5199. x-go-name: Total
  5200. type: object
  5201. saml_provider_PerformChangeOwnerOutput:
  5202. description: ""
  5203. saml_provider_PerformPrivateOutput:
  5204. description: ""
  5205. saml_provider_PerformPublicOutput:
  5206. description: ""
  5207. saml_provider_ValidateCreateDataOutput:
  5208. description: ""
  5209. schema:
  5210. properties:
  5211. saml_provider:
  5212. $ref: '#/definitions/SAMLProviderDetails'
  5213. type: object
  5214. saml_provider_ValidateUpdateDataOutput:
  5215. description: ""
  5216. schema:
  5217. properties:
  5218. saml_provider:
  5219. $ref: '#/definitions/SAMLProviderDetails'
  5220. type: object
  5221. samluser_CustomizeDeleteOutput:
  5222. description: ""
  5223. schema:
  5224. properties:
  5225. samluser:
  5226. $ref: '#/definitions/SamluserDetails'
  5227. type: object
  5228. samluser_FetchCustomizeColumnsOutput:
  5229. description: ""
  5230. schema:
  5231. properties:
  5232. samluser:
  5233. $ref: '#/definitions/SamluserDetails'
  5234. type: object
  5235. samluser_GetDetailsMetadataOutput:
  5236. description: ""
  5237. schema:
  5238. properties:
  5239. samluser:
  5240. additionalProperties:
  5241. type: string
  5242. type: object
  5243. x-go-name: Output
  5244. type: object
  5245. samluser_GetDetailsStatusOutput:
  5246. description: ""
  5247. schema:
  5248. properties:
  5249. samluser:
  5250. $ref: '#/definitions/GetDetailsStatusOutput'
  5251. type: object
  5252. samluser_ListItemFilterOutput:
  5253. description: ""
  5254. schema:
  5255. properties:
  5256. limit:
  5257. format: int64
  5258. type: integer
  5259. x-go-name: Limit
  5260. offset:
  5261. format: int64
  5262. type: integer
  5263. x-go-name: Offset
  5264. samlusers:
  5265. items:
  5266. $ref: '#/definitions/SamluserDetails'
  5267. type: array
  5268. x-go-name: Output
  5269. total:
  5270. format: int64
  5271. type: integer
  5272. x-go-name: Total
  5273. type: object
  5274. samluser_PerformChangeOwnerOutput:
  5275. description: ""
  5276. samluser_ValidateCreateDataOutput:
  5277. description: ""
  5278. schema:
  5279. properties:
  5280. samluser:
  5281. $ref: '#/definitions/SamluserDetails'
  5282. type: object
  5283. samluser_ValidateUpdateDataOutput:
  5284. description: ""
  5285. schema:
  5286. properties:
  5287. samluser:
  5288. $ref: '#/definitions/SamluserDetails'
  5289. type: object
  5290. schemes:
  5291. - https
  5292. - http
  5293. securityDefinitions:
  5294. keystone:
  5295. in: header
  5296. name: X-Auth-Token
  5297. type: apiKey
  5298. swagger: "2.0"