| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327 |
- basePath: /
- consumes:
- - application/json
- definitions:
- CloudgroupAddUserInput:
- properties:
- clouduser_id:
- description: 用户Id
- type: string
- x-go-name: ClouduserId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupAttachPolicyInput:
- properties:
- cloudpolicy_id:
- description: 权限Id
- type: string
- x-go-name: CloudpolicyId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- cloudpolicy_ids:
- description: 权限Id列表, 权限provider必须和权限组provider一致
- items:
- type: string
- type: array
- x-go-name: CloudpolicyIds
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- is_public:
- description: 是否共享
- type: boolean
- x-go-name: IsPublic
- manager_id:
- description: 子账号Id
- type: string
- x-go-name: ManagerId
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- public_scope:
- description: 共享范围
- type: string
- x-go-name: PublicScope
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupDetachPolicyInput:
- properties:
- cloudpolicy_id:
- description: 权限Id
- type: string
- x-go-name: CloudpolicyId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupDetails:
- properties:
- brand:
- description: 品牌信息
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloudaccount:
- description: 云账号名称
- type: string
- x-go-name: Cloudaccount
- cloudaccount_id:
- description: 云账号Id
- type: string
- x-go-name: CloudaccountId
- cloudpolicies:
- items:
- $ref: '#/definitions/SCloudIdBaseResource'
- type: array
- x-go-name: Cloudpolicies
- cloudpolicy_count:
- description: 权限数量
- format: int64
- type: integer
- x-go-name: CloudpolicyCount
- clouduser_count:
- description: 公有云子用户数量
- format: int64
- type: integer
- x-go-name: ClouduserCount
- cloudusers:
- items:
- $ref: '#/definitions/SCloudIdBaseResource'
- type: array
- x-go-name: Cloudusers
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- domain_src:
- description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: DomainSrc
- external_id:
- description: 云上Id, 对应云上资源自身Id
- type: string
- x-go-name: ExternalId
- iam_login_url:
- description: 公有云账号登录地址
- type: string
- x-go-name: IamLoginUrl
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- imported_at:
- description: 资源导入时间
- format: date-time
- type: string
- x-go-name: ImportedAt
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- is_public:
- description: 是否共享
- type: boolean
- x-go-name: IsPublic
- manager:
- description: 云订阅名称
- type: string
- x-go-name: Manager
- manager_id:
- description: 子订阅Id
- type: string
- x-go-name: ManagerId
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- provider:
- description: 平台信息
- type: string
- x-go-name: Provider
- public_scope:
- description: 默认共享范围
- type: string
- x-go-name: PublicScope
- public_src:
- description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: PublicSrc
- shared_domains:
- description: 共享的域列表
- items:
- $ref: '#/definitions/SharedDomain'
- type: array
- x-go-name: SharedDomains
- shared_projects:
- description: 共享的项目列表
- items:
- $ref: '#/definitions/SharedProject'
- type: array
- x-go-name: SharedProjects
- source:
- description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
- type: string
- x-go-name: Source
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupRemoveUserInput:
- properties:
- clouduser_id:
- description: 用户Id
- type: string
- x-go-name: ClouduserId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupSetPoliciesInput:
- properties:
- cloudpolicy_ids:
- description: 权限Ids
- items:
- type: string
- type: array
- x-go-name: CloudpolicyIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupSetUsersInput:
- properties:
- clouduser_ids:
- description: 公有云子账号Ids
- items:
- type: string
- type: array
- x-go-name: ClouduserIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupSyncstatusInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudgroupUpdateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudpolicyDetails:
- properties:
- brand:
- description: 品牌信息
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloudaccount:
- description: 云账号名称
- type: string
- x-go-name: Cloudaccount
- cloudaccount_id:
- description: 云账号Id
- type: string
- x-go-name: CloudaccountId
- cloudgroup_count:
- format: int64
- type: integer
- x-go-name: CloudgroupCount
- clouduser_count:
- format: int64
- type: integer
- x-go-name: ClouduserCount
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- document:
- description: 策略内容
- type: object
- x-go-name: Document
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- domain_src:
- description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: DomainSrc
- external_id:
- description: 云上Id, 对应云上资源自身Id
- type: string
- x-go-name: ExternalId
- iam_login_url:
- description: 公有云账号登录地址
- type: string
- x-go-name: IamLoginUrl
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- imported_at:
- description: 资源导入时间
- format: date-time
- type: string
- x-go-name: ImportedAt
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- is_public:
- description: 是否共享
- type: boolean
- x-go-name: IsPublic
- manager:
- description: 云订阅名称
- type: string
- x-go-name: Manager
- manager_id:
- description: 子订阅Id
- type: string
- x-go-name: ManagerId
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- policy_type:
- description: |-
- 权限类型
- 权限类型 | 说明 |
- ---------------|----------------------|
- system | 平台内置权限 |
- custom | 用户自定义权限 |
- type: string
- x-go-name: PolicyType
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- provider:
- description: 平台信息
- type: string
- x-go-name: Provider
- public_scope:
- description: 默认共享范围
- type: string
- x-go-name: PublicScope
- public_src:
- description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: PublicSrc
- shared_domains:
- description: 共享的域列表
- items:
- $ref: '#/definitions/SharedDomain'
- type: array
- x-go-name: SharedDomains
- shared_projects:
- description: 共享的项目列表
- items:
- $ref: '#/definitions/SharedProject'
- type: array
- x-go-name: SharedProjects
- source:
- description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
- type: string
- x-go-name: Source
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- CloudroleDetails:
- properties:
- brand:
- description: 品牌信息
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloudaccount:
- description: 云账号名称
- type: string
- x-go-name: Cloudaccount
- cloudaccount_id:
- description: 云账号Id
- type: string
- x-go-name: CloudaccountId
- cloudgroup_id:
- type: string
- x-go-name: CloudgroupId
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- document:
- type: object
- x-go-name: Document
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- domain_src:
- description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: DomainSrc
- enabled:
- description: 资源是否启用
- type: boolean
- x-go-name: Enabled
- external_id:
- description: 云上Id, 对应云上资源自身Id
- type: string
- x-go-name: ExternalId
- iam_login_url:
- description: 公有云账号登录地址
- type: string
- x-go-name: IamLoginUrl
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- imported_at:
- description: 资源导入时间
- format: date-time
- type: string
- x-go-name: ImportedAt
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- is_public:
- description: 是否共享
- type: boolean
- x-go-name: IsPublic
- manager:
- description: 云订阅名称
- type: string
- x-go-name: Manager
- manager_id:
- description: 子订阅Id
- type: string
- x-go-name: ManagerId
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- provider:
- description: 平台信息
- type: string
- x-go-name: Provider
- public_scope:
- description: 默认共享范围
- type: string
- x-go-name: PublicScope
- public_src:
- description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: PublicSrc
- saml_provider_id:
- type: string
- x-go-name: SAMLProviderId
- shared_domains:
- description: 共享的域列表
- items:
- $ref: '#/definitions/SharedDomain'
- type: array
- x-go-name: SharedDomains
- shared_projects:
- description: 共享的项目列表
- items:
- $ref: '#/definitions/SharedProject'
- type: array
- x-go-name: SharedProjects
- source:
- description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
- type: string
- x-go-name: Source
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserAttachPolicyInput:
- properties:
- cloudpolicy_id:
- description: |-
- 权限Id
- 云平台 | 说明 |
- ----------|---------------------------------------------|
- Google | 支持 |
- Aliyun | 支持 |
- Huawei | 不支持 |
- Azure | 支持 |
- 腾讯云 | 支持 |
- type: string
- x-go-name: CloudpolicyId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserChangeOwnerInput:
- properties:
- user_id:
- description: 本地用户Id
- type: string
- x-go-name: UserId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserCreateAccessKeyInput:
- properties:
- name:
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- cloudaccount_id:
- description: |-
- 云账号ID
- Azure云账号需要有User administrator权限,否则删操作会出现Insufficient privileges to complete the operation错误信息
- type: string
- x-go-name: CloudaccountId
- cloudgroup_ids:
- description: 初始化权限组Id列表, 权限组必须和云账号平台属性相同
- items:
- type: string
- type: array
- x-go-name: CloudgroupIds
- cloudpolicy_ids:
- description: |-
- 初始的权限Id列表, 权限必须属于指定的云账号
- 云平台 | 说明 |
- ----------|---------------------------------------------|
- Google | 至少需要一个初始权限 |
- Aliyun | 支持 |
- Huawei | 不支持 |
- Azure | 支持 |
- 腾讯云 | 支持 |
- items:
- type: string
- type: array
- x-go-name: CloudpolicyIds
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- email:
- description: 邮箱地址
- example: test@example.com
- type: string
- x-go-name: Email
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_console_login:
- default: false
- description: 是否可控制台登录
- type: boolean
- x-go-name: IsConsoleLogin
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- manager_id:
- description: 云订阅ID
- type: string
- x-go-name: ManagerId
- mobile_phone:
- description: 手机号码
- example: 86-1868888****
- type: string
- x-go-name: MobilePhone
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- notify:
- default: false
- description: 是否发送邮件通知(仅设置email不为空生效)
- type: boolean
- x-go-name: Notify
- owner_id:
- description: 本地用户Id,若为空则使用当前用户Id作为此参数值
- type: string
- x-go-name: OwnerId
- password:
- description: |-
- 用户密码, 若is_console_login = true时, 此参数不传时会生成12位随机密码
- 云平台 | 说明 |
- ----------|---------------------------------------------|
- Google | 不支持此参数 |
- Aliyun | 支持 |
- Huawei | 支持 |
- Azure | 支持 |
- 腾讯云 | 支持 |
- type: string
- x-go-name: Password
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserDeleteAccessKeyInput:
- properties:
- access_key:
- type: string
- x-go-name: AccessKey
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserDetachPolicyInput:
- properties:
- cloudpolicy_id:
- description: |-
- 权限Id
- 云平台 | 说明 |
- ----------|---------------------------------------------|
- Google | 支持,但最少需要保留一个权限 |
- Aliyun | 支持 |
- Huawei | 不支持 |
- Azure | 不支持 |
- 腾讯云 | 支持 |
- type: string
- x-go-name: CloudpolicyId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserDetails:
- properties:
- brand:
- description: 品牌信息
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloudaccount:
- description: 云账号名称
- type: string
- x-go-name: Cloudaccount
- cloudaccount_id:
- description: 云账号Id
- type: string
- x-go-name: CloudaccountId
- cloudgroup_count:
- description: 权限组数量
- format: int64
- type: integer
- x-go-name: CloudgroupCount
- cloudgroups:
- items:
- $ref: '#/definitions/SCloudIdBaseResource'
- type: array
- x-go-name: Cloudgroups
- cloudpolicies:
- items:
- $ref: '#/definitions/SCloudIdBaseResource'
- type: array
- x-go-name: Cloudpolicies
- cloudpolicy_count:
- description: 权限数量
- format: int64
- type: integer
- x-go-name: CloudpolicyCount
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- domain_src:
- description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: DomainSrc
- email:
- description: 邮箱地址
- type: string
- x-go-name: Email
- external_id:
- description: 云上Id, 对应云上资源自身Id
- type: string
- x-go-name: ExternalId
- iam_login_url:
- description: 公有云账号登录地址
- type: string
- x-go-name: IamLoginUrl
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- imported_at:
- description: 资源导入时间
- format: date-time
- type: string
- x-go-name: ImportedAt
- is_console_login:
- description: 是否可以控制台登录
- type: boolean
- x-go-name: IsConsoleLogin
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- manager:
- description: 云订阅名称
- type: string
- x-go-name: Manager
- manager_id:
- description: 子订阅Id
- type: string
- x-go-name: ManagerId
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- mobile_phone:
- description: 手机号码
- type: string
- x-go-name: MobilePhone
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- owner_id:
- description: 本地用户Id
- type: string
- x-go-name: OwnerId
- owner_name:
- description: 用户名称
- type: string
- x-go-name: OwnerName
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- provider:
- description: 平台信息
- type: string
- x-go-name: Provider
- secret:
- type: string
- x-go-name: Secret
- source:
- description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
- type: string
- x-go-name: Source
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserJoinGroupInput:
- properties:
- cloudgroup_id:
- description: 权限组Id
- type: string
- x-go-name: CloudgroupId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserLeaveGroupInput:
- properties:
- cloudgroup_id:
- description: 权限组Id
- type: string
- x-go-name: CloudgroupId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserResetPasswordInput:
- properties:
- password:
- description: |-
- 若此参数为空, 默认会生成随机12位密码
- 云平台 | 说明 |
- ----------|---------------------------------------------|
- Google | 不支持 |
- Aliyun | 支持 |
- Huawei | 支持 |
- Azure | 支持 |
- 腾讯云 | 支持 |
- type: string
- x-go-name: Password
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserSetGroupsInput:
- properties:
- cloudgroup_ids:
- description: 权限组Ids
- items:
- type: string
- type: array
- x-go-name: CloudgroupIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserSetPoliciesInput:
- properties:
- cloudpolicy_ids:
- description: 权限Ids
- items:
- type: string
- type: array
- x-go-name: CloudpolicyIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- ClouduserSyncstatusInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- EnabledStatusInfrasResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- Error:
- properties:
- class:
- type: string
- x-go-name: Class
- code:
- format: int64
- type: integer
- x-go-name: Code
- details:
- type: string
- x-go-name: Details
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/httperrors
- GetCloudaccountSamlOutput:
- properties:
- entity_id:
- description: cloudaccount SAML ServiceProvider entity ID
- type: string
- x-go-name: EntityId
- init_login_url:
- description: initial SAML SSO login URL for this cloudaccount
- type: string
- x-go-name: InitLoginUrl
- metadata_url:
- description: metadata URL for this cloudaccount
- type: string
- x-go-name: MetadataUrl
- redirect_login_url:
- description: redirect login URL for this cloudaccount
- type: string
- x-go-name: RedirectLoginUrl
- redirect_logout_url:
- description: redirect logout URL for this cloudaccount
- type: string
- x-go-name: RedirectLogoutUrl
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- GetDetailsStatusOutput:
- properties:
- status:
- description: 状态
- type: string
- x-go-name: Status
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformChangeDomainOwnerInput:
- properties:
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformDisableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformEnableInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformPrivateInput:
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- PerformPublicDomainInput:
- properties:
- scope:
- description: 共享项目资源的共享范围,可能的值为:project, domain和system
- pattern: project|domain|system
- type: string
- x-go-name: Scope
- shared_domain_ids:
- description: 如果共享范围为域,则在此列表中指定共享的目标域
- items:
- type: string
- type: array
- x-go-name: SharedDomainIds
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- SAMLProviderDetails:
- properties:
- auth_url:
- type: string
- x-go-name: AuthUrl
- brand:
- description: 品牌信息
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloudaccount:
- description: 云账号名称
- type: string
- x-go-name: Cloudaccount
- cloudaccount_id:
- description: 云账号Id
- type: string
- x-go-name: CloudaccountId
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- domain_src:
- description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: DomainSrc
- entity_id:
- type: string
- x-go-name: EntityId
- external_id:
- description: 云上Id, 对应云上资源自身Id
- type: string
- x-go-name: ExternalId
- iam_login_url:
- description: 公有云账号登录地址
- type: string
- x-go-name: IamLoginUrl
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- imported_at:
- description: 资源导入时间
- format: date-time
- type: string
- x-go-name: ImportedAt
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- is_public:
- description: 是否共享
- type: boolean
- x-go-name: IsPublic
- manager_id:
- description: 子订阅Id
- type: string
- x-go-name: ManagerId
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- metadata_document:
- type: string
- x-go-name: MetadataDocument
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- provider:
- description: 平台信息
- type: string
- x-go-name: Provider
- public_scope:
- description: 默认共享范围
- type: string
- x-go-name: PublicScope
- public_src:
- description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: PublicSrc
- shared_domains:
- description: 共享的域列表
- items:
- $ref: '#/definitions/SharedDomain'
- type: array
- x-go-name: SharedDomains
- shared_projects:
- description: 共享的项目列表
- items:
- $ref: '#/definitions/SharedProject'
- type: array
- x-go-name: SharedProjects
- source:
- description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目'
- type: string
- x-go-name: Source
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- SCloudIdBaseResource:
- properties:
- id:
- type: string
- x-go-name: Id
- name:
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- STag:
- properties:
- key:
- description: 标签Kye
- type: string
- x-go-name: Key
- value:
- description: 标签Value
- type: string
- x-go-name: Value
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- SamluserCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- cloudaccount_id:
- description: 权限组和账号必须是同一平台
- type: string
- x-go-name: CloudaccountId
- cloudgroup_id:
- description: 权限组和账号必须是同一平台
- type: string
- x-go-name: CloudgroupId
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- email:
- type: string
- x-go-name: Email
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- owner_id:
- description: 本地用户Id,若为空则使用当前用户Id作为此参数值
- type: string
- x-go-name: OwnerId
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- SamluserDetails:
- properties:
- brand:
- description: 品牌信息
- type: string
- x-go-name: Brand
- can_delete:
- description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因
- example: true
- type: boolean
- x-go-name: CanDelete
- can_update:
- description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因
- example: true
- type: boolean
- x-go-name: CanUpdate
- cloudaccount:
- description: 云账号名称
- type: string
- x-go-name: Cloudaccount
- cloudaccount_id:
- type: string
- x-go-name: CloudaccountId
- cloudgroup:
- description: 公有云用户名称
- type: string
- x-go-name: Cloudgroup
- cloudgroup_id:
- type: string
- x-go-name: CloudgroupId
- cloudrole_id:
- type: string
- x-go-name: CloudroleId
- created_at:
- description: 资源创建时间
- format: date-time
- type: string
- x-go-name: CreatedAt
- delete_fail_reason:
- $ref: '#/definitions/Error'
- deleted:
- description: 资源是否被删除
- type: boolean
- x-go-name: Deleted
- deleted_at:
- description: 资源删除时间
- format: date-time
- type: string
- x-go-name: DeletedAt
- description:
- description: 资源描述信息
- type: string
- x-go-name: Description
- domain_id:
- description: 域Id
- type: string
- x-go-name: DomainId
- domain_src:
- description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来'
- example: local
- type: string
- x-go-name: DomainSrc
- email:
- description: 邮箱地址
- type: string
- x-go-name: Email
- iam_login_url:
- description: 公有云账号登录地址
- type: string
- x-go-name: IamLoginUrl
- id:
- description: 资源UUID
- type: string
- x-go-name: Id
- is_emulated:
- description: |-
- 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
- list 接口默认不会返回这类资源,除非显示指定 is_emulate=true 过滤参数
- type: boolean
- x-go-name: IsEmulated
- manager:
- type: string
- x-go-name: Manager
- manager_id:
- type: string
- x-go-name: ManagerId
- metadata:
- additionalProperties:
- type: string
- description: 标签
- type: object
- x-go-name: Metadata
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- org_node_md5:
- description: 用以组织架构变更通知其他服务权限变更
- type: string
- x-go-name: OrgNodeMd5
- owner_id:
- description: 本地用户Id
- type: string
- x-go-name: OwnerId
- owner_name:
- description: 用户名称
- type: string
- x-go-name: OwnerName
- progress:
- description: 操作进度0-100
- format: float
- type: number
- x-go-name: Progress
- project_domain:
- description: 资源归属项目的域名称
- type: string
- x-go-name: ProjectDomain
- provider:
- description: 平台信息
- type: string
- x-go-name: Provider
- status:
- description: 资源状态
- type: string
- x-go-name: Status
- update_fail_reason:
- $ref: '#/definitions/Error'
- update_version:
- description: 资源被更新次数
- format: int64
- type: integer
- x-go-name: UpdateVersion
- updated_at:
- description: 资源更新时间
- format: date-time
- type: string
- x-go-name: UpdatedAt
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid
- SharedDomain:
- properties:
- id:
- type: string
- x-go-name: Id
- name:
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- SharedProject:
- properties:
- domain:
- type: string
- x-go-name: Domain
- domain_id:
- type: string
- x-go-name: DomainId
- id:
- type: string
- x-go-name: Id
- name:
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StatusDomainLevelResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StatusInfrasResourceBaseCreateInput:
- properties:
- __meta__:
- additionalProperties:
- type: string
- description: 标签列表,最多支持20个
- example:
- user:rd: op
- type: object
- x-go-name: Metadata
- description:
- description: 资源描述
- example: test create network
- type: string
- x-go-name: Description
- dry_run:
- default: false
- description: 预检验参数,若为true则仅检查参数,并不真正创建变更
- type: boolean
- x-go-name: DryRun
- generate_name:
- description: |-
- 生成资源名称的模板,如果name为空,则为必填项
- description: generated resource name, given a pattern to generate name, required if name is not given
- example: test###
- type: string
- x-go-name: GenerateName
- is_emulated:
- description: |-
- 资源是否为模拟资源
- description: the resource is an emulated resource
- type: boolean
- x-go-name: IsEmulated
- is_public:
- description: 是否共享
- type: boolean
- x-go-name: IsPublic
- name:
- description: |-
- 资源名称,如果generate_name为空,则为必填项
- description: resource name, required if generated_name is not given
- example: test-network
- type: string
- uniqueItems: true
- x-go-name: Name
- project_domain_id:
- description: 指定项目归属域名称或ID
- type: string
- x-go-name: ProjectDomainId
- public_scope:
- description: 共享范围
- type: string
- x-go-name: PublicScope
- status:
- description: 用来存储资源的状态
- type: string
- x-go-name: Status
- required:
- - name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- StatusInfrasResourceBaseUpdateInput:
- properties:
- description:
- description: 资源描述
- type: string
- x-go-name: Description
- name:
- description: 资源名称
- type: string
- x-go-name: Name
- type: object
- x-go-package: yunion.io/x/onecloud/pkg/apis
- TTagSet:
- items:
- $ref: '#/definitions/STag'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- TTagSetList:
- items:
- $ref: '#/definitions/TTagSet'
- type: array
- x-go-package: yunion.io/x/onecloud/pkg/util/tagutils
- host: '"127.0.0.1:8889"'
- info:
- contact:
- email: lizexi@yunion.cn
- name: Zexi Li
- description: Cloudid API
- license:
- name: Apache 2.0
- url: http://www.apache.org/licenses/LICENSE-2.0.html
- version: "1.0"
- paths:
- /cloudgroups:
- get:
- description: 列表
- operationId: cloudgroup_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 以资源是否共享过滤列表
- in: query
- name: is_public
- type: boolean
- x-go-name: IsPublic
- - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
- in: query
- name: public_scope
- type: string
- x-go-name: PublicScope
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 根据平台过滤
- in: query
- items:
- type: string
- name: provider
- type: array
- x-go-name: Provider
- - in: query
- name: cloudaccount_id
- type: string
- x-go-name: CloudaccountId
- - description: 根据云订阅过滤资源
- in: query
- name: manager_id
- type: string
- x-go-name: ManagerId
- - description: 过滤子账号所在的权限组
- in: query
- name: clouduser_id
- type: string
- x-go-name: ClouduserId
- - description: 根据权限过滤权限组
- in: query
- name: cloudpolicy_id
- type: string
- x-go-name: CloudpolicyId
- responses:
- "200":
- $ref: '#/responses/cloudgroup_ListItemFilterOutput'
- summary: 权限组列表
- tags:
- - cloudgroup
- post:
- description: 新建
- operationId: cloudgroup_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_ValidateCreateDataOutput'
- summary: 创建权限组
- tags:
- - cloudgroup
- /cloudgroups/{id}:
- delete:
- description: 删除
- operationId: cloudgroup_CustomizeDelete
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudgroup_CustomizeDeleteOutput'
- summary: 删除权限组
- tags:
- - cloudgroup
- get:
- description: 获取详情
- operationId: cloudgroup_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudgroup_FetchCustomizeColumnsOutput'
- summary: 获取权限组详情
- tags:
- - cloudgroup
- put:
- description: 更新
- operationId: cloudgroup_ValidateUpdateData
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_ValidateUpdateDataOutput'
- summary: 更新权限组
- tags:
- - cloudgroup
- /cloudgroups/{id}/add-user:
- post:
- description: '权限组状态必须为: available'
- operationId: cloudgroup_PerformAddUser
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupAddUserInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformAddUserOutput'
- summary: 向权限组加入用户
- tags:
- - cloudgroup
- /cloudgroups/{id}/attach-policy:
- post:
- description: '权限组状态必须为: available'
- operationId: cloudgroup_PerformAttachPolicy
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupAttachPolicyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformAttachPolicyOutput'
- summary: 向权限组添加权限
- tags:
- - cloudgroup
- /cloudgroups/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: cloudgroup_PerformChangeOwner
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/PerformChangeDomainOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformChangeOwnerOutput'
- summary: 执行操作ChangeOwner
- tags:
- - cloudgroup
- /cloudgroups/{id}/detach-policy:
- post:
- description: '权限组状态必须为: available'
- operationId: cloudgroup_PerformDetachPolicy
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupDetachPolicyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformDetachPolicyOutput'
- summary: 从权限组移除权限
- tags:
- - cloudgroup
- /cloudgroups/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: cloudgroup_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudgroup_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - cloudgroup
- /cloudgroups/{id}/private:
- post:
- description: 执行操作Private
- operationId: cloudgroup_PerformPrivate
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/PerformPrivateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformPrivateOutput'
- summary: 执行操作Private
- tags:
- - cloudgroup
- /cloudgroups/{id}/public:
- post:
- description: 执行操作Public
- operationId: cloudgroup_PerformPublic
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/PerformPublicDomainInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformPublicOutput'
- summary: 执行操作Public
- tags:
- - cloudgroup
- /cloudgroups/{id}/remove-user:
- post:
- description: '权限组状态必须为: available'
- operationId: cloudgroup_PerformRemoveUser
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupRemoveUserInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformRemoveUserOutput'
- summary: 从权限组移除用户
- tags:
- - cloudgroup
- /cloudgroups/{id}/saml:
- get:
- description: 获取指定信息Saml
- operationId: cloudgroup_GetDetailsSaml
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudgroup_GetDetailsSamlOutput'
- summary: 获取指定信息Saml
- tags:
- - cloudgroup
- /cloudgroups/{id}/set-policies:
- post:
- description: '权限组状态必须为: available'
- operationId: cloudgroup_PerformSetPolicies
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupSetPoliciesInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformSetPoliciesOutput'
- summary: 设置权限组添权限(全量覆盖)
- tags:
- - cloudgroup
- /cloudgroups/{id}/set-users:
- post:
- description: '权限组状态必须为: available'
- operationId: cloudgroup_PerformSetUsers
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupSetUsersInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformSetUsersOutput'
- summary: 设置权限组用户(全量覆盖)
- tags:
- - cloudgroup
- /cloudgroups/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: cloudgroup_GetDetailsStatus
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudgroup_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - cloudgroup
- /cloudgroups/{id}/syncstatus:
- post:
- description: 执行操作Syncstatus
- operationId: cloudgroup_PerformSyncstatus
- parameters:
- - description: The Id or Name of cloudgroup
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupSyncstatusInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudgroup_PerformSyncstatusOutput'
- summary: 恢复权限组状态
- tags:
- - cloudgroup
- /cloudpolicies:
- get:
- description: 列表
- operationId: cloudpolicy_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 以资源是否共享过滤列表
- in: query
- name: is_public
- type: boolean
- x-go-name: IsPublic
- - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
- in: query
- name: public_scope
- type: string
- x-go-name: PublicScope
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - in: query
- name: cloudaccount_id
- type: string
- x-go-name: CloudaccountId
- - description: 根据平台过滤
- in: query
- items:
- type: string
- name: provider
- type: array
- x-go-name: Provider
- - description: 根据子账号过滤权限
- in: query
- name: clouduser_id
- type: string
- x-go-name: ClouduserId
- - description: 根据权限组过滤权限
- in: query
- name: cloudgroup_id
- type: string
- x-go-name: CloudgroupId
- - description: 根据订阅过滤权限
- in: query
- name: manager_id
- type: string
- x-go-name: ManagerId
- - description: |-
- 权限类型
- 类型 | 说明 |
- ---------| ------------ |
- system | 过滤系统权限 |
- custom | 过滤自定义权限 |
- in: query
- name: policy_type
- type: string
- x-go-name: PolicyType
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_ListItemFilterOutput'
- summary: 公有云权限列表
- tags:
- - cloudpolicy
- /cloudpolicies/{id}:
- delete:
- description: 删除
- operationId: cloudpolicy_CustomizeDelete
- parameters:
- - description: The Id or Name of cloudpolicy
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - cloudpolicy
- get:
- description: 获取详情
- operationId: cloudpolicy_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of cloudpolicy
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_FetchCustomizeColumnsOutput'
- summary: 获取公有云权限详情
- tags:
- - cloudpolicy
- /cloudpolicies/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: cloudpolicy_PerformChangeOwner
- parameters:
- - description: The Id or Name of cloudpolicy
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudpolicy:
- $ref: '#/definitions/PerformChangeDomainOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_PerformChangeOwnerOutput'
- summary: 执行操作ChangeOwner
- tags:
- - cloudpolicy
- /cloudpolicies/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: cloudpolicy_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of cloudpolicy
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - cloudpolicy
- /cloudpolicies/{id}/private:
- post:
- description: 执行操作Private
- operationId: cloudpolicy_PerformPrivate
- parameters:
- - description: The Id or Name of cloudpolicy
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudpolicy:
- $ref: '#/definitions/PerformPrivateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_PerformPrivateOutput'
- summary: 执行操作Private
- tags:
- - cloudpolicy
- /cloudpolicies/{id}/public:
- post:
- description: 执行操作Public
- operationId: cloudpolicy_PerformPublic
- parameters:
- - description: The Id or Name of cloudpolicy
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudpolicy:
- $ref: '#/definitions/PerformPublicDomainInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_PerformPublicOutput'
- summary: 执行操作Public
- tags:
- - cloudpolicy
- /cloudpolicies/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: cloudpolicy_GetDetailsStatus
- parameters:
- - description: The Id or Name of cloudpolicy
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudpolicy_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - cloudpolicy
- /cloudroles:
- get:
- description: 列表
- operationId: cloudrole_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 以资源是否共享过滤列表
- in: query
- name: is_public
- type: boolean
- x-go-name: IsPublic
- - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
- in: query
- name: public_scope
- type: string
- x-go-name: PublicScope
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 根据平台过滤
- in: query
- items:
- type: string
- name: provider
- type: array
- x-go-name: Provider
- - in: query
- name: cloudaccount_id
- type: string
- x-go-name: CloudaccountId
- - description: 根据云订阅过滤资源
- in: query
- name: manager_id
- type: string
- x-go-name: ManagerId
- - description: 根据权限组Id过滤资源
- in: query
- name: cloudgroup_id
- type: string
- x-go-name: CloudgroupId
- responses:
- "200":
- $ref: '#/responses/cloudrole_ListItemFilterOutput'
- summary: 公有云角色列表
- tags:
- - cloudrole
- post:
- description: 新建
- operationId: cloudrole_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/StatusInfrasResourceBaseCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudrole_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - cloudrole
- /cloudroles/{id}:
- delete:
- description: 删除
- operationId: cloudrole_CustomizeDelete
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudrole_CustomizeDeleteOutput'
- summary: 删除公有云角色
- tags:
- - cloudrole
- get:
- description: 获取详情
- operationId: cloudrole_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudrole_FetchCustomizeColumnsOutput'
- summary: 获取公有云角色详情
- tags:
- - cloudrole
- put:
- description: 更新
- operationId: cloudrole_ValidateUpdateData
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudrole_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - cloudrole
- /cloudroles/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: cloudrole_PerformChangeOwner
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/PerformChangeDomainOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudrole_PerformChangeOwnerOutput'
- summary: 执行操作ChangeOwner
- tags:
- - cloudrole
- /cloudroles/{id}/disable:
- post:
- description: 执行操作Disable
- operationId: cloudrole_PerformDisable
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/PerformDisableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudrole_PerformDisableOutput'
- summary: 禁用资源
- tags:
- - cloudrole
- /cloudroles/{id}/enable:
- post:
- description: 执行操作Enable
- operationId: cloudrole_PerformEnable
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/PerformEnableInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudrole_PerformEnableOutput'
- summary: 启用资源
- tags:
- - cloudrole
- /cloudroles/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: cloudrole_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudrole_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - cloudrole
- /cloudroles/{id}/private:
- post:
- description: 执行操作Private
- operationId: cloudrole_PerformPrivate
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/PerformPrivateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudrole_PerformPrivateOutput'
- summary: 执行操作Private
- tags:
- - cloudrole
- /cloudroles/{id}/public:
- post:
- description: 执行操作Public
- operationId: cloudrole_PerformPublic
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/PerformPublicDomainInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/cloudrole_PerformPublicOutput'
- summary: 执行操作Public
- tags:
- - cloudrole
- /cloudroles/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: cloudrole_GetDetailsStatus
- parameters:
- - description: The Id or Name of cloudrole
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/cloudrole_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - cloudrole
- /cloudusers:
- get:
- description: 列表
- operationId: clouduser_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 查询指定的用户(ID或名称)拥有的资源
- in: query
- name: user_id
- type: string
- x-go-name: UserId
- - description: 根据平台过滤
- in: query
- items:
- type: string
- name: provider
- type: array
- x-go-name: Provider
- - in: query
- name: cloudaccount_id
- type: string
- x-go-name: CloudaccountId
- - description: 根据云订阅过滤资源
- in: query
- name: manager_id
- type: string
- x-go-name: ManagerId
- - description: 过滤绑定权限的子账号
- in: query
- name: cloudpolicy_id
- type: string
- x-go-name: CloudpolicyId
- - description: 过滤属于指定权限组的子账号
- in: query
- name: cloudgroup_id
- type: string
- x-go-name: CloudgroupId
- responses:
- "200":
- $ref: '#/responses/clouduser_ListItemFilterOutput'
- summary: 公有云用户列表
- tags:
- - clouduser
- post:
- description: 新建
- operationId: clouduser_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserCreateInput'
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_ValidateCreateDataOutput'
- summary: 创建公有云用户
- tags:
- - clouduser
- /cloudusers/{id}:
- delete:
- description: 删除
- operationId: clouduser_CustomizeDelete
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/clouduser_CustomizeDeleteOutput'
- summary: 删除公有云用户
- tags:
- - clouduser
- get:
- description: 获取详情
- operationId: clouduser_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/clouduser_FetchCustomizeColumnsOutput'
- summary: 获取公有云用户详情
- tags:
- - clouduser
- /cloudusers/{id}/access-keys:
- get:
- description: 获取指定信息AccessKeys
- operationId: clouduser_GetDetailsAccessKeys
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/clouduser_GetDetailsAccessKeysOutput'
- summary: 获取指定信息AccessKeys
- tags:
- - clouduser
- /cloudusers/{id}/attach-policy:
- post:
- description: '用户状态必须为: available'
- operationId: clouduser_PerformAttachPolicy
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserAttachPolicyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformAttachPolicyOutput'
- summary: 绑定用户权限
- tags:
- - clouduser
- /cloudusers/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: clouduser_PerformChangeOwner
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserChangeOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformChangeOwnerOutput'
- summary: 变更子账号所属本地用户
- tags:
- - clouduser
- /cloudusers/{id}/create-access-key:
- post:
- description: 执行操作CreateAccessKey
- operationId: clouduser_PerformCreateAccessKey
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserCreateAccessKeyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformCreateAccessKeyOutput'
- summary: 执行操作CreateAccessKey
- tags:
- - clouduser
- /cloudusers/{id}/delete-access-key:
- post:
- description: 执行操作DeleteAccessKey
- operationId: clouduser_PerformDeleteAccessKey
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserDeleteAccessKeyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformDeleteAccessKeyOutput'
- summary: 执行操作DeleteAccessKey
- tags:
- - clouduser
- /cloudusers/{id}/detach-policy:
- post:
- description: '用户状态必须为: available'
- operationId: clouduser_PerformDetachPolicy
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserDetachPolicyInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformDetachPolicyOutput'
- summary: 解绑用户权限
- tags:
- - clouduser
- /cloudusers/{id}/join-group:
- post:
- description: '用户状态必须为: available'
- operationId: clouduser_PerformJoinGroup
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserJoinGroupInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformJoinGroupOutput'
- summary: 将用户加入权限组
- tags:
- - clouduser
- /cloudusers/{id}/leave-group:
- post:
- description: '用户状态必须为: available'
- operationId: clouduser_PerformLeaveGroup
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserLeaveGroupInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformLeaveGroupOutput'
- summary: 将用户从权限组中移除
- tags:
- - clouduser
- /cloudusers/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: clouduser_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/clouduser_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - clouduser
- /cloudusers/{id}/reset-password:
- post:
- description: '用户状态必须为: available'
- operationId: clouduser_PerformResetPassword
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserResetPasswordInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformResetPasswordOutput'
- summary: 重置用户密码
- tags:
- - clouduser
- /cloudusers/{id}/set-groups:
- post:
- description: '用户状态必须为: available'
- operationId: clouduser_PerformSetGroups
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserSetGroupsInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformSetGroupsOutput'
- summary: 设置用户权限组列表(全量覆盖)
- tags:
- - clouduser
- /cloudusers/{id}/set-policies:
- post:
- description: '用户状态必须为: available'
- operationId: clouduser_PerformSetPolicies
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserSetPoliciesInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformSetPoliciesOutput'
- summary: 设置用户权限列表(全量覆盖)
- tags:
- - clouduser
- /cloudusers/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: clouduser_GetDetailsStatus
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/clouduser_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - clouduser
- /cloudusers/{id}/syncstatus:
- post:
- description: 执行操作Syncstatus
- operationId: clouduser_PerformSyncstatus
- parameters:
- - description: The Id or Name of clouduser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserSyncstatusInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/clouduser_PerformSyncstatusOutput'
- summary: 同步用户状态
- tags:
- - clouduser
- /saml_providers:
- get:
- description: 列表
- operationId: saml_provider_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 以资源是否共享过滤列表
- in: query
- name: is_public
- type: boolean
- x-go-name: IsPublic
- - description: 根据资源的共享范围过滤列表,可能值为:system, domain, project
- in: query
- name: public_scope
- type: string
- x-go-name: PublicScope
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 根据平台过滤
- in: query
- items:
- type: string
- name: provider
- type: array
- x-go-name: Provider
- - in: query
- name: cloudaccount_id
- type: string
- x-go-name: CloudaccountId
- - description: 根据云订阅过滤资源
- in: query
- name: manager_id
- type: string
- x-go-name: ManagerId
- responses:
- "200":
- $ref: '#/responses/saml_provider_ListItemFilterOutput'
- summary: 公有云身份提供商列表
- tags:
- - saml_provider
- post:
- description: 新建
- operationId: saml_provider_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- saml_provider:
- $ref: '#/definitions/StatusInfrasResourceBaseCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/saml_provider_ValidateCreateDataOutput'
- summary: 新建
- tags:
- - saml_provider
- /saml_providers/{id}:
- delete:
- description: 删除
- operationId: saml_provider_CustomizeDelete
- parameters:
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/saml_provider_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - saml_provider
- get:
- description: 获取详情
- operationId: saml_provider_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/saml_provider_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - saml_provider
- put:
- description: 更新
- operationId: saml_provider_ValidateUpdateData
- parameters:
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/saml_provider_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - saml_provider
- /saml_providers/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: saml_provider_PerformChangeOwner
- parameters:
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/PerformChangeDomainOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/saml_provider_PerformChangeOwnerOutput'
- summary: 执行操作ChangeOwner
- tags:
- - saml_provider
- /saml_providers/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: saml_provider_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/saml_provider_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - saml_provider
- /saml_providers/{id}/private:
- post:
- description: 执行操作Private
- operationId: saml_provider_PerformPrivate
- parameters:
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/PerformPrivateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/saml_provider_PerformPrivateOutput'
- summary: 执行操作Private
- tags:
- - saml_provider
- /saml_providers/{id}/public:
- post:
- description: 执行操作Public
- operationId: saml_provider_PerformPublic
- parameters:
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/PerformPublicDomainInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/saml_provider_PerformPublicOutput'
- summary: 执行操作Public
- tags:
- - saml_provider
- /saml_providers/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: saml_provider_GetDetailsStatus
- parameters:
- - description: The Id or Name of saml_provider
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/saml_provider_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - saml_provider
- /samlusers:
- get:
- description: 列表
- operationId: samluser_ListItemFilter
- parameters:
- - default: 20
- description: 查询限制量
- format: int64
- in: query
- name: limit
- type: integer
- x-go-name: Limit
- - default: 0
- description: 查询偏移量
- format: int64
- in: query
- name: offset
- type: integer
- x-go-name: Offset
- - description: 列表排序时,用于排序的字段的名称,该字段不提供时,则按默认字段排序。一般时按照资源的新建时间逆序排序。
- in: query
- items:
- type: string
- name: order_by
- type: array
- x-go-name: OrderBy
- - description: 列表排序时的顺序,desc为从高到低,asc为从低到高。默认是按照资源的创建时间desc排序。
- example: desc|asc
- in: query
- name: order
- type: string
- x-go-name: Order
- - description: 列表返回资源的更多详细信息。默认只显示基本字段,该字段为true则返回扩展字段信息。
- in: query
- name: details
- type: boolean
- x-go-name: Details
- - description: 模糊搜索所有字段
- in: query
- name: search
- type: string
- x-go-name: Search
- - description: |-
- 指定过滤条件,允许指定多个,每个条件的格式为"字段名称.操作符(匹配信息)",例如name字段等于test的过滤器为:name.equals('test')
- 支持的操作符如下:
- 操作符 | 参数个数 | 举例 | 说明 |
- ---------------|----------|------------------------------------------------|-----------------------------|
- in | > 0 | name.in("test", "good") | 在给定数组中 |
- notin | > 0 | name.notin('test') | 不在给定数组中 |
- between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 |
- ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 |
- gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 |
- le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 |
- lt | 1 | sync_seconds.lt(900) | 严格大于给定值 |
- like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 |
- contains | > 0 | name.contains('test') | 包含任意一个给定字符串 |
- startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 |
- endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 |
- equals | > 0 | name.equals('test') | 等于任意一个给定值 |
- notequals | 1 | name.notequals('test') | 不等于给定值 |
- isnull | 0 | name.isnull() | 值为SQL的NULL |
- isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL |
- isempty | 0 | name.isempty('test') | 值为空字符串 |
- isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 |
- isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 |
- in: query
- items:
- type: string
- name: filter
- type: array
- x-go-name: Filter
- - description: |-
- 指定关联过滤条件,允许指定多个,后端将根据关联过滤条件和其他表关联查询,支持的查询语法和filter相同,
- 和其他表关联的语法如下:
- joint_resources.related_key(origin_key).filter_col.filter_ops(values)
- 其中,joint_resources为要关联的资源名称,related_key为关联表column,origin_key为当前表column, filter_col为
- 关联表用于查询匹配的field名称,field_ops为filter支持的操作,values为匹配的值
- 举例:
- guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222')
- in: query
- items:
- type: string
- name: joint_filter
- type: array
- x-go-name: JointFilter
- - description: 如果filter_any为true,则查询所有filter的并集,否则为交集
- in: query
- name: filter_any
- type: boolean
- x-go-name: FilterAny
- - description: 返回结果只包含指定的字段
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 用于数据导出,指定导出的数据字段
- in: query
- name: export_keys
- type: string
- x-go-name: ExportKeys
- - description: 返回结果携带delete_fail_reason和update_fail_reason字段
- in: query
- name: show_fail_reason
- type: boolean
- x-go-name: ShowFailReason
- - description: 是否返回状态统计信息,默认为False
- in: query
- name: summary_stats
- type: boolean
- x-go-name: SummaryStats
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(包含这些标签)
- in: query
- name: tags
- x-go-name: Tags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还包含这些标签,OR的关系)
- in: query
- name: obj_tags
- x-go-name: ObjTags
- - $ref: '#/definitions/TTagSet'
- description: 通过标签过滤(不包含这些标签)
- in: query
- name: no_tags
- x-go-name: NoTags
- - $ref: '#/definitions/TTagSetList'
- description: 通过一组标签过滤(还不包含这些标签,AND的关系)
- in: query
- name: no_obj_tags
- x-go-name: NoObjTags
- - description: 通过标签排序
- in: query
- name: order_by_tag
- type: string
- x-go-name: OrderByTag
- - description: |-
- deprecated
- 返回资源的标签不包含用户标签
- in: query
- name: without_user_meta
- type: boolean
- x-go-name: WithoutUserMeta
- - description: 返回包含用户标签的资源
- in: query
- name: with_user_meta
- type: boolean
- x-go-name: WithUserMeta
- - description: 返回包含外部标签的资源
- in: query
- name: with_cloud_meta
- type: boolean
- x-go-name: WithCloudMeta
- - description: 返回包含任意标签的资源
- in: query
- name: with_any_meta
- type: boolean
- x-go-name: WithAnyMeta
- - description: 返回列表数据中包含资源的标签数据(Metadata)
- in: query
- name: with_meta
- type: boolean
- x-go-name: WithMeta
- - description: 显示所有的资源,包括模拟的资源
- in: query
- name: show_emulated
- type: boolean
- x-go-name: ShowEmulated
- - description: 以资源ID过滤列表
- in: query
- items:
- type: string
- name: id
- type: array
- x-go-name: Ids
- - description: 以资源名称过滤列表
- in: query
- items:
- type: string
- name: name
- type: array
- x-go-name: Names
- - description: 指定查询的权限范围,可能值为project, domain or system
- in: query
- name: scope
- type: string
- x-go-name: Scope
- - description: 指定项目归属域名称或ID
- in: query
- name: project_domain_id
- type: string
- x-go-name: ProjectDomainId
- - description: 对具有域属性的资源,严格匹配域ID
- in: query
- items:
- type: string
- name: project_domain_ids
- type: array
- x-go-name: ProjectDomainIds
- - description: 按domain名称排序,可能值为asc|desc
- in: query
- name: order_by_domain
- pattern: asc|desc
- type: string
- x-go-name: OrderByDomain
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: domain_tags
- x-go-name: DomainTags
- - $ref: '#/definitions/TTagSetList'
- description: filter by domain tags
- in: query
- name: no_domain_tags
- x-go-name: NoDomainTags
- - description: 以资源的状态过滤列表
- in: query
- items:
- type: string
- name: status
- type: array
- x-go-name: Status
- - description: 查询指定的用户(ID或名称)拥有的资源
- in: query
- name: user_id
- type: string
- x-go-name: UserId
- - description: 根据权限组Id过滤资源
- in: query
- name: cloudgroup_id
- type: string
- x-go-name: CloudgroupId
- - description: 根据平台过滤
- in: query
- items:
- type: string
- name: provider
- type: array
- x-go-name: Provider
- - in: query
- name: cloudaccount_id
- type: string
- x-go-name: CloudaccountId
- responses:
- "200":
- $ref: '#/responses/samluser_ListItemFilterOutput'
- summary: SAML认证用户列表
- tags:
- - samluser
- post:
- description: 新建
- operationId: samluser_ValidateCreateData
- parameters:
- - in: body
- name: body
- schema:
- properties:
- count:
- default: 1
- format: int64
- type: integer
- x-go-name: Count
- samluser:
- $ref: '#/definitions/SamluserCreateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/samluser_ValidateCreateDataOutput'
- summary: 创建SAML认证用户
- tags:
- - samluser
- /samlusers/{id}:
- delete:
- description: 删除
- operationId: samluser_CustomizeDelete
- parameters:
- - description: The Id or Name of samluser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/samluser_CustomizeDeleteOutput'
- summary: 删除
- tags:
- - samluser
- get:
- description: 获取详情
- operationId: samluser_FetchCustomizeColumns
- parameters:
- - description: The Id or Name of samluser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/samluser_FetchCustomizeColumnsOutput'
- summary: 获取详情
- tags:
- - samluser
- put:
- description: 更新
- operationId: samluser_ValidateUpdateData
- parameters:
- - description: The Id or Name of samluser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- samluser:
- $ref: '#/definitions/StatusDomainLevelResourceBaseUpdateInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/samluser_ValidateUpdateDataOutput'
- summary: 更新
- tags:
- - samluser
- /samlusers/{id}/change-owner:
- post:
- description: 执行操作ChangeOwner
- operationId: samluser_PerformChangeOwner
- parameters:
- - description: The Id or Name of samluser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- - in: body
- name: body
- schema:
- properties:
- samluser:
- $ref: '#/definitions/PerformChangeDomainOwnerInput'
- type: object
- x-go-name: Body
- responses:
- "200":
- $ref: '#/responses/samluser_PerformChangeOwnerOutput'
- summary: 更改项目
- tags:
- - samluser
- /samlusers/{id}/metadata:
- get:
- description: 获取指定信息Metadata
- operationId: samluser_GetDetailsMetadata
- parameters:
- - description: |-
- 指定需要获取的所有标签的KEY列表,如果列表为空,则获取全部标签
- 标签分为
- 类型 | 说明 |
- ----------|---------------------------------------------|
- 系统标签 | 平台定义的标签 |
- 用户标签 | key以user:为前缀,用户自定义标签 |
- 外部标签 | key以ext:为前缀,为从其他平台同步过来的标签 |
- in: query
- items:
- type: string
- name: field
- type: array
- x-go-name: Field
- - description: 按标签前缀过滤
- in: query
- name: prefix
- type: string
- x-go-name: Prefix
- - description: The Id or Name of samluser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/samluser_GetDetailsMetadataOutput'
- summary: 获取资源标签(元数据)
- tags:
- - samluser
- /samlusers/{id}/status:
- get:
- description: 获取指定信息Status
- operationId: samluser_GetDetailsStatus
- parameters:
- - description: The Id or Name of samluser
- in: path
- name: id
- required: true
- type: string
- x-go-name: Id
- responses:
- "200":
- $ref: '#/responses/samluser_GetDetailsStatusOutput'
- summary: 获取资源状态
- tags:
- - samluser
- produces:
- - application/json
- responses:
- cloudgroup_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupDetails'
- type: object
- cloudgroup_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupDetails'
- type: object
- cloudgroup_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- cloudgroup:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- cloudgroup_GetDetailsSamlOutput:
- description: ""
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/GetCloudaccountSamlOutput'
- type: object
- cloudgroup_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- cloudgroup_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- cloudgroups:
- items:
- $ref: '#/definitions/CloudgroupDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- cloudgroup_PerformAddUserOutput:
- description: ""
- cloudgroup_PerformAttachPolicyOutput:
- description: ""
- cloudgroup_PerformChangeOwnerOutput:
- description: ""
- cloudgroup_PerformDetachPolicyOutput:
- description: ""
- cloudgroup_PerformPrivateOutput:
- description: ""
- cloudgroup_PerformPublicOutput:
- description: ""
- cloudgroup_PerformRemoveUserOutput:
- description: ""
- cloudgroup_PerformSetPoliciesOutput:
- description: ""
- cloudgroup_PerformSetUsersOutput:
- description: ""
- cloudgroup_PerformSyncstatusOutput:
- description: ""
- cloudgroup_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupDetails'
- type: object
- cloudgroup_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- cloudgroup:
- $ref: '#/definitions/CloudgroupDetails'
- type: object
- cloudpolicy_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- cloudpolicy:
- $ref: '#/definitions/CloudpolicyDetails'
- type: object
- cloudpolicy_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- cloudpolicy:
- $ref: '#/definitions/CloudpolicyDetails'
- type: object
- cloudpolicy_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- cloudpolicy:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- cloudpolicy_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- cloudpolicy:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- cloudpolicy_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- cloudpolicies:
- items:
- $ref: '#/definitions/CloudpolicyDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- cloudpolicy_PerformChangeOwnerOutput:
- description: ""
- cloudpolicy_PerformPrivateOutput:
- description: ""
- cloudpolicy_PerformPublicOutput:
- description: ""
- cloudrole_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/CloudroleDetails'
- type: object
- cloudrole_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/CloudroleDetails'
- type: object
- cloudrole_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- cloudrole:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- cloudrole_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- cloudrole_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- cloudroles:
- items:
- $ref: '#/definitions/CloudroleDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- cloudrole_PerformChangeOwnerOutput:
- description: ""
- cloudrole_PerformDisableOutput:
- description: ""
- cloudrole_PerformEnableOutput:
- description: ""
- cloudrole_PerformPrivateOutput:
- description: ""
- cloudrole_PerformPublicOutput:
- description: ""
- cloudrole_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/CloudroleDetails'
- type: object
- cloudrole_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- cloudrole:
- $ref: '#/definitions/CloudroleDetails'
- type: object
- clouduser_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserDetails'
- type: object
- clouduser_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserDetails'
- type: object
- clouduser_GetDetailsAccessKeysOutput:
- description: ""
- clouduser_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- clouduser:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- clouduser_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- clouduser_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- cloudusers:
- items:
- $ref: '#/definitions/ClouduserDetails'
- type: array
- x-go-name: Output
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- clouduser_PerformAttachPolicyOutput:
- description: ""
- clouduser_PerformChangeOwnerOutput:
- description: ""
- clouduser_PerformCreateAccessKeyOutput:
- description: ""
- clouduser_PerformDeleteAccessKeyOutput:
- description: ""
- clouduser_PerformDetachPolicyOutput:
- description: ""
- clouduser_PerformJoinGroupOutput:
- description: ""
- clouduser_PerformLeaveGroupOutput:
- description: ""
- clouduser_PerformResetPasswordOutput:
- description: ""
- clouduser_PerformSetGroupsOutput:
- description: ""
- clouduser_PerformSetPoliciesOutput:
- description: ""
- clouduser_PerformSyncstatusOutput:
- description: ""
- clouduser_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- clouduser:
- $ref: '#/definitions/ClouduserDetails'
- type: object
- saml_provider_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/SAMLProviderDetails'
- type: object
- saml_provider_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/SAMLProviderDetails'
- type: object
- saml_provider_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- saml_provider:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- saml_provider_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- saml_provider_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- saml_providers:
- items:
- $ref: '#/definitions/SAMLProviderDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- saml_provider_PerformChangeOwnerOutput:
- description: ""
- saml_provider_PerformPrivateOutput:
- description: ""
- saml_provider_PerformPublicOutput:
- description: ""
- saml_provider_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/SAMLProviderDetails'
- type: object
- saml_provider_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- saml_provider:
- $ref: '#/definitions/SAMLProviderDetails'
- type: object
- samluser_CustomizeDeleteOutput:
- description: ""
- schema:
- properties:
- samluser:
- $ref: '#/definitions/SamluserDetails'
- type: object
- samluser_FetchCustomizeColumnsOutput:
- description: ""
- schema:
- properties:
- samluser:
- $ref: '#/definitions/SamluserDetails'
- type: object
- samluser_GetDetailsMetadataOutput:
- description: ""
- schema:
- properties:
- samluser:
- additionalProperties:
- type: string
- type: object
- x-go-name: Output
- type: object
- samluser_GetDetailsStatusOutput:
- description: ""
- schema:
- properties:
- samluser:
- $ref: '#/definitions/GetDetailsStatusOutput'
- type: object
- samluser_ListItemFilterOutput:
- description: ""
- schema:
- properties:
- limit:
- format: int64
- type: integer
- x-go-name: Limit
- offset:
- format: int64
- type: integer
- x-go-name: Offset
- samlusers:
- items:
- $ref: '#/definitions/SamluserDetails'
- type: array
- x-go-name: Output
- total:
- format: int64
- type: integer
- x-go-name: Total
- type: object
- samluser_PerformChangeOwnerOutput:
- description: ""
- samluser_ValidateCreateDataOutput:
- description: ""
- schema:
- properties:
- samluser:
- $ref: '#/definitions/SamluserDetails'
- type: object
- samluser_ValidateUpdateDataOutput:
- description: ""
- schema:
- properties:
- samluser:
- $ref: '#/definitions/SamluserDetails'
- type: object
- schemes:
- - https
- - http
- securityDefinitions:
- keystone:
- in: header
- name: X-Auth-Token
- type: apiKey
- swagger: "2.0"
|