From 78ec06e743c438d2684b934b22be4e545cdc7b2a Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Thu, 29 Jan 2026 15:26:58 +0000 Subject: [PATCH] Changes to ccn_api-ref from docs/doc-exports#1451 (CCN API 20250121 version) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reviewed-by: Hajba, László Antal Co-authored-by: OpenTelekomCloud Proposal Bot Co-committed-by: OpenTelekomCloud Proposal Bot --- .../images/en-us_image_0000001508295281.png | Bin 0 -> 54806 bytes .../central_network_capabilities/index.rst | 14 + .../querying_central_network_capabilities.rst | 384 +++++++++++++++++ .../api/central_network_connections/index.rst | 16 + ...dwidth_of_a_central_network_connection.rst | 261 +++++++++++ ...he_list_of_central_network_connections.rst | 301 +++++++++++++ .../adding_a_central_network_policy.rst | 306 +++++++++++++ .../applying_a_central_network_policy.rst | 404 ++++++++++++++++++ .../deleting_a_central_network_policy.rst | 78 ++++ .../api/central_network_policies/index.rst | 22 + ...e_current_policy_and_an_applied_policy.rst | 326 ++++++++++++++ ...g_the_list_of_central_network_policies.rst | 271 ++++++++++++ .../api/central_network_quotas/index.rst | 14 + ...erying_central_network_resource_quotas.rst | 168 ++++++++ .../creating_a_central_network.rst | 399 +++++++++++++++++ .../deleting_a_central_network.rst | 287 +++++++++++++ api-ref/source/api/central_networks/index.rst | 22 + .../querying_a_central_network.rst | 304 +++++++++++++ .../querying_the_central_network_list.rst | 368 ++++++++++++++++ .../updating_a_central_network.rst | 331 ++++++++++++++ ...creating_a_global_connection_bandwidth.rst | 356 +++++++++++++++ ...deleting_a_global_connection_bandwidth.rst | 73 ++++ .../global_connection_bandwidths/index.rst | 28 ++ ...querying_a_global_connection_bandwidth.rst | 278 ++++++++++++ ...g_the_global_connection_bandwidth_list.rst | 362 ++++++++++++++++ ...idths_that_meet_the_binding_conditions.rst | 342 +++++++++++++++ .../querying_the_site_list.rst | 233 ++++++++++ ...ation_of_a_global_connection_bandwidth.rst | 209 +++++++++ ...updating_a_global_connection_bandwidth.rst | 342 +++++++++++++++ api-ref/source/api/index.rst | 24 ++ api-ref/source/api_usage_guidelines.rst | 12 + api-ref/source/appendix/error_codes.rst | 100 +++++ api-ref/source/appendix/index.rst | 18 + .../appendix/obtaining_a_project_id.rst | 72 ++++ api-ref/source/appendix/status_codes.rst | 56 +++ api-ref/source/change_history.rst | 20 + api-ref/source/conf.py | 0 api-ref/source/docutils.conf | 2 + api-ref/source/index.rst | 15 +- ...upported_by_policy-based_authorization.rst | 82 ++++ .../index.rst | 16 + .../introduction.rst | 31 ++ 42 files changed, 6944 insertions(+), 3 deletions(-) create mode 100644 api-ref/source/_static/images/en-us_image_0000001508295281.png create mode 100644 api-ref/source/api/central_network_capabilities/index.rst create mode 100644 api-ref/source/api/central_network_capabilities/querying_central_network_capabilities.rst create mode 100644 api-ref/source/api/central_network_connections/index.rst create mode 100644 api-ref/source/api/central_network_connections/modifying_the_bandwidth_of_a_central_network_connection.rst create mode 100644 api-ref/source/api/central_network_connections/querying_the_list_of_central_network_connections.rst create mode 100644 api-ref/source/api/central_network_policies/adding_a_central_network_policy.rst create mode 100644 api-ref/source/api/central_network_policies/applying_a_central_network_policy.rst create mode 100644 api-ref/source/api/central_network_policies/deleting_a_central_network_policy.rst create mode 100644 api-ref/source/api/central_network_policies/index.rst create mode 100644 api-ref/source/api/central_network_policies/querying_the_changes_between_the_current_policy_and_an_applied_policy.rst create mode 100644 api-ref/source/api/central_network_policies/querying_the_list_of_central_network_policies.rst create mode 100644 api-ref/source/api/central_network_quotas/index.rst create mode 100644 api-ref/source/api/central_network_quotas/querying_central_network_resource_quotas.rst create mode 100644 api-ref/source/api/central_networks/creating_a_central_network.rst create mode 100644 api-ref/source/api/central_networks/deleting_a_central_network.rst create mode 100644 api-ref/source/api/central_networks/index.rst create mode 100644 api-ref/source/api/central_networks/querying_a_central_network.rst create mode 100644 api-ref/source/api/central_networks/querying_the_central_network_list.rst create mode 100644 api-ref/source/api/central_networks/updating_a_central_network.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/creating_a_global_connection_bandwidth.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/deleting_a_global_connection_bandwidth.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/index.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/querying_a_global_connection_bandwidth.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/querying_the_global_connection_bandwidth_list.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/querying_the_list_of_global_connection_bandwidths_that_meet_the_binding_conditions.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/querying_the_site_list.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/querying_the_tenant_configuration_of_a_global_connection_bandwidth.rst create mode 100644 api-ref/source/api/global_connection_bandwidths/updating_a_global_connection_bandwidth.rst create mode 100644 api-ref/source/api/index.rst create mode 100644 api-ref/source/api_usage_guidelines.rst create mode 100644 api-ref/source/appendix/error_codes.rst create mode 100644 api-ref/source/appendix/index.rst create mode 100644 api-ref/source/appendix/obtaining_a_project_id.rst create mode 100644 api-ref/source/appendix/status_codes.rst create mode 100644 api-ref/source/change_history.rst mode change 100755 => 100644 api-ref/source/conf.py create mode 100644 api-ref/source/docutils.conf create mode 100644 api-ref/source/permissions_and_supported_actions/actions_supported_by_policy-based_authorization.rst create mode 100644 api-ref/source/permissions_and_supported_actions/index.rst create mode 100644 api-ref/source/permissions_and_supported_actions/introduction.rst diff --git a/api-ref/source/_static/images/en-us_image_0000001508295281.png b/api-ref/source/_static/images/en-us_image_0000001508295281.png new file mode 100644 index 0000000000000000000000000000000000000000..ec3abb85c4e87fdcfd64e390ee05842d55edaffe GIT binary patch literal 54806 zcmb@tby$?$*EWo|fr5gP(mF_&-O}Biqas}n-62DlbTddd($Wpm%>YBZ zmwNx6_j#W`-sAheym-SXfw(B%xw3EUY`zSXj4J z@BagQ1HGog!@?Syl@xoc>^8MMi|s{ta?^RxYcuj%k>(krsPTni7s0K!3jTL{SPS~9h+d7D@GhfkwQF^wDx9(&tXz3r z-dq;P^{zTFRdArdVl-a+w{8Q&0w0A{F=b?{NSE`8$=@$Nm}*>nm5aS|DcxmiGH&_lSt;?^Dga|LX4ce|5Lm z26`m8U)KPs=#tjlubedC)L_;0?b2e83?{=h99rWh34uO0d;#(yb4-1X-tyk$xaKK1 zDV`Jf+vkFq9P6;fO~Z3ba;8X0)_YMKn%UQT1^#ebF7YS}2L|(^XB}qayUo zGPqqyAFe4z=he<%#vE->i`x=OoVnv$Egd;XOFCg?4i4&^$q)4DtXciL-e%vvAP9Nt zOGQnVE;j+8Es>-X>|%8%afCJ~Xdid(8RKxo%}Y}YbA9{xl0j+v>k;aljTvJJhq-z4 zf#Euj^}h@JKqycS9h4)Gq?@`)=}E0>HF(KoBK-iu94YyN^X*4HbWC+|hDO|%t6fza z;XkjuZeC$4P@<2Ajb>A5jNZTW+7SI7X~FCm8@{F_1_gaCqu9%J(8_uvE1%tLxv#jN9XKtxCM7xovmwjW8M<1%G-Xf3LdwrL-dCY z1~sf!_(dwvIED+~7~vT1(3>~DEKMVo-MVR#^34A19DF;vg3LhVE;@^eZNhC4?}jny zeFfr)4@u^vUEu8N^Gsd{0fI>&fUh~ymf*ZA3*YaD9JlTuS5AJde1Ny*(Dk8-;xVH& z*3LSP&u#uvC@ld)lFhntV{NzHipO_P_9p1$74cH$FJ*>>t){x2APw6alYt+~7xaHN z?+2|1BG=jcec-)-%-W;tuPrO<*j{tfo_5?<*Dn&~chbox<_fk%TNn~;SJ#R{bNG(P zCZ|kN&JV!cdN*TkyisYHzf>Z|pIH)QoNvT?%;`m|G?fT#3Z*}wHMSi2I=SQj&$e8q) zi@uZE1!Es$*h56U&1k*-tC1jS>;1bz)b=jBMpC4a+q7&;x*nfD5+a7wB z6f6aK0M>^&9FkBGoUV)sk)0$1e05$s$>6vd>oYCq&YPooMy$eCEi$G}HL zS6HfzESO{%?@m@01rGYS7WC(T9TrY^AROoxNk|mXr_D;)6rqX{GK4hg-o=k+TN89w z_MN2JCc=0O-J8xX>$Z}bFhW&A%CC_xrSd4Qa$KXTOWI=*-K=wXVG$>;){uXKJ>gI1ipuESY`ilSUmnaHYONTfLH0)?tfuiW|qn)1Hx^ z1HCfsV88hAt2V#-)p^6P)b`*SV>RED$<9TThEmm#C&xVa19!;rSyG~&T<-d=>E5A% za|9?xGWYB@%CjRmt3UBFNr38a_}%}&qJ$t{vR%7!i`Ht6G<`{D%y==H1Ih~Q(K@R> zfYr5YK3-F>*N$Q9{-d z*ONS&s2l8AvY=7Uq&AuyJsYPRTEnF6Pz4z{e{+cP)G8- z?M^)CAummPr;gOsp*i)eFE3Q&FM4gep)da8(5ES=Oy1kWwc^8C-0~{so}B^Wp0~&c zVd|an^3b8aex_PzUirpV!JOG(Alb~zdBLw2&}v-t!W}L?^k6f4i zT8Yi)B3n00(8QF=R$L*XUjGPtMvhC$7F>IAs6=#0Z*muA%?Hdv3=k$KLCFdAH6Y%s z6(rgaEJLtLYVRHlrO!^3rKuT?hPiohS;z0i^AS~Va@_Q3c?HrVoj0 zkF-YzG3VJ84mj)~L&?1QN^|*c9)ezoeAHCjNm~CBR@UHt>@B@hPI}{&zNw;Vuk0F7 zB3X8fH{YcH69*+iW}yxx@x+LBbGa z7;ST89`E|*dB%Vz5fdVqE~BXe%~tENXx{(F;rHJ#Dp}zzBkT9 zA9jp#|6|w>xG{OqJgOR-ij_@gRNC*nlJR&Wc)+ie{r2L;hhtw}3U6#$0`j>;FTOz;qMh<3+?Yd$^V2Ht7KH!MmEID2E zs_IPc=!kAGc1Gpt#CTIEJT#S`T;r~|YmI`~@?3hhMrIL8>8s-2m`!rVe`=SI#HbwpukLP^48{jJc4ck_Ja<~q}>>Ip9c zah?qtGIsX+B(zYa8B93G7Rq-!d~({SGWF&4?UM#U>PjuQdqsYny1iWUFeUIS#$ie! zccgglKWdasA!^KL2q#u5YWss{#ZQ z)#ieOkL``qE-o75%!Ha~waV4_xDq!ibG?zAZy$O_nqKVaO8=B*CvLRFJwd9~Kb?B2 zam1MawiMN32ZCI+r&VxjBZj5T;6m-{9N5y6lAfU)FqC;j!Q3`9CR)IusL(tbjoaVm z6Wn)jGg26c-c$}?flYC*IfX%2A!NpiTfAEYToSgAu^FjIen+a|y5|)ohlANeCLz8J zKzOUWGxc#)<5=6H{Fv3_mG@(fWpL~sMRS5Hy!K4)d-UYjX-_6h5gUn4lQ&`*OxW1H zFeds!@p@+I+|->Ef!_ms%R)9WS-#!mdK1h8+E8G78SEP^cM^f)szL(@%8o z9U{{ObvcrpLClmDDkfw9mb(!HKG@U_&=tZoTDyx-65CL#A(egI3zjxkf2zs#d=a8t z0yk2)wx=g+)E~*e81ces|1g*u&3k{sMkwi|;|3>us(*OR$Ms9<(pYKL;Fq-u$%M=a z%W?Yq5scYfNL8S|*zT9Gxa*F#m06VV%hMoEtKQDt+p-26vw8%>W?JY9f1rIvslo${ zE0ZB8(L+-tX{(LKxNF7~+TVdZ9xDVgNFrHn#HPy&AZ?Iy&-2Q^#g=}9VZIwjC$aYp z%2b}$_3OC>7@;gfXDnoaF0?R^IL)2Ck`ySv?h;9m+Jg>V=|igPDkg0-kz;IWq%sL? zR(=taZv=MJp_S*6cBmiodNIO8eQY*on9Y>+*d&-E;7n|kWj?tLva&Y!Fll6UY+wES zz|CxzPQHz|*G0BwOE~qA6Obt8tCT;L->ClsoP*V6fP18VxP~xPo6&0!ZTp8_ffaq#bzEY(HTu_>06C)*kBcGc7 zz=Lh-;UW;qrBu4_IZC~KDV?A9Pt)#}P`bU(lJ!X(hNmE+JTtpQcoQvW+C$mj;}$#z zQscW=&o8twJL|rA3F8zpa^$3fM5vc^T7)#LPKD(hVn|sVNc^snuv>VYl*#~yBP)hJ>Wq4Hqg}aDMjHUsPdgnWK2fh?nxJHv8bGeO zAx@(Ac=Wy38!ku)4;s_j({!Rj_^PZLUnlK7zlZ2#c`ACrgh&xc8cPLehV>C#Gi+KN zm85D%V>j*^)wGJ+ISR+YG2jS3%KC((q2f!zZbynnT<^F}aMW<&O7aToTxO5P3C9+Fb)K6`tZHJDNbN*S6 z;tAuSY|7SfjckmyMb}jr)@Hht&rfcSRmJX|osJq$@iH)CNuNLZ@GrU$w-~I<&v2t` zF`kr^+tZ_fbb%##wWrwklnO*BYjX6#r)hO}!L3*I=PfY10x9*In&h9oU^M8g?iA`sF zRUrVEGBPKt6+?bmO_S-qI{onc+N2wBQ(a#510x~k^XXYqitu@4!nUm0+%9X_BV&0{ zA;*xWm5}IJ{6SuvbL0EGD34ve#MPTv1!QP9WyQ9;h1?W#G1UAP&ik|{ML@LMb}Jm} zbCXQ)ih|f8LH!AJDXMbv8DZTCClUh;^}zBM05n7c9G&z{ozsnhfr`a-lGKy7mE0$l}xf`<-B;n=HLn@IgrVBeIXd>NP zVZZF$A5@v{$C!Wnsh2V9;Gas@V2o?nSW}GtvUZ&FQ(|ED7Nq*9!DNhcQ%H(pwK==u z>X_)Xu(#YiRBYu&QC?%&&e5N5tEj(a3#&Y7V)c32+kT@*`K4ezPAxP1A1oH&R1(i# zbD`ky%A>)#9uG_0*0CR>#bpxtibh!?7{i5@^)~&cjw9F6a$NRrFD%J7jvSJ=7ZpxP zxZ;MHS^z+Y_eLh#cPtjZI*&Ov>$->&!^v}5 zX6ol)=o5Ga`19P! zkR`y``<>VdE-98vzKq_FRz{m1({IWzLQ-dNrk%!aBk}!So@ZZjSJyl&zW-lfns^MU zIZ|)mqX~+?(s$8nvQ6>l-^O|^Hb#;cr%X;rblLk}BMQnq+yJ>*>HBFcRS+C^@9%G1 zl`0{dY*E#@)HS~ZG#Xz@H%ZoCh@D~t!{SDC8VUdYsQGSwJ~Ydqv|3xce_}n0e_qkL z?fYD4cO+bxZQXa?xt>GQ;g}>d2$jV4_XW3qa!B)_%p~Vs#PY(Rum_RClwW^6VZl2j z>81ZxAfqcje8>wU!y_7wTt(oG|oBJ13+*KOjfZ5i*=;5#$WR#4CKL{}&r!xva zAM>JEkNyiXx&<=}Mf{6KehB#g7lZu2Lz;juU7_b)Ph$VB@`LI5ek;D>e{jx!{vYC; z|MxNe!lwJrUS_STdeMa4_i0fqW*i&{~E zEcyk_kNzUB3vWMwDgmRQ{~G24_O0Mi>R_T7n!kW6^&Li-CnL-b{&%i!kJF($8PM-n z8PHqJMH;LmQQby-39PEcbIF(wT~e(2L!S%4*jVYC|Lte8ig5CyBPI!*#^-3xU|61v zKl@!Q{Ez>8R97P|SeR#&L^r^So~Cfr=h1pl;^WYcQSzi5Q3!g3Q$a( zTD@kz{SI;C=7Ts%n#(AD{4Q8YXpiG+H>ABW_@*!QSSWwi zi+&H&I<6A$|ije(W^G3+{2)$aUT5R_PV4Of2a_YrtN*=2_cHsQ2LA`oe1q8t{%_UD#KN?b#U3 zL)Er*HUT4k58vxY!~qw-YeCN(04=zKGBJdS11HiM2LO&KpISG=^QK+c(Wsk!y?gAN z3=fW+Yy3zmh1Www%tfAZT4*|y(?Fh@x~$->%C7e!2oB0fdM_pgnZmgqJ`ejOoW zB?(byJymiC+o%h2focj192^jutQxkqD)6R>>nHQ2J3!{vJ|h&nZPLsW0C%PvQ+}T0 z->s#Rvk@AnwtnSSQ4@zV&D~R=^cxcQ@;GmtoxB-gs4)i$v03*uiNr7C4?}CXvbyH_ zhUXq8>$W8Adlb6-oErk5w7&Cw^iu4D^Aoz&kw-^9{E3`ayx^R=RYy#_ln>jk-)B!> z2Wj4n+p_UCCi51;0T@@+^A+0X6nZ9w@CR&(mx6=Wxzh-<>g6_~72#G*2fbAqc{%G- z-kWsv2m0>?0sDF;4ad@RhwyU_+Q@9E<=rXU)PtpzisBnyo!+tpjv@;3(@x7sGx(wp zyo zS~yK#f&olO7F@>a|7p)0g|0t`|42zVp?;uFZGwo*Z zR`(Ehp4+(u6$w+8t;I-5DCsVd7vmyxNVip!&b|&KfCo=~FAY^!P6YAhSi&ga=28Pp z>MHRZ)#a1M~cHS~xQ%o=|2Z|++y7@l2%*nW+uy0ZlcV(?Kp1IGfjv{8a zG2A&0o@I;}0I8Zu!js~ngo#)WPY6huXana6f}^ji*3)EG>76~^tz&l3{+6%6O!41Yh)jR8c=(!vtJusPlU~n?Ty`fRC-`chibBNPg2W5z~!}nabPVRJ41k zfGkidrV1aE?&|5zPfXwQ!8}wd2Az2CC<13Ukj~5&;{x>AicfB!vMwTSZk4&(i&-71 zp`k%YFY^>^qkXj2Un`KrXIa~^1N)Wj_wuoYR_jKu9()q;HM(ltw-{G zl!p#}!o!mr9e8;gG!=62WTpQ6hiP`8gcp}B)6t)1yn=^U;x%U6BYl+WF5rEs0_N~! zWS`;d|3l5e?j6T2<5ez!z2J4~LVVZG%GfrLE z`aQxYJ0a2YgYMFJ#-Z8_UR_PljkJuFF0wVj?LbD)niH`65&o%rap(#AT%PsDaqLZ1hWO-8-mp}=9V`U~2F^8l z)^7@Z{p)~b!OD5Zu=7{KA+jmbaH^9&Z*^o`WaN#I%l8S1q193o90=lO*!yIvsP!iG z=)h%P;Q;_Vn(s7?&@{Xw>@g+xw{nv_dkkOt+F*QQ5zxtr7oz-yEMGF^9}^Lca1h;f z+UrHM+&ZQL+8DqyQ7rrI*Q8$4ZPM3Ug87e7q3!SMHbln08q(mLZA*@=$hGhy+Xnbj zQL=qE za7z-90NQ)A&RlPpdF3r$(PWAkKCJd+V^Sa6s5Uymy=i&MF(a9$^-`0f&Jg+4a~6k$ zsdm=8bQgU@2Oo^~R|??~7QP-+)5{7<74nozc@;x%GLSs^O}|y8Ks5`Alt~j#iM>4N zq%j{z7I6H9zLz2=fonBC5H81|SrIrciK6=mA7m_=fC!m-m7p9kADUC)&qOV{-$ad3GXg?!i1LkNx(tHIRhfUVZF zZ02Zx2vHpWKl|#(C0FnpjNZjW5Qa=KJjW5D*%I-9hzTFEX~veSjx;E(dE1!yXmg@W zW9>MBC1+5FH)%4WW;jF{g!mChAEm(_S7kfG*o?aDeDKQYE{s9`+Cc(IrL&x%4J$|6S$w zt1UmpV=iM>7y!md)<~V@-be_&;0>m1?Nbt-U^JRlSWLcjG|!75Y7ndRHC(l}z@h1X z+C*j$ipUq4PvSiX+knN5y^JtIgcrBK1Qh!a+c7wGfg6IPN&Abd@q*M~*5^$+D28O%5@8b6ZUfB0~vI*hu}d5c77LWRlr$5t&o zQQ&yl_5`KNG`T%Uk<~}AZP`5%Qu7@~Q=0|H70tD!yUeYU=$A)T=*UTZ-B@h(SKJ&4 zI62}#g;MkO%+KGn1rd6pcPsJb5>ZZ*Tv_klqBe)f&2A-{ms7`Wt56(gD(sV&EiK zMj0C;Ir64PMs4lwL-G~OJ`q5jkgAHzR<1-Qawsikeq`1~l5`Ld{fhHo5q&|x>xNVn zeH)$nl~TyF-JtZd8g5Tl-xJQSJ#4VVC?~o~XYIz@H_5*<9?1B%f~w2z+!aHp_(&!j zO;9+_s>$$lt((C4%Ek-d=QoS56p!n&^fCxTj_b?_z)u=H0?{8ps9=CmtsQYC15>4d zrB~RNDf$Wwt=-ER9ka!&mtVV9QXpU?_8U}^pY5albErj$qA)|2dh;4I0v#(S0hLBrQ?3TBM_xkmGdwi?~(zXXu%fd?Mtm&2x z>*>6Hp#cU3-_`S}O{*0(+rwVh`m@1Jl>^XNp)f+&&iFwZlu1Pjk^0J6ivK7pPIoEa zq1FG9_MKs#tFxQ!^1*i<7f3F}iHGX*Ov z)~gl?N3)N5swGt#_}-u7rku%(uEibdYJcsqbJbRuIOQs9uAmf#2O%8Qlnr;WOj$CZ zwda5XtzS#i#jM1#X#tT^RK(_&{H|gW$ophWjg(FE_-r|1WRO;~6?JnhJ@^%rB{A=V zvA$S*SNh87m%_D3yXqq#caC5l20}ps?f5-*FS#1^bL9r8`BEvK?0{Z_{i;R&OR00p zA{Fk2UC|-z5NWaWi=_Yy346V4(-q1vd1QaOIb0+ye1{x!7QGl3#>_OF zhV6-O#q0&GKR8awfiGldI*I_ugmlfg4WNU-gj;t;yP-(~Amnw%ZVvq#YY)R-XhRee zumAC+{Q(?dWLu4reiM!a)RJ52&=CK$Z_rk}hJh^BtUUfU2FK%jiN!8PmqoFTAzE4k zg(5X9PlvobDn8?1%|SfSIFiR45CD(<`8sjxtl%<=NrsMOW3aPkFvaIliA`#Mblgz~ z^!&MO4+Z=E9GQf72a+k>G~t$d$d;NEVQ-I2@vyV@v(eDNzy=r%5(H@=15ZsuAUwKRAa4Tev2jW>ytz?wx zf`2AR>>NtG_nDO7EzR7|m^sG=1UNDDVh)lO*Gk#(_W)w;H0hLoj2>;gSm~lQasN82 zYs>~9^G@kOkPv0JUXon}m2B7mt@jI7qpd(tN%0ql&iU9pDAVX_1PR$ogxJLp9*{R) z)FZdA0s%R|%s=|@@Y7B8q$D6;Ng>esqOK2b+#M^9wNoJzg?DRxPtCK0kFxt2STqjG zR*&kYZ2gcMDHML5myII=4w`?7EwRIXnS`r0H8@mDgNy$;y}wJuvG?MO_E6()W5iS= z=2p-Zv7!dI70UEeb`p1ygvX!{j5m+)CI}O5L0Ge(;ltSk1?Unr!M4-@uf0qc-^R?{ znq|fM_AmqhHJ^&6S3FHiygcrXVmKdXa}SN4|KNc7-eaJI%oA90K5(#ZV*HUrMSG%F zb~`tTU}b&e#j()OEE}IA@)!~E9%7~)5+At|-A3v>wZUwtp2ztr4gBn*ASjL`UF6(R z!Vh9mo|-D;!Ed`~UU6|dU|?;P_)=7pjb~vf_JoqU@-yh}z6@O`;!urwDYycDbA8+z zc+HvtHFx(2B&6OVU4US9Xc|v1($ZPhxDa1kO?5tj{7ofJdE>243 z(wPj@^2d3ZHO{&yf`guj3A;2sMaIippJg35yuu8hwB%F4l~#-!nS;8$T5a;}8NbMq&ZjPBAlu#s4H#ZLU5vqE z$Xp{A$;7k_aK3pQdd`kJ@?`u{1v{CZ51Qm%96RX>9|pSCo!F2IP)@nYam6i z_Q6Hv2i-`r;Q1Q`>*cXL%LLLxEM zS6uuSq|Jr^O(o4O&fGB0j`AmFQB8*mFv27(?F|rXY0~vaqxdtRL{S3j{}(3QnC~GsA3biE2Z- z17@$XU6-@>USIhF0)|srAtC~wHMZ+rjymgg8<7JcFxAC0OEAOcBvIaPw~l9Eu=`#< zcRLAiB9cbV+NppUdg5B+kja+pJrx(CE_9^?ljWWU^0?%({~JDA?e>#+ZMGwP)~dhs^zCTt@eK3G{M!9Q)!qiRAburkr=4*N4u= zgh8eFJel+QD_u6Q6()XO(#zG~dI+axg1a#8$YVyt078pqYis{C%tvUTspg66_HNk9 z@lyDNv7Iq37QX5Qh^^lp$+#l$+C-hQ=WKNiCJJkHM0|J2i$Muo&(vXzj2nC~TIuX;nM#vQ;+ z0J+P*dCCM3F&c}> z%=Nfkc$ue!KJz&7+!C4&-H--A6|+4uJiXr_ zwClrf{0e05JB`7~athx;&Q%WDh(N)2KP%B5rKWH+>ERyl#@rEC`9hAm?|r3`d-v97 zm6Y6ybgmVqcLZImrmJN06kbnd_m8ot1=o+W%R24OoU2+eUln)UFRt9$7Ikq4^0A)E z3W-fs4x5{WT@Ebj-s{(}UGmz5goIN_kDg_Ch;rO{kKyd6xO3& zX8n>OV(JWn^xPjhuLygBO_O8dzmx8f zem-g9;cjkgcekp62nTUwL5)StPuvhUh7Q2KYm%}b@49fk z?&s({x15_==F_Ui7!+q-uBk!y5Oe1Cxck#Kp^M15@*aH50Q=f!dIUe zzmS~-o4m2K-HdG>-ChF8c0kMmsDD*ty<}F{%I80x*2Jx4ZzMf8J=FzN9oZ~op?-+A zJMJPA(37;zw(nIF2As2f0NEa4vn2qKp%>VSFxl0y+VJ^$o!rmo#=mCm)f||AMqT6B ze~Wm{t~pulbGPKG|1Cn5ET9z`$}5G|`NA8{<(J32*je7$g2e=YuqsmC04Y*@CdC?q zu#5S+P?kun9aKnwXBXMwPg49N0iyZD-M#LNko53K+VeYZg3MGycdK#T#~e%zO$Tsy zqo=DaRYvn1Onx^(hWtzQdC)@x@#y`6{6SH*IA;acBKOZEJXCnUn>85TgI(;$zjxr???}4 zWb`^{K@%wUdwZqhGbw{%zTX$J6zueHFi|B6rRsgpq;wwrU2dwhIvgT(X!zVgkIsVwqe=vIFLkDp{Su;W#*7x zMLdcu&7x8AtW!4TXq*`&-Xa74j9xT6KXr}$CrxZs)%B$t)=U?M-`+Lx^&HNLs z2c6Pn64jq?)8lG&KWDo=mATT{cA}OM%2ac zHu4xX*3zQg7`7l*Jv=N1D!qEigf~-U@Snbbm`d|3>ju9>wSR2-zFf4&R;>DqwE#&) zWbvoJ+e+TZks#0R17PVPwI_>=!`K>9n{1pENP;AN*u9)cRkr_(w1Zrl46HNbyE@tVGzPyHuO2_*b<6JcK?4T_8D|y#|Q)eD;tnkwnD%{ zH3w-S2;rYN!O=oCYM(&P&;K(!qPzf6L>+(=|F*Up=>KefB?ulhx}tr>Jp9`TPRk}` zpX(0*d1}^w=AnS3#)E9qOKBk!5++NUuE&Eua~o@VMs=K!dZQul)8R~U5`V6Gy%~Fh z@ZcxPOZt2B>jT5Pzs+XF`riXD1pV97|LFLCG^ukzCkLu^7gWFBX}-z;lb^R@n@dJoq*IIz5b{`KKs!fdbk<<*@x0@jduBeHjci1IxNsf`-zX+E20(G2x4Gj&9r;Jj0 zPtC8duQ2B!#ERfyNAuF9;AkykIFt=uH0xR11}HPfEsP5#j)v3Vmj@C%Qas|TN_VSEA2C(u z@je#wG?;J(`kYm=4e302bt9{ha2-Luhq0=s(tukx`(phK1^+-a136&XI~7z%sb#o@ zNM2FQpm3}5H|QhN*l==Qk&h2-&}}S@uR8B=Zv>%=&V4LD)s272>Sf?LEpD6bM&Zj2tBwek4!uolnv4)Q%BP&*6G#*x;I5gMayD{saJUTuxe_*+}P3 z?v{Fa%4xcXioXSNfW!Y*dx@GZ{e_x0vUYr@3lM_-=n>!KEW_a2_v?5&I+N=;|r`yj{(C%hWA-QJ@Qmg|(u zeNw!4hGQPme-lsn^^7Slz1n3ksh+!h;~V;3+tQg1F#f`S1yfug4~SIp8NnX3*kGbQA48?quZ&OaQw=3ttE6grZE{$ra@*p;xPy=RJn7m5#%*w$nt7V^y@ZA- z!)cP|eu@j;*Q3kf?@Hlqp~-yZ5=L+9g)81GT?r|P=tRB0zsqH_*yqD}TzD+Xg3@g; zKp!~W&J5nT9A(MuI4-2sPIzwKd3iSkyxa6um6!ab{^sY?9EQm|$cxLjm2IF!^M|9W#ZJZM_-J}yJe-Tn}{$kw_m?C}N8W~n|!RoQE^cxWvl zN1tu^v_p`;%DIH}E`_-k(p*B-r~ZBW+#OAIYLe-u^^i=7<4~rnjNWcke`>Wz#XP2U z=~w0iy$w*}Ej|=yHVzdRA9Lzz`}nA6{>fBkududjeQQm(ym+j~?;B6Qg<1ceo+Ncz zNC{7>Ey1(;Q%8I`_J^HYmi{8;Wmob^OI4i*ke+0XDc4_KW5~*a)QCm3$QtC{g5L=x z<+1eE{HvzU?ygz~< ziB;ZSs62_UMHHeeA{7n;hqRmGQ4{QBkCo~~<2bC(><;{D>}|EAM>KPW2bMcd0;9k$)B#UK3?ea+K zl6blGtBHntgpX|@LSIf($m>jV>=(xx37HGK>eRp>>eXRaJlbR8 zJ&Ma>Y*Lf{C6vzO=?}1>UusirWIaphX?hn{)kBY$G&) zm7gag>oeSAda+k)D!JL5pTB;mhWB>ifmNfxBc)?TgVvAo)8Tq*-@cE7-Hf^-eIb0! z9;}>7FNb>@cRzrZTe~SF&?(PRf;gIMmOI(jls9b;*LMGLfp|DJulLfsvX41?>?CWR z5A-BA?S+|Z@!W7n6egptqpJp#qQt8XIO21J`EQnGeME(+hQER4LBBl->+OGe5;N;? z_PDQYTs6m2Potzw4E^|`R1%0S(Gikn%%HD7y(s=qk9DEPyylhy6J%clzE>Pw)JWPAnv|3YdwI^OB$)B_-n3pL^ zSFh4somHt0#A`&yKsVRm$a2t@@cB08T1tky!ciGHqgap4^N{fI$m+qhjz^W%1f#f$ zzw{$P)?rHu)4rReAa9%PZ?PZ!9RFyC-)DY;9!}as;6e*WGOf37rnKX7b3bW)n?l*VMNq%j`^xE9 z0^-%4I-9H*@~Yuz5}iT)z^IvD^M+-sSsoe!Dx;-jBY2iYTk>> zmkyz>?B%4?;PVz5v0eLC10o%7|5E_`UQ(h4N`RI`%fUhWN*G{kCkE<02-W{2iEPS9 zDDDwgu!vEd{&vWyNAO0D$Eo@xYw*um+RvswQ{Ph86BK4DT^?bZhzQ-tt#cC6SB5w# z_yharBn6@EbX<1-M5q%Q;YAEMS86%B&&e)wYqp&QFuZ%dOg-n(+^!xN)~>@f@hVi? z3URo1?XiRaq7AFIF&YZdA3YR*M z%LQ3^QoT^I#;cS8C0Bt48YaO{Q_Cqk&ogU|D>+(0rk@WVVw<`qx-V@=9?`qvRi#Sg zQy-0FFFNCrK2G(v(0SJV-5p6g?(rzC_So+yAXNh2pE+!l#Z3(&veBQmx1^-1Olra` z+ow@&y|PW&dD3!eIje=JN7)g8eahH(N{48tNv`jIpVb3a(yW^W?4P!=tCk`c@;?O- zF2Hu2G|$e;qb(cO-dpc}(dp1fIHcr}y?kcbAH)zc^PuC_)`>%u#UqVxR_~-2->ja5 zEn^SzE4alGVH=zA3+K!S#`NLhs)pHW*p+25*>4>AuIp{U?8?b32dFmqt!LL=IkJ)( z>@S1VRvv=>;dMeJtNb)lF|Ec{1T3zCHS(;Men3;W$ z*p^j-p9+r*YV^#vMzBznw)VREvucB%@9xGQWX1TVrDZmG4p=Zf{WoEWD>bZ>aLD{x z1+kEs6S$e4O^^*}1V2;Ntcw9I34CC913)d+Q|7>SQyc>I4-7~)*mYY~jRL7H4^Pb} znj}x+yv45VPKlDCmxmdCIsQON{E1MEEc;;AGdKE-8QV01yqdmSux6I9kuuxvO z%yN0E=z+yvham|&rEZ!fw}f%mQ-ZZe)J?A?RaShEq5E=d-ANs2%r7k0*5NPzi?;U; zYI5z`N9~ObSU?m6G^lhCX;PzLAkqm44;+7lK05AI--iVq$sC@Z_2btxu>Trr0Jl;zyf zy>7oN#aRy`1f8~;iw5G@3_ZC-2JHMszq7rojSde(i&<~(xk&_*qBfX1^W4-rr-e-G z^7IN8U#L9Yv^S}E>&v||N{NJN8R^V>9kXKJ0sJ_{-<6%cV0)2AD{HmFnRqq02|2!= zCYR;m+Qszb$+f95#!W7SLRW``zhT=cT1V%H*agl6>&85D%L^at6%_}zTAGD-1FjpY zck5*8@(!;vuQUr1jnBv{GhfVDfAud`W23bhnyOc~rSau1fbVpM8lg5x8^IPEM@o*e z)1EdI+cS|Xt0AlotbQX7U-q~&aH&e_noyBvX}FU;CM@24 zv!^|nnsq61G&!61cxc1_HH2x%uK+E4KlGn1%)KL9YjM$6xjW@Y;$6pUTEg>aP;P45 zCDYQpT|bQ)H%a1|Wy2pS^)D}(fME3Ry@HID}hCTX!b(xSMr749&}HJE9xA z*pkPSoF@t5Q43rV_q93vM=SrMk*~u(Usk%f9o_eS(&WDZ? zt=o>23AnF4XU}<3^ZIyaXD5j6IomQvEYd(UdH*t6Gr1GF-@A8$+IUxbF!^T>7XKON zvNVqR{w<_wva$u?yZH!n`?O;GC1Ge=mOb8FkloogMAOro(u5ie2BRNU7qbXJadM} z`f1X^^+yR7n)fh$SvpIzoymYc`SI>SVL<_yTpb|j0St@BO??F7e9n`VpH2D!VNB?v z0sniL3ZJfvbD`Y*rNj{_i=S#XFV}u%6cUGuiXNHvFOuZy;peXOaZC2;+<{6<$HmE9Kq8SN-?%rqgv^FZtk=@o z&Xm^!VQjta=_;Yp>v)xF_%_3oj$vP{cKshRZql@wEMm<{BB1EmX zzU0w@sRE(cQqwbW|xw%f|nC_&3Up3FOEB%>aj zX17w=#WYYv6gRn~@}1}V^!psR&z10%UQSF*EMjq=*jb+kOPZy|v2|z+k0MXh`*EIp z{=~iBq%oi~wd+VN@ki;~*J0Jz8(`YYHf08zcn5RzL>Eb6o@xSUx`ogZxG*D8$C12C z;Fhhel_?X`-8s=uu)Y}F@=RKKY{bdMrCoG2Jb+1}R&}Z+;$|=I%j){J4n(NJCIL_7onJ%n${oAp6c087}m1frl zNN7&+on~hq{Pog(44ZtI-7#>j)-16!V>6#b)UKR#Eyy zoF*hDkLiVNEvW5#D00Q2OUtL_zC29GMicclVJ1q{@_xK!WXXx&yG$#&86CpOXkH7M zx@eMpG;ri&D)o=Vl99vtA|`1gjAc~kmgQSlbZ#XvSodazYG)Of7o2OGktr>MOobJR z6@-sR1Tagi$X4&^P3o{PFzAd7-vgZ}pwB1-6?4F*C0N`khATGR)MtIcf%xPD;r$pH zIY)3kFsWLNPcU8ao)`!D&ll4W6I{~L$flqhd-mnDlBHZ-K%>73Q&{$eC6Md99AWvEpy;9H>@h#1i25PW|azIwexsGTyI|%|%|= zWPL!?-S=>j5=(=#Z*r4aA#5ko|vR-2bLT|KXc{_vin=kL7w8o3YC627jhx z`9MCm{OoMN+naV83kV2kZCB8;{3nU*fmRgVJ^v=aCtiOQU!N`K=|C}XIgb>owd5%p^ z?L7iwGgOpeJ6?U`X`&h^@_2omYIg4M;lnij`cV+#C{A>>5e_ zV+%w5F)M-@g2~CryK8f7S1Pb`ws_J;`AnRIGl4Gj$$VeVT)3mnHpn)pbDRm>XBKmK z3N%OQaF4awe5=8Nn3yZOZyYFs!pl7sfQe5wTjn-HUo`jhl-wi$|08JHnx3tpHF^Q; zqmV*)o_=|?^~|C=o6nG^3KawYQeUx2>`-xYsqpXJoX*%T9T<`&p`dmKZc`LIeMQ{q z{ZL@D-TvNoZ>AO#kku$CoDq%M**!yl@;7-~V@CmE19#XurKIiwsuw?xS3 zo|$eVS8Mwd3~)}*>H9;ZB^%tIC4Z3*TpHZ%pW^Os@OMjj^2U8?>(uX(Xf@#&DLF35 zQ(<^kPFL$hipeiE&4*@&LC=Lq^o8TEoC8`c-bbkr`Z(Waqq6t;hSz;P!oF}bomRc; zrAF~bgJ>ac?%il|q3g^m^`4WHWcJPaBiBw|e|z_%#K;jyXZnkTo(sf#^~ulkOIW<( z(u%!yB)9geC%VD^+@I&rhq@>9NS|S$OL>UBM>BOw{`I|pyQdDz$Sg)*$BS)5jK+=* zdaw^}&eP%~BqUY`{lhA^TbFCOmTSJWEGnupAv8RmG`5c(J%KGMDiRSb)d!;}`;?pe zq|K6mLz5WZQPcQdP8HF)F+T53i?u7e_eJ#Uc-N2Zc+=sy@5EW~?l)JF=Yj@i#EKX~Aq#+4PfJwDT@AH=@D6%ei?S-DW1Z?aNR z!H3)`#iJ_cy5psmAC9H#=gG-ZOwLuIKRxN+WTPi@ldOgr@E$fPTWnDx!sMD=23pp* z8+>^gRljPR`(2g><3l3Keh#~i*^TxZ8a&fEuv-5<0+xA}tVf)kRZ>uJdN?*T6!!5f z|Gt_R(}CjQpXrdkX#Nqb#$U4_tp^PG21?@4A=$)#rfL?4!rh({hL%q?3kRml`VZB^d~uFnu34GvZZ#z6e7=rZnsCKBF2jzbQ^ z2!d!jFS_3g0iON}eiyUz0Rm%%VHl5rg%amLTrwQo39Zj?<>CAKi8phw+LYKd0`sHl z`XW_U{Ti}<8HScdgGC3^@1%ykC5aXSSHr}sV`r0pFX-Kqurpt}IlBs|x&638>j%AC zY~mh!=%|OT+)A?>tUcX~6FFU;8q~$*)+^AcbCI@PCvK=}d#^-zULm@5SYV197k06) zje`yyl7k+OF|d53Tx`^9)0=!+0^MUq$GO7+RvQ?!Z}%{@zeeaY5)?GFQWXq1BHny5 z9gZrdXJg=v3+KyGgZ$JJxsjGFc4sPFsY~ML72%9AJ+7aM!E2{;N zKoyses80iFU;n_syxiQy+1a!4rlzJhuV3%!=_x9HKn}vDrLo_*;meD)(*H0P5)!hr zvy*yr&erw>EsNFdNJb_mCPv1(w4*0!u7DC2M@L5kgV-&n&o2*yI5Q_Fr?|LyqWkC1 zpWqa4Y;3H~boi-WxNt%6_U*b@G%l=q;O#N{eggvovknEaO=EpMHIsaf^YUgXbag}J4yy0zw}rgNeD8!)+eG_@9kZk&{$@B&w79FEq}%=`Ds0D$3M`+Kw@NImHb&1gQ)j$wnNHVEcDNZpssNX@i9aRgvOW_oF)2 zQsG+i<54TZem#uwVJmc2w)q8DZe4K!OU{8i#7c*eHXNxm@ z<5NlSHeQP;E3t3=^;a@XF=yn&T{Zpx*BPi}^hthl+$TblS3AmX@i>ut*x0dwo_I0c!p4bN9rvq=kmFLyLj6z)xw|+Z!vd9IQ3tW)bT|D1he(#x^@;q{$Pb zT%+@xbIk|TvC_%#PN1;(b>d=}Zo%!43e;)mR{ahOkp(o2qx$He{|CNo!-uDR~k`Qlh;coC}=H1u# zx&*A}=a=C4&xZdo)%>uEl;^vts{4^)B0rbqS?Ev>@%xS*gFo0dN4#_#5M3=Ojo;r=7m(1?)g@cj=jBF- z&TQz}p8xrfG(Jw66YbbTy*WWGX+O~;hsMtyjDOwN9b z(f9=;w4a})l?8Gd6;Cd0#D_92)X@C;OabqP$yiE zrJL6jd$blkzL#o)(Vf)r#5rQn(Z&Iq48YZn(VNT4PAX=N?bU2nCy#7Sk^6F4rMPrB zyJU@!>w&6JkF{OJ`bJ>VQJ%}iwqBDZiIJBL{ehnD@m(=|{J_g+*3hd$w9jqR@1Xb~DxZq^i zUjX}<&T!}Dnp;|;7EaQ>ht@-@*4*{=7nnJ@_C;G-`E@2F#?dCB_g+j#+3$a{WO zEi9Gtdzbh3Y59#%)=w-5-vz=yh&vSR)it4my1po6yGt{o>0TZN(ES^~cLE%2{TxZH z#j9KmiOz{TaY@DxxELT^;4-{g_jR_KIV83(>jtlG(d@TG+2$+eUS6aQ$8LxDIsho0lx2ibLt24jnIsdtDg7Mbt`Buqj7Z)h^BAu+B>CZnYLd zH!LW~vx2ZtSzbsJ7UD~a42iho@Kogoy`$^GNNikO-?wjf=DW;otE%`UEN8*lmt_6d z>ivbluCK3yi!OF{`tf|}G*iXxCWIcs^S<8An}ZV^iK+DtuwoRAwLk zmk{+?R(ugbc^Ufs87bEn3q`-5;6fo~7(rJKSuga($xJ!nA-R1kU6oB^( zv$3{jr}1q+r@GqE>nk6Okq?|M0D?PNLvxHC#ke<4y#8xADT-*>7uRY~RCZPB?yj2k z0jx|>cF8kk;KRAel;KZ!P#$K4L6UNDb*PIB47-KTE`jSN2&?e=eL6Dd*K43J=YRKQ zP5uc-SHJhOhWO!G>Fzawd0cuWyI_O~u+C@@fnFYo_lj>Ko zG`z!C`7iEj#1ZLkMu%t3(Pi{q0wLi+KW#lp^WmhYqg3Np<~qWj*eNS3M^WY)uz#~z z)!$y^zO&?J*EyU8xr z@-w=5P^@@Bzk+l^IHVZB71PfU=D66=!lm+%miS+k;f94>^bv%M`3muHAnvll7(uS# ztPG36AY5Fi6rtAaxOa}BUrKz*5#!L43n)Lc8jh}*A74DOpnGe{3*NN!TZQ(Qw8OXZ zM(h0u7pFds+5vauMQ08I-MgpEuO|_E)Y61gy5)TqdaBQ2I$+JA{tEz`QORKf0Es?I z9;wukuO?@e52Kuh!?OBGE2%w(kLLXPD+MNE$>k3Qes$wY3~xwZN~%oxS#PO5Q@sim zZC16E-r2OJqu*ag*%a*4x7R@1Q2H-yRyS8d)57Q-`rA=!{4^5e2FK{U5pi-SUYuvY z&oMguG%AXm{%f~wJldEXRJJTCU%g7Ts>bKJx8!Qg84@2hl(Qt6iIf*)%W;ge=sW8i z!JGn@4TKzDQ^$g!`AFh*R`09|5_-pl2W*DpX`UQQR}~8YV$Fe<@A?56i!wJO=hiz6 ztCe0n8KzBL>&qo~=8y$f0%7AFOGJ8_z5HL8G3fs4uJJ>|fnUKANU@b|URp(r+b{1d zR{GY!*m#AyUIu!DD(!Z;xn)7O4%=7BVGUT;fOIe0U|!yem^{`^Hv4zC{s z)>9qUZV%OnDnskTwa-+)4r8=m4DUVkNF#;Hs#?fp6vKP@&8wO3!7xX5IJy9z@JcN> zv!Hq9zE?QI{BlK*m7Zwk_(x($c0hE$q=1&AD*($o*<|`TQT(!h3)zHZYonqu4YTYg z5A#CDui320M+_tj{B!g^IPfN5!_=gHialnD*zfXx0hxUBC#YXJxp5Xt1h<^4kzcawgm@4Q+W zh#$Si(~~i0_mWSH(S?pPArL}Mji$T%0&KT=6f8>ABIL2J>N@l|y2#ccU0H`r_qEdw zkOjXt>!H7oZ>O8v5#FJt=Pns{1Kt7SJ(~=d1v~(7cLyfS@V0wV*4Y%rT}T@h^J!i7 zD9GAB=jJ6a-d=tDewuD~12&j)lQdU3Whh;~TnWc{xQh=-MCsnoY0m>lHI;^ij(=sz zHTEp%z*`0wp%AH$wfOnmXogFosgvRZyiV|R_4So#XlZGgWk&1i@wtnX%%-Q;Ve8he z$vPDHq@+>%V)$KcIDkF=d}p=;e%FujFzBtI3Z|sElvN5j(K9E=9E&79D|wh^E{kXc zSB&s<-*r8T1xbyD`>`ABn(4rCy_9C7%NR&HNy{wlxS_9lm#n6wq7Wm5)K}TK#kPkR z1a|e%S@S*Ku6OSmzQ_mo(l+P^g^R!V7?1BkU~i@Vx@c}|yQI_DTu=U1;o<(eh^qVL zVMkLH=I6J)=LNZd`8@OzKIwt!>lc;Wtj$bK4V%xaLU>lVwUo@x&Z69`9=Q*ljhC0j z)JD`k#1e_jMs!PgRcZ_i%=LA3N{mn!rLnJ{Je7|B?uO^Vl#EN`9DXSGtHejy#xh9l z^>#97S8uRFx1Y$#McD!{{6y&oSJ!k{7&8uCk9ue7I)Q3Qc5qBpiaML?$8tbhVj3DD z2D@YLu-Llji>x2>}30By)_Xzs`y#YIE02NO2DI` z=+k}9-(9KX?rLw(#iI(It?MlrIy9vN;C`g z;cCWigC@DEQ@U3Ru8Hcd^S!a6P?Yzg zX6ov?2?86N(T(knxEDNw(F#~FxNCe}zoye6Jn9M*{_Q>^KiY}t!Q}4Y0pO{cr{~&$ zZ&m%tm?fEW%=Dr0&}*oPvh?(HUf6Kp6<*XYiSdoSBb9WVA2>r`L!E==q*bYPfBzq( zuM?<}@DI(gx6NfZT>m^+)vqW&V|x%_+*#k>@uvhAVSOcUZWy)4NKZ{c@op1OQ&ucwJof;Ej>%5vk??c^%Pk@zGWA!- z`Qdd{{wgG?*gO0K%hV4LP+rpbieCG=ywX*`R;41(`c@IpO)-((?@X~irmp|A#jP6e zw)7^D)zHP((Xr)K5I=vkl*U3=Kmg5DFPI+R3k{27h0q%}#CUnN^gm+a!lK0ALtx~y zQIMRRtnqwHTOA#pGH7n>VNOn+*4WUHh)Za%gROL~p&MdtZN1wDNZ5_f=LPOSNi!Se zj;1u1K2Cg6QB_sdi+17-L)nbxf8WWfckx;b%wqBQS@Y_qDysfqH95K#*TA!38%vp8SzVtEpe8tUp|Bswvx2q@*x}{Rr-FK8}M2hQ;%2uY3|8la48fqEXliIob`0|yR?bo&t~klf z!__qqY8x1^VZ8tOk$$$3?b7Vp{E;)KPoLheBqgE7J%`lhR2zQ2{l4$d`wj1=g9X^T zHsZA|c7k6Z-m4myTYYUL9wAToeoseVggd<(OUL>07O>QE7zFkuxV_}Ak(%F{)%rI7 z#^TZ z)Ajtcb|3catF)r0{zzSZa>KNLD`ON(mUx@qhc4=9s3U92;FouXE^}+&{r!O}p>U@h z;6c9t&Yz_+#GIInlH+{vK!e?%xInP5wp3M6g0luOUSO7b@%`o7w=b4c%E|`P(>dBi zwPU1rf21a<^o!nCR#B*QSd96ZK=P5p967~y0PJCBwt%l%JDvy6>gZn_(O3Z23b?Tq z$oqe72T$bCPW7v$3vXqZ?99~<2k`DZT7Y;QqjBA{@qm!)>zcISl8La6ES6?@c09q`ScobtAA=mGrV1~Rb|=R{ zP3ixbT{xhc`V5OE{rXBoHnVuk+zl6hJsGnZnSs!c7*28AylJ|aB6wS{>&U(}xGfo? z0*H8+mW!g&HX!3q^&QVi89hy*)4wkdP{4mtjzOVU+fZ=1-$e$j50QzA@4u!k1K!bZ zI8croAn^oWrg{tPx{ar2Y0nLL1Avu19xL$V-)xUm!IZRaT_Mg`r#wVJL8&&Oe;w}lL<}6=#OlgT2a~jL;lK) z@2qL3(HqaLTpYg)#= z4hX%lkT9yqZ8*}R(Wvu8)CqktR~64nBc}fQ7)b4Nx(qSGPpgodN?HQu$ZTwagJg~v zRcLlFSCKKcEa2+Y?A6u7r3ksOQw{<{^yca*Vr*0NN-9s%KM>u2T-a6SgmEqPudtLO zy*=k0N=+0?C0rirra}78I@W?RMv%Jrdp~EuT^EKtN_HxN;EJ@vdm5=3Plj>r5Vo4| zq)EX>-o{1)`@w~KN0kqgWjGM`FXcdrd9I-9_Rl`D{5q%=lerdRoE@Jiy{ciX2d)M? z-XfMX^yvBJ=*NDlI-pD|Jaacc#g8iVdr4KlTk8`UN_r;+ei#($y{vvrXWn1$7f&3} z8XrjCCRkJDwkxqtbZi_&V2RAJ(WPGYTLTZ)YXO=W6ihXxWnvuQzn=g8lYJSm#QAKP5-Ym3R>zK+UX$1 zyE;AJyI1zJJ@3Yi9gi;^cj?XL&1U*K{Ak0NwfI}xE+glPn*M1k)c-9pj-@zD%PX_( zL;}36U*Nn_>dkvBL3>HgR%3ML6+3E%0F3>Ik-dd3+VLc|OVy8#21HkFpv3?l*usYe9FPfXlO`0}C$#loLCs#(=rL;+MNjEkB zWCz;mHOVYnKr;bBVJ`l*#g}02i=J&W9vfnG=749Daz*mqY{-KS(I4gkkgzYXbm5Mc zb6>^NZ+E-t9nDT!>}ms>p%mHuAe2T_*4}xOK{c~uuX<0yv?oWyqNE`nQjAN@-MOxn z4>Rk@(Sm6Fn!TdqI3n)Jcl3bz|J#3j_7mz2xpLvcjpVgVn%+HNuZ+~DCs z*df0nT$~FRa#AybqaKLzShqa zc5bs~Mv@-o{%?l>-Uc;G(BkLh;~cIctKH?xx1=9{rYgq%EU3 zZ#=51%qXrZsTNc7IM7c)024P$<$^)C$4Ef0-WU|RdPB|Qv=zq1#W^-3_p+E|%M&+8 zOOJyb?;#_Ky#<*-v9vSADC`G`rxN8()oM-yPH>|8}^?V2pOJco8}jgmh@@%RGd* zxVZnz7KNJX#RCE|efrE~qrcntecREMVkXbBGzfsCNpOQ7l7D}ncgJd`nsj4)chM_% zQN6Rfd$oON{bu(|5DaX(0Mh=0FQoT6^8LGM?c8E2&_=wQ0hT}8(|W)6_!6qjexyv% z20ta|qtg+SW4H{(lllxwnYnfe9^+O0!w2!h-Eq>5$Km`AY}a8!+|$ox9rY4K;J@K| zp5NLZ1S|HX(8R<`)*Jpd z($#k^of?qDhYnG~m#U|09HR4A0E68P5X>4YScIS0t&qB{$E;;cuOamKU;>r@;XTve zC=#UVcfbnDz*TNg-vc>Y=a@XpGv7~e9)xEXUP7$R&54V10@QF{^ljGna7a`pa_k;`5nfkz!Y+x zzBTy48v|@x4zuw3tC*|w2R---V!)D;66=woXG1*?l2_%>Efn})zc_JRRA2CUf-eLH zz3>4-|C7T%;QVVLRmMsP{mGG`K6SnEkqfh8h7{q#)vhf=tT75rR$>aW@XE-~cx2Ui zx%;LDcGe8IucWtI1K`lq-0>6z2CdUAzi{4I(L>%tUguUdU;+O8Tmm{C3^GPSf?swJ zAiwZ~t#P_F3J`qprwuXacV7il4l{g!Sld|VW!TbmZC?E|e;IejKa}VnE@3VlN<}W&a8M+@NR%lxGXy$QK zH~?*1?N#Gz2b-J|oTFdEpO2NmhleCO44(f*5dC|=^AIUi^~Rjh-eOc1)$Q(XA)WLp zwNm64cJltDyu3f-4@xTUlEx{tW{CJLv72_AuTDS4yfb~R39Q$lLy*A!1AxcDEip8d z>2=}#K-mE2_J!b}^9RXDlQYT~^lik+V-`_DFJX+Y1>y96;4Dj)ikDoOxL~j^1}Vfs+643_|nGv+s>bq0>6*vi|msQJLM1O zL3xZx5^CwC{duL0>^rxkje7^jru)BpKL;fG)VNN#s09{kdvXsXA$Mf7u}L+l*s_S{ zUz8GtRz`uGxBoWx#n@ z%tsH4i_30j09WQAJlvPfTMP}khO--NyYRXgPf>=vt$ju%HTX)X1dZ{#*r7;ExBi?#A^STgXs06uKxatu!|yC8IviDARN2E5P-<8EXX7^sdDN z>4@^X_fm}zVZt5e132KtDhWfM0-j^17J+?@QYV0HoS5!-&(Od`e|&Z|5}d(bVH$J3 z&3!Ga5zV)Ie?AR(W}}f=Q*qf_MqNGBZF@mCpLVL)N-(_3>3Pbt=&()Q8MtLh-Xp#E z=yA2o$~K`#oT`oaI_+%WAN)SZ3q&**pUj-ty+Jnrf!wZqttMy3LbH296oEGlWOt zn?68}SI+F`a@pisVU4gfrRS-CspCdS^*|}{U;R)6Zs36eT%|`WN3#?@EM5UXj<`5! zhj{H12iV$~(YT1ng*>-;!Xm%>3??eChP#PRKSb9m_Yn%+L%c%`?)JD0BkX?XMBKjx z=ESTBLVu&Ko`&(`05|DyHfi`xG=w-eH#fT=?wa`E)+IFE%X0_GtAF?JUk|aIzRSxK ztfT5OR{B=9fep52qrmxoZe|u9kqqbthNxPXa0Uu~kUNla{dM?fWQyT^V;Q4aG!`E z_sWpiKMs5as1DWJDy`=jZ$Sp6(2T z=GPgCF-Gb6JB~B_p-;iKkMBem9+zM=jmcz;Ag-9rXI z9+Mqs#(+fY^khTb+-RXt$iJ@WFDZ-DWQiQmDb{3z%zyAZJ_d0y; z*t2?0Edf&UEvg0~9Xx=ch>p87(BVixBCjg;&RFurido-R zDbZn~&|xPyDRkJx(Ho&!X3UHC2qP&10-ZojNx~0ffurRKFw={yT-|BzZzzpdYBW`Hvypnp_k&Yg3qBfTRRQvcRS)F z#^)yrE+~YnFuFcK$W%ro_f6&M_9!e+9F<&PEA`Szx`SbVoixB`>-0;mM$d!;j!e!y zYBdWKa_kxRkD+#dd|6($pWv@)42X@0f!0t&54Ucz(aqJ!K5JCbTq7797ZBsLZ(nQb zzUl855YT0ldGeO7soG~lxr&x zy(>h=JZG3(M|b*+`lRj1r5YM1foM>*))3pMs(porcYb**X^*YIXZo*}5uF_^J$WA= z+Xo6tF`_eFuTt$!T>FQr=67Mxi4pf271oK%6_+rdDC1~(VEH?x%?Pz=Rm{syg?EzQ zmcpa;bV~qZ);q~GGDX8G;-Op3d1HHRaCO*q$<};zjmG@Zm)kR~5f_<>{k)wN=77RL z8==>7C2aaUwX(m>7;Oo{(EIF_F!%3jgZV4LEV+{A3$t_EljkSeW-x~7wj;1{PmG}`{!@O2`9?~2AafeLQ}t~=Kqo_fE}or)LCKks z%Nh;-?f&Yc?wUPaeI+xW!y8q!-3z>bJo-|{LEXasH`vs{u5*;H&rg-?7N}z(=;9NLWZ1OOu0BNz(}pl zVy=K!Gq8Pt>8?xxjHy~?WcKTBcco$)O&i>?FkqlaUNvT@!~?&p3`|UWtT3DGzC`Lb zaHc8yArR(XkW`S8;taGV%`1S+zu6op7Dz`zaQGFKmTr!0M_r%~WgrkFa1~Crn?b>$ zZi62$~o&(=H*&Ksqx8mvl_@5Fzj%h-zVS`Mc731nHCon6~ADAm`AkgoG1TQmp64&=|g^x>9=!KfcFOFo;} z>Zy72nzVfU;54t;~l=FDe5>~Pi(BVR_6PK}J z!C)Ld{ggIZ+6`f4Wu=A(bOi;FAMh&-b0B@xQY}7|Jl`|suu=4{+EMum-?MP<6&a`Nd>N~c0wFK zp&``KRR8vEc7=H^oP_}c|Dv>A`oiq#cvm_G22snMknf|P0Qq(3(0idV`nmi`_P*-U zAItL9OsuRkdlt^lZSh7ZkERKjvER)bH{IJynrQXJC2t)KR>@{DHDsw$$zGX0?j@F3EVFXTVu1w zk*MUPj0+7a9jpu&E==wr94&`IlC7h^@3>3g17F|OX?^i;bf4b+Hfsk_|6>db^pX9i zBA)MJTxdW4s=27wMLqXuT0A^F0%NmBc3}3msv~QTo@~c0bb%bkODn*RQC>ZP` zWK^pXUqG<>JIP z{!1*!kC&Jlz;gTgu+9om1ytdqk~Q_(`j!19%XTQ&MD^X8NvgO4y#H!dmJ3v*cdv_m zRaDwTFG^ld{1@(#qIb9}+0MNT8pPeZ1g*AP-J{0idAm0gSzc&+rfu(@-Zo>{Tv3P< z+E+tbHk2&67HUtq?d5UYXBcyzeuE>@a(e9S?~+Xl*1j*Kx)z`v+a(2DBiQva$J}NF zLtUlq`%AYOx&$eZkqnViS1-r^RJ*0Z>TE}(cXTMUCfg2>RR!hJ{B5c^})S(PMNhf2(k{uKC`QZaHi;}QdE9gPLTq+2o( z(5c1IPlZ+82pyQ_VMC|bPoOySKuSO5_46rJsB)N24o={io`m+u7Q4)1LKniG6a!)@ z_Vkk`(O#hqS5e27+kz{#S*WqFbFk8_tq$J0gV=>%l4uWCyc>l#)*?OkM5ab}4bV4~&XKBdT`r+uPQ z;bFy^^XiHRSGLKgq9md3^kI?Xucs91=h`tA)h#yLK{qyY4SCb2KgLSqwusg&#g%)U z_Fm7ZG6VB=#;^rm26kHuQB*n5i}tNqy++=|7Io_0#jFe2OzNtxS*G+$MtsdiJ|Jl4CMX0Z!|DxwcUOOYDr(1^ znRrtuW*f(;VXDEvTedzr@55oa^kTBtZFkDMyWlNJnJ#07f*PSf!uf*%;HDVrK5y?U zz$qsuC#5RK32})w&hUaX$gM@cqI88bov)o736ZjzXt^5Qm&)6O=OHa>rSN)QI@*g8 zY6B&v*7b0`vkH1PY8wyPsx^nO3+iM3UH%FWxRQfdsruqV`p&m9TMXy9XRPN>*V>Ue z^uI;1jY=Brlg6q~YFi1Ky|F&8WfLuV<3vc5?nH!}gYyS<_Lxs2U2n76yiH33{3|l7 z1k7o;p2<&_Ax@YY$bXcJHe>Ovw0}}QrBTM$Wg)s$z@u{>J{FtR!3Qll5mXf0)*orv zCXOcz_^g=RvrHuQ#9IVtGCtULm}zw3)`KPseOO89vu%~M>NOE%E|d8dam#hxLqd8n$WMBO&` z)VInGv{n7UYNfD2tO7b7$ep5gHZ84m;a)3xu7{>~VgsU!bCWf&1n&)rd_UQFi((f) z11o*5fr`r|pF*^=;`6N%6X;{)^3;U=SK+*lHXBlpX=G}&wZHV1PjzCl_@dOfKU+Uy&E;%q=OS~)5#Mhc? z>U6`&m}ZS$pELv41ma9C*(9eRIzo7OrbcEIB~V1Bj#0q4t4>NHu4(ux?LvxU)!cvL zQANrh2|YV^kqq)gcc6`-h~{6*ngwVYU{|tDE7p}uAX?0axnJCpw=l0i9pGWFKPXwU zEWe<7rFe1F#w(|&geDc+w9_MUBF($ur;xlw^rx=*!!=^IF>llo#aW6Um&?O4#oN0H zV_Lef%%ZT>Lz;RKGc{K-5=gn-8~JA275YdQ=PMPtUh{@MCr2#!oGwKpumO{<(rdcL zIl{~LIz4gbPg@#z<)809#L_^uI~0e_6F20O;cq^h2WXxFuNZVNBhZw#&KGbM;Pi9*;kUVH zO+iK}4us#)&h>t2RFXvJCxa{=Vcv=od^Sq_`0?4n?sa2utcXf(Am^+%T>GJHt{h zA7Z=I^V%Vh=rUsIYe{zLJ()U0Jpi~Om(U4w%wjiaT%IV-`ib!M84GUzwv@Pq&aIO( zE0t-@GnNK5Ujvg}4E7$1S(MU#3b(%gAe{M9^L4Bb zXk7o3yrt&rc}Q_zfCDc?HDG9TX2O6Fm{3uG$?C9S_1R#sc8K%r)0;I8=n3X#dIasU zSbyeVpg;I^c}OOU886^Ntk}u7Fl;g}%ktLM5m|W-u7qS23LFylNioD^+CBub!%Dzy z9dtR-`LCR9jy^_OaFQz2k*X>`l4|NL6_q9=x(w(uMuKmqnOIIm3G5dtHUEA9lZ%E)%z>0dTXd!u5o{*pjEuFBWpVd33iU*aOl z>6YM`=n&e|y#up=ip-N>l45~9F398oLB$pZj+&dZG4h$DT&3PoBM`4jo7SHxjUP3y zKzPYyj|#uwEmh%E(<$wi@jrL*A-~}K^df&|m4qiE2ZtXR{bAbMQj55;IzoAZiE{TH zul^s3pLlyJcm3qq)V-QYSo$PQFR2LSTCD-LU859!95fPVcEm6LNmVo7OFIyv zumzjSkHVed5z4c_e;r2bR59oq|vz=+OAbS56$kABG*NMwL|MDzI6&>xyX-De^O>2kDcNUTQ zsrYn8rCU7f@~$?f1!YWcYnkUdFCA%_nhX)u?OHQ$bX+^0_|&8)>ve(3F`$<_bm%pB zH_2a0c}Ix>L(Z7Il21iOH7jF6IPR7~i@s%T-9D-WpIyb%zj=2!2jcVRJubxd2aTyG z)5ic`JrJI@W7yF*iEQg(&_YvGb%*YPGQ*dz+yK`mhl$d2>O6w;5ce>`>X(fGj^@yz zQ=qo{*6kdy)oqX|2H0MvWRbrL42vn}#kzC=ZTHV3^3BIc^$wBx;V=uSJ{|GJ%@4!L zE{zqq0?f1WFH#9?2dS^K*Y__{N*+MCSa)&~*xcve?m~eu?uf3Y+1sJ`);WSCVt!N~ zd(mLv^`4NgYJj>1bgwyqUlbF;WV^}i}%h@9UyHu(BqYk8HUFSuMuk9Xj-5{Wsj7)y+sY@ zhXLDi^{-4VQTP0q#52Obzx|J7ZmL&wAJp@CJgbRWo@`Kxl@tI)L!kQa=1n>M#EkN7 zh7L&`ul=Nh1)tVvrZ`9b`2R3S|zRy&iWUT+~B7lJI;H=73!+ zC#*8?^{B?&(r)bmYApfVMIIk2B6>d0gPc4YF*|Hq-nk0sodcaeW$9J@C_yh3fAz)} zd3_eSiTUw zufA5bG-hc~VBZ~wi`NCNdD4Gt6OMZX<%u4IbMl4RJsv@<3(0VucfnzMl0D{7) zFrI2liWsc3^WRDuaMnQS4A5=;v(UdCD~QVePj~Mf)#Tds4Pr$>#iKN-3JOxA(xj^x z2_PW77wH}8HDCi21dKH4M+hx6={<-F9J&NThft&wkQzt`%oTjz=Q-z_S+l;G`QBNx zhChIH*Q?$8+P__X`{Y^BH4xhmB1x};VW8wjP~{n=Brh~MAqQO@q~Zoug6i>o87q_k*F-P?|WmnIVml19S0L{gjRIkjPtrT)L zDyuw-^T){gHrC;3yp!>p4)VT%Oed)Oj%WyUwPJv#^efZUq1p} zPMFIt>NEx)dyc|6m~p|yi77u-;{6ogtH$YHKkljpdVBXt8?Ywh8C3-q8f**pvZhl+ z)H~VddgG(^3DK2j3AjVfm~UhR@n4z3XU^2fsAk_6VT5Q`{HY&zL-l1_0@t?1sX8|p zl>f{U@X}XEl5HTf#(OcW!NK{q><*SG;C#rh3q1<`2_opr=}N9 zF~7unszx)*@6QGp-4HY(*4FQI)UD-x4q}*-tz}Ll`&f|gG_%VJb#j(jG%r^Q4V@n? z&0czyi{`{uHS9?(Clnkw9$#E{2upvttWJo%CBK%(kUtx3LlB9ZDE)dTzlit*HM=wF zW0)&;iFDSlE`3rUGhTrE55ZS%2Wpd&Ib00h_3KN;VMLbm#rg zwx`!{-~7gJ^&Ua3RW=frNl90VQl*l%!(RLkUyQOTG zH?7>>>%PgV6OH$FFe=hOdN*+w^4+aSNl}{ns&Rf)6(LvACH#KX%NW=EYbB$1pmW2P zsoW+9E6=^{QxxP>RZ5I0YLDT}&q3=%kHe+zXO7O^pGypG->AASSmk1tir%nHpiNbr z&W0tRT~$CjL!BWFoEku-jsf{!F+-QAndA&>M zx06Usi@W^J5VBC!<*hsZj{+@csW3IJb*eRrd^nSae)_JK?HeS!(B#WK+-2hv!iW;bkiQm=J?=D>Am)J^;rl;O`m zKQtj$ib>C&@W}!t6qbM5#Ed?E_D)n~SumZx!bMZ2JU?0h zU-{_@>JSsR=c;$!6CWc+$TqIY9R2xsnrfnAFL`8lGPcviFEiwMamSZPuKXo#6ZYAY zi=m8@1T_4-xsS=U3?hn}t+u_=u)t@Xz&eHN}s)LAY zK*<2Tr=O{o$YLV1^D9aH`(a6loq4$S4=JC17dBK{Y&5kvgRrvD1sjCJ`Mhj(#=L>@ zI8La8i^i;-e$O22l@@ZOB!|O(0bsBl)CnB`vYOS&<-d^inO_+4YM`_$bQM`J(#3f| z74sodqnKtixZx^DB;f(-2W3AwW7Kb;#wo=3N}K(~F-ZqKiOm&%&6=TN^E+Z^kKNP+ zs204IjwvrtKkwr6OmDg&cHw19#Oa^8CgaOg)IeZIk6`acV9U6+!J!V{Ie7!Lfv@Ir z?foFO3Pwbufu@mlU)obH~kp=L3d6e*#T)zi+Y`@>1J*Zm0dxTz>e;W~Q!4yES{kbI-bT!rqn`yc$jEL}SbFNHZHGL5X4 zR8H1Zmm)SROyPGOd{CnTtdeFsEg;I=iRqX-LysYJ$(Q}=CiJ6>kY?o6unE3Rhpm=) zWzlr_FQS5Ri3wS!4&2R~uBHmtxH-Gjx|ve!gk0AA>npggPaTQ{yuq5JvypSU{kzXrXMB>tEXqZ%5WMpUAeDCe! zOhH?HU23v?noYCgX4+M!dqGOplCkc*JEJjEp2Of~d~vPIrluc^gR^2;My6?1<}p)M zVu_{CSqp+sum)M5Jw|hR6_OSx6;|9v6bl!sEf0LL?Ml<{6H=o${$7pN? zJaDvP|8aU#tm1GZ^AKcj!-CcIj^MtxRTq-{Jwz7ECn0dzR3tL^}Tw6E7DbR|AzxiuLv-mFYXV{#ouccfeT zP~y}mPXns2d;My4Ny3}xLMY%`GtgM zSKWP0kV`XOaW?=l_TR2v1CH>br^}T+t&!}qPxqOZAB2IhN;!D8Z*ZG+nXSLH)=?S^ zrJqHxW;PISmrKjE#51q{S=dt;gHZ?r{9g`^5Mw!?_@fN`->=d`TKFBz^!0>Su2z>$ zmKNi@BHSm7YAHUgB_r@qK|}!H*&!i$-1C@yPE$c?Sr_0NOV|T*0$FuBz$r zjk~Nqu|a;j+Sb@Yv$`q#VL&iwE67mtoftDfk5m0F9P|9IshM%JlPU@5ot9A?u?62C z+u(RmyDCi(N`o(!FD%#{K|Rnm@QMZ)!@Q#d9ozn$YuDsJ7B=8$2#Wgmb6gSOwSeWv z+lTiC4^bX?LcmQ_T#8iTq7?23@biZ4XrPa~4y5Hiqr2a_suFO;_Dkzo-v|mAzBjoY z_tGNe1v~E~$aDgizZle`33of~o$|cu=>C&wil@9p6?bz@e9IpNUE-CI(7C8KBHOU_ z{8n*CCVAMoom*I?SlDED5%zRL2|Mt!DOU7M<6VB_lCuwq`Kfxt)`Sm)p;U&Wk#44+ zt@5jsul>`EUlv*EmcIi3^^URpVPImmj~VCc`w5Mh&k74LPih}17Q93QJTUh+>pG(^9*r8H}aurssHCETmZiuo7O<^OA=>f zzcTOTF@Mu>kJUt)O4Ti<7DRT<@g`mdo*2EF#@Q$d(^OvitqBqFu@fs{l+hWB2`_gE ztzAb}I^MC1t-Yxk*6f~YBhbUAsfT1^(8V82X^-|{RZJ(y-$1IdqKtIAc3MEa((29I ze1yTXUr%nAkF2k)sQw-oEY@Ei$!RpX%}5}58zJ9*g}=qT zF1+)N?@{&>NWJ)wF|u;_FOSM05xTtl)%P!=v^|iQsfUw(NWo_B@4%+kHXa25La9kO ziwBB>A+Ox0Nu2oxD%kDO?&8VKyICf05@lgG5v?oxe;}{DJrvPCKoyoX#Y2KOBp0)i z1#ykbYh{qSUjrhXV?slE3kL=GM$>1KP!>?1kcw(mk}1zvcUvT0C}r~2D~D9+INh5X z@gp|esf@~Nh0J;W5rqTa-$_e7n#fr)8IDKBnyRLbY4Zz9%tpBWQLy~e%2rQTlF5Gf zv?Pp4?V0f%Vy^YH_J}WWM=bfZv6hm3oVBeX=R>v5wrtD?ev(FB_EXipy;sUA6_t%U zNIn2y97;*G?-sw5mBokOCk|=1-Uvw+x}2l(-IV>HX-56*=4P7VHQ^5d6+7fs#)2W? z#-QSDJT+J%arG2$k99z%lxG(8W;_JogAg(YNmRWjAl5?tf;>=UpX8}Df22=OljN4Y zSf}=WQ!~8iVP5RX8&yB8O4VRVmc>o+)&8F0Tdgno-4tn5zSnBaIcdEP24w%*jq3ld~p#9%k$J6tt{ih~ZMLeeWOxzfSw(Cm~+qT&}Q!}L>_8abtCFVuC_NndC zUDm8e{`fHueoZg`Jf#i+caTx9y!p&@@*thdzuM~*mg*6xW?Fnb@Q->(Fv}hr4bo^kG$GZbcB}ad4(i;`1r=d z@$d^!Vq4(mAN3cgiONkierWo90QQyrP!n8l=+tD)hYM=WNhhL<&*xvaOZ{d1!QsIM z^79Bw?#^MjzU|I|i@_ZOv1T8f($nb4DajOns6*bg!;PMkI*1E8g+f)h1eAxOte~c2 z)9KH!!h&W;JtXSs5RavnQ+kIK5EW&rcqCbmm#^Ars)#6Wk*V|?_2JsuQU()8{ELg6Esmn_*$7xUuC4OG>Gp|Xa5Spd&+YfZ>o@I9j&gFbmNVI(&9eWR3 zi$+N0rm*(R2#hT;<#{?d);$r^6uw>Pu0_`tBdOVH`R;@sa^O{Zm!{L@`flhFSe_*? zZty#uE6(;|Tv+1eF?#zw*5U*IkIpOurK(Lk-ud=_cy{vx!`1VERhFKyjP`2*eCh;&^2vC%FsalTe2}?SZ?VdPwhps-T6x1T;mAo@pXE zKyrAN+U3{DQ6oi$I@+K@*?KTJ^N71!2XrJgy;r8<40E+jcem^7!V4w#MDn^s?d;XcLYydLRjM(!AD=2X|@ESROBA(P+ z3ojA86E#xd2oqVpU&B_hd<+ua|0(tv zLwYCRb-D&dgthZ)KfK@GXdK`UE6lT(Ybd*4U2HORxg0pH2;3DWC-o&)3~B~kGRV!o zsl^q``=<=iORQ>!bKzd-9<<7G`=iQ>SYgakqz3D01Kf0vMxBdAHDE-ch%Y!|q)SJa zPb3|Xj)s00MP3muEIpd35t%9*!VFIkfhHBfLGvF_8Nkm;)E@5?=MHN-$>ua4U zr-kg+6aNtIw&}GIo1M?)6=2Oh&!q~==02V6*h~CFTCKHF>=~%3`*?E|GM9e^1UWA= zyp0uLr~&xpW1Rr2m_borz%|VAIG`(ik*#WNGForG;MM1c&>TDx`Az|@h zp|p2xH7UZR!(i~XYPUpOtb=WubMA!`pDVU@xuXIGS;``~7}(YhG@r`78N}{Hnj$YP z7aCZpIB8{XRCt6OFVQO=T6~5q0tm~FA#c)`kkEyC#LA8!wb`K#kkRe6aX?{ zb%7Ax3q$F;BZC_L2uU?xmoTz@)*nX-;IYYJ9fWzSOKHD1#=bg?;VL}qPi9;5*0T~T zJSyC4=**&{hg|KiYAdO$zh$h&J}tm`V$9WDdqMhC^W78DYSlN=QHF&w9KU!Z`Hw>3 z0K_?pFr=dT3Q!Y82Yr2H`~~J+y2fxya{BIi%=Y>7fWJ5U*a=X8PZHSJ)Bg>CfOkSG zPAAxK&rn&pT_+?VnpMQmcmvxzb0|3ChR)tG;|#U~fu|J8fPVu8;Pv2i9;-i`{In+A zAT8Uq?p-8S!DJe^7`fQD!8GCPtQ|X;kemIV8vy^8uDdAkTzG`6uC4-0d-s(zuZ}^N zUz8LJN|PU607wIHF#tyiVTiy9^BxUy#^ZZr58JEIZUL)rrjCr@;6k9wLn(=-Xd-cR zQ#f4=0EBgW6&1(XMO4bvFsrx=+IKx;cM0Ut$87T6q+X^(IPS35tu+#oP1);IC;?0q zEk6SW>BlzK*x*3|_hn8_Ub(`2$Gd=ish=;`g3{$y zKZ=ilatBu!6O;(DdBVZss-3Z!1D z@o{!mR*;#lsAy|!?9^*3-TczTcc$WR(_n%S7n5lGHSI{iZFYT72on+Mi(_rbWd{lC zV>O#vIgbrD2MOr9Etg^**ij%P=>JGQQ!s&L2f-gYNwMJNrGo z7dd_}jH@!gvEXl8#7&3FLIWcSOOT?nKcYMw8V7waRT`4!n&m`p&*0ZO01%5v*kBwK zQqvjO3Q{bp@})$|eX=1XRq%SqvV=xl+p9j6i6T#~pHg=&GxA(RjYq5MaB%o~4`?>+ z^eYHYcuo3DPgBC-YFkf`tPWaiT~%ladMBw4DDvUS$!u7|M83Y;cJ@j;e~Iw64|^xq zw(SXW_5&>Pm-PB`6vuDR!EIB$To$nTUZ6Cd-X&Z+ttFN-kq2TZ)5B(_d0CgAc2o66 zma?Xyf`(ex*nTJm!_z7uwdUFBMyi*gkWhsitK3Ygk^~5Yet5d*r2W&%kENB+cpsHI zVSCM%WY>u|Y*8_)SvQuj&gm+Fa)g%-p;|2W>|?$uRu;MpzZ^g9qNdk_K%vV5vDADV zf^fZVOYy6~0nopg>!4yk^TjwsL1VKZqS>?%$V7kq8zmL9@jQHIQe`gaDA=V21DmXM%ZN_$ichZU2o{J&07m9>$?{;!+%1SlA3OE;t}u-Z~csZxuCE zR|jr}tFwD7a=+C-#oPoIaV(O_{xE>MmmF8|DS7F0vGq?EWqI#hf_&BGY z4Y!dXW~to4nS7u(#h7!0BtFV6|J*8Y2ZG5B8NIJXmsc9%*VBwsahg5d%0^5NJdp=A zH2J8Dj6`-9JSuq!N7p~_+|FPnD0N2!S*D|{#)k%r;1JT*eXQj(tne+6bVGGh34%GO za*VeXn=ev&ZRRBGei53K+xnfD7$J%>aW>MaU-7;O9g+RQjw;Fb%MA5EYH_Heho?_< z(kj{`IJA?F3k4RtOx!teLN2k{+lN<_e=bGjY9n(B^8?~F*V`xL{bUmVlwV~kqT>Dt zERG+hgfTK9$hu1|L)qWJ`$K5fs@6Bp{+x4Bz zK88y*d4ENo4+VRnLE-FdyJc39T>rSL6d4#`Ta@q3sT|<6b~Rjd8#V5r6E7k0sCdNL zlkD6at&%X9R=KmEIhdvc_g*zG8i_PXHL5bu!ynIlPie|E-_l+xXwryf8}%P?K88st zDOd}{PJqP|uZUMSF+XD>+h_M*EYxAEw9>}AcC0f0Fh;&r4_0c3F7KU*5{8S0%MR!6 zzZsvFS(0m0>i9Quwc%eFkfdJa`rzz9oL~Nz!|{=FdOagHGzo~K0-uGuv{5q z`e%|>+-e~^rru2Sa4X>tU1VFGRCIOq!OPKC4ui{&N{o~&X%i-XP0C5cOPBd#SD_?h zcl#Oj;J5Jj$9oyLjSB)D38tRwBPv~pu*mop%l)BNgq^hA)l-u$#j)F`B87cshKKxpL^ z4BSf#%V?fwD>Kt3j3+Se1gqxPk+xGVt4UfoY+AwuAwlDPu8t!4#eO^JWzLbIn#tE% z7t)hT2d8~5t4Pfgq(d2HNnf_@<=-O~t3X{Jq9#6irss`!WX7Ot)I_e};%>6tntVh{ zh@9GU#AC$qFJEYC7`Ho`zLuu#aZ1j0xd6_ZQ} zhtY}|BHh)`n%+0wH~$V0^^b?}G#%UH`DRd>t^mJ zpXvVIX(cGw7vb5xue6+@;BbDdYFSJ}=ngeM1}EcAsv;iuTTLRC3%lkABXoIRbac``2RRdjlU2g^)1Wl0yPiWj~cn?A@*%bNKV89}) z3+0q^ACdO?SJs+~Y`OceGfrio(}YcS>&YfpVNm|mjS4;}%c%K2dw&qU*IGVKcp6t6 zl#0&#aTus2dpOv;!+TkU=fI;}kDk2IlYwhZK=URYG-k-74%{ZW@B%$+EB>RSrqbJq z(-Id7tQ<;U5XonN9eg(U;FJDsMs!8yF1C79cxXBH!5yCbQr$8mNW&zyhI3@Qe=T-^ z(@bS-=}~rM$BrtNw z%#`Ms0cJ#sEkN}K&$*f2k2f)fN|jHLZS0~$YSx6=5G{^Ic*iH~9yT~VpnKG@ENz>B z&|PJTWWSer=CJ^#{i|QkjpBQ1%cCQtLcx@zj~0<+W-SQ@V!CTmkjE#DOs>Mt)Oax= zjFETjtFq5?j?`&#q>K{+&H5Mm(Vxc-9^0pW-M}R%l<#a)L2Jp=_H~7g<~;_@4zk;=eNr80cdQTs4;P6+dWt4P?#s!tN56}1pFxg*p}>qDEcf+nZTWRQwnr4*BLyH?Ae zuvNoyWF`*t6lWC*8_L>m)RC}3S2fzZs`%)hpqxig@dzKdW;fPy$kDK&PrJ;{*tM&y-BH&GC8nB0 zcqBt-u{?nix*s+8?xY8IT#XRD;aEH(u*|kNfbQNOdN=K97sD0#;jE$W)QBZL-+SQT zyQiWYqKoz@yA%YredW_u`B1|Kc=?a4w*g{(5#nw5T?H{O9p2*3AS6A z*L>So>MPQfh%u3r43wy!rL-}^->MQ_MIz03SD2+tJVIn3w_>UMws1K3z0%~bQ z610*T?1>^ypwAya&|+3u@PwzRZ3$l<*R^-@;&~z^O@@~0st5Oo4GuPe@ps```1#1l z-eR>#e>2x#__Mv=M>861cFc?yT9|xP)O=gg)%tT`tg`F52W^kmP3Y6j%l-DLpi=pt zn+D}ewbGo*D+Ur(!?)NghP8pxaGH{@#Ii8XTzEKY*V?m;UhmG`41OeHlii4-4~moD zCeg=-0u4!?A$vHd@nP2dx~Z|DFY&eOxMrHdfw<(8>qh3 zxc@qn5I}gW6Syy*A8Xjx-`bF8S}HfUDIZOT#?VDfun=>-v$wcTF$2C%(Z~AL`A>Aq>k++7EhPZ!@h(IzCxj0lG?{?cn`J zhiCF(*KT5%ICj65G9)twP1mXmj_py)!PHFxR;%U(Nz=DQP}Dw$rPc)Wt(jfxj;K_G z?KhyL+Jt-lfD%bP#**Y8OCQj>^|ORm;TXY3HV8(pTZYWC6^jkdPvC7_LUVTIKO;J# z5;=COsi@2awUCk#qDvJ0XfV)j2TJYIu=R3qK4^iE6Eq)bH{ufF|4ud6)ZHIP69T#9 zfh=J-*jK2-?HzPu7-^TcoRNRtJw~!H+giPO;I?lGuM5g1wvO0%FxPUymxvyED-|na z3$@nrzOI4prTSrmayrBf+4Snwl#ocKcpHNVGc_~KaTqSX7+wmH;c;=VrxxjPTtZz@ zJbEac#?v-B2O*QY^|`wrc%*?=ZkP@8u|c>r?tXdenkH9M3U=Z6@Y_3Hg)mxLvqPAl zd&RGj+;aD8cQad+>vDrkQn@1=`Ab4NLknP}OD@eR5MgN^fAe9cpkEUsPFD3>C^N+_ zMn>sd{IL$7cm>`Xk)@Q4?q=eqV#CYz(c6+zzoJkOS2Q=MRc9S8YKCB(7x57~ZB@XZ zxv*|Dz{#kyBq}b(qJtiK)no|-=U-DKBFnOZ#h8)iVR-etH#y*bB-dPt)_OJ%bG-iCT`jLMu>6Df@c za+XWzaSG4Z(hsp;ifswD-5Z^so4?Z$0sI;NS3bGJmHh9A9*2~$g_ zDk>%)3)P0wuEDR>3}0!Mmd_s~biWxtlT>>vdxIR3zWdMTq}?zmN+?7sXd+7j9^@;lSFjr+E{L)k zG;E3lopM?FI&v*8fd?|iZmt;OD%<$8cE(J9hpxBgEd$FMs0(eE$i@DF%XtwszDvX4 z#b<<>G^mTtakY99ngP3+TUkvj4TX!g67m z-&J!K(+@6@*b)}L{Cw@O*Jp-;2+I9c<=eA_=;=q-iMZStUxXUg3wijPO4UPaMOOF6YUmfAPpc0Dj_fKoc(6WvL0@p+q`v~gm4xMxAnd7>n^ z{nJfMiK#^pkbL)US~kG=DBi~}zgX*_Bb&W_-ZDhjPdGQDp>2GCI`N?WKSG)!UXLv8 z|F6RCf9#CqRvqy|ps?!#9)BKw^+&dploTlMA!gkkI{=Da9i#g5hPpg?YplkDS1pB^ zc<)bDXB-+1E}-TNe6|ds^z+9D-t@o?*)>1)h0N!b;zNf=;TYu)5f8K|28YnsTp`&M zo5MK}c&|zcy<)x;9(x-}z^36M*HVUV4-Nj;!QQpVG&8x{>4QVkN((+qU2@5{qadU; z0)+3bwPfP@3P5PI3R9X1{zehZt?##(bsN34R7F1^wI!IPG@P z*{$;&qAS0s#$mP+9!=g&ROA`i#Cj3PGlPe?7RgpK--)SI)hf!kn8V8Tk-gIc;m+3w z#$hrxhJB>WWVzsZ*C?5_vexdr!?}DD-2TP})5Uea#KE85GTiq6r{Lb$mnI_-cjN)6ZS$3H&9^8hs{HdosG%NHrTh*2-H0a1 zvRXo#!$-xq!FW?mS@Fvy-xh164|cL6*A6>vC*%v8Xp;3z{jip#gIOlEA)m?fzZZ{OnQ@kXgk2jsQzvG36#5p4b^m&tZqzOI^?e{(D2x%wl@69uk$ zojO{Q^;0gnnJY&1lin)+aSXiI9R`qkhv+yxhR`w6 z#M-Ux!p6YeRcSP#BTa&MP{QUnVa6eyW8nUK{$I&rIb00n1V!-%58pj)VCAfv*&)>h z^|2Za+;;B$pfI8DcNpz&_*V1i!?P%7u(#Lj4-3}JAvBwLJCD@P_{_BWsHK&yrL3y!PS-FtZ3AD z_PNZvYez>#1-mN<6wYD%mAgq7Ki_Ev`APRiGjK1ipl3JxEB zk5Hd*eNyMQ)7`PQKODpxJoUY)p}@NMaQc8XZJ4xjc}|@flg{|VEcCY366s)RtXa!w z#GmkO5DwSrClYV;O!$q@WqyG0u`773@E@!{kAcY8A5zKRnPK?;?%nO{m8rIC#OZPQ zNX{;e`81!O=9LpUK3(uZFFbrTjLGv{TMvB;@G>;NfnY}RjDCpJJfdmj4=SCkZ%Jn)f`B;veO)Rp3^ zHdgPhkt0O+28~`tVOAB<2LuyZVr6B3S<*z~Tm?~#r-1O3C+Ga3lS(B3u0 z*`_Mer^d!r(s)QScB=ZW0}~_r=ffa*vcX=+TS?4_nYV8Dg^tlcT)7SovfnT>Id7gi zb^q!s4h0miH}!tOujXSUMR2u`Jyl*5hlVzX@THv4icgu|P0+)H?{k`$nhZ=#r4WVk zO+tmbEP={6*(G?g9z$3aSzSi5meidNT~AD${>T{6X3qS(3+E$5M|I4@={Gcy2JbSs zBFQDeBb(L$kI8le_+PJG{ zqTzn;4Jw$4QK!-9T*qqA{F@V<2v9t}0`MX|yRKnz)le+cTiA%~LeJV7PCaarny4g= zy8lkLMc~bqE0%wONtyjR>40E4b(Q<~{OrE`{{4X;sKe5*m+PS(wJMyB!KY6YY3vtY z%I_;A$?M^Vob>u6zrDIwYUY-(znn92w)v!ouj;e9d{5oxwmf$Q z#pQ(+wnD7!72`;^OS^zF%lzVW@N6*DXJ9W9)jwL5M89}YQHRTy zVA5hCHjsvs+^04;QY*Q@z=zX5lnW2v)9XQ(la7&A z&{&;k7hAfek~;(G^b15XTL>A0hh2tyr(Z9%&GyH(VaP`Es5#5%bs7x#oRCiu-gI*| z8xskKWLt>3+_SZDlL}ft%2HNE=t2gB$X@2%w)g?n_zR`5;GmvaADO<}o4Jj5g$>;r zL}bpG=cKAWS`RbTEqcYi<#8u-f zV`4laxMFXptAle~w{hb2aB%I`&%Iz#PwL~A{oNc2A408}uZXt@_q zk$u54l&S0Pbb%HVSa+$;3*9^d3FhYxPRNgbT&E#k@v!_$peK+-4A5=V^jEXW>k0B*ssAi^S#YErrLXyyLsu@;_xZ87FM zE5n7w1wfOg`k(haBA53T78^|D&%^0|JZXJNmR_qC+tPSX2^hONu0mZe%_6bdg*y=6 zdT~!7W{@nib?sm01|-*3NH|$t`76YGSDRHfahLfp2z9WjzAw^7cJJD&ACTFOa()+6 z*895mNs>ni!WhY!oYXyn$59Fm($TZ!a5^G+!)ZtUU*?@emk{ph!1>NZ z%0QwsOg0*11}6dng45TAJje?Z#CZ9?HaG11CI(#Jaz?5@%)I%SQ8B{O9vX^$Isxg`i<>@? zK)1!5`W65T3WgYfx}M)Irw8dR zoH+LAy5*U7HsR%ITwRY5ACwVu2t#DD9()!R*Oy?rUSbu%uW9aiC-jS5Hf)&>(@D<< zmLP|-7PuyG>7xoKUtq;n3$Gmf3GVQ4cL^%7x;ZJPlKrqZK0w}Ut61*f`yTZTvoh=E zJw-F39epa=b5W?H!!~9cESlq%XMQ~Y&q(=|DUzx9ZfDD^f zTDqd}yyZWOqbpN3T-2LR|0(~>2e^x%iJQ;P$n;6*R9%Pqnvb}F@updngD0K7v-CI8 ziBk`NY6TR9|4e2wz5V`Pd_~7knm(4QE%G5ILfAB5k*cRnWS`L_;h+{Cc+nt0D;L}lmi$hq~+udx)vjy?b5;onx= z@738Ty7sCSk}_u1Rj58*w^1V-)$l7u(fh*Mwc}J)e_I}MvOR^>Qv;=j2%eVEc+gVhXF73v6^I{B36}&J2o6oIFb=?p4F;s&LURMr z6u8+1j^1eB-oW995c9JnG#n=b$#Lex1p22LxqT~)ZWtQ%Y>uj8_Z}Hmne)0pICh+B z#WP%#1d68WhI^K4BK@{x_A5HpaFvsX8FQS9JC&;o?E_7U z<6;MJpTnd>zACU)DIv8cckjm!(s$MLM#p`OK)f*Xgu+Rxp+$Q8ody9+0sW#~7Hsn- zy}joMgUWo>=hdaz^g1zzWv=o1X|2`*^6uqyxtm)rsJK7eKG|{!ngj=Ag#u71Lm&e+ zBRn@z#l{uxM2vu3ypuYV=ABE+MP^Xp_-{|POXdTw27@9!E+$1}`xHh8aMW~&4t`-@wwv^X#EvzGCYwB4<`jCA9&g#s}q1~o3DyUF#Ur~<#8kqAn3#b3kM->J4-H2?9B_Pk+Q^bkOM z>gl;H=F7@9%uHY;OGHft?=HH=cSeMk!f10|Y4{mtN-6e!9R^`(@L&0@>U?SMf-E_0 zV{X|1=>X`hhY3ZnGEHP=99LH+JlxZ7rALvTN8syKFIvD4>PFo zA?-&?U%y)W_D1p%o=Ya5K?E{4}(Qce13a3(>uWlDek zVR`13-9MHGkjE|QF$VQxE{0S2U&~vB;D?P{84-h~NyL=LwlVkK{_jRo6Y#sarm!U# zV-C_4X{dg%{G*LD(ApVfN4If*pxpv|I=craW(xM|%;*1TqAXo7euHF|L};2}QlspH zIjbgnV;rrfyKUUkVT6mvsJx~A{?z}&)xM}fW&ZQ;!wPWyv%k;UF)C)ZzdZ%ubgKXL zQB&nkWQw6#78s4+NCfPx4Cv|pO%i1qBR|mr(ek`x;qXLENxrX0&MRBc4k{(6+QXs; H<}d#@Kp` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_central_network_capabilities diff --git a/api-ref/source/api/central_network_capabilities/querying_central_network_capabilities.rst b/api-ref/source/api/central_network_capabilities/querying_central_network_capabilities.rst new file mode 100644 index 0000000..a58731a --- /dev/null +++ b/api-ref/source/api/central_network_capabilities/querying_central_network_capabilities.rst @@ -0,0 +1,384 @@ +:original_name: ListCentralNetworkCapabilities.html + +.. _ListCentralNetworkCapabilities: + +Querying Central Network Capabilities +===================================== + +Function +-------- + +This API is used to query central network capabilities. + +URI +--- + +GET /v3/{domain_id}/gcn/capabilities + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | capability | No | Array of strings | Capabilities. Multiple capabilities can be queried. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +--------------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+ + | Parameter | Type | Description | + +==============+================================================================================================================================+=======================================+ + | request_id | String | Request ID. | + +--------------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +--------------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+ + | capabilities | Array of :ref:`CentralNetworkCapabilityEntry ` objects | List of central network capabilities. | + +--------------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------+ + +.. _listcentralnetworkcapabilities__response_pageinfo: + +.. table:: **Table 5** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listcentralnetworkcapabilities__response_centralnetworkcapabilityentry: + +.. table:: **Table 6** CentralNetworkCapabilityEntry + + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========================================================================================================================================+==============================================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | capability | String | Central network capabilities. | + | | | | + | | | - **central-network.is-support**: central networks | + | | | | + | | | - **central-network.is-support-enterprise-project**: enterprise projects for central networks | + | | | | + | | | - **central-network.is-support-tag**: central network tagging | + | | | | + | | | - **central-network.is-support-custom-er-table**: custom route tables on central networks | + | | | | + | | | - **connection-bandwidth.size-range**: bandwidth capacity for a cross-site connection | + | | | | + | | | - **connection-bandwidth.charge-mode**: billing mode of the global connection bandwidth for assigning cross-site connection bandwidths | + | | | | + | | | - **connection-bandwidth.free-line**: free lines for cross-site connections | + | | | | + | | | - **er-instance.support-regions**: list of the regions where Enterprise Router is available | + | | | | + | | | - **er-instance.support-ipv6-regions**: list of the regions where Enterprise Router supports IPv6 | + | | | | + | | | - **er-instance.support-dscp-regions**: list of the regions that support global connection bandwidth classes for enterprise routers | + | | | | + | | | - **er-instance.support-sts5-regions**: list of the regions where sts5 can make API calls to Enterprise Router | + | | | | + | | | - **er-instance.support-sites**: list of the sites where Enterprise Router is available | + | | | | + | | | - **custom-connections.is-support**: custom connections | + | | | | + | | | - **custom-connections.support-regions**: list of the regions where custom connections can be created | + | | | | + | | | - **gdgw-instance.support-dscp-regions**: list of the regions where the bandwidth for global DC gateways has different classes | + | | | | + | | | - **gdgw-instance.support-freeze-regions**: list of the regions where global connection bandwidths used by global DC gateways can be frozen | + | | | | + | | | - **gdgw-attachment.is-support**: global DC gateways as attachments | + | | | | + | | | - **gdgw-attachment.support-regions**: list of the regions where global DC gateways can be used as attachments | + | | | | + | | | - **gdgw-attachment.support-sites**: list of the sites where global DC gateways can be used as attachments | + | | | | + | | | - **er-route-table-attachment.is-support**: enterprise router route tables as attachments | + | | | | + | | | - **er-route-table-attachment.support-regions**: list of the regions where enterprise router route tables can be used as attachments | + | | | | + | | | - **er-route-table-attachment.support-sites**: list of the sites where enterprise router route tables can be used as attachments | + | | | | + | | | - **cloud-alliance.support-regions**: list of the regions that support Cloud Alliance | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | specifications | :ref:`CentralNetworkCapabilitySpecifications ` object | Central network specification details. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listcentralnetworkcapabilities__response_centralnetworkcapabilityspecifications: + +.. table:: **Table 7** CentralNetworkCapabilitySpecifications + + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +========================+============================================================================================================================+=======================================================+ + | is_support | Boolean | Whether central network specifications are supported. | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | size_range | :ref:`ConnectionBandwidthSizeRange ` object | JSON | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | charge_mode | Array of strings | List | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | free_lines | Array of :ref:`ConnectionBandwidthFreeLine ` objects | List of free lines. | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | support_regions | Array of strings | List | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | support_ipv6_regions | Array of strings | List | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | support_dscp_regions | Array of strings | List | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | support_sts5_regions | Array of strings | List | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | support_sites | Array of :ref:`SiteSpecifications ` objects | List | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | support_freeze_regions | Array of strings | List | + +------------------------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + +.. _listcentralnetworkcapabilities__response_connectionbandwidthsizerange: + +.. table:: **Table 8** ConnectionBandwidthSizeRange + + ========= ==== ============== + Parameter Type Description + ========= ==== ============== + min Long Minimum value. + max Long Maximum value. + ========= ==== ============== + +.. _listcentralnetworkcapabilities__response_connectionbandwidthfreeline: + +.. table:: **Table 9** ConnectionBandwidthFreeLine + + ========= ================ =========== + Parameter Type Description + ========= ================ =========== + [items] Array of strings Free line. + ========= ================ =========== + +.. _listcentralnetworkcapabilities__response_sitespecifications: + +.. table:: **Table 10** SiteSpecifications + + +-----------+--------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+======================================================================================================================+ + | region_id | String | Region ID. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying central network capabilities + +.. code-block:: text + + GET https://{cc_endpoint}/v3/{domain_id}/gcn/capabilities + +Example Responses +----------------- + +**Status code: 200** + +Central network capabilities have been queried. + +.. code-block:: + + { + "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "page_info" : { + "current_count" : 1 + }, + "capabilities" : [ { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "central-network.is-support", + "specifications" : { + "is_support" : true + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "central-network.is-support-tag", + "specifications" : { + "is_support" : true + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-route-table-attachment.is-support", + "specifications" : { + "is_support" : true + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "central-network.is-support-custom-er-table", + "specifications" : { + "is_support" : true + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "central-network.is-support-enterprise-project", + "specifications" : { + "is_support" : true + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "gdgw-attachment.is-support", + "specifications" : { + "is_support" : true + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "gdgw-attachment.support-regions", + "specifications" : { + "support_regions" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-instance.support-sts5-regions", + "specifications" : { + "support_sts5_regions" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-route-table-attachment.support-sites", + "specifications" : { + "support_sites" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-instance.support-regions", + "specifications" : { + "support_regions" : [ "region1", "region2" ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "connection-bandwidth.charge-mode", + "specifications" : { + "charge_mode" : [ "bwd" ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "gdgw-instance.support-freeze-regions", + "specifications" : { + "support_freeze_regions" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "connection-bandwidth.size-range", + "specifications" : { + "size_range" : { + "min" : 1, + "max" : 2 + } + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "gdgw-instance.support-dscp-regions", + "specifications" : { + "support_dscp_regions" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-instance.support-ipv6-regions", + "specifications" : { + "support_ipv6_regions" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "cloud-alliance.support-regions", + "specifications" : { + "support_regions" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "gdgw-attachment.support-sites", + "specifications" : { + "support_sites" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-instance.support-dscp-regions", + "specifications" : { + "support_dscp_regions" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-instance.support-sites", + "specifications" : { + "support_sites" : [ ] + } + }, { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "domain_id" : "XXX", + "capability" : "er-route-table-attachment.support-regions", + "specifications" : { + "support_regions" : [ ] + } + } ] + } + +Status Codes +------------ + +=========== =============================================== +Status Code Description +=========== =============================================== +200 Central network capabilities have been queried. +=========== =============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_connections/index.rst b/api-ref/source/api/central_network_connections/index.rst new file mode 100644 index 0000000..99d8e14 --- /dev/null +++ b/api-ref/source/api/central_network_connections/index.rst @@ -0,0 +1,16 @@ +:original_name: topic_300000008.html + +.. _topic_300000008: + +Central Network Connections +=========================== + +- :ref:`Querying the List of Central Network Connections ` +- :ref:`Modifying the Bandwidth of a Central Network Connection ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_the_list_of_central_network_connections + modifying_the_bandwidth_of_a_central_network_connection diff --git a/api-ref/source/api/central_network_connections/modifying_the_bandwidth_of_a_central_network_connection.rst b/api-ref/source/api/central_network_connections/modifying_the_bandwidth_of_a_central_network_connection.rst new file mode 100644 index 0000000..808eefe --- /dev/null +++ b/api-ref/source/api/central_network_connections/modifying_the_bandwidth_of_a_central_network_connection.rst @@ -0,0 +1,261 @@ +:original_name: UpdateCentralNetworkConnection.html + +.. _UpdateCentralNetworkConnection: + +Modifying the Bandwidth of a Central Network Connection +======================================================= + +Function +-------- + +This API is used to update a central network connection. + +URI +--- + +PUT /v3/{domain_id}/gcn/central-network/{central_network_id}/connections/{connection_id} + +.. table:: **Table 1** Path Parameters + + +--------------------+-----------+--------+----------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +====================+===========+========+==============================================+ + | domain_id | Yes | String | Account ID. | + +--------------------+-----------+--------+----------------------------------------------+ + | central_network_id | Yes | String | Central network ID. | + +--------------------+-----------+--------+----------------------------------------------+ + | connection_id | Yes | String | ID of the connection on the central network. | + +--------------------+-----------+--------+----------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +----------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============================+=================+=======================================================================================================================+==============================================================================================================================================================================================================================================+ + | central_network_connection | Yes | :ref:`UpdateCentralNetworkConnection ` object | Details of the central network connection to be updated. | + | | | | | + | | | | - **bandwidth_type**: **BandwidthPackage** (billed by bandwidth or traffic) or **TestBandwidth** (free bandwidth for testing cross-region connectivity) | + | | | | | + | | | | - **global_connection_bandwidth_id**: mandatory if **bandwidth_type** is **BandwidthPackage** and not required if **bandwidth_type** is **TestBandwidth**. | + | | | | | + | | | | - **bandwidth_size**: mandatory if **bandwidth_type** is **BandwidthPackage** (the sum of cross-site connection bandwidths cannot exceed the capacity of the bandwidth package) and not required if **bandwidth_type** is **TestBandwidth** | + +----------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _updatecentralnetworkconnection__request_updatecentralnetworkconnection: + +.. table:: **Table 4** UpdateCentralNetworkConnection + + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================================+=================+=================+=======================================================================================================================================================================================+ + | bandwidth_type | Yes | String | Bandwidth type. The bandwidth types are as follows: | + | | | | | + | | | | - **BandwidthPackage**: A global connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth. | + | | | | | + | | | | - **TestBandwidth**: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | No | Long | Bandwidth range, in Mbit/s. This parameter is mandatory if **bandwidth_type** is **BandwidthPackage** and not required if **bandwidth_type** is **TestBandwidth**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | No | String | Global connection bandwidth ID. This parameter is mandatory if **bandwidth_type** is **BandwidthPackage** and not required if **bandwidth_type** is **TestBandwidth**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 202** + +.. table:: **Table 5** Response body parameters + + +----------------------------+------------------------------------------------------------------------------------------------------------+------------------------------------+ + | Parameter | Type | Description | + +============================+============================================================================================================+====================================+ + | request_id | String | Request ID. | + +----------------------------+------------------------------------------------------------------------------------------------------------+------------------------------------+ + | central_network_connection | :ref:`CentralNetworkConnection ` object | Connection on the central network. | + +----------------------------+------------------------------------------------------------------------------------------------------------+------------------------------------+ + +.. _updatecentralnetworkconnection__response_centralnetworkconnection: + +.. table:: **Table 6** CentralNetworkConnection + + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+====================================================================================================+=======================================================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | central_network_id | String | Central network ID. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | central_network_plane_id | String | ID of the central network plane. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | String | Global connection bandwidth ID. If **bandwidth_type** is set to **TestBandwidth**, no global connection bandwidth is bound, and this parameter is not displayed. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_type | String | Bandwidth type. The bandwidth types are as follows: | + | | | | + | | | - **BandwidthPackage**: A global connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth. | + | | | | + | | | - **TestBandwidth**: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Long | Bandwidth range, in Mbit/s. If **bandwidth_type** is set to **TestBandwidth**, the bandwidth size is the default value, and this parameter is not displayed. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network connection status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **FREEZING** | + | | | | + | | | - **UNFREEZING** | + | | | | + | | | - **RECOVERING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **APPROVING** | + | | | | + | | | - **APPROVED** | + | | | | + | | | - **UNAPPROVED** | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_frozen | Boolean | Whether the resource is frozen. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | String | Type of a central network connection. | + | | | | + | | | - **ER-ER**: peering connection between enterprise routers | + | | | | + | | | - **ER-GDGW**: connection between an enterprise router and a global DC gateway | + | | | | + | | | - **ER-ER_ROUTE_TABLE**: connection between an enterprise router and an enterprise router route table | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_point_pair | Array of :ref:`ConnectionPoint ` objects | Both ends of a central network connection. The length is fixed to an array of 2. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +--------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _updatecentralnetworkconnection__response_connectionpoint: + +.. table:: **Table 7** ConnectionPoint + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | parent_instance_id | String | Parent resource ID of the instance at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of the resource that can be added to a central network as an attachment. | + | | | | + | | | - **ER**: enterprise router | + | | | | + | | | - **GDGW**: global DC gateway | + | | | | + | | | - **ER_ROUTE_TABLE**: enterprise router route table | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Updating a cross-site connection on a central network + +.. code-block:: text + + PUT /v3/{domain_id}/gcn/central-network/{central_network_id}/connections/{connection_id} + + { + "central_network_connection" : { + "bandwidth_type" : "BandwidthPackage", + "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "bandwidth_size" : 20 + } + } + +Example Responses +----------------- + +**Status code: 202** + +The central network connection has been updated. + +.. code-block:: + + { + "request_id" : "e108915cd5de228ef252be95ce6ef2c2", + "central_network_connection" : { + "id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0", + "name" : "er-connection", + "domain_id" : "XXX", + "enterprise_project_id" : "0", + "central_network_id" : "43ad756e-2780-463e-a8ed-27a5bd77b7a7", + "central_network_plane_id" : "238f60d5-ed1a-4508-8473-45509c530c8f", + "bandwidth_type" : "TestBandwidth", + "state" : "UPDATING", + "is_frozen" : false, + "connection_type" : "ER-ER", + "connection_point_pair" : [ { + "id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a", + "project_id" : "XXX", + "region_id" : "region-abc", + "site_code" : "region-abc", + "instance_id" : "d238dd85-f769-485b-aa05-d20e1d3889df", + "type" : "ER" + }, { + "id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1", + "project_id" : "XXX", + "region_id" : "region-abc", + "site_code" : "region-abc", + "instance_id" : "96abbb18-4a77-4103-aa8e-b1c836154282", + "type" : "ER" + } ], + "created_at" : "2023-10-09T08:02:43.31Z", + "updated_at" : "2023-10-09T08:02:43.307Z" + } + } + +Status Codes +------------ + +=========== ================================================ +Status Code Description +=========== ================================================ +202 The central network connection has been updated. +=========== ================================================ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_connections/querying_the_list_of_central_network_connections.rst b/api-ref/source/api/central_network_connections/querying_the_list_of_central_network_connections.rst new file mode 100644 index 0000000..f46c01a --- /dev/null +++ b/api-ref/source/api/central_network_connections/querying_the_list_of_central_network_connections.rst @@ -0,0 +1,301 @@ +:original_name: ListCentralNetworkConnections.html + +.. _ListCentralNetworkConnections: + +Querying the List of Central Network Connections +================================================ + +Function +-------- + +This API is used to query the list of central network connections. + +Parameters **marker** and **limit** are used for pagination query. The default value of **limit** is **0**. If **marker** is not specified, the first data record is returned. + +URI +--- + +GET /v3/{domain_id}/gcn/central-network/{central_network_id}/connections + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== =================== + Parameter Mandatory Type Description + ================== ========= ====== =================== + domain_id Yes String Account ID. + central_network_id Yes String Central network ID. + ================== ========= ====== =================== + +.. table:: **Table 2** Query Parameters + + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================================+=================+==================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_key | No | String | Field for sorting. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | Object | Whether the resources are sorted in ascending or descending order. **asc** indicates the ascending order and **desc** indicates the descending order. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | Array of strings | Resource ID. Multiple IDs can be queried. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | Array of strings | The resource name used for query. Multiple names can be specified for query. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | No | Array of strings | Resource status. Multiple statuses can be used for query. | + | | | | | + | | | | - **AVAILABLE** | + | | | | | + | | | | - **CREATING** | + | | | | | + | | | | - **UPDATING** | + | | | | | + | | | | - **DELETING** | + | | | | | + | | | | - **FREEZING** | + | | | | | + | | | | - **UNFREEZING** | + | | | | | + | | | | - **RECOVERING** | + | | | | | + | | | | - **FAILED** | + | | | | | + | | | | - **DELETED** | + | | | | | + | | | | - **APPROVING** | + | | | | | + | | | | - **APPROVED** | + | | | | | + | | | | - **UNAPPROVED** | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | No | Array of strings | Bandwidth package IDs. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_type | No | Object | Bandwidth type. The bandwidth types are as follows: | + | | | | | + | | | | - **BandwidthPackage**: A global connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth. | + | | | | | + | | | | - **TestBandwidth**: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | No | Object | Type of a central network connection. Multiple types can be used for query. | + | | | | | + | | | | - **ER-ER**: connections between enterprise routers | + | | | | | + | | | | - **ER-GDGW**: connections between enterprise routers and global DC gateways | + | | | | | + | | | | - **ER-ER_ROUTE_TABLE**: connections between enterprise routers and route tables of other enterprise routers | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_cross_region | No | Boolean | Whether there are different regions. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------------------------+---------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + | Parameter | Type | Description | + +=============================+=====================================================================================================================+==========================================+ + | request_id | String | Request ID. | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + | central_network_connections | Array of :ref:`CentralNetworkConnection ` objects | List of the central network connections. | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + +.. _listcentralnetworkconnections__response_pageinfo: + +.. table:: **Table 5** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listcentralnetworkconnections__response_centralnetworkconnection: + +.. table:: **Table 6** CentralNetworkConnection + + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+===================================================================================================+=======================================================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | central_network_id | String | Central network ID. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | central_network_plane_id | String | ID of the central network plane. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | String | Global connection bandwidth ID. If **bandwidth_type** is set to **TestBandwidth**, no global connection bandwidth is bound, and this parameter is not displayed. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_type | String | Bandwidth type. The bandwidth types are as follows: | + | | | | + | | | - **BandwidthPackage**: A global connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth. | + | | | | + | | | - **TestBandwidth**: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Long | Bandwidth range, in Mbit/s. If **bandwidth_type** is set to **TestBandwidth**, the bandwidth size is the default value, and this parameter is not displayed. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network connection status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **FREEZING** | + | | | | + | | | - **UNFREEZING** | + | | | | + | | | - **RECOVERING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **APPROVING** | + | | | | + | | | - **APPROVED** | + | | | | + | | | - **UNAPPROVED** | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_frozen | Boolean | Whether the resource is frozen. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | String | Type of a central network connection. | + | | | | + | | | - **ER-ER**: peering connection between enterprise routers | + | | | | + | | | - **ER-GDGW**: connection between an enterprise router and a global DC gateway | + | | | | + | | | - **ER-ER_ROUTE_TABLE**: connection between an enterprise router and an enterprise router route table | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_point_pair | Array of :ref:`ConnectionPoint ` objects | Both ends of a central network connection. The length is fixed to an array of 2. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +--------------------------------+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listcentralnetworkconnections__response_connectionpoint: + +.. table:: **Table 7** ConnectionPoint + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | parent_instance_id | String | Parent resource ID of the instance at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of the resource that can be added to a central network as an attachment. | + | | | | + | | | - **ER**: enterprise router | + | | | | + | | | - **GDGW**: global DC gateway | + | | | | + | | | - **ER_ROUTE_TABLE**: enterprise router route table | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the list of central network connections + +.. code-block:: text + + GET /v3/{domain_id}/gcn/central-network/{central_network_id}/connections + +Example Responses +----------------- + +**Status code: 200** + +The list of central network connections has been queried. + +.. code-block:: + + { + "request_id" : "0050ea65af7e190d9a791d9e69f28e63", + "page_info" : { + "current_count" : 1 + }, + "central_network_connections" : [ { + "id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0", + "name" : "er-connection", + "domain_id" : "XXX", + "enterprise_project_id" : "0", + "central_network_id" : "43ad756e-2780-463e-a8ed-27a5bd77b7a7", + "central_network_plane_id" : "238f60d5-ed1a-4508-8473-45509c530c8f", + "bandwidth_type" : "TestBandwidth", + "state" : "AVAILABLE", + "is_frozen" : false, + "connection_type" : "ER-ER", + "connection_point_pair" : [ { + "id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a", + "project_id" : "XXX", + "region_id" : "region-abc", + "site_code" : "region-abc", + "instance_id" : "d238dd85-f769-485b-aa05-d20e1d3889df", + "type" : "ER" + }, { + "id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1", + "project_id" : "XXX", + "region_id" : "region-abc", + "site_code" : "region-abc", + "instance_id" : "96abbb18-4a77-4103-aa8e-b1c836154282", + "type" : "ER" + } ], + "created_at" : "2023-10-09T08:02:43.31Z", + "updated_at" : "2023-10-09T08:02:43.307Z" + } ] + } + +Status Codes +------------ + +=========== ========================================================= +Status Code Description +=========== ========================================================= +200 The list of central network connections has been queried. +=========== ========================================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_policies/adding_a_central_network_policy.rst b/api-ref/source/api/central_network_policies/adding_a_central_network_policy.rst new file mode 100644 index 0000000..fb13064 --- /dev/null +++ b/api-ref/source/api/central_network_policies/adding_a_central_network_policy.rst @@ -0,0 +1,306 @@ +:original_name: CreateCentralNetworkPolicy.html + +.. _CreateCentralNetworkPolicy: + +Adding a Central Network Policy +=============================== + +Function +-------- + +This API is used to add a central network policy. A policy cannot be modified. If the policy cannot meet your requirements, you need to add a new policy. + +URI +--- + +POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== =================== + Parameter Mandatory Type Description + ================== ========= ====== =================== + domain_id Yes String Account ID. + central_network_id Yes String Central network ID. + ================== ========= ====== =================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +---------------------------------+-----------+---------------------------------------------------------------------------------------------------------------+----------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================================+===========+===============================================================================================================+==================================+ + | central_network_policy_document | Yes | :ref:`CentralNetworkPolicyDocument ` object | Central network policy document. | + +---------------------------------+-----------+---------------------------------------------------------------------------------------------------------------+----------------------------------+ + +.. _createcentralnetworkpolicy__request_centralnetworkpolicydocument: + +.. table:: **Table 4** CentralNetworkPolicyDocument + + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+=======================================================================================================================+======================================================+ + | default_plane | Yes | String | Name of the default central network plane. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | planes | Yes | Array of :ref:`CentralNetworkPlaneDocument ` objects | List of the central network planes. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | er_instances | No | Array of :ref:`AssociateErInstanceDocument ` objects | List of the enterprise routers on a central network. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + +.. _createcentralnetworkpolicy__request_centralnetworkplanedocument: + +.. table:: **Table 5** CentralNetworkPlaneDocument + + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=======================================================================================================================+==================================================================================+ + | name | Yes | String | Instance name. | + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | No | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | No | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _createcentralnetworkpolicy__request_associateertabledocument: + +.. table:: **Table 6** AssociateErTableDocument + + +----------------------------+-----------+--------+------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============================+===========+========+==========================================+ + | project_id | Yes | String | Project ID. | + +----------------------------+-----------+--------+------------------------------------------+ + | region_id | Yes | String | Region ID. | + +----------------------------+-----------+--------+------------------------------------------+ + | enterprise_router_id | Yes | String | Enterprise router ID. | + +----------------------------+-----------+--------+------------------------------------------+ + | enterprise_router_table_id | Yes | String | ID of the enterprise router route table. | + +----------------------------+-----------+--------+------------------------------------------+ + +.. _createcentralnetworkpolicy__request_excludeerconnectiondocument: + +.. table:: **Table 7** ExcludeErConnectionDocument + + +-----------+-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=======================================================================================================================+==============================================================================+ + | [items] | No | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _createcentralnetworkpolicy__request_associateerinstancedocument: + +.. table:: **Table 8** AssociateErInstanceDocument + + ==================== ========= ====== ===================== + Parameter Mandatory Type Description + ==================== ========= ====== ===================== + enterprise_router_id Yes String Enterprise router ID. + project_id Yes String Project ID. + region_id Yes String Region ID. + ==================== ========= ====== ===================== + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 9** Response body parameters + + +------------------------+------------------------------------------------------------------------------------------------+----------------------------------------+ + | Parameter | Type | Description | + +========================+================================================================================================+========================================+ + | request_id | String | Request ID. | + +------------------------+------------------------------------------------------------------------------------------------+----------------------------------------+ + | central_network_policy | :ref:`CentralNetworkPolicy ` object | Details of the central network policy. | + +------------------------+------------------------------------------------------------------------------------------------+----------------------------------------+ + +.. _createcentralnetworkpolicy__response_centralnetworkpolicy: + +.. table:: **Table 10** CentralNetworkPolicy + + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========================+================================================================================================================+========================================================================================================================================+ + | id | String | Instance ID. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network policy status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CANCELING** | + | | | | + | | | - **APPLYING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | central_network_id | String | Central network ID. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | document_template_version | String | Document template version. | + | | | | + | | | - **2022.08.30**: August 30, 2022 | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | is_applied | Boolean | Whether the policy is applied or not. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | version | Integer | Version of the central network policy. The version number of the policy is automatically increased by 1 each time a policy is created. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | document | :ref:`CentralNetworkPolicyDocument ` object | Central network policy document. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createcentralnetworkpolicy__response_centralnetworkpolicydocument: + +.. table:: **Table 11** CentralNetworkPolicyDocument + + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | Parameter | Type | Description | + +===============+========================================================================================================================+======================================================+ + | default_plane | String | Name of the default central network plane. | + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlaneDocument ` objects | List of the central network planes. | + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | er_instances | Array of :ref:`AssociateErInstanceDocument ` objects | List of the enterprise routers on a central network. | + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + +.. _createcentralnetworkpolicy__response_centralnetworkplanedocument: + +.. table:: **Table 12** CentralNetworkPlaneDocument + + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+========================================================================================================================+==================================================================================+ + | name | String | Instance name. | + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _createcentralnetworkpolicy__response_associateertabledocument: + +.. table:: **Table 13** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _createcentralnetworkpolicy__response_excludeerconnectiondocument: + +.. table:: **Table 14** ExcludeErConnectionDocument + + +-----------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _createcentralnetworkpolicy__response_associateerinstancedocument: + +.. table:: **Table 15** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +Example Requests +---------------- + +Adding a central network policy + +.. code-block:: text + + POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies + + { + "central_network_policy_document" : { + "default_plane" : "default-plane", + "planes" : [ { + "name" : "default-plane" + } ], + "er_instances" : [ { + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "project_id" : "XXX", + "region_id" : "region-abc" + } ] + } + } + +Example Responses +----------------- + +**Status code: 201** + +The central network policy has been added. + +.. code-block:: + + { + "request_id" : "76bfd2b0d492d0e479fbbd3981869c12", + "central_network_policy" : { + "id" : "f03478aa-3975-4ca7-9fb2-b49428a01636", + "created_at" : "2023-10-09T06:22:40.857Z", + "domain_id" : "XXX", + "state" : "AVAILABLE", + "central_network_id" : "e096c86f-817c-418c-945c-6b1d8860a15d", + "document_template_version" : "2022.08.30", + "is_applied" : true, + "version" : 1, + "document" : { + "default_plane" : "default-plane", + "planes" : [ { + "name" : "default-plane", + "associate_er_tables" : [ { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" + } ] + } ], + "er_instances" : [ { + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "project_id" : "XXX", + "region_id" : "region-abc" + } ] + } + } + } + +Status Codes +------------ + +=========== ========================================== +Status Code Description +=========== ========================================== +201 The central network policy has been added. +=========== ========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_policies/applying_a_central_network_policy.rst b/api-ref/source/api/central_network_policies/applying_a_central_network_policy.rst new file mode 100644 index 0000000..3eae86b --- /dev/null +++ b/api-ref/source/api/central_network_policies/applying_a_central_network_policy.rst @@ -0,0 +1,404 @@ +:original_name: ApplyCentralNetworkPolicy.html + +.. _ApplyCentralNetworkPolicy: + +Applying a Central Network Policy +================================= + +Function +-------- + +This API is used to apply a central network policy. + +URI +--- + +POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/apply + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== ========================== + Parameter Mandatory Type Description + ================== ========= ====== ========================== + domain_id Yes String Account ID. + policy_id Yes String Central network policy ID. + central_network_id Yes String Central network ID. + ================== ========= ====== ========================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 202** + +.. table:: **Table 3** Response body parameters + + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | Parameter | Type | Description | + +===================================+=================================================================================================================================+=========================================+ + | request_id | String | Request ID. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | central_network_policy | :ref:`CentralNetworkPolicy ` object | Details of the central network policy. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | central_network_policy_change_set | Array of :ref:`CentralNetworkElementChangeEntry ` objects | List of central network policy changes. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + +.. _applycentralnetworkpolicy__response_centralnetworkpolicy: + +.. table:: **Table 4** CentralNetworkPolicy + + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========================+===============================================================================================================+========================================================================================================================================+ + | id | String | Instance ID. | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network policy status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CANCELING** | + | | | | + | | | - **APPLYING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | central_network_id | String | Central network ID. | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | document_template_version | String | Document template version. | + | | | | + | | | - **2022.08.30**: August 30, 2022 | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | is_applied | Boolean | Whether the policy is applied or not. | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | version | Integer | Version of the central network policy. The version number of the policy is automatically increased by 1 each time a policy is created. | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | document | :ref:`CentralNetworkPolicyDocument ` object | Central network policy document. | + +---------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _applycentralnetworkpolicy__response_centralnetworkpolicydocument: + +.. table:: **Table 5** CentralNetworkPolicyDocument + + +---------------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | Parameter | Type | Description | + +===============+=======================================================================================================================+======================================================+ + | default_plane | String | Name of the default central network plane. | + +---------------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlaneDocument ` objects | List of the central network planes. | + +---------------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | er_instances | Array of :ref:`AssociateErInstanceDocument ` objects | List of the enterprise routers on a central network. | + +---------------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + +.. _applycentralnetworkpolicy__response_centralnetworkplanedocument: + +.. table:: **Table 6** CentralNetworkPlaneDocument + + +------------------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=======================================================================================================================+==================================================================================+ + | name | String | Instance name. | + +------------------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _applycentralnetworkpolicy__response_centralnetworkelementchangeentry: + +.. table:: **Table 7** CentralNetworkElementChangeEntry + + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================================+=========================================================================================================================+==================================================================================================================+ + | operation_id | String | Instance status. | + | | | | + | | | - **CreateCentralNetworkPlane**: adds a central network plane. | + | | | | + | | | - **DeleteCentralNetworkPlane**: removes a central network plane. | + | | | | + | | | - **UpdateCentralNetworkPlane**: updates a central network plane. | + | | | | + | | | - **CreateCentralNetworkErInstance**: adds an enterprise router as an attachment on a central network. | + | | | | + | | | - **DeleteCentralNetworkErInstance**: removes an enterprise router from a central network. | + | | | | + | | | - **CreateCentralNetworkErConnection**: creates a connection between enterprise routers on a central network. | + | | | | + | | | - **DeleteCentralNetworkErConnection**: deletes a connection between enterprise routers from a central network. | + | | | | + | | | - **CreateCentralNetworkErTable**: adds an enterprise router route table as an attachment on a central network. | + | | | | + | | | - **DeleteCentralNetworkErTable**: removes an enterprise router route table from a central network. | + | | | | + | | | - **SwitchCentralNetworkErTable**: changes an enterprise router route table on a central network. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | original_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | newest_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_er_instance | :ref:`AssociateErInstanceDocument ` object | Details of the central network. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_er_instance | :ref:`AssociateErInstanceDocument ` object | Details of the central network. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | central_network_plane_name | String | Name of the central network plane. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_er_connection | Array of :ref:`AssociateErTableDocument ` objects | Enterprise router route table associated with the central network plane. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_er_connection | Array of :ref:`AssociateErTableDocument ` objects | Enterprise router route table associated with the central network plane. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_er_table | :ref:`AssociateErTableDocument ` object | Enterprise router route table associated with the central network plane. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_er_table | :ref:`AssociateErTableDocument ` object | Enterprise router route table associated with the central network plane. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | switch_central_network_er_table | :ref:`SwitchErTableDocument ` object | Policy document for changing the enterprise router route table. | + +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + +.. _applycentralnetworkpolicy__response_centralnetworkplanechangedocument: + +.. table:: **Table 8** CentralNetworkPlaneChangeDocument + + +------------------------+-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=======================================================================================================================+================================================================================+ + | name | String | Instance name. | + +------------------------+-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | is_default | Boolean | Whether the plane is the default one. | + +------------------------+-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on a central network. | + +------------------------+-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. _applycentralnetworkpolicy__response_excludeerconnectiondocument: + +.. table:: **Table 9** ExcludeErConnectionDocument + + +-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=======================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _applycentralnetworkpolicy__response_associateerinstancedocument: + +.. table:: **Table 10** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +.. _applycentralnetworkpolicy__response_associateertabledocument: + +.. table:: **Table 11** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _applycentralnetworkpolicy__response_switchertabledocument: + +.. table:: **Table 12** SwitchErTableDocument + + +-------------------------------------+--------+-----------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================================+========+=================================================================+ + | project_id | String | Project ID. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | region_id | String | Region ID. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | original_enterprise_router_table_id | String | Specifies the route table ID of the original enterprise router. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | new_enterprise_router_table_id | String | Specifies the route table ID of the new enterprise router. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + +Example Requests +---------------- + +Applying a central network policy + +.. code-block:: text + + POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/apply + +Example Responses +----------------- + +**Status code: 202** + +The central network policy has been applied. + +.. code-block:: + + { + "request_id" : "edb137a2c46c5bda0409833359bb649b", + "central_network_policy" : { + "id" : "ff51f460-4bbe-4385-b2c4-efbe3318076f", + "created_at" : "2023-10-09T07:00:33.663Z", + "domain_id" : "XXX", + "state" : "APPLYING", + "central_network_id" : "e096c86f-817c-418c-945c-6b1d8860a15d", + "document_template_version" : "2022.08.30", + "is_applied" : false, + "version" : 2, + "document" : { + "default_plane" : "default-plane", + "planes" : [ { + "name" : "default-plane", + "associate_er_tables" : [ { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" + } ] + } ], + "er_instances" : [ { + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "project_id" : "XXX", + "region_id" : "region-abc" + } ] + } + }, + "central_network_policy_change_set" : [ { + "operation_id" : "UpdateCentralNetworkPlane", + "original_central_network_plane" : { + "name" : "default-plane", + "is_default" : true, + "associate_er_tables" : [ { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" + } ] + }, + "newest_central_network_plane" : { + "name" : "default-plane", + "is_default" : true, + "associate_er_tables" : [ { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" + } ] + } + }, { + "operation_id" : "CreateCentralNetworkErInstance", + "create_central_network_er_instance" : { + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "project_id" : "XXX", + "region_id" : "region-abc" + } + }, { + "operation_id" : "DeleteCentralNetworkErInstance", + "delete_central_network_er_instance" : { + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "project_id" : "XXX", + "region_id" : "region-abc" + } + }, { + "operation_id" : "CreateCentralNetworkErConnection", + "central_network_plane_name" : "default-plane", + "index" : 0, + "create_central_network_er_connection" : [ { + "project_id" : "XXX", + "region_id" : "region-abc-1", + "enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd", + "enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826" + }, { + "project_id" : "8d01a037388442f6a2e435f4f30860a3", + "region_id" : "region-abc-2", + "enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601", + "enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c" + } ] + }, { + "operation_id" : "DeleteCentralNetworkErConnection", + "central_network_plane_name" : "default-plane", + "index" : 1, + "delete_central_network_er_connection" : [ { + "project_id" : "XXX", + "region_id" : "region-abc-1", + "enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd", + "enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826" + }, { + "project_id" : "8d01a037388442f6a2e435f4f30860a3", + "region_id" : "region-abc-2", + "enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601", + "enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c" + } ] + }, { + "operation_id" : "CreateCentralNetworkErTable", + "central_network_plane_name" : "default-plane", + "create_central_network_er_table" : { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" + } + }, { + "operation_id" : "DeleteCentralNetworkErTable", + "central_network_plane_name" : "default-plane", + "delete_central_network_er_table" : { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" + } + }, { + "operation_id" : "SwitchCentralNetworkErTable", + "central_network_plane_name" : "default-plane", + "switch_central_network_er_table" : { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "5cc75ed0-bd6c-3af4-663b-caba3315bb08", + "original_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138156", + "new_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138158" + } + } ] + } + +Status Codes +------------ + +=========== ============================================ +Status Code Description +=========== ============================================ +202 The central network policy has been applied. +=========== ============================================ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_policies/deleting_a_central_network_policy.rst b/api-ref/source/api/central_network_policies/deleting_a_central_network_policy.rst new file mode 100644 index 0000000..66e8c0f --- /dev/null +++ b/api-ref/source/api/central_network_policies/deleting_a_central_network_policy.rst @@ -0,0 +1,78 @@ +:original_name: DeleteCentralNetworkPolicy.html + +.. _DeleteCentralNetworkPolicy: + +Deleting a Central Network Policy +================================= + +Function +-------- + +This API is used to delete a central network policy. An applied policy cannot be deleted. + +URI +--- + +DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id} + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== ========================== + Parameter Mandatory Type Description + ================== ========= ====== ========================== + domain_id Yes String Account ID. + policy_id Yes String Central network policy ID. + central_network_id Yes String Central network ID. + ================== ========= ====== ========================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 204** + +.. table:: **Table 3** Response header parameters + + ============ ====== =========== + Parameter Type Description + ============ ====== =========== + x-request-id String ``-`` + ============ ====== =========== + +Example Requests +---------------- + +Deleting a central network policy + +.. code-block:: text + + DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id} + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ============================================ +Status Code Description +=========== ============================================ +204 The central network policy has been deleted. +=========== ============================================ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_policies/index.rst b/api-ref/source/api/central_network_policies/index.rst new file mode 100644 index 0000000..05e93bf --- /dev/null +++ b/api-ref/source/api/central_network_policies/index.rst @@ -0,0 +1,22 @@ +:original_name: topic_300000009.html + +.. _topic_300000009: + +Central Network Policies +======================== + +- :ref:`Adding a Central Network Policy ` +- :ref:`Querying the List of Central Network Policies ` +- :ref:`Applying a Central Network Policy ` +- :ref:`Deleting a Central Network Policy ` +- :ref:`Querying the Changes Between the Current Policy and an Applied Policy ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + adding_a_central_network_policy + querying_the_list_of_central_network_policies + applying_a_central_network_policy + deleting_a_central_network_policy + querying_the_changes_between_the_current_policy_and_an_applied_policy diff --git a/api-ref/source/api/central_network_policies/querying_the_changes_between_the_current_policy_and_an_applied_policy.rst b/api-ref/source/api/central_network_policies/querying_the_changes_between_the_current_policy_and_an_applied_policy.rst new file mode 100644 index 0000000..8269d64 --- /dev/null +++ b/api-ref/source/api/central_network_policies/querying_the_changes_between_the_current_policy_and_an_applied_policy.rst @@ -0,0 +1,326 @@ +:original_name: ListCentralNetworkPolicyChangeSet.html + +.. _ListCentralNetworkPolicyChangeSet: + +Querying the Changes Between the Current Policy and an Applied Policy +===================================================================== + +Function +-------- + +This API is used query the changes between the current policy and an applied policy. + +URI +--- + +GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/change-set + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== ========================== + Parameter Mandatory Type Description + ================== ========= ====== ========================== + domain_id Yes String Account ID. + policy_id Yes String Central network policy ID. + central_network_id Yes String Central network ID. + ================== ========= ====== ========================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | Parameter | Type | Description | + +===================================+=========================================================================================================================================+=========================================+ + | request_id | String | Request ID. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | central_network_policy_change_set | Array of :ref:`CentralNetworkElementChangeEntry ` objects | List of central network policy changes. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + +.. _listcentralnetworkpolicychangeset__response_pageinfo: + +.. table:: **Table 4** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listcentralnetworkpolicychangeset__response_centralnetworkelementchangeentry: + +.. table:: **Table 5** CentralNetworkElementChangeEntry + + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================================+=================================================================================================================================+==================================================================================================================+ + | operation_id | String | Instance status. | + | | | | + | | | - **CreateCentralNetworkPlane**: adds a central network plane. | + | | | | + | | | - **DeleteCentralNetworkPlane**: removes a central network plane. | + | | | | + | | | - **UpdateCentralNetworkPlane**: updates a central network plane. | + | | | | + | | | - **CreateCentralNetworkErInstance**: adds an enterprise router as an attachment on a central network. | + | | | | + | | | - **DeleteCentralNetworkErInstance**: removes an enterprise router from a central network. | + | | | | + | | | - **CreateCentralNetworkErConnection**: creates a connection between enterprise routers on a central network. | + | | | | + | | | - **DeleteCentralNetworkErConnection**: deletes a connection between enterprise routers from a central network. | + | | | | + | | | - **CreateCentralNetworkErTable**: adds an enterprise router route table as an attachment on a central network. | + | | | | + | | | - **DeleteCentralNetworkErTable**: removes an enterprise router route table from a central network. | + | | | | + | | | - **SwitchCentralNetworkErTable**: changes an enterprise router route table on a central network. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | original_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | newest_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_plane | :ref:`CentralNetworkPlaneChangeDocument ` object | Central network plane document. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_er_instance | :ref:`AssociateErInstanceDocument ` object | Details of the central network. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_er_instance | :ref:`AssociateErInstanceDocument ` object | Details of the central network. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | central_network_plane_name | String | Name of the central network plane. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_er_connection | Array of :ref:`AssociateErTableDocument ` objects | Enterprise router route table associated with the central network plane. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_er_connection | Array of :ref:`AssociateErTableDocument ` objects | Enterprise router route table associated with the central network plane. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | create_central_network_er_table | :ref:`AssociateErTableDocument ` object | Enterprise router route table associated with the central network plane. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | delete_central_network_er_table | :ref:`AssociateErTableDocument ` object | Enterprise router route table associated with the central network plane. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | switch_central_network_er_table | :ref:`SwitchErTableDocument ` object | Policy document for changing the enterprise router route table. | + +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + +.. _listcentralnetworkpolicychangeset__response_centralnetworkplanechangedocument: + +.. table:: **Table 6** CentralNetworkPlaneChangeDocument + + +------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+===============================================================================================================================+================================================================================+ + | name | String | Instance name. | + +------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | is_default | Boolean | Whether the plane is the default one. | + +------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on a central network. | + +------------------------+-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. _listcentralnetworkpolicychangeset__response_excludeerconnectiondocument: + +.. table:: **Table 7** ExcludeErConnectionDocument + + +-----------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _listcentralnetworkpolicychangeset__response_associateerinstancedocument: + +.. table:: **Table 8** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +.. _listcentralnetworkpolicychangeset__response_associateertabledocument: + +.. table:: **Table 9** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _listcentralnetworkpolicychangeset__response_switchertabledocument: + +.. table:: **Table 10** SwitchErTableDocument + + +-------------------------------------+--------+-----------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================================+========+=================================================================+ + | project_id | String | Project ID. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | region_id | String | Region ID. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | original_enterprise_router_table_id | String | Specifies the route table ID of the original enterprise router. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + | new_enterprise_router_table_id | String | Specifies the route table ID of the new enterprise router. | + +-------------------------------------+--------+-----------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the changes between the current policy and an applied policy + +.. code-block:: text + + GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/change-set + +Example Responses +----------------- + +**Status code: 200** + +Changes between the current policy and applied policy have been queried. + +.. code-block:: + + { + "request_id" : "a334adc3e2cba87855de6f3ab58b9db5", + "page_info" : { + "current_count" : 5 + }, + "central_network_policy_change_set" : [ { + "operation_id" : "UpdateCentralNetworkPlane", + "original_central_network_plane" : { + "name" : "default-plane", + "is_default" : true, + "associate_er_tables" : [ { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" + } ] + }, + "newest_central_network_plane" : { + "name" : "default-plane", + "is_default" : true, + "associate_er_tables" : [ { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" + } ] + } + }, { + "operation_id" : "CreateCentralNetworkErInstance", + "create_central_network_er_instance" : { + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "project_id" : "XXX", + "region_id" : "region-abc" + } + }, { + "operation_id" : "DeleteCentralNetworkErInstance", + "delete_central_network_er_instance" : { + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "project_id" : "XXX", + "region_id" : "region-abc" + } + }, { + "operation_id" : "CreateCentralNetworkErConnection", + "central_network_plane_name" : "default-plane", + "index" : 0, + "create_central_network_er_connection" : [ { + "project_id" : "XXX", + "region_id" : "region-abc-1", + "enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd", + "enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826" + }, { + "project_id" : "8d01a037388442f6a2e435f4f30860a3", + "region_id" : "region-abc-2", + "enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601", + "enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c" + } ] + }, { + "operation_id" : "DeleteCentralNetworkErConnection", + "central_network_plane_name" : "default-plane", + "index" : 1, + "delete_central_network_er_connection" : [ { + "project_id" : "XXX", + "region_id" : "region-abc-1", + "enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd", + "enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826" + }, { + "project_id" : "8d01a037388442f6a2e435f4f30860a3", + "region_id" : "region-abc-2", + "enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601", + "enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c" + } ] + }, { + "operation_id" : "CreateCentralNetworkErTable", + "central_network_plane_name" : "default-plane", + "create_central_network_er_table" : { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", + "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" + } + }, { + "operation_id" : "DeleteCentralNetworkErTable", + "central_network_plane_name" : "default-plane", + "delete_central_network_er_table" : { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" + } + }, { + "operation_id" : "SwitchCentralNetworkErTable", + "central_network_plane_name" : "default-plane", + "switch_central_network_er_table" : { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "5cc75ed0-bd6c-3af4-663b-caba3315bb08", + "original_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138156", + "new_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138158" + } + } ] + } + +Status Codes +------------ + ++-------------+--------------------------------------------------------------------------+ +| Status Code | Description | ++=============+==========================================================================+ +| 200 | Changes between the current policy and applied policy have been queried. | ++-------------+--------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_policies/querying_the_list_of_central_network_policies.rst b/api-ref/source/api/central_network_policies/querying_the_list_of_central_network_policies.rst new file mode 100644 index 0000000..975e336 --- /dev/null +++ b/api-ref/source/api/central_network_policies/querying_the_list_of_central_network_policies.rst @@ -0,0 +1,271 @@ +:original_name: ListCentralNetworkPolicies.html + +.. _ListCentralNetworkPolicies: + +Querying the List of Central Network Policies +============================================= + +Function +-------- + +This API is used to query the list of central network policies. + +Parameters **marker** and **limit** are used for pagination query. The default value of **limit** is **0**. If **marker** is not specified, the first data record is returned. + +URI +--- + +GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== =================== + Parameter Mandatory Type Description + ================== ========= ====== =================== + domain_id Yes String Account ID. + central_network_id Yes String Central network ID. + ================== ========= ====== =================== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+===================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_key | No | String | Field for sorting. | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | Object | Whether the resources are sorted in ascending or descending order. **asc** indicates the ascending order and **desc** indicates the descending order. | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | Array of strings | Resource ID. Multiple IDs can be queried. | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | No | Array of strings | Resource status. Multiple statuses can be used for query. | + | | | | | + | | | | - **AVAILABLE** | + | | | | | + | | | | - **CANCELING** | + | | | | | + | | | | - **APPLYING** | + | | | | | + | | | | - **FAILED** | + | | | | | + | | | | - **DELETED** | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_applied | No | Boolean | Whether the policy is applied or not. | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | version | No | Array of integers | The version used for query. Multiple versions can be specified for query. This parameter cannot be used. | + +-----------------+-----------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +--------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------+ + | Parameter | Type | Description | + +==========================+==========================================================================================================+=======================================+ + | request_id | String | Request ID. | + +--------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +--------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------+ + | central_network_policies | Array of :ref:`CentralNetworkPolicy ` objects | List of the central network policies. | + +--------------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------+ + +.. _listcentralnetworkpolicies__response_pageinfo: + +.. table:: **Table 5** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listcentralnetworkpolicies__response_centralnetworkpolicy: + +.. table:: **Table 6** CentralNetworkPolicy + + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========================+================================================================================================================+========================================================================================================================================+ + | id | String | Instance ID. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network policy status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CANCELING** | + | | | | + | | | - **APPLYING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | central_network_id | String | Central network ID. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | document_template_version | String | Document template version. | + | | | | + | | | - **2022.08.30**: August 30, 2022 | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | is_applied | Boolean | Whether the policy is applied or not. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | version | Integer | Version of the central network policy. The version number of the policy is automatically increased by 1 each time a policy is created. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | document | :ref:`CentralNetworkPolicyDocument ` object | Central network policy document. | + +---------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listcentralnetworkpolicies__response_centralnetworkpolicydocument: + +.. table:: **Table 7** CentralNetworkPolicyDocument + + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | Parameter | Type | Description | + +===============+========================================================================================================================+======================================================+ + | default_plane | String | Name of the default central network plane. | + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlaneDocument ` objects | List of the central network planes. | + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | er_instances | Array of :ref:`AssociateErInstanceDocument ` objects | List of the enterprise routers on a central network. | + +---------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + +.. _listcentralnetworkpolicies__response_centralnetworkplanedocument: + +.. table:: **Table 8** CentralNetworkPlaneDocument + + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+========================================================================================================================+==================================================================================+ + | name | String | Instance name. | + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _listcentralnetworkpolicies__response_associateertabledocument: + +.. table:: **Table 9** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _listcentralnetworkpolicies__response_excludeerconnectiondocument: + +.. table:: **Table 10** ExcludeErConnectionDocument + + +-----------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _listcentralnetworkpolicies__response_associateerinstancedocument: + +.. table:: **Table 11** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +Example Requests +---------------- + +Querying the list of central network policies + +.. code-block:: text + + GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies + +Example Responses +----------------- + +**Status code: 200** + +The list of central network policies has been queried. + +.. code-block:: + + { + "request_id" : "76bfd2b0d492d0e479fbbd3981869c12", + "page_info" : { + "current_count" : 1 + }, + "central_network_policies" : [ { + "id" : "f03478aa-3975-4ca7-9fb2-b49428a01636", + "created_at" : "2023-10-09T06:22:40.857Z", + "domain_id" : "XXX", + "state" : "AVAILABLE", + "central_network_id" : "e096c86f-817c-418c-945c-6b1d8860a15d", + "document_template_version" : "2022.08.30", + "is_applied" : true, + "version" : 1, + "document" : { + "default_plane" : "default-plane", + "planes" : [ { + "name" : "default-plane", + "associate_er_tables" : [ { + "project_id" : "XXX", + "region_id" : "region-abc", + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" + } ] + } ], + "er_instances" : [ { + "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", + "project_id" : "XXX", + "region_id" : "region-abc" + } ] + } + } ] + } + +Status Codes +------------ + +=========== ====================================================== +Status Code Description +=========== ====================================================== +200 The list of central network policies has been queried. +=========== ====================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_network_quotas/index.rst b/api-ref/source/api/central_network_quotas/index.rst new file mode 100644 index 0000000..09632f8 --- /dev/null +++ b/api-ref/source/api/central_network_quotas/index.rst @@ -0,0 +1,14 @@ +:original_name: topic_300000014.html + +.. _topic_300000014: + +Central Network Quotas +====================== + +- :ref:`Querying Central Network Resource Quotas ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_central_network_resource_quotas diff --git a/api-ref/source/api/central_network_quotas/querying_central_network_resource_quotas.rst b/api-ref/source/api/central_network_quotas/querying_central_network_resource_quotas.rst new file mode 100644 index 0000000..7268491 --- /dev/null +++ b/api-ref/source/api/central_network_quotas/querying_central_network_resource_quotas.rst @@ -0,0 +1,168 @@ +:original_name: ListCentralNetworkQuotas.html + +.. _ListCentralNetworkQuotas: + +Querying Central Network Resource Quotas +======================================== + +Function +-------- + +This API is used to query the resource quotas. + +URI +--- + +GET /v3/{domain_id}/gcn/quotas + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | quota_type | No | Array of strings | Quota type. Multiple quota types can be queried. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +------------+------------------------------------------------------------------------------------------------------+-------------+ + | Parameter | Type | Description | + +============+======================================================================================================+=============+ + | request_id | String | Request ID. | + +------------+------------------------------------------------------------------------------------------------------+-------------+ + | quotas | Array of :ref:`CentralNetworkQuota ` objects | Quota list. | + +------------+------------------------------------------------------------------------------------------------------+-------------+ + +.. _listcentralnetworkquotas__response_centralnetworkquota: + +.. table:: **Table 5** CentralNetworkQuota + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==============================================================================================================================================================+ + | quota_key | String | Quota type of a central network. | + | | | | + | | | - **central_networks_per_account**: number of central networks per account | + | | | | + | | | - **policy_versions_per_central_network**: number of policies per central network | + | | | | + | | | - **size_of_document_per_central_network_policy_version**: size of the central network policy document, in KB | + | | | | + | | | - **planes_per_central_network**: number of planes per central network | + | | | | + | | | - **er_instances_per_region_per_central_network**: number of enterprise routers that can be added to each central network as attachments in each region | + | | | | + | | | - **connections_per_central_network**: number of connections per central network | + | | | | + | | | - **attachments_per_central_network**: number of attachments per central network | + | | | | + | | | - **GDGW_attachments_per_region_per_central_network**: number of global DC gateways that can be added to each central network as attachments in each region | + | | | | + | | | - **ER_ROUTE_TABLE_attachments_per_region_per_central_network**: number of enterprise router route table attachments on each central network in each region | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | quota_limit | Integer | Quotas. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | used | Integer | Used quotas. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | unit | String | Unit of the quota value. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying resource quotas + +.. code-block:: text + + GET https://{cc_endpoint}/v3/{domain_id}/gcn/quotas + +Example Responses +----------------- + +**Status code: 200** + +The central network resource quotas have been queried. + +.. code-block:: + + { + "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "quotas" : [ { + "quota_key" : "central_networks_per_account", + "quota_limit" : 6, + "used" : 0, + "unit" : "count" + }, { + "quota_key" : "policy_versions_per_central_network", + "quota_limit" : 500, + "unit" : "count" + }, { + "quota_key" : "er_instances_per_region_per_central_network", + "quota_limit" : 1, + "unit" : "count" + }, { + "quota_key" : "connections_per_central_network", + "quota_limit" : -1, + "unit" : "count" + }, { + "quota_key" : "GDGW_attachments_per_region_per_central_network", + "quota_limit" : 3, + "unit" : "count" + }, { + "quota_key" : "ER_ROUTE_TABLE_attachments_per_region_per_central_network", + "quota_limit" : 3, + "unit" : "count" + }, { + "quota_key" : "attachments_per_central_network", + "quota_limit" : -1, + "unit" : "count" + }, { + "quota_key" : "size_of_document_per_central_network_policy_version", + "quota_limit" : 10240, + "unit" : "KB" + } ] + } + +Status Codes +------------ + +=========== ====================================================== +Status Code Description +=========== ====================================================== +200 The central network resource quotas have been queried. +=========== ====================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_networks/creating_a_central_network.rst b/api-ref/source/api/central_networks/creating_a_central_network.rst new file mode 100644 index 0000000..485dc6a --- /dev/null +++ b/api-ref/source/api/central_networks/creating_a_central_network.rst @@ -0,0 +1,399 @@ +:original_name: CreateCentralNetwork.html + +.. _CreateCentralNetwork: + +Creating a Central Network +========================== + +Function +-------- + +This API is used to create a central network. + +URI +--- + +POST /v3/{domain_id}/gcn/central-networks + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------------+-----------+-----------------------------------------------------------------------------------------+------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+=========================================================================================+==================+ + | central_network | Yes | :ref:`CreateCentralNetwork ` object | Central network. | + +-----------------+-----------+-----------------------------------------------------------------------------------------+------------------+ + +.. _createcentralnetwork__request_createcentralnetwork: + +.. table:: **Table 4** CreateCentralNetwork + + +-----------------------+-----------+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========================================================================================================+============================================================+ + | name | Yes | String | Instance name. | + +-----------------------+-----------+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ + | description | No | String | Resource description. Angle brackets (<>) are not allowed. | + +-----------------------+-----------+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ + | enterprise_project_id | No | String | ID of the enterprise project that the resource belongs to. | + +-----------------------+-----------+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ + | policy_document | No | :ref:`CentralNetworkPolicyDocument ` object | Central network policy document. | + +-----------------------+-----------+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ + +.. _createcentralnetwork__request_centralnetworkpolicydocument: + +.. table:: **Table 5** CentralNetworkPolicyDocument + + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+=================================================================================================================+======================================================+ + | default_plane | Yes | String | Name of the default central network plane. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | planes | Yes | Array of :ref:`CentralNetworkPlaneDocument ` objects | List of the central network planes. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + | er_instances | No | Array of :ref:`AssociateErInstanceDocument ` objects | List of the enterprise routers on a central network. | + +---------------+-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------+ + +.. _createcentralnetwork__request_centralnetworkplanedocument: + +.. table:: **Table 6** CentralNetworkPlaneDocument + + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=================================================================================================================+==================================================================================+ + | name | Yes | String | Instance name. | + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | No | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | No | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+-----------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _createcentralnetwork__request_associateertabledocument: + +.. table:: **Table 7** AssociateErTableDocument + + +----------------------------+-----------+--------+------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============================+===========+========+==========================================+ + | project_id | Yes | String | Project ID. | + +----------------------------+-----------+--------+------------------------------------------+ + | region_id | Yes | String | Region ID. | + +----------------------------+-----------+--------+------------------------------------------+ + | enterprise_router_id | Yes | String | Enterprise router ID. | + +----------------------------+-----------+--------+------------------------------------------+ + | enterprise_router_table_id | Yes | String | ID of the enterprise router route table. | + +----------------------------+-----------+--------+------------------------------------------+ + +.. _createcentralnetwork__request_excludeerconnectiondocument: + +.. table:: **Table 8** ExcludeErConnectionDocument + + +-----------+-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=================================================================================================================+==============================================================================+ + | [items] | No | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _createcentralnetwork__request_associateerinstancedocument: + +.. table:: **Table 9** AssociateErInstanceDocument + + ==================== ========= ====== ===================== + Parameter Mandatory Type Description + ==================== ========= ====== ===================== + enterprise_router_id Yes String Enterprise router ID. + project_id Yes String Project ID. + region_id Yes String Region ID. + ==================== ========= ====== ===================== + +Response Parameters +------------------- + +**Status code: 202** + +.. table:: **Table 10** Response body parameters + + +-----------------+------------------------------------------------------------------------------+------------------+ + | Parameter | Type | Description | + +=================+==============================================================================+==================+ + | request_id | String | Request ID. | + +-----------------+------------------------------------------------------------------------------+------------------+ + | central_network | :ref:`CentralNetwork ` object | Central network. | + +-----------------+------------------------------------------------------------------------------+------------------+ + +.. _createcentralnetwork__response_centralnetwork: + +.. table:: **Table 11** CentralNetwork + + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============================+====================================================================================================================+===============================================================================================+ + | id | String | Instance ID. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | state | String | Central network status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **RESTORING** | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | default_plane_id | String | ID of the default central network plane. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_associate_route_enabled | Boolean | Whether to enable Default Route Table Association. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_propagate_route_enabled | Boolean | Whether to enable Default Route Table Propagation. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlane ` objects | List of central network planes. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | er_instances | Array of :ref:`CentralNetworkErInstance ` objects | List of enterprise routers on a central network. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | connections | Array of :ref:`CentralNetworkConnectionInfo ` objects | List of the enterprise router attachments on a central network. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +.. _createcentralnetwork__response_centralnetworkplane: + +.. table:: **Table 12** CentralNetworkPlane + + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+==================================================================================================================+==================================================================================+ + | id | String | Instance ID. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _createcentralnetwork__response_associateertabledocument: + +.. table:: **Table 13** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _createcentralnetwork__response_excludeerconnectiondocument: + +.. table:: **Table 14** ExcludeErConnectionDocument + + +-----------+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _createcentralnetwork__response_associateerinstancedocument: + +.. table:: **Table 15** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +.. _createcentralnetwork__response_centralnetworkerinstance: + +.. table:: **Table 16** CentralNetworkErInstance + + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+======================================================================================================================+ + | id | String | Instance ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | asn | Long | ASN of the network instance when BGP is used for routing. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + +.. _createcentralnetwork__response_centralnetworkconnectioninfo: + +.. table:: **Table 17** CentralNetworkConnectionInfo + + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+==========================================================================================+==================================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | plane_id | String | ID of the central network plane. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | String | Global connection bandwidth ID. If **bandwidth_type** is set to **TestBandwidth**, no global connection bandwidth is bound, and this parameter is not displayed. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Long | Bandwidth range, in Mbit/s. If **bandwidth_type** is set to **TestBandwidth**, the bandwidth size is the default value, and this parameter is not displayed. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | String | Type of a central network connection. | + | | | | + | | | - **ER-ER**: peering connection between enterprise routers | + | | | | + | | | - **ER-GDGW**: connection between an enterprise router and a global DC gateway | + | | | | + | | | - **ER-ER_ROUTE_TABLE**: connection between an enterprise router and an enterprise router route table | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_point_pair | Array of :ref:`ConnectionPoint ` objects | Both ends of a central network connection. The length is fixed to an array of 2. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network connection status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **FREEZING** | + | | | | + | | | - **UNFREEZING** | + | | | | + | | | - **RECOVERING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **APPROVING** | + | | | | + | | | - **APPROVED** | + | | | | + | | | - **UNAPPROVED** | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createcentralnetwork__response_connectionpoint: + +.. table:: **Table 18** ConnectionPoint + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | parent_instance_id | String | Parent resource ID of the instance at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of the resource that can be added to a central network as an attachment. | + | | | | + | | | - **ER**: enterprise router | + | | | | + | | | - **GDGW**: global DC gateway | + | | | | + | | | - **ER_ROUTE_TABLE**: enterprise router route table | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Creating a central network + +.. code-block:: text + + POST /v3/{domain_id}/gcn/central-networks + + { + "central_network" : { + "name" : "name" + } + } + +Example Responses +----------------- + +**Status code: 202** + +The central network has been created. + +.. code-block:: + + { + "request_id" : "e9837622a6d4f31e4417b5432f42fafe", + "central_network" : { + "id" : "e096c86f-817c-418c-945c-6b1d8860a15d", + "name" : "name", + "created_at" : "2023-10-09T06:22:40.856Z", + "updated_at" : "2023-10-09T06:22:40.856Z", + "domain_id" : "XXX", + "state" : "CREATING", + "enterprise_project_id" : "0" + } + } + +Status Codes +------------ + +=========== ===================================== +Status Code Description +=========== ===================================== +202 The central network has been created. +=========== ===================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_networks/deleting_a_central_network.rst b/api-ref/source/api/central_networks/deleting_a_central_network.rst new file mode 100644 index 0000000..777817c --- /dev/null +++ b/api-ref/source/api/central_networks/deleting_a_central_network.rst @@ -0,0 +1,287 @@ +:original_name: DeleteCentralNetwork.html + +.. _DeleteCentralNetwork: + +Deleting a Central Network +========================== + +Function +-------- + +This API is used to delete a central network. Remove the attachments before deleting the central network. + +URI +--- + +DELETE /v3/{domain_id}/gcn/central-networks/{central_network_id} + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== =================== + Parameter Mandatory Type Description + ================== ========= ====== =================== + domain_id Yes String Account ID. + central_network_id Yes String Central network ID. + ================== ========= ====== =================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 202** + +.. table:: **Table 3** Response body parameters + + +-----------------+------------------------------------------------------------------------------+------------------+ + | Parameter | Type | Description | + +=================+==============================================================================+==================+ + | request_id | String | Request ID. | + +-----------------+------------------------------------------------------------------------------+------------------+ + | central_network | :ref:`CentralNetwork ` object | Central network. | + +-----------------+------------------------------------------------------------------------------+------------------+ + +.. _deletecentralnetwork__response_centralnetwork: + +.. table:: **Table 4** CentralNetwork + + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============================+====================================================================================================================+===============================================================================================+ + | id | String | Instance ID. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | state | String | Central network status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **RESTORING** | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | default_plane_id | String | ID of the default central network plane. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_associate_route_enabled | Boolean | Whether to enable Default Route Table Association. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_propagate_route_enabled | Boolean | Whether to enable Default Route Table Propagation. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlane ` objects | List of central network planes. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | er_instances | Array of :ref:`CentralNetworkErInstance ` objects | List of enterprise routers on a central network. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | connections | Array of :ref:`CentralNetworkConnectionInfo ` objects | List of the enterprise router attachments on a central network. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +.. _deletecentralnetwork__response_centralnetworkplane: + +.. table:: **Table 5** CentralNetworkPlane + + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+==================================================================================================================+==================================================================================+ + | id | String | Instance ID. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _deletecentralnetwork__response_associateertabledocument: + +.. table:: **Table 6** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _deletecentralnetwork__response_excludeerconnectiondocument: + +.. table:: **Table 7** ExcludeErConnectionDocument + + +-----------+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _deletecentralnetwork__response_associateerinstancedocument: + +.. table:: **Table 8** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +.. _deletecentralnetwork__response_centralnetworkerinstance: + +.. table:: **Table 9** CentralNetworkErInstance + + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+======================================================================================================================+ + | id | String | Instance ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | asn | Long | ASN of the network instance when BGP is used for routing. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + +.. _deletecentralnetwork__response_centralnetworkconnectioninfo: + +.. table:: **Table 10** CentralNetworkConnectionInfo + + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+==========================================================================================+==================================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | plane_id | String | ID of the central network plane. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | String | Global connection bandwidth ID. If **bandwidth_type** is set to **TestBandwidth**, no global connection bandwidth is bound, and this parameter is not displayed. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Long | Bandwidth range, in Mbit/s. If **bandwidth_type** is set to **TestBandwidth**, the bandwidth size is the default value, and this parameter is not displayed. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | String | Type of a central network connection. | + | | | | + | | | - **ER-ER**: peering connection between enterprise routers | + | | | | + | | | - **ER-GDGW**: connection between an enterprise router and a global DC gateway | + | | | | + | | | - **ER-ER_ROUTE_TABLE**: connection between an enterprise router and an enterprise router route table | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_point_pair | Array of :ref:`ConnectionPoint ` objects | Both ends of a central network connection. The length is fixed to an array of 2. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network connection status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **FREEZING** | + | | | | + | | | - **UNFREEZING** | + | | | | + | | | - **RECOVERING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **APPROVING** | + | | | | + | | | - **APPROVED** | + | | | | + | | | - **UNAPPROVED** | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _deletecentralnetwork__response_connectionpoint: + +.. table:: **Table 11** ConnectionPoint + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | parent_instance_id | String | Parent resource ID of the instance at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of the resource that can be added to a central network as an attachment. | + | | | | + | | | - **ER**: enterprise router | + | | | | + | | | - **GDGW**: global DC gateway | + | | | | + | | | - **ER_ROUTE_TABLE**: enterprise router route table | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Deleting a central network + +.. code-block:: text + + DELETE /v3/{domain_id}/gcn/central-networks/{central_network_id} + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ===================================== +Status Code Description +=========== ===================================== +202 The central network has been deleted. +=========== ===================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_networks/index.rst b/api-ref/source/api/central_networks/index.rst new file mode 100644 index 0000000..2889daf --- /dev/null +++ b/api-ref/source/api/central_networks/index.rst @@ -0,0 +1,22 @@ +:original_name: topic_300000006.html + +.. _topic_300000006: + +Central Networks +================ + +- :ref:`Creating a Central Network ` +- :ref:`Querying the Central Network List ` +- :ref:`Querying a Central Network ` +- :ref:`Updating a Central Network ` +- :ref:`Deleting a Central Network ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_central_network + querying_the_central_network_list + querying_a_central_network + updating_a_central_network + deleting_a_central_network diff --git a/api-ref/source/api/central_networks/querying_a_central_network.rst b/api-ref/source/api/central_networks/querying_a_central_network.rst new file mode 100644 index 0000000..90a2ebe --- /dev/null +++ b/api-ref/source/api/central_networks/querying_a_central_network.rst @@ -0,0 +1,304 @@ +:original_name: ShowCentralNetwork.html + +.. _ShowCentralNetwork: + +Querying a Central Network +========================== + +Function +-------- + +This API is used to query the details about a central network. + +URI +--- + +GET /v3/{domain_id}/gcn/central-networks/{central_network_id} + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== =================== + Parameter Mandatory Type Description + ================== ========= ====== =================== + domain_id Yes String Account ID. + central_network_id Yes String Central network ID. + ================== ========= ====== =================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------+----------------------------------------------------------------------------+------------------+ + | Parameter | Type | Description | + +=================+============================================================================+==================+ + | request_id | String | Request ID. | + +-----------------+----------------------------------------------------------------------------+------------------+ + | central_network | :ref:`CentralNetwork ` object | Central network. | + +-----------------+----------------------------------------------------------------------------+------------------+ + +.. _showcentralnetwork__response_centralnetwork: + +.. table:: **Table 4** CentralNetwork + + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============================+==================================================================================================================+===============================================================================================+ + | id | String | Instance ID. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | state | String | Central network status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **RESTORING** | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | default_plane_id | String | ID of the default central network plane. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_associate_route_enabled | Boolean | Whether to enable Default Route Table Association. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_propagate_route_enabled | Boolean | Whether to enable Default Route Table Propagation. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlane ` objects | List of central network planes. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | er_instances | Array of :ref:`CentralNetworkErInstance ` objects | List of enterprise routers on a central network. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | connections | Array of :ref:`CentralNetworkConnectionInfo ` objects | List of the enterprise router attachments on a central network. | + +------------------------------+------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +.. _showcentralnetwork__response_centralnetworkplane: + +.. table:: **Table 5** CentralNetworkPlane + + +------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+================================================================================================================+==================================================================================+ + | id | String | Instance ID. | + +------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _showcentralnetwork__response_associateertabledocument: + +.. table:: **Table 6** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _showcentralnetwork__response_excludeerconnectiondocument: + +.. table:: **Table 7** ExcludeErConnectionDocument + + +-----------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _showcentralnetwork__response_associateerinstancedocument: + +.. table:: **Table 8** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +.. _showcentralnetwork__response_centralnetworkerinstance: + +.. table:: **Table 9** CentralNetworkErInstance + + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+======================================================================================================================+ + | id | String | Instance ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | asn | Long | ASN of the network instance when BGP is used for routing. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + +.. _showcentralnetwork__response_centralnetworkconnectioninfo: + +.. table:: **Table 10** CentralNetworkConnectionInfo + + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+========================================================================================+==================================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | plane_id | String | ID of the central network plane. | + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | String | Global connection bandwidth ID. If **bandwidth_type** is set to **TestBandwidth**, no global connection bandwidth is bound, and this parameter is not displayed. | + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Long | Bandwidth range, in Mbit/s. If **bandwidth_type** is set to **TestBandwidth**, the bandwidth size is the default value, and this parameter is not displayed. | + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | String | Type of a central network connection. | + | | | | + | | | - **ER-ER**: peering connection between enterprise routers | + | | | | + | | | - **ER-GDGW**: connection between an enterprise router and a global DC gateway | + | | | | + | | | - **ER-ER_ROUTE_TABLE**: connection between an enterprise router and an enterprise router route table | + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_point_pair | Array of :ref:`ConnectionPoint ` objects | Both ends of a central network connection. The length is fixed to an array of 2. | + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network connection status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **FREEZING** | + | | | | + | | | - **UNFREEZING** | + | | | | + | | | - **RECOVERING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **APPROVING** | + | | | | + | | | - **APPROVED** | + | | | | + | | | - **UNAPPROVED** | + +--------------------------------+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showcentralnetwork__response_connectionpoint: + +.. table:: **Table 11** ConnectionPoint + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | parent_instance_id | String | Parent resource ID of the instance at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of the resource that can be added to a central network as an attachment. | + | | | | + | | | - **ER**: enterprise router | + | | | | + | | | - **GDGW**: global DC gateway | + | | | | + | | | - **ER_ROUTE_TABLE**: enterprise router route table | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the details about a central network + +.. code-block:: text + + GET /v3/{domain_id}/gcn/central-networks/{central_network_id} + +Example Responses +----------------- + +**Status code: 200** + +The details about a central network have been queried. + +.. code-block:: + + { + "request_id" : "ebfebe2205832c9ed7c3d1131041cc0f", + "central_network" : { + "id" : "e096c86f-817c-418c-945c-6b1d8860a15d", + "name" : "name", + "created_at" : "2023-10-09T06:22:40.856Z", + "updated_at" : "2023-10-09T06:22:40.856Z", + "domain_id" : "XXX", + "state" : "AVAILABLE", + "enterprise_project_id" : "0" + } + } + +Status Codes +------------ + +=========== ====================================================== +Status Code Description +=========== ====================================================== +200 The details about a central network have been queried. +=========== ====================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_networks/querying_the_central_network_list.rst b/api-ref/source/api/central_networks/querying_the_central_network_list.rst new file mode 100644 index 0000000..1053226 --- /dev/null +++ b/api-ref/source/api/central_networks/querying_the_central_network_list.rst @@ -0,0 +1,368 @@ +:original_name: ListCentralNetworks.html + +.. _ListCentralNetworks: + +Querying the Central Network List +================================= + +Function +-------- + +This API is used to query the central network list. + +Parameters **marker** and **limit** are used for pagination query. The default value of **limit** is **0**. If **marker** is not specified, the first data record is returned. + +URI +--- + +GET /v3/{domain_id}/gcn/central-networks + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================================+=================+==================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_key | No | String | Field for sorting. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | Object | Whether the resources are sorted in ascending or descending order. **asc** indicates the ascending order and **desc** indicates the descending order. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | Array of strings | Resource ID. Multiple IDs can be queried. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | Array of strings | The resource name used for query. Multiple names can be specified for query. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | No | Array of strings | Resource status. Multiple statuses can be used for query. | + | | | | | + | | | | - **AVAILABLE** | + | | | | | + | | | | - **UPDATING** | + | | | | | + | | | | - **FAILED** | + | | | | | + | | | | - **CREATING** | + | | | | | + | | | | - **DELETING** | + | | | | | + | | | | - **DELETED** | + | | | | | + | | | | - **RESTORING** | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | Array of strings | Enterprise project IDs. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_router_id | No | Array of strings | Enterprise router IDs. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attachment_instance_id | No | Array of strings | Attachment ID. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | No | Array of strings | Bandwidth package IDs. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_id | No | Array of strings | Connection ID. | + +--------------------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +------------------+---------------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +==================+=======================================================================================+===============================+ + | request_id | String | Request ID. | + +------------------+---------------------------------------------------------------------------------------+-------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +------------------+---------------------------------------------------------------------------------------+-------------------------------+ + | central_networks | Array of :ref:`CentralNetwork ` objects | Central network list. | + +------------------+---------------------------------------------------------------------------------------+-------------------------------+ + +.. _listcentralnetworks__response_pageinfo: + +.. table:: **Table 5** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listcentralnetworks__response_centralnetwork: + +.. table:: **Table 6** CentralNetwork + + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============================+===================================================================================================================+===============================================================================================+ + | id | String | Instance ID. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | state | String | Central network status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **RESTORING** | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | default_plane_id | String | ID of the default central network plane. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_associate_route_enabled | Boolean | Whether to enable Default Route Table Association. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_propagate_route_enabled | Boolean | Whether to enable Default Route Table Propagation. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlane ` objects | List of central network planes. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | er_instances | Array of :ref:`CentralNetworkErInstance ` objects | List of enterprise routers on a central network. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | connections | Array of :ref:`CentralNetworkConnectionInfo ` objects | List of the enterprise router attachments on a central network. | + +------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +.. _listcentralnetworks__response_centralnetworkplane: + +.. table:: **Table 7** CentralNetworkPlane + + +------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=================================================================================================================+==================================================================================+ + | id | String | Instance ID. | + +------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _listcentralnetworks__response_associateertabledocument: + +.. table:: **Table 8** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _listcentralnetworks__response_excludeerconnectiondocument: + +.. table:: **Table 9** ExcludeErConnectionDocument + + +-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+-----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _listcentralnetworks__response_associateerinstancedocument: + +.. table:: **Table 10** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +.. _listcentralnetworks__response_centralnetworkerinstance: + +.. table:: **Table 11** CentralNetworkErInstance + + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+======================================================================================================================+ + | id | String | Instance ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | asn | Long | ASN of the network instance when BGP is used for routing. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + +.. _listcentralnetworks__response_centralnetworkconnectioninfo: + +.. table:: **Table 12** CentralNetworkConnectionInfo + + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+=========================================================================================+==================================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | plane_id | String | ID of the central network plane. | + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | String | Global connection bandwidth ID. If **bandwidth_type** is set to **TestBandwidth**, no global connection bandwidth is bound, and this parameter is not displayed. | + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Long | Bandwidth range, in Mbit/s. If **bandwidth_type** is set to **TestBandwidth**, the bandwidth size is the default value, and this parameter is not displayed. | + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | String | Type of a central network connection. | + | | | | + | | | - **ER-ER**: peering connection between enterprise routers | + | | | | + | | | - **ER-GDGW**: connection between an enterprise router and a global DC gateway | + | | | | + | | | - **ER-ER_ROUTE_TABLE**: connection between an enterprise router and an enterprise router route table | + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_point_pair | Array of :ref:`ConnectionPoint ` objects | Both ends of a central network connection. The length is fixed to an array of 2. | + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network connection status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **FREEZING** | + | | | | + | | | - **UNFREEZING** | + | | | | + | | | - **RECOVERING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **APPROVING** | + | | | | + | | | - **APPROVED** | + | | | | + | | | - **UNAPPROVED** | + +--------------------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listcentralnetworks__response_connectionpoint: + +.. table:: **Table 13** ConnectionPoint + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | parent_instance_id | String | Parent resource ID of the instance at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of the resource that can be added to a central network as an attachment. | + | | | | + | | | - **ER**: enterprise router | + | | | | + | | | - **GDGW**: global DC gateway | + | | | | + | | | - **ER_ROUTE_TABLE**: enterprise router route table | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the central network list + +.. code-block:: text + + GET /v3/{domain_id}/gcn/central-networks + +Example Responses +----------------- + +**Status code: 200** + +The central network list has been queried. + +.. code-block:: + + { + "request_id" : "0b6ba65808f9d7277f916d44845d271c", + "page_info" : { + "current_count" : 1 + }, + "central_networks" : [ { + "id" : "e096c86f-817c-418c-945c-6b1d8860a15d", + "name" : "name", + "created_at" : "2023-10-09T06:22:40.856Z", + "updated_at" : "2023-10-09T06:22:40.856Z", + "domain_id" : "XXX", + "state" : "AVAILABLE", + "enterprise_project_id" : "0" + } ] + } + +Status Codes +------------ + +=========== ========================================== +Status Code Description +=========== ========================================== +200 The central network list has been queried. +=========== ========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/central_networks/updating_a_central_network.rst b/api-ref/source/api/central_networks/updating_a_central_network.rst new file mode 100644 index 0000000..2d90bec --- /dev/null +++ b/api-ref/source/api/central_networks/updating_a_central_network.rst @@ -0,0 +1,331 @@ +:original_name: UpdateCentralNetwork.html + +.. _UpdateCentralNetwork: + +Updating a Central Network +========================== + +Function +-------- + +This API is used to update a central network. + +URI +--- + +PUT /v3/{domain_id}/gcn/central-networks/{central_network_id} + +.. table:: **Table 1** Path Parameters + + ================== ========= ====== =================== + Parameter Mandatory Type Description + ================== ========= ====== =================== + domain_id Yes String Account ID. + central_network_id Yes String Central network ID. + ================== ========= ====== =================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +-----------------+-----------+-----------------------------------------------------------------------------------------+-----------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+=========================================================================================+===============================================+ + | central_network | Yes | :ref:`UpdateCentralNetwork ` object | Details of the central network to be updated. | + +-----------------+-----------+-----------------------------------------------------------------------------------------+-----------------------------------------------+ + +.. _updatecentralnetwork__request_updatecentralnetwork: + +.. table:: **Table 4** UpdateCentralNetwork + + +-------------+-----------+--------+------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+============================================================+ + | name | No | String | Instance name. | + +-------------+-----------+--------+------------------------------------------------------------+ + | description | No | String | Resource description. Angle brackets (<>) are not allowed. | + +-------------+-----------+--------+------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------------+------------------------------------------------------------------------------+------------------+ + | Parameter | Type | Description | + +=================+==============================================================================+==================+ + | request_id | String | Request ID. | + +-----------------+------------------------------------------------------------------------------+------------------+ + | central_network | :ref:`CentralNetwork ` object | Central network. | + +-----------------+------------------------------------------------------------------------------+------------------+ + +.. _updatecentralnetwork__response_centralnetwork: + +.. table:: **Table 6** CentralNetwork + + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============================+====================================================================================================================+===============================================================================================+ + | id | String | Instance ID. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | state | String | Central network status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **RESTORING** | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | default_plane_id | String | ID of the default central network plane. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_associate_route_enabled | Boolean | Whether to enable Default Route Table Association. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | auto_propagate_route_enabled | Boolean | Whether to enable Default Route Table Propagation. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | planes | Array of :ref:`CentralNetworkPlane ` objects | List of central network planes. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | er_instances | Array of :ref:`CentralNetworkErInstance ` objects | List of enterprise routers on a central network. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | connections | Array of :ref:`CentralNetworkConnectionInfo ` objects | List of the enterprise router attachments on a central network. | + +------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + +.. _updatecentralnetwork__response_centralnetworkplane: + +.. table:: **Table 7** CentralNetworkPlane + + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+==================================================================================================================+==================================================================================+ + | id | String | Instance ID. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | associate_er_tables | Array of :ref:`AssociateErTableDocument ` objects | List of the enterprise routers on a central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + | exclude_er_connections | Array of :ref:`ExcludeErConnectionDocument ` objects | Whether to exclude the connections to enterprise routers on the central network. | + +------------------------+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ + +.. _updatecentralnetwork__response_associateertabledocument: + +.. table:: **Table 8** AssociateErTableDocument + + +----------------------------+--------+------------------------------------------+ + | Parameter | Type | Description | + +============================+========+==========================================+ + | project_id | String | Project ID. | + +----------------------------+--------+------------------------------------------+ + | region_id | String | Region ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------------+--------+------------------------------------------+ + | enterprise_router_table_id | String | ID of the enterprise router route table. | + +----------------------------+--------+------------------------------------------+ + +.. _updatecentralnetwork__response_excludeerconnectiondocument: + +.. table:: **Table 9** ExcludeErConnectionDocument + + +-----------+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================================================================+==============================================================================+ + | [items] | Array of :ref:`AssociateErInstanceDocument ` objects | Connections between enterprise routers managed by the central network plane. | + +-----------+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + +.. _updatecentralnetwork__response_associateerinstancedocument: + +.. table:: **Table 10** AssociateErInstanceDocument + + ==================== ====== ===================== + Parameter Type Description + ==================== ====== ===================== + enterprise_router_id String Enterprise router ID. + project_id String Project ID. + region_id String Region ID. + ==================== ====== ===================== + +.. _updatecentralnetwork__response_centralnetworkerinstance: + +.. table:: **Table 11** CentralNetworkErInstance + + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+======================================================================================================================+ + | id | String | Instance ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | enterprise_router_id | String | Enterprise router ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | asn | Long | ASN of the network instance when BGP is used for routing. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +----------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + +.. _updatecentralnetwork__response_centralnetworkconnectioninfo: + +.. table:: **Table 12** CentralNetworkConnectionInfo + + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================================+==========================================================================================+==================================================================================================================================================================+ + | id | String | Instance ID. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | plane_id | String | ID of the central network plane. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | global_connection_bandwidth_id | String | Global connection bandwidth ID. If **bandwidth_type** is set to **TestBandwidth**, no global connection bandwidth is bound, and this parameter is not displayed. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Long | Bandwidth range, in Mbit/s. If **bandwidth_type** is set to **TestBandwidth**, the bandwidth size is the default value, and this parameter is not displayed. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_type | String | Type of a central network connection. | + | | | | + | | | - **ER-ER**: peering connection between enterprise routers | + | | | | + | | | - **ER-GDGW**: connection between an enterprise router and a global DC gateway | + | | | | + | | | - **ER-ER_ROUTE_TABLE**: connection between an enterprise router and an enterprise router route table | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connection_point_pair | Array of :ref:`ConnectionPoint ` objects | Both ends of a central network connection. The length is fixed to an array of 2. | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Central network connection status. | + | | | | + | | | - **AVAILABLE** | + | | | | + | | | - **CREATING** | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **DELETING** | + | | | | + | | | - **FREEZING** | + | | | | + | | | - **UNFREEZING** | + | | | | + | | | - **RECOVERING** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **DELETED** | + | | | | + | | | - **APPROVING** | + | | | | + | | | - **APPROVED** | + | | | | + | | | - **UNAPPROVED** | + +--------------------------------+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _updatecentralnetwork__response_connectionpoint: + +.. table:: **Table 13** ConnectionPoint + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | parent_instance_id | String | Parent resource ID of the instance at an end of a connection. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of the resource that can be added to a central network as an attachment. | + | | | | + | | | - **ER**: enterprise router | + | | | | + | | | - **GDGW**: global DC gateway | + | | | | + | | | - **ER_ROUTE_TABLE**: enterprise router route table | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Updating a central network + +.. code-block:: text + + PUT /v3/{domain_id}/gcn/central-networks/{central_network_id} + + { + "central_network" : { + "description" : "new description" + } + } + +Example Responses +----------------- + +**Status code: 200** + +The central network has been updated. + +.. code-block:: + + { + "request_id" : "b0f83900a5850b757cc59bf919d90947", + "central_network" : { + "id" : "e096c86f-817c-418c-945c-6b1d8860a15d", + "name" : "name", + "description" : "new description", + "created_at" : "2023-10-09T06:22:40.856Z", + "updated_at" : "2023-10-09T06:27:55.75Z", + "domain_id" : "XXX", + "state" : "AVAILABLE", + "enterprise_project_id" : "0" + } + } + +Status Codes +------------ + +=========== ===================================== +Status Code Description +=========== ===================================== +200 The central network has been updated. +=========== ===================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/creating_a_global_connection_bandwidth.rst b/api-ref/source/api/global_connection_bandwidths/creating_a_global_connection_bandwidth.rst new file mode 100644 index 0000000..05619c7 --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/creating_a_global_connection_bandwidth.rst @@ -0,0 +1,356 @@ +:original_name: CreateGlobalConnectionBandwidth.html + +.. _CreateGlobalConnectionBandwidth: + +Creating a Global Connection Bandwidth +====================================== + +Function +-------- + +This API is used to create a global connection bandwidth. + +URI +--- + +POST /v3/{domain_id}/gcb/gcbandwidths + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +----------------------------+-----------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============================+===========+==========================================================================================================================+==============================================+ + | globalconnection_bandwidth | Yes | :ref:`CreateGlobalConnectionBandwidth ` object | Details about a global connection bandwidth. | + +----------------------------+-----------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _createglobalconnectionbandwidth__request_createglobalconnectionbandwidth: + +.. table:: **Table 4** CreateGlobalConnectionBandwidth + + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+=================+=================+=================================================================================================================================================================================================================================================================================+ + | name | Yes | String | Instance name. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Resource description. Angle brackets (<>) are not allowed. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bordercross | Yes | Boolean | Cross-border attribute of a global connection bandwidth. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | Yes | String | Type of a global connection bandwidth. | + | | | | | + | | | | - **TrsArea**: cross-geographic-region bandwidth (not supported) | + | | | | | + | | | | - **Area**: geographic-region bandwidth | + | | | | | + | | | | - **SubArea**: region bandwidth (not supported) | + | | | | | + | | | | - **Region**: multi-city bandwidth (not supported) | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | ID of the enterprise project that the resource belongs to. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | Yes | String | Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. | + | | | | | + | | | | Range: | + | | | | | + | | | | - **bwd**: billing by bandwidth | + | | | | | + | | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | | + | | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Yes | Integer | The capacity of a global connection bandwidth, in Mbit/s. | + | | | | | + | | | | Value range: 2 Mbit/s to 300 Mbit/s | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sla_level | No | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | | + | | | | - **Pt**: Platinum | + | | | | | + | | | | - **Au**: Gold | + | | | | | + | | | | - **Ag**: Silver | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_area | No | String | Local access point. This parameter is used together with **remote_area** to describe the applicability of a global connection bandwidth. | + | | | | | + | | | | The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). The site code is obtained through API calls. If the bandwidth type is **Region**, this parameter is optional. For other types, this parameter is mandatory. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_area | No | String | Remote access point. This parameter is used together with **local_area** to describe the applicability of a global connection bandwidth. | + | | | | | + | | | | The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). The site code is obtained through API calls. If the bandwidth type is **Region**, this parameter is optional. For other types, this parameter is mandatory. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code_id | No | String | UUID of a line specification code. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 201** + +.. table:: **Table 5** Response body parameters + + +----------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Type | Description | + +============================+===============================================================================================================+==============================================+ + | request_id | String | Request ID. | + +----------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | globalconnection_bandwidth | :ref:`GlobalConnectionBandwidth ` object | Details about a global connection bandwidth. | + +----------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _createglobalconnectionbandwidth__response_globalconnectionbandwidth: + +.. table:: **Table 6** GlobalConnectionBandwidth + + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+=============================================================================================================================================================+=====================================================================================================================================================================+ + | id | String | Instance ID. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bordercross | Boolean | Cross-border attribute of a global connection bandwidth. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of a global connection bandwidth. | + | | | | + | | | - **TrsArea**: cross-geographic-region bandwidth (not supported) | + | | | | + | | | - **Area**: geographic-region bandwidth | + | | | | + | | | - **SubArea**: region bandwidth (not supported) | + | | | | + | | | - **Region**: multi-city bandwidth (not supported) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | String | Instance type. | + | | | | + | | | - **CC**: cloud connection (not supported) | + | | | | + | | | - **GEIP**: global EIP (not supported) | + | | | | + | | | - **GCN**: central network | + | | | | + | | | - **GSN**: site network (not supported) | + | | | | + | | | - **ALL**: all instance types | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. | + | | | | + | | | Range: | + | | | | + | | | - **bwd**: billing by bandwidth | + | | | | + | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | + | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | The capacity of a global connection bandwidth, in Mbit/s. | + | | | | + | | | Value range: 2 Mbit/s to 300 Mbit/s | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: Platinum | + | | | | + | | | - **Au**: Gold | + | | | | + | | | - **Ag**: Silver | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_area | String | Name of the local access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_area | String | Name of the remote access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_site_code | String | Code of the local access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_site_code | String | Code of s remote access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | String | Global connection bandwidth status. | + | | | | + | | | - **NORMAL**: The bandwidth is normal. | + | | | | + | | | - **FREEZED**: The bandwidth is frozen. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | frozen | Boolean | Whether a global connection bandwidth is frozen. | + | | | | + | | | - **true**: The bandwidth is frozen. | + | | | | + | | | - **false**: The bandwidth is not frozen. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code_id | String | UUID of a line specification code. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | directional_connections | Array of :ref:`DirectionalConnection ` objects | Directional connections. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_share | Boolean | Whether a global connection bandwidth can be used by multiple instances. | + | | | | + | | | Range: | + | | | | + | | | - **true**: The bandwidth can be used by multiple instances. | + | | | | + | | | - **false**: The bandwidth cannot be used by multiple instances. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`GlobalConnectionBandwidthAssociatedInstance ` objects | The list of instances that the global connection bandwidth is bound to. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eps_id | String | ID of the enterprise project that the instance belongs to. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | Billing information. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Range of a global connection bandwidth, in Mbit/s. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: platinum | + | | | | + | | | - **Au**: gold | + | | | | + | | | - **Ag**: silver | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Bound instance ID. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_type | Integer | Bound instance type. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_region_id | String | Region of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_project_id | Integer | Project ID of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createglobalconnectionbandwidth__response_directionalconnection: + +.. table:: **Table 7** DirectionalConnection + + ================ ====== =============================== + Parameter Type Description + ================ ====== =============================== + name String Instance name. + id String Instance ID. + local_site_code String Code of the local access point. + remote_site_code String Code of s remote access point. + ================ ====== =============================== + +.. _createglobalconnectionbandwidth__response_globalconnectionbandwidthassociatedinstance: + +.. table:: **Table 8** GlobalConnectionBandwidthAssociatedInstance + + +------------+--------+------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+====================================================================================+ + | id | String | Bound instance ID. | + +------------+--------+------------------------------------------------------------------------------------+ + | type | String | Bound instance type. | + +------------+--------+------------------------------------------------------------------------------------+ + | region_id | String | Region of the bound instance. The default value is **global** for global services. | + +------------+--------+------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the bound instance. | + +------------+--------+------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Creating a geographic-region bandwidth + +.. code-block:: text + + POST https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths + + { + "globalconnection_bandwidth" : { + "name" : "test_area", + "description" : "Description", + "bordercross" : false, + "type" : "Area", + "charge_mode" : "bwd", + "size" : 5, + "local_area" : "site-abc", + "remote_area" : "site-def" + } + } + +Example Responses +----------------- + +**Status code: 201** + +The global connection bandwidth has been created. + +.. code-block:: + + { + "request_id" : "1b90e4762e3090961a30ca3a712dc0ed", + "globalconnection_bandwidth" : { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "name" : "name", + "description" : "description", + "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76", + "bordercross" : false, + "type" : "Area", + "binding_service" : "ALL", + "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0", + "charge_mode" : "bwd", + "size" : 100, + "sla_level" : "Au", + "local_site_code" : "site-def", + "remote_site_code" : "site-abc", + "frozen" : false, + "spec_code_id" : "", + "tags" : [ ], + "created_at" : "2024-01-24T08:26:41.914Z", + "updated_at" : "2024-01-24T08:26:41.914Z", + "enable_share" : false, + "instances" : [ ] + } + } + +Status Codes +------------ + +=========== ================================================= +Status Code Description +=========== ================================================= +201 The global connection bandwidth has been created. +=========== ================================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/deleting_a_global_connection_bandwidth.rst b/api-ref/source/api/global_connection_bandwidths/deleting_a_global_connection_bandwidth.rst new file mode 100644 index 0000000..15d09b7 --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/deleting_a_global_connection_bandwidth.rst @@ -0,0 +1,73 @@ +:original_name: DeleteGlobalConnectionBandwidth.html + +.. _DeleteGlobalConnectionBandwidth: + +Deleting a Global Connection Bandwidth +====================================== + +Function +-------- + +This API is used to delete a global connection bandwidth. + +URI +--- + +DELETE /v3/{domain_id}/gcb/gcbandwidths/{id} + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== ============ + Parameter Mandatory Type Description + ========= ========= ====== ============ + domain_id Yes String Account ID. + id Yes String Instance ID. + ========= ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 204** + +The global connection bandwidth has been deleted. + +None + +Example Requests +---------------- + +Deleting a global connection bandwidth + +.. code-block:: text + + DELETE https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id} + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ================================================= +Status Code Description +=========== ================================================= +204 The global connection bandwidth has been deleted. +=========== ================================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/index.rst b/api-ref/source/api/global_connection_bandwidths/index.rst new file mode 100644 index 0000000..ea79361 --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/index.rst @@ -0,0 +1,28 @@ +:original_name: topic_300000019.html + +.. _topic_300000019: + +Global Connection Bandwidths +============================ + +- :ref:`Querying the Global Connection Bandwidth List ` +- :ref:`Creating a Global Connection Bandwidth ` +- :ref:`Querying a Global Connection Bandwidth ` +- :ref:`Updating a Global Connection Bandwidth ` +- :ref:`Deleting a Global Connection Bandwidth ` +- :ref:`Querying the List of Global Connection Bandwidths That Meet the Binding Conditions ` +- :ref:`Querying the Tenant Configuration of a Global Connection Bandwidth ` +- :ref:`Querying the Site List ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_the_global_connection_bandwidth_list + creating_a_global_connection_bandwidth + querying_a_global_connection_bandwidth + updating_a_global_connection_bandwidth + deleting_a_global_connection_bandwidth + querying_the_list_of_global_connection_bandwidths_that_meet_the_binding_conditions + querying_the_tenant_configuration_of_a_global_connection_bandwidth + querying_the_site_list diff --git a/api-ref/source/api/global_connection_bandwidths/querying_a_global_connection_bandwidth.rst b/api-ref/source/api/global_connection_bandwidths/querying_a_global_connection_bandwidth.rst new file mode 100644 index 0000000..1d2512c --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/querying_a_global_connection_bandwidth.rst @@ -0,0 +1,278 @@ +:original_name: ShowGlobalConnectionBandwidth.html + +.. _ShowGlobalConnectionBandwidth: + +Querying a Global Connection Bandwidth +====================================== + +Function +-------- + +This API is used to query the details about a global connection bandwidth. + +URI +--- + +GET /v3/{domain_id}/gcb/gcbandwidths/{id} + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== ============ + Parameter Mandatory Type Description + ========= ========= ====== ============ + domain_id Yes String Account ID. + id Yes String Instance ID. + ========= ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +----------------------------+-------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Type | Description | + +============================+=============================================================================================================+==============================================+ + | request_id | String | Request ID. | + +----------------------------+-------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | globalconnection_bandwidth | :ref:`GlobalConnectionBandwidth ` object | Details about a global connection bandwidth. | + +----------------------------+-------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _showglobalconnectionbandwidth__response_globalconnectionbandwidth: + +.. table:: **Table 4** GlobalConnectionBandwidth + + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+===========================================================================================================================================================+=====================================================================================================================================================================+ + | id | String | Instance ID. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bordercross | Boolean | Cross-border attribute of a global connection bandwidth. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of a global connection bandwidth. | + | | | | + | | | - **TrsArea**: cross-geographic-region bandwidth (not supported) | + | | | | + | | | - **Area**: geographic-region bandwidth | + | | | | + | | | - **SubArea**: region bandwidth (not supported) | + | | | | + | | | - **Region**: multi-city bandwidth (not supported) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | String | Instance type. | + | | | | + | | | - **CC**: cloud connection (not supported) | + | | | | + | | | - **GEIP**: global EIP (not supported) | + | | | | + | | | - **GCN**: central network | + | | | | + | | | - **GSN**: site network (not supported) | + | | | | + | | | - **ALL**: all instance types | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. | + | | | | + | | | Range: | + | | | | + | | | - **bwd**: billing by bandwidth | + | | | | + | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | + | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | The capacity of a global connection bandwidth, in Mbit/s. | + | | | | + | | | Value range: 2 Mbit/s to 300 Mbit/s | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: Platinum | + | | | | + | | | - **Au**: Gold | + | | | | + | | | - **Ag**: Silver | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_area | String | Name of the local access point. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_area | String | Name of the remote access point. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_site_code | String | Code of the local access point. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_site_code | String | Code of s remote access point. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | String | Global connection bandwidth status. | + | | | | + | | | - **NORMAL**: The bandwidth is normal. | + | | | | + | | | - **FREEZED**: The bandwidth is frozen. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | frozen | Boolean | Whether a global connection bandwidth is frozen. | + | | | | + | | | - **true**: The bandwidth is frozen. | + | | | | + | | | - **false**: The bandwidth is not frozen. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code_id | String | UUID of a line specification code. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | directional_connections | Array of :ref:`DirectionalConnection ` objects | Directional connections. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_share | Boolean | Whether a global connection bandwidth can be used by multiple instances. | + | | | | + | | | Range: | + | | | | + | | | - **true**: The bandwidth can be used by multiple instances. | + | | | | + | | | - **false**: The bandwidth cannot be used by multiple instances. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`GlobalConnectionBandwidthAssociatedInstance ` objects | The list of instances that the global connection bandwidth is bound to. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eps_id | String | ID of the enterprise project that the instance belongs to. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | Billing information. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Range of a global connection bandwidth, in Mbit/s. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: platinum | + | | | | + | | | - **Au**: gold | + | | | | + | | | - **Ag**: silver | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Bound instance ID. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_type | Integer | Bound instance type. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_region_id | String | Region of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_project_id | Integer | Project ID of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showglobalconnectionbandwidth__response_directionalconnection: + +.. table:: **Table 5** DirectionalConnection + + ================ ====== =============================== + Parameter Type Description + ================ ====== =============================== + name String Instance name. + id String Instance ID. + local_site_code String Code of the local access point. + remote_site_code String Code of s remote access point. + ================ ====== =============================== + +.. _showglobalconnectionbandwidth__response_globalconnectionbandwidthassociatedinstance: + +.. table:: **Table 6** GlobalConnectionBandwidthAssociatedInstance + + +------------+--------+------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+====================================================================================+ + | id | String | Bound instance ID. | + +------------+--------+------------------------------------------------------------------------------------+ + | type | String | Bound instance type. | + +------------+--------+------------------------------------------------------------------------------------+ + | region_id | String | Region of the bound instance. The default value is **global** for global services. | + +------------+--------+------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the bound instance. | + +------------+--------+------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying a global connection bandwidth + +.. code-block:: text + + GET https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id} + +Example Responses +----------------- + +**Status code: 200** + +The global connection bandwidth details have been queried. + +.. code-block:: + + { + "request_id" : "1b90e4762e3090961a30ca3a712dc0ed", + "globalconnection_bandwidth" : { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "name" : "name", + "description" : "description", + "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76", + "bordercross" : false, + "type" : "Region", + "binding_service" : "ALL", + "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0", + "charge_mode" : "bwd", + "size" : 100, + "sla_level" : "Au", + "local_site_code" : "site-def", + "remote_site_code" : "site-abc", + "frozen" : false, + "spec_code_id" : "", + "tags" : [ ], + "created_at" : "2024-01-24T08:26:41.914Z", + "updated_at" : "2024-01-24T08:26:41.914Z", + "enable_share" : false, + "instances" : [ ] + } + } + +Status Codes +------------ + +=========== ========================================================== +Status Code Description +=========== ========================================================== +200 The global connection bandwidth details have been queried. +=========== ========================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/querying_the_global_connection_bandwidth_list.rst b/api-ref/source/api/global_connection_bandwidths/querying_the_global_connection_bandwidth_list.rst new file mode 100644 index 0000000..6f481b3 --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/querying_the_global_connection_bandwidth_list.rst @@ -0,0 +1,362 @@ +:original_name: ListGlobalConnectionBandwidths.html + +.. _ListGlobalConnectionBandwidths: + +Querying the Global Connection Bandwidth List +============================================= + +Function +-------- + +This API is used to query the global connection bandwidth list. + +Parameters **marker** and **limit** are used for pagination query. The two parameters take effect only when they are used together. + +URI +--- + +GET /v3/{domain_id}/gcb/gcbandwidths + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+=================+==================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | Array of strings | Resource ID. Multiple IDs can be queried. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | Array of strings | The resource name used for query. Multiple names can be specified for query. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | Array of strings | Enterprise project IDs. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | No | Array of strings | Bound instance ID used for listing global connection bandwidths. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_type | No | Array of strings | Bound instance type used for listing global connection bandwidths. Instance type: | + | | | | | + | | | | - **CC**: cloud connection (not supported) | + | | | | | + | | | | - **GEIP**: global EIP (not supported) | + | | | | | + | | | | - **GCN**: central network | + | | | | | + | | | | - **GSN**: site network (not supported) | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | No | Array of strings | Bound instance type used for listing global connection bandwidths. Instance type: | + | | | | | + | | | | - **CC**: cloud connection (not supported) | + | | | | | + | | | | - **GEIP**: global EIP (not supported) | + | | | | | + | | | | - **GCN**: central network | + | | | | | + | | | | - **GSN**: site network (not supported) | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | Array of strings | Bandwidth type used for listing global connection bandwidths. Bandwidth type: | + | | | | | + | | | | - **TrsArea**: cross-geographic-region bandwidth (not supported) | + | | | | | + | | | | - **Area**: geographic-region bandwidth | + | | | | | + | | | | - **SubArea**: region bandwidth (not supported) | + | | | | | + | | | | - **Region**: multi-city bandwidth (not supported) | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | No | Array of strings | Status used for listing global connection bandwidths. | + | | | | | + | | | | - **NORMAL**: The global connection bandwidth is available. | + | | | | | + | | | | - **FREEZED**: The global connection bandwidth is frozen. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | No | Array of strings | Billing option used for querying global connection bandwidths. | + | | | | | + | | | | - **bwd**: billed by bandwidth | + | | | | | + | | | | - **95**: standard 95th percentile bandwidth billing | + | | | | | + | | | | - **95avr**: average daily 95th percentile bandwidth billing | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------------------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+========================================================================================================================+==================================================================+ + | request_id | String | Request ID. | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | globalconnection_bandwidths | Array of :ref:`GlobalConnectionBandwidth ` objects | Response body for querying the global connection bandwidth list. | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + +.. _listglobalconnectionbandwidths__response_pageinfo: + +.. table:: **Table 5** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listglobalconnectionbandwidths__response_globalconnectionbandwidth: + +.. table:: **Table 6** GlobalConnectionBandwidth + + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+============================================================================================================================================================+=====================================================================================================================================================================+ + | id | String | Instance ID. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bordercross | Boolean | Cross-border attribute of a global connection bandwidth. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of a global connection bandwidth. | + | | | | + | | | - **TrsArea**: cross-geographic-region bandwidth (not supported) | + | | | | + | | | - **Area**: geographic-region bandwidth | + | | | | + | | | - **SubArea**: region bandwidth (not supported) | + | | | | + | | | - **Region**: multi-city bandwidth (not supported) | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | String | Instance type. | + | | | | + | | | - **CC**: cloud connection (not supported) | + | | | | + | | | - **GEIP**: global EIP (not supported) | + | | | | + | | | - **GCN**: central network | + | | | | + | | | - **GSN**: site network (not supported) | + | | | | + | | | - **ALL**: all instance types | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. | + | | | | + | | | Range: | + | | | | + | | | - **bwd**: billing by bandwidth | + | | | | + | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | + | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | The capacity of a global connection bandwidth, in Mbit/s. | + | | | | + | | | Value range: 2 Mbit/s to 300 Mbit/s | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: Platinum | + | | | | + | | | - **Au**: Gold | + | | | | + | | | - **Ag**: Silver | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_area | String | Name of the local access point. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_area | String | Name of the remote access point. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_site_code | String | Code of the local access point. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_site_code | String | Code of s remote access point. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | String | Global connection bandwidth status. | + | | | | + | | | - **NORMAL**: The bandwidth is normal. | + | | | | + | | | - **FREEZED**: The bandwidth is frozen. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | frozen | Boolean | Whether a global connection bandwidth is frozen. | + | | | | + | | | - **true**: The bandwidth is frozen. | + | | | | + | | | - **false**: The bandwidth is not frozen. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code_id | String | UUID of a line specification code. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | directional_connections | Array of :ref:`DirectionalConnection ` objects | Directional connections. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_share | Boolean | Whether a global connection bandwidth can be used by multiple instances. | + | | | | + | | | Range: | + | | | | + | | | - **true**: The bandwidth can be used by multiple instances. | + | | | | + | | | - **false**: The bandwidth cannot be used by multiple instances. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`GlobalConnectionBandwidthAssociatedInstance ` objects | The list of instances that the global connection bandwidth is bound to. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eps_id | String | ID of the enterprise project that the instance belongs to. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | Billing information. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Range of a global connection bandwidth, in Mbit/s. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: platinum | + | | | | + | | | - **Au**: gold | + | | | | + | | | - **Ag**: silver | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Bound instance ID. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_type | Integer | Bound instance type. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_region_id | String | Region of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_project_id | Integer | Project ID of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listglobalconnectionbandwidths__response_directionalconnection: + +.. table:: **Table 7** DirectionalConnection + + ================ ====== =============================== + Parameter Type Description + ================ ====== =============================== + name String Instance name. + id String Instance ID. + local_site_code String Code of the local access point. + remote_site_code String Code of s remote access point. + ================ ====== =============================== + +.. _listglobalconnectionbandwidths__response_globalconnectionbandwidthassociatedinstance: + +.. table:: **Table 8** GlobalConnectionBandwidthAssociatedInstance + + +------------+--------+------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+====================================================================================+ + | id | String | Bound instance ID. | + +------------+--------+------------------------------------------------------------------------------------+ + | type | String | Bound instance type. | + +------------+--------+------------------------------------------------------------------------------------+ + | region_id | String | Region of the bound instance. The default value is **global** for global services. | + +------------+--------+------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the bound instance. | + +------------+--------+------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the global connection bandwidth list + +.. code-block:: text + + GET https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths + +Example Responses +----------------- + +**Status code: 200** + +The global connection bandwidth list has been queried. + +.. code-block:: + + { + "request_id" : "61126320a1802d5c6444f9d2d76526c2", + "globalconnection_bandwidths" : [ { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "name" : "name", + "description" : "description", + "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76", + "bordercross" : false, + "type" : "Region", + "binding_service" : "ALL", + "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0", + "charge_mode" : "bwd", + "size" : 100, + "sla_level" : "Au", + "local_site_code" : "site-abc", + "remote_site_code" : "site-def", + "frozen" : false, + "spec_code_id" : "", + "tags" : [ ], + "created_at" : "2024-01-24T08:26:41.914Z", + "updated_at" : "2024-01-24T08:26:41.914Z", + "enable_share" : false, + "instances" : [ ] + } ], + "page_info" : { + "next_marker" : "XXX", + "previous_marker" : "XXX", + "current_count" : 1 + } + } + +Status Codes +------------ + +=========== ====================================================== +Status Code Description +=========== ====================================================== +200 The global connection bandwidth list has been queried. +=========== ====================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/querying_the_list_of_global_connection_bandwidths_that_meet_the_binding_conditions.rst b/api-ref/source/api/global_connection_bandwidths/querying_the_list_of_global_connection_bandwidths_that_meet_the_binding_conditions.rst new file mode 100644 index 0000000..71924cc --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/querying_the_list_of_global_connection_bandwidths_that_meet_the_binding_conditions.rst @@ -0,0 +1,342 @@ +:original_name: ListSupportBindingConnectionBandwidths.html + +.. _ListSupportBindingConnectionBandwidths: + +Querying the List of Global Connection Bandwidths That Meet the Binding Conditions +================================================================================== + +Function +-------- + +This API is used to query the list of global connection bandwidths that meet the binding conditions. + +Parameters **marker** and **limit** are used for pagination query. The two parameters take effect only when they are used together. + +URI +--- + +GET /v3/{domain_id}/gcb/gcbandwidths/support-bindings + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+=================+==================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | Array of strings | Enterprise project IDs. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_area | No | String | Local access point. | + | | | | | + | | | | - If the bandwidth type is set to **region**, all multi-city bandwidths that meet the filtering criteria are returned. This field is not matched for filtering. | + | | | | | + | | | | - For other types, this field is used to match **local_area** of the backbone bandwidth. | + | | | | | + | | | | Additional filtering criteria: The optimal backbone bandwidth type is selected based on **local_area** and **remote_area** for filtering. | + | | | | | + | | | | Restrictions: **local_area** and **remote_area** can or cannot be left blank at the same time, and their site types must be the same. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_area | No | String | Remote access point. | + | | | | | + | | | | - If the bandwidth type is set to **region**, all multi-city bandwidths that meet the filtering criteria are returned. This field is not matched for filtering. | + | | | | | + | | | | - For other types, this field is used to match **remote_area** of the backbone bandwidth. | + | | | | | + | | | | Additional filtering criteria: The optimal backbone bandwidth type is selected based on **local_area** and **remote_area** for filtering. | + | | | | | + | | | | Restrictions: **local_area** and **remote_area** can or cannot be left blank at the same time, and their site types must be the same. | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | Yes | String | Bound instance type used for listing global connection bandwidths. Instance type: | + | | | | | + | | | | - **CC**: cloud connection (not supported) | + | | | | | + | | | | - **GEIP**: global EIP (not supported) | + | | | | | + | | | | - **GCN**: central network | + | | | | | + | | | | - **GSN**: site network (not supported) | + +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+================================================================================================================================+==================================================================+ + | request_id | String | Request ID. | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | globalconnection_bandwidths | Array of :ref:`GlobalConnectionBandwidth ` objects | Response body for querying the global connection bandwidth list. | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + +.. _listsupportbindingconnectionbandwidths__response_pageinfo: + +.. table:: **Table 5** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listsupportbindingconnectionbandwidths__response_globalconnectionbandwidth: + +.. table:: **Table 6** GlobalConnectionBandwidth + + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+====================================================================================================================================================================+=====================================================================================================================================================================+ + | id | String | Instance ID. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bordercross | Boolean | Cross-border attribute of a global connection bandwidth. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of a global connection bandwidth. | + | | | | + | | | - **TrsArea**: cross-geographic-region bandwidth (not supported) | + | | | | + | | | - **Area**: geographic-region bandwidth | + | | | | + | | | - **SubArea**: region bandwidth (not supported) | + | | | | + | | | - **Region**: multi-city bandwidth (not supported) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | String | Instance type. | + | | | | + | | | - **CC**: cloud connection (not supported) | + | | | | + | | | - **GEIP**: global EIP (not supported) | + | | | | + | | | - **GCN**: central network | + | | | | + | | | - **GSN**: site network (not supported) | + | | | | + | | | - **ALL**: all instance types | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. | + | | | | + | | | Range: | + | | | | + | | | - **bwd**: billing by bandwidth | + | | | | + | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | + | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | The capacity of a global connection bandwidth, in Mbit/s. | + | | | | + | | | Value range: 2 Mbit/s to 300 Mbit/s | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: Platinum | + | | | | + | | | - **Au**: Gold | + | | | | + | | | - **Ag**: Silver | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_area | String | Name of the local access point. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_area | String | Name of the remote access point. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_site_code | String | Code of the local access point. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_site_code | String | Code of s remote access point. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | String | Global connection bandwidth status. | + | | | | + | | | - **NORMAL**: The bandwidth is normal. | + | | | | + | | | - **FREEZED**: The bandwidth is frozen. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | frozen | Boolean | Whether a global connection bandwidth is frozen. | + | | | | + | | | - **true**: The bandwidth is frozen. | + | | | | + | | | - **false**: The bandwidth is not frozen. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code_id | String | UUID of a line specification code. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | directional_connections | Array of :ref:`DirectionalConnection ` objects | Directional connections. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_share | Boolean | Whether a global connection bandwidth can be used by multiple instances. | + | | | | + | | | Range: | + | | | | + | | | - **true**: The bandwidth can be used by multiple instances. | + | | | | + | | | - **false**: The bandwidth cannot be used by multiple instances. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`GlobalConnectionBandwidthAssociatedInstance ` objects | The list of instances that the global connection bandwidth is bound to. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eps_id | String | ID of the enterprise project that the instance belongs to. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | Billing information. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Range of a global connection bandwidth, in Mbit/s. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: platinum | + | | | | + | | | - **Au**: gold | + | | | | + | | | - **Ag**: silver | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Bound instance ID. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_type | Integer | Bound instance type. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_region_id | String | Region of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_project_id | Integer | Project ID of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listsupportbindingconnectionbandwidths__response_directionalconnection: + +.. table:: **Table 7** DirectionalConnection + + ================ ====== =============================== + Parameter Type Description + ================ ====== =============================== + name String Instance name. + id String Instance ID. + local_site_code String Code of the local access point. + remote_site_code String Code of s remote access point. + ================ ====== =============================== + +.. _listsupportbindingconnectionbandwidths__response_globalconnectionbandwidthassociatedinstance: + +.. table:: **Table 8** GlobalConnectionBandwidthAssociatedInstance + + +------------+--------+------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+====================================================================================+ + | id | String | Bound instance ID. | + +------------+--------+------------------------------------------------------------------------------------+ + | type | String | Bound instance type. | + +------------+--------+------------------------------------------------------------------------------------+ + | region_id | String | Region of the bound instance. The default value is **global** for global services. | + +------------+--------+------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the bound instance. | + +------------+--------+------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the list of global connection bandwidths that meet the binding conditions + +.. code-block:: text + + GET https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/support-bindings?binding_service=CC&local_area=site-def&remote_area=site-abc + +Example Responses +----------------- + +**Status code: 200** + +The global connection bandwidth list has been queried. + +.. code-block:: + + { + "request_id" : "61126320a1802d5c6444f9d2d76526c2", + "globalconnection_bandwidths" : [ { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "name" : "name", + "description" : "description", + "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76", + "bordercross" : false, + "type" : "Region", + "binding_service" : "CC", + "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0", + "charge_mode" : "bwd", + "size" : 100, + "sla_level" : "Au", + "local_site_code" : "site-def", + "remote_site_code" : "site-abc", + "frozen" : false, + "spec_code_id" : "", + "tags" : [ ], + "created_at" : "2024-01-24T08:26:41.914Z", + "updated_at" : "2024-01-24T08:26:41.914Z", + "enable_share" : false, + "instances" : [ ] + } ], + "page_info" : { + "next_marker" : "XXX", + "previous_marker" : "XXX", + "current_count" : 1 + } + } + +Status Codes +------------ + +=========== ====================================================== +Status Code Description +=========== ====================================================== +200 The global connection bandwidth list has been queried. +=========== ====================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/querying_the_site_list.rst b/api-ref/source/api/global_connection_bandwidths/querying_the_site_list.rst new file mode 100644 index 0000000..6a8705c --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/querying_the_site_list.rst @@ -0,0 +1,233 @@ +:original_name: ListGlobalConnectionBandwidthSites.html + +.. _ListGlobalConnectionBandwidthSites: + +Querying the Site List +====================== + +Function +-------- + +This API is used to query the site list. + +Parameters **marker** and **limit** are used for pagination query. The two parameters take effect only when they are used together. + +URI +--- + +GET /v3/{domain_id}/gcb/sites + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | No | Integer | Number of records returned on each page. | + | | | | | + | | | | The value ranges from 1 to 2000. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Pagination query information. You can obtain the **marker** values from the response of the last API call. You can enter the **marker** value of the previous page or the next page. If you enter the **marker** value of the previous page, the previous page will be queried. If you enter the **marker** value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the **limit** value, cannot be modified. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | Array of strings | Resource ID. Multiple IDs can be queried. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name_en | No | String | User-defined site information in English. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name_cn | No | String | User-defined site information in English. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | site_code | No | String | Site code. | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | site_type | No | String | Site type. | + | | | | | + | | | | - **Area**: a geographic region site | + | | | | | + | | | | - **SubArea**: a region site | + | | | | | + | | | | - **Region**: a multi-city site | + +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+ + | Parameter | Type | Description | + +=============+======================================================================================================================================+===========================================+ + | request_id | String | Request ID. | + +-------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information. | + +-------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+ + | total_count | Integer | Total number of records. | + +-------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+ + | site_infos | Array of :ref:`GlobalConnectionBandwidthSites ` objects | Response body for querying the site list. | + +-------------+--------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+ + +.. _listglobalconnectionbandwidthsites__response_pageinfo: + +.. table:: **Table 5** PageInfo + + =============== ======= ============================================ + Parameter Type Description + =============== ======= ============================================ + next_marker String Backward pagination identifier. + previous_marker String Forward pagination identifier. + current_count Integer Number of the resources in the current list. + =============== ======= ============================================ + +.. _listglobalconnectionbandwidthsites__response_globalconnectionbandwidthsites: + +.. table:: **Table 6** GlobalConnectionBandwidthSites + + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+======================================================================================================================+===================================================================================================================================================================================+ + | id | String | Instance ID. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_id | String | Region ID. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name_en | String | User-defined site name in English. | + | | | | + | | | Value range: 1 to 255 characters | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name_cn | String | User-defined site name in English. | + | | | | + | | | Value range: 1 to 64 characters | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | site_code | String | Site code in the format of [-[-]]. | + | | | | + | | | Value range: 1 to 64 characters | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | site_type | String | Site type that corresponds to the site code. One code indicates a site in a geographic region, two codes indicate a site in a region, and three codes indicate a multi-city site. | + | | | | + | | | The value can be: | + | | | | + | | | - **Area**: a geographic region site | + | | | | + | | | - **SubArea**: a region site | + | | | | + | | | - **Region**: a multi-city site | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_list | String | List of services supported at the site. Multiple services are separated by commas (,). | + | | | | + | | | Value range: 0 to 255 characters | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | group_list | Array of :ref:`SiteGroupReferenceInfo ` objects | Data model for association between site groups and external systems. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Whether the site is a central site or an edge site. **center**: indicates a central site. | + | | | | + | | | Value range: 0 to 255 characters | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code | String | The specification code of the site. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_size | String | The number of subordinates of the site. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_share | String | Whether a global connection bandwidth can be used by multiple instances in the site. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listglobalconnectionbandwidthsites__response_sitegroupreferenceinfo: + +.. table:: **Table 7** SiteGroupReferenceInfo + + +-------------+--------+------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+========+============================================================+ + | id | String | Instance ID. | + +-------------+--------+------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +-------------+--------+------------------------------------------------------------+ + | name_en | String | User-defined site group name in English. | + +-------------+--------+------------------------------------------------------------+ + | name_cn | String | User-defined site group name in English. | + +-------------+--------+------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the site list + +.. code-block:: text + + GET https://{cc_endpoint}/v3/{domain_id}/gcb/sites + +Example Responses +----------------- + +**Status code: 200** + +The site list has been queried. + +.. code-block:: + + { + "request_id" : "61126320a1802d5c6444f9d2d76526c2", + "site_infos" : [ { + "id" : "5c2d5343-cde2-4a41-83ae-56b7f44d73b5", + "description" : "description", + "name_cn" : "Site abc", + "name_en" : "site-abc", + "site_code" : "site-abc", + "site_type" : "Region", + "service_list" : "CC,GCN", + "region_id" : "region-abc", + "public_border_group" : "center", + "group_list" : [ { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "description" : "description" + } ], + "created_at" : "2024-01-24T08:26:41.914Z", + "updated_at" : "2024-01-24T08:26:41.914Z" + } ], + "total_count" : 10, + "page_info" : { + "next_marker" : "XXX", + "previous_marker" : "XXX", + "current_count" : 1 + } + } + +Status Codes +------------ + +=========== =============================== +Status Code Description +=========== =============================== +200 The site list has been queried. +=========== =============================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/querying_the_tenant_configuration_of_a_global_connection_bandwidth.rst b/api-ref/source/api/global_connection_bandwidths/querying_the_tenant_configuration_of_a_global_connection_bandwidth.rst new file mode 100644 index 0000000..94a2537 --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/querying_the_tenant_configuration_of_a_global_connection_bandwidth.rst @@ -0,0 +1,209 @@ +:original_name: ListGlobalConnectionBandwidthConfigs.html + +.. _ListGlobalConnectionBandwidthConfigs: + +Querying the Tenant Configuration of a Global Connection Bandwidth +================================================================== + +Function +-------- + +This API is used to query the tenant configuration of a global connection bandwidth. + +URI +--- + +GET /v3/{domain_id}/gcb/configs + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + domain_id Yes String Account ID. + ========= ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +------------+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+==========================================================================================================================================+===========================================================================+ + | request_id | String | Request ID. | + +------------+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | configs | :ref:`ListGlobalConnectionBandwidthConfigs ` object | Dynamic configuration items for purchasing a global connection bandwidth. | + +------------+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + +.. _listglobalconnectionbandwidthconfigs__response_listglobalconnectionbandwidthconfigs: + +.. table:: **Table 4** ListGlobalConnectionBandwidthConfigs + + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================================================================================================+=====================================================================================================+ + | size_range | Array of :ref:`GlobalConnectionBandwidthSizeRange ` objects | Capacity of global connection bandwidths by billing option. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | charge_mode | Array of strings | List of supported billing options. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | services | Array of strings | Instance type. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | gcb_type | Array of strings | Bandwidth type. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | ratio_95peak_plus | Integer | Percentage of the minimum bandwidth in enhanced 95th percentile bandwidth billing. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | ratio_95peak_guar | Integer | Percentage of the minimum bandwidth in standard 95th percentile bandwidth billing. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | crossborder | Boolean | Whether a cross-border permit is approved. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | quotas | Array of :ref:`GlobalConnectionBandwidthQuotas ` objects | Quota information. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | sla_level | Array of strings | Line grade. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | bind_limit | Integer | Maximum number of instances that are allowed to use a shared bandwidth. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | enable_area_bandwidth | Boolean | Whether to enable the geographic region bandwidth. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | enable_change_95 | Boolean | Whether standard 95th percentile bandwidth billing can be changed to billing by bandwidth capacity. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | enable_spec_code | Boolean | Whether multiple line specifications are supported. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | ces_enabled | Boolean | Whether to enable Cloud Eye monitoring. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | gcbType | Array of strings | Bandwidth type. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | gcbSizeRange | Array of :ref:`GlobalConnectionBandwidthSizeRange ` objects | Bandwidth range of global connection bandwidths by billing option. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | relation | :ref:`GlobalConnectionBandwidthRelation ` object | Instance type. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | chargeMode | Array of strings | List of supported billing options. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + +.. _listglobalconnectionbandwidthconfigs__response_globalconnectionbandwidthquotas: + +.. table:: **Table 5** GlobalConnectionBandwidthQuotas + + +-----------------------+-----------------------+----------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================+ + | quota | Integer | Quotas. | + +-----------------------+-----------------------+----------------------------------------------------------+ + | used | Integer | Used quotas. | + +-----------------------+-----------------------+----------------------------------------------------------+ + | type | String | Quota type. | + | | | | + | | | - **gcb.size**: global connection bandwidth capacity | + | | | | + | | | - **gcb.count**: number of global connection bandwidths | + +-----------------------+-----------------------+----------------------------------------------------------+ + +.. _listglobalconnectionbandwidthconfigs__response_globalconnectionbandwidthsizerange: + +.. table:: **Table 6** GlobalConnectionBandwidthSizeRange + + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================+ + | type | String | Billing option. | + | | | | + | | | Range: | + | | | | + | | | - **bwd**: billing by bandwidth | + | | | | + | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | + | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | min | Integer | Minimum global connection bandwidth, in Mbit/s. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | max | Integer | Maximum global connection bandwidth, in Mbit/s. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +.. _listglobalconnectionbandwidthconfigs__response_globalconnectionbandwidthrelation: + +.. table:: **Table 7** GlobalConnectionBandwidthRelation + + ========= ================ ============== + Parameter Type Description + ========= ================ ============== + Area Array of strings Instance type. + ========= ================ ============== + +Example Requests +---------------- + +Querying the tenant configuration of a global connection bandwidth + +.. code-block:: text + + GET https://{cc_endpoint}/v3/{domain_id}/gcb/configs + +Example Responses +----------------- + +**Status code: 200** + +The tenant configuration of the global connection bandwidth has been queried. + +.. code-block:: + + { + "request_id" : "61126320a1802d5c6444f9d2d76526c2", + "configs" : { + "size_range" : [ { + "min" : 2, + "max" : 300, + "type" : "bwd" + } ], + "charge_mode" : [ "bwd", 95, "95avr" ], + "services" : [ "GEIP", "CC", "GCN", "GSN" ], + "gcb_type" : [ "Region", "SubArea", "Area", "TrsArea" ], + "ratio_95peak_guar" : 0, + "crossborder" : false, + "quotas" : [ { + "quota" : 99999999, + "used" : 3451, + "type" : "gcb.size" + }, { + "quota" : 10000, + "used" : 16, + "type" : "gcb.count" + } ], + "bind_limit" : 200, + "sla_level" : [ "Pt", "Au", "Ag" ] + } + } + +Status Codes +------------ + ++-------------+-------------------------------------------------------------------------------+ +| Status Code | Description | ++=============+===============================================================================+ +| 200 | The tenant configuration of the global connection bandwidth has been queried. | ++-------------+-------------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/global_connection_bandwidths/updating_a_global_connection_bandwidth.rst b/api-ref/source/api/global_connection_bandwidths/updating_a_global_connection_bandwidth.rst new file mode 100644 index 0000000..12939ee --- /dev/null +++ b/api-ref/source/api/global_connection_bandwidths/updating_a_global_connection_bandwidth.rst @@ -0,0 +1,342 @@ +:original_name: UpdateGlobalConnectionBandwidth.html + +.. _UpdateGlobalConnectionBandwidth: + +Updating a Global Connection Bandwidth +====================================== + +Function +-------- + +This API is used to update a global connection bandwidth. + +URI +--- + +PUT /v3/{domain_id}/gcb/gcbandwidths/{id} + +.. table:: **Table 1** Path Parameters + + ========= ========= ====== ============ + Parameter Mandatory Type Description + ========= ========= ====== ============ + domain_id Yes String Account ID. + id Yes String Instance ID. + ========= ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token No String User token. + ============ ========= ====== =========== + +.. table:: **Table 3** Request body parameters + + +----------------------------+-----------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============================+===========+==========================================================================================================================+==============================================+ + | globalconnection_bandwidth | Yes | :ref:`UpdateGlobalConnectionBandwidth ` object | Details about a global connection bandwidth. | + +----------------------------+-----------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _updateglobalconnectionbandwidth__request_updateglobalconnectionbandwidth: + +.. table:: **Table 4** UpdateGlobalConnectionBandwidth + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================================================================================================================+ + | name | No | String | Instance name. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Resource description. Angle brackets (<>) are not allowed. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | No | Integer | The capacity of a global connection bandwidth, in Mbit/s. | + | | | | | + | | | | Value range: 2 Mbit/s to 300 Mbit/s | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | No | String | Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. | + | | | | | + | | | | Range: | + | | | | | + | | | | - **bwd**: billing by bandwidth | + | | | | | + | | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | | + | | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sla_level | No | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | | + | | | | - **Pt**: Platinum | + | | | | | + | | | | - **Au**: Gold | + | | | | | + | | | | - **Ag**: Silver | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | No | String | Instance type. | + | | | | | + | | | | - **CC**: cloud connection (not supported) | + | | | | | + | | | | - **GEIP**: global EIP (not supported) | + | | | | | + | | | | - **GCN**: central network | + | | | | | + | | | | - **GSN**: site network (not supported) | + | | | | | + | | | | - **ALL**: all instance types | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code_id | No | String | UUID of a line specification code. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +----------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Type | Description | + +============================+===============================================================================================================+==============================================+ + | request_id | String | Request ID. | + +----------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | globalconnection_bandwidth | :ref:`GlobalConnectionBandwidth ` object | Details about a global connection bandwidth. | + +----------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + +.. _updateglobalconnectionbandwidth__response_globalconnectionbandwidth: + +.. table:: **Table 6** GlobalConnectionBandwidth + + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+=============================================================================================================================================================+=====================================================================================================================================================================+ + | id | String | Instance ID. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Resource description. Angle brackets (<>) are not allowed. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the account that the instance belongs to. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bordercross | Boolean | Cross-border attribute of a global connection bandwidth. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Type of a global connection bandwidth. | + | | | | + | | | - **TrsArea**: cross-geographic-region bandwidth (not supported) | + | | | | + | | | - **Area**: geographic-region bandwidth | + | | | | + | | | - **SubArea**: region bandwidth (not supported) | + | | | | + | | | - **Region**: multi-city bandwidth (not supported) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding_service | String | Instance type. | + | | | | + | | | - **CC**: cloud connection (not supported) | + | | | | + | | | - **GEIP**: global EIP (not supported) | + | | | | + | | | - **GCN**: central network | + | | | | + | | | - **GSN**: site network (not supported) | + | | | | + | | | - **ALL**: all instance types | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project that the resource belongs to. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. | + | | | | + | | | Range: | + | | | | + | | | - **bwd**: billing by bandwidth | + | | | | + | | | - **95**: standard 95th percentile bandwidth billing (not supported) | + | | | | + | | | - **95avr**: average daily 95th percentile bandwidth billing (not supported) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | The capacity of a global connection bandwidth, in Mbit/s. | + | | | | + | | | Value range: 2 Mbit/s to 300 Mbit/s | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: Platinum | + | | | | + | | | - **Au**: Gold | + | | | | + | | | - **Ag**: Silver | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_area | String | Name of the local access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_area | String | Name of the remote access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | local_site_code | String | Code of the local access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_site_code | String | Code of s remote access point. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | String | Global connection bandwidth status. | + | | | | + | | | - **NORMAL**: The bandwidth is normal. | + | | | | + | | | - **FREEZED**: The bandwidth is frozen. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | frozen | Boolean | Whether a global connection bandwidth is frozen. | + | | | | + | | | - **true**: The bandwidth is frozen. | + | | | | + | | | - **false**: The bandwidth is not frozen. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code_id | String | UUID of a line specification code. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the resource was created. The UTC time is in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the resource was updated. The UTC time must be in the *yyyy-MM-ddTHH:mm:ss* format. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | directional_connections | Array of :ref:`DirectionalConnection ` objects | Directional connections. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_share | Boolean | Whether a global connection bandwidth can be used by multiple instances. | + | | | | + | | | Range: | + | | | | + | | | - **true**: The bandwidth can be used by multiple instances. | + | | | | + | | | - **false**: The bandwidth cannot be used by multiple instances. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`GlobalConnectionBandwidthAssociatedInstance ` objects | The list of instances that the global connection bandwidth is bound to. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eps_id | String | ID of the enterprise project that the instance belongs to. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | Billing information. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Range of a global connection bandwidth, in Mbit/s. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_sla_level | String | Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. | + | | | | + | | | - **Pt**: platinum | + | | | | + | | | - **Au**: gold | + | | | | + | | | - **Ag**: silver | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Bound instance ID. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_type | Integer | Bound instance type. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_region_id | String | Region of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_project_id | Integer | Project ID of the bound instance. | + | | | | + | | | This parameter has been discarded. Please do not use it. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _updateglobalconnectionbandwidth__response_directionalconnection: + +.. table:: **Table 7** DirectionalConnection + + ================ ====== =============================== + Parameter Type Description + ================ ====== =============================== + name String Instance name. + id String Instance ID. + local_site_code String Code of the local access point. + remote_site_code String Code of s remote access point. + ================ ====== =============================== + +.. _updateglobalconnectionbandwidth__response_globalconnectionbandwidthassociatedinstance: + +.. table:: **Table 8** GlobalConnectionBandwidthAssociatedInstance + + +------------+--------+------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+========+====================================================================================+ + | id | String | Bound instance ID. | + +------------+--------+------------------------------------------------------------------------------------+ + | type | String | Bound instance type. | + +------------+--------+------------------------------------------------------------------------------------+ + | region_id | String | Region of the bound instance. The default value is **global** for global services. | + +------------+--------+------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the bound instance. | + +------------+--------+------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Updating a global connection bandwidth + +.. code-block:: text + + PUT https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id} + + { + "globalconnection_bandwidth" : { + "name" : "test", + "description" : "Description", + "size" : 5 + } + } + +Example Responses +----------------- + +**Status code: 200** + +The global connection bandwidth has been updated. + +.. code-block:: + + { + "request_id" : "1b90e4762e3090961a30ca3a712dc0ed", + "globalconnection_bandwidth" : { + "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", + "name" : "name", + "description" : "description", + "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76", + "bordercross" : false, + "type" : "Region", + "binding_service" : "CC", + "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0", + "charge_mode" : "bwd", + "size" : 100, + "sla_level" : "Au", + "local_site_code" : "site-def", + "remote_site_code" : "site-abc", + "frozen" : "false,", + "spec_code_id" : "", + "tags" : [ ], + "created_at" : "2024-01-24T08:26:41.914Z", + "updated_at" : "2024-01-24T08:26:41.914Z", + "enable_share" : false, + "instances" : [ ] + } + } + +Status Codes +------------ + +=========== ================================================= +Status Code Description +=========== ================================================= +200 The global connection bandwidth has been updated. +=========== ================================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/index.rst b/api-ref/source/api/index.rst new file mode 100644 index 0000000..f5a3329 --- /dev/null +++ b/api-ref/source/api/index.rst @@ -0,0 +1,24 @@ +:original_name: cc_01_0014.html + +.. _cc_01_0014: + +API +=== + +- :ref:`Central Networks ` +- :ref:`Central Network Connections ` +- :ref:`Central Network Policies ` +- :ref:`Central Network Quotas ` +- :ref:`Central Network Capabilities ` +- :ref:`Global Connection Bandwidths ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + central_networks/index + central_network_connections/index + central_network_policies/index + central_network_quotas/index + central_network_capabilities/index + global_connection_bandwidths/index diff --git a/api-ref/source/api_usage_guidelines.rst b/api-ref/source/api_usage_guidelines.rst new file mode 100644 index 0000000..7c6039c --- /dev/null +++ b/api-ref/source/api_usage_guidelines.rst @@ -0,0 +1,12 @@ +:original_name: cc_01_0013.html + +.. _cc_01_0013: + +API Usage Guidelines +==================== + +Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://*Endpoint/uri*. In the URL, *uri* indicates the resource path, that is, the API access path. + +Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by **Application/json**. + +For details about how to use APIs, see `API Usage Guidelines `__. diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst new file mode 100644 index 0000000..2a02e87 --- /dev/null +++ b/api-ref/source/appendix/error_codes.rst @@ -0,0 +1,100 @@ +:original_name: ErrorCode.html + +.. _ErrorCode: + +Error Codes +=========== + ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| Status Code | Error Code | Error Message | Description | Handling Measure | ++=============+============+===============================================================================================================+===============================================================================================================+==============================================================================================+ +| 400 | CC.1001 | The parameter is invalid. | Invalid parameter. | Enter a valid parameter. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1006 | Tenants are restricted and cannot operate APIs such as adding or modifying resources. | Your account is restricted. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1007 | Internal Server Error. | An exception occurred when you are calling the API. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1031 | The cloud connection name already in use. | This cloud connection name already exists. | Change the name. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1032 | The cloud connection cannot be deleted because it has network instances. | This cloud connection has instances and cannot be deleted. | Remove the network instances from the cloud connection and then delete the cloud connection. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1033 | The cloud connection quota is insufficient. | Insufficient resource quotas. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1041 | Internal Server Error. | Unknown internal error. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1042 | The cloud connection instance is frozen. | The cloud connection is frozen. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1043 | ER type cloud connection is not supported. | Cloud connections cannot be used by enterprise routers. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1050 | Please wait for approval. | The cross-border permit is rejected or has not been approved. | Check the status of the cross-border permit. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1051 | No application for cross-border. | No application for the cross-border permit has been submitted. | Submit an application. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1052 | The bandwidth package used in regionBandwidth cannot be deleted. | The bandwidth package is in use. | Delete the inter-region bandwidths and then delete the bandwidth package. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1053 | The bandwidth package name is already in use. | The bandwidth package name already exists. | Change the name. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1054 | The bandwidth package is frozen. | The bandwidth package is frozen. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1055 | The bandwidth package has been bound. | The bandwidth package has been bound to a cloud connection. | Check the bandwidth package. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1056 | Used RegionBandwidth is bigger than new BwpSize. | The bandwidth size cannot be smaller than the used bandwidth. | Check the used bandwidth in the bandwidth package. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1057 | The account does not have the permission to operation. | The IP address is not whitelisted. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1061 | Failed to delete the bandwidth package persistence. | Incorrect value returned for deleting the bandwidth package. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1062 | Failed to update the bandwidth package persistence. | Incorrect value returned for updating the bandwidth package. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1070 | Same-direction instance is existed in cloud connection. | Bandwidth has been assigned for communications between regions. | Check the bandwidth assigned for the network instances in the regions. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1071 | Region Bandwidth Size is greater than bandwidth package size. | The inter-region bandwidth is greater than the bandwidth of the bandwidth package. | Decrease the inter-domain bandwidth or increase the bandwidth in the bandwidth package. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1072 | ER type cloud connection does not support 95-billed bandwidth packages. | 95th percentile bandwidth packages for cloud connections used by enterprise routers. | Bind a bandwidth package of another type. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1081 | Internal Server Error. | Unknown internal error. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1090 | The instance has been used. | The network instance has been loaded to a cloud connection. | Load other network instances. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1091 | The CIDR of a network instance under the same cloud connection is unique. | The CIDR block of network instances loaded to the same cloud connection must be unique. | Use different CIDR blocks. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1092 | The instance is not authorized. | The other user has not authorized this network instance for your use. | Check the network instance. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1093 | The network instance routing conflict. | The route has been used by other resources, such as a VPC peering connection or a VPN. | Check for route conflicts. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1094 | The ER instance status is not available. | The enterprise router status is abnormal. | Check the enterprise router status. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1095 | The ER attachment status not available. | The same attachment is created when the enterprise router is loaded. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1096 | The ER attachment quota is insufficient. | Insufficient attachment quota for loading the enterprise router to the cloud connection. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1110 | Cross account authorization does not support cloud connection instances of this account. | Cross-account authorization is not allowed for cloud connections in the current account. | Check the cloud connections. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1111 | The network instance has been authorized. | The network instance has been authorized. | Check the authorized network instance. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1171 | Related bandwidth package is not available. | The bandwidth package is unavailable. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1250 | If an enterprise project has been enabled you need to specify the enterprise project when creating resources. | The enterprise project must be specified. | Specify an enterprise project when creating a resource. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1269 | To create a resource in an enterprise project,you need to apply it first. | The enterprise project must be specified. | Do not specify an enterprise project when creating a resource. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1290 | The cloud connection quota is insufficient. | Insufficient cloud connection quota. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1291 | No quotas for instance for this region. | The quota of network instances that can be loaded to the cloud connection in a single region is insufficient. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1292 | No quotas for region for this cloudconnect. | The quota of regions where network instances can be loaded to the cloud connection is insufficient. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 400 | CC.1293 | No quotas for route for this cloudconnect. | The quota of routes that can be configured for the cloud connection is insufficient. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 401 | CC.1003 | The parameter of domainId is illegal. | Invalid account. | Ensure that the tenant ID is valid. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 403 | CC.1004 | You do not have permission to operate. | Access denied. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 404 | CC.1002 | The resource could not be found. | The resource was not found. | Enter correct resource information. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 409 | CC.1005 | The resource already exists. | The resource already exists. | Do not create the resource repeatedly. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 500 | CC.1000 | Internal Server Error. | Unknown internal error. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| 500 | CC.1251 | Internal Server Error. | Unknown internal error. | Contact customer service. | ++-------------+------------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/index.rst b/api-ref/source/appendix/index.rst new file mode 100644 index 0000000..29dd125 --- /dev/null +++ b/api-ref/source/appendix/index.rst @@ -0,0 +1,18 @@ +:original_name: cc_01_0024.html + +.. _cc_01_0024: + +Appendix +======== + +- :ref:`Status Codes ` +- :ref:`Error Codes ` +- :ref:`Obtaining a Project ID ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + status_codes + error_codes + obtaining_a_project_id diff --git a/api-ref/source/appendix/obtaining_a_project_id.rst b/api-ref/source/appendix/obtaining_a_project_id.rst new file mode 100644 index 0000000..98b7550 --- /dev/null +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -0,0 +1,72 @@ +:original_name: cc_01_0027.html + +.. _cc_01_0027: + +Obtaining a Project ID +====================== + +Scenarios +--------- + +A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available: + +- :ref:`Obtain the Project ID by Calling an API ` +- :ref:`Obtain the Project ID from the Console ` + +.. _cc_01_0027__en-us_topic_0121673684_section86806471133: + +Obtain the Project ID by Calling an API +--------------------------------------- + +You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria. + +The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from `Regions and Endpoints `__. + +The following is an example response. The value of **id** is the project ID. + +.. code-block:: + + { + "projects": [ + { + "domain_id": "65ewtrgaggshhk1223245sghjlse684b", + "is_domain": false, + "parent_id": "65ewtrgaggshhk1223245sghjlse684b", + "name": "project_name", + "description": "", + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg" + }, + "id": "a4adasfjljaaaakla12334jklga9sasfg", + "enabled": true + } + ], + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects" + } + } + +.. _cc_01_0027__en-us_topic_0121673684_section32975495318: + +Obtain a Project ID from the Console +------------------------------------ + +A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID: + +#. Log in to the management console. + +#. Click the username and select **My Credentials** from the drop-down list. + + On the **My Credentials** page, view project IDs in the project list. + + + .. figure:: /_static/images/en-us_image_0000001508295281.png + :alt: **Figure 1** Viewing project IDs + + **Figure 1** Viewing project IDs + + In multi-project scenarios, expand the region, and obtain your sub-project ID from the **Project ID** column. diff --git a/api-ref/source/appendix/status_codes.rst b/api-ref/source/appendix/status_codes.rst new file mode 100644 index 0000000..d09a489 --- /dev/null +++ b/api-ref/source/appendix/status_codes.rst @@ -0,0 +1,56 @@ +:original_name: cc_01_0025.html + +.. _cc_01_0025: + +Status Codes +============ + +- Normal + + .. table:: **Table 1** Status codes for successful requests + + +-------------+----------------+-------------------------------------------------------+ + | Status Code | Returned Value | Description | + +=============+================+=======================================================+ + | 200 | OK | Normal response for the POST, GET, and PUT operations | + +-------------+----------------+-------------------------------------------------------+ + | 201 | Created | Normal response code for POST operations | + +-------------+----------------+-------------------------------------------------------+ + | 204 | No Content | Normal response code for DELETE operations | + +-------------+----------------+-------------------------------------------------------+ + +- Abnormal + + .. table:: **Table 2** Status codes for failed requests + + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | Status Code | Returned Value | Description | + +=============+===============================+============================================================================================+ + | 400 | Bad Request | The server failed to process the request. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 401 | Unauthorized | You must enter a username and password to access the requested page. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 403 | Forbidden | You are forbidden to access the requested page. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 404 | Not Found | The server could not find the requested page. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 405 | Method Not Allowed | You are not allowed to use the method specified in the request. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 406 | Not Acceptable | The response generated by the server could not be accepted by the client. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 407 | Proxy Authentication Required | You must use the proxy server for authentication so that the request can be processed. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 408 | Request Timeout | The request timed out. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 409 | Conflict | The request could not be processed due to a conflict. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 500 | Internal Server Error | Failed to complete the request because of an internal service error. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 501 | Not Implemented | Failed to complete the request because the server does not support the requested function. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 502 | Bad Gateway | Failed to complete the request because the server has received an invalid response. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 503 | Service Unavailable | Failed to complete the request because the service is unavailable. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ + | 504 | Gateway Timeout | A gateway timeout error occurred. | + +-------------+-------------------------------+--------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst new file mode 100644 index 0000000..07ab980 --- /dev/null +++ b/api-ref/source/change_history.rst @@ -0,0 +1,20 @@ +:original_name: cc_01_0029.html + +.. _cc_01_0029: + +Change History +============== + ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+=========================================================================================================================================+ +| 2025-01-29 | This release incorporates the following changes: | +| | | +| | Deleted sections "Binding a Global Connection Bandwidth to an Instance" and "Unbinding a Global Connection Bandwidth from an Instance." | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| 2025-01-22 | This release incorporates the following changes: | +| | | +| | Resolved the issue that there were two titles for querying the details about a global connection bandwidth. | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| 2024-11-26 | This issue is the first official release. | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py old mode 100755 new mode 100644 diff --git a/api-ref/source/docutils.conf b/api-ref/source/docutils.conf new file mode 100644 index 0000000..7cbe4c1 --- /dev/null +++ b/api-ref/source/docutils.conf @@ -0,0 +1,2 @@ +[html writers] +table-style: table, caption-top \ No newline at end of file diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index e12e193..c79504e 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,3 +1,12 @@ -============================================= -Welcome to the documentation of cloud-connect -============================================= +============================= +Cloud Connect - API Reference +============================= + +.. toctree:: + :maxdepth: 1 + + api_usage_guidelines + api/index + permissions_and_supported_actions/index + appendix/index + change_history diff --git a/api-ref/source/permissions_and_supported_actions/actions_supported_by_policy-based_authorization.rst b/api-ref/source/permissions_and_supported_actions/actions_supported_by_policy-based_authorization.rst new file mode 100644 index 0000000..b75353f --- /dev/null +++ b/api-ref/source/permissions_and_supported_actions/actions_supported_by_policy-based_authorization.rst @@ -0,0 +1,82 @@ +:original_name: cc_02_0003.html + +.. _cc_02_0003: + +Actions Supported by Policy-based Authorization +=============================================== + +This topic describes the actions supported by Cloud Connect in policy-based authorization. + +Supported Actions +----------------- + +Cloud Connect provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies: + +- Permissions: allow or deny operations on specified resources under specific conditions. +- APIs: REST APIs that can be called by a user who has been granted specific permissions. +- Actions: specific operations that are allowed or denied. +- Related actions: actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions. +- IAM or enterprise projects: type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "Y" indicates that the action supports the project and "x" indicates that the action does not support the project. + +Cloud Connect supports the following actions in custom policies: + +- :ref:`Central Networks `: actions supported by all central network APIs, such as the APIs for creating, updating, and deleting a central network, querying central network details, and querying the central network list +- :ref:`Central Network Policies `: actions supported by all central network policy APIs, such as the APIs for adding, applying, deleting a central network policy, querying central network policy details, querying the central network policy list, and querying policy changes +- :ref:`Central Network Connections `: actions supported by all central network connection APIs, such as the APIs for querying the central network connection list and updating a central network connection + +.. _cc_02_0003__section1554071374415: + +Central Networks +---------------- + +.. table:: **Table 1** Actions supported for central networks + + +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+ + | Permission | API | Action | Related Action | IAM Project | Enterprise Project | + +===================================+==================================================================+==========================+================+=============+====================+ + | Creating a central network | POST /v3/{domain_id}/gcn/central-networks | cc:centralNetwork:create | ``-`` | Y | Y | + +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+ + | Updating a central network | PUT /v3/{domain_id}/gcn/central-networks/{central_network_id} | cc:centralNetwork:update | ``-`` | Y | Y | + +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+ + | Deleting a central network | DELETE /v3/{domain_id}/gcn/central-networks/{central_network_id} | cc:centralNetwork:delete | ``-`` | Y | Y | + +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+ + | Querying central network details | GET /v3/{domain_id}/gcn/central-networks/{central_network_id} | cc:centralNetwork:get | ``-`` | Y | Y | + +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+ + | Querying the central network list | GET /v3/{domain_id}/gcn/central-networks | cc:centralNetwork:list | ``-`` | Y | Y | + +-----------------------------------+------------------------------------------------------------------+--------------------------+----------------+-------------+--------------------+ + +.. _cc_02_0003__section1096015764615: + +Central Network Policies +------------------------ + +.. table:: **Table 2** Actions supported for central network policies + + +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+ + | Permission | API | Action | Related Action | IAM Project | Enterprise Project | + +===================================+==============================================================================================+=================================+================+=============+====================+ + | Adding a central network policy | POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies | cc:centralNetwork:createPolicy | ``-`` | Y | Y | + +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+ + | Applying a central network policy | POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/apply | cc:centralNetwork:applyPolicy | ``-`` | Y | Y | + +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+ + | Deleting a central network policy | DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id} | cc:centralNetwork:deletePolicy | ``-`` | Y | Y | + +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+ + | Querying the central network list | GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies | cc:centralNetwork:listPolicies | ``-`` | Y | Y | + +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+ + | Querying policy changes | GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/change-set | cc:centralNetwork:listChangeSet | ``-`` | Y | Y | + +-----------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+----------------+-------------+--------------------+ + +.. _cc_02_0003__section13988959134617: + +Central Network Connections +--------------------------- + +.. table:: **Table 3** Actions supported for central network connections + + +----------------------------------------------+------------------------------------------------------------------------------------------+------------------------------------+----------------+-------------+--------------------+ + | Permission | API | Action | Related Action | IAM Project | Enterprise Project | + +==============================================+==========================================================================================+====================================+================+=============+====================+ + | Querying the central network connection list | GET /v3/{domain_id}/gcn/central-network/{central_network_id}/connections | cc:centralNetwork:listConnections | ``-`` | Y | Y | + +----------------------------------------------+------------------------------------------------------------------------------------------+------------------------------------+----------------+-------------+--------------------+ + | Updating a central network connection | PUT /v3/{domain_id}/gcn/central-network/{central_network_id}/connections/{connection_id} | cc:centralNetwork:updateConnection | ``-`` | Y | Y | + +----------------------------------------------+------------------------------------------------------------------------------------------+------------------------------------+----------------+-------------+--------------------+ diff --git a/api-ref/source/permissions_and_supported_actions/index.rst b/api-ref/source/permissions_and_supported_actions/index.rst new file mode 100644 index 0000000..6cc696e --- /dev/null +++ b/api-ref/source/permissions_and_supported_actions/index.rst @@ -0,0 +1,16 @@ +:original_name: cc_02_0001.html + +.. _cc_02_0001: + +Permissions and Supported Actions +================================= + +- :ref:`Introduction ` +- :ref:`Actions Supported by Policy-based Authorization ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + introduction + actions_supported_by_policy-based_authorization diff --git a/api-ref/source/permissions_and_supported_actions/introduction.rst b/api-ref/source/permissions_and_supported_actions/introduction.rst new file mode 100644 index 0000000..1876fb4 --- /dev/null +++ b/api-ref/source/permissions_and_supported_actions/introduction.rst @@ -0,0 +1,31 @@ +:original_name: cc_02_0002.html + +.. _cc_02_0002: + +Introduction +============ + +You can use Identity and Access Management (IAM) for fine-grained permissions management of your Cloud Connect resources. If your account does not need individual IAM users, you can skip this topic. + +With IAM, you can control access to specific cloud resources. IAM supports role/policy-based authorization and identity policy-based authorization. + +The following table describes the differences between the two authorization models. + +.. table:: **Table 1** Differences between role/policy-based and identity policy-based authorization + + +---------------------+-------------------------------------+-------------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Authorization Model | Authorization Using | Permissions | Authorization Method | Scenario | + +=====================+=====================================+=====================================+==============================================+============================================================================================================================================================================================================================================================================================================================+ + | Role/Policy | User-permission-authorization scope | - System-defined roles | Assigning roles or policies to principals | To authorize a user, you need to add it to a user group first and then specify the scope of authorization. It is hard to provide fine-grained permissions control using authorization by user groups and a limited number of condition keys. This method is suitable for small- and medium-sized enterprises. | + | | | - System-defined policies | | | + | | | - Custom policies | | | + +---------------------+-------------------------------------+-------------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Identity policy | User-policy | - System-defined identity policies | - Assigning identity policies to principals | You can authorize a user by attaching an identity policy to it. User-specific authorization and a variety of key conditions allow for more fine-grained permissions control. However, this model can be hard to set up. It requires a certain amount of expertise and is suitable for medium- and large-sized enterprises. | + | | | - Custom identity policies | - Attaching identity policies to principals | | + +---------------------+-------------------------------------+-------------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Policies and actions in the two authorization models are not interoperable. You are advised to use the identity policy-based authorization model. + +If you use IAM users in your account to call an API, the IAM users must be granted the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. + +Assume that an IAM user wants to call an API to query central networks. With role/policy-based authorization, the IAM user must be granted the permissions allowing for action **cc:centralNetwork:list**. With identity policy-based authorization, the IAM user must be granted the permissions allowing for action **cc:centralNetwork:list**.