From a539bdd6664bfc29b8699b641d022d9520e77d46 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Tue, 6 Feb 2024 09:16:27 +0000 Subject: [PATCH] Changes to vpc_api-ref from docs/doc-exports#556 (VPC API 20230106 version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit VPC Reviewed-by: Sarda, Priya Reviewed-by: Hajba, László Antal Co-authored-by: proposalbot Co-committed-by: proposalbot --- .../images/en-us_image_0000001487964866.png | Bin 0 -> 14175 bytes .../images/en-us_image_0000001538444809.png | Bin 0 -> 14175 bytes .../images/en-us_image_0000001538445357.png | Bin 0 -> 28901 bytes api-ref/source/api_v3/common_pools/index.rst | 14 + .../common_pools/querying_common_pools.rst | 160 +++ api-ref/source/api_v3/eips/binding_an_eip.rst | 491 ++++++++ api-ref/source/api_v3/eips/index.rst | 20 + .../source/api_v3/eips/querying_all_eips.rst | 849 ++++++++++++++ .../api_v3/eips/querying_eip_details.rst | 626 ++++++++++ .../source/api_v3/eips/unbinding_an_eip.rst | 428 +++++++ api-ref/source/api_v3/index.rst | 16 + .../apis/bandwidth/querying_a_bandwidth.rst | 44 +- .../apis/bandwidth/querying_bandwidths.rst | 55 +- .../apis/bandwidth/updating_a_bandwidth.rst | 38 +- .../adding_an_eip_to_a_shared_bandwidth.rst | 66 +- .../assigning_a_shared_bandwidth.rst | 37 +- .../{elastic_ip => eip}/assigning_an_eip.rst | 244 ++-- .../source/apis/{elastic_ip => eip}/index.rst | 4 +- .../{elastic_ip => eip}/querying_an_eip.rst | 39 +- .../{elastic_ip => eip}/querying_eips.rst | 40 +- api-ref/source/apis/eip/releasing_an_eip.rst | 86 ++ .../{elastic_ip => eip}/updating_an_eip.rst | 48 +- .../deleting_an_eip_tag.rst | 4 +- .../eip_tag_management/querying_eip_tags.rst | 4 +- ...erying_eip_tags_in_a_specified_project.rst | 4 +- .../apis/elastic_ip/releasing_an_eip.rst | 72 -- .../querying_floating_ip_addresses.rst | 2 +- api-ref/source/apis/index.rst | 6 +- .../assigning_a_private_ip_address.rst | 196 ++-- .../deleting_a_private_ip_address.rst | 30 +- .../querying_private_ip_address_details.rst | 130 ++- .../querying_private_ip_addresses.rst | 156 +-- ...p_address_usage_on_a_specified_network.rst | 160 ++- api-ref/source/apis/quota/querying_quotas.rst | 389 ++++--- ...associating_subnets_with_a_route_table.rst | 215 ++++ .../route_table/creating_a_route_table.rst | 258 +++++ .../route_table/deleting_a_route_table.rst | 66 ++ ...associating_subnets_from_a_route_table.rst | 219 ++++ api-ref/source/apis/route_table/index.rst | 26 + .../route_table/querying_a_route_table.rst | 201 ++++ .../route_table/querying_route_tables.rst | 169 +++ .../route_table/updating_a_route_table.rst | 379 +++++++ .../creating_a_security_group.rst | 350 +++--- .../creating_a_security_group_rule.rst | 277 ++--- .../deleting_a_security_group.rst | 28 +- .../deleting_a_security_group_rule.rst | 28 +- .../querying_security_group_details.rst | 286 +++-- .../querying_security_group_rule_details.rst | 166 ++- .../querying_security_group_rules.rst | 254 +++-- .../querying_security_groups.rst | 389 ++++--- .../source/apis/subnet/creating_a_subnet.rst | 417 +++---- .../source/apis/subnet/deleting_a_subnet.rst | 28 +- .../apis/subnet/querying_subnet_details.rst | 240 ++-- .../source/apis/subnet/querying_subnets.rst | 303 ++--- .../subnet/updating_subnet_information.rst | 200 ++-- ...batch_creating_or_deleting_subnet_tags.rst | 84 +- .../creating_a_tag_for_a_subnet.rst | 30 +- .../deleting_a_subnet_tag.rst | 18 +- .../querying_subnet_tags.rst | 22 +- ...ing_subnet_tags_in_a_specified_project.rst | 22 +- .../querying_subnets_by_tag.rst | 198 ++-- .../virtual_private_cloud/creating_a_vpc.rst | 250 ++-- .../virtual_private_cloud/deleting_a_vpc.rst | 28 +- .../querying_vpc_details.rst | 176 ++- .../virtual_private_cloud/querying_vpcs.rst | 229 ++-- .../updating_vpc_information.rst | 278 ++--- .../vpc_flow_log/creating_a_vpc_flow_log.rst | 259 +++-- .../vpc_flow_log/deleting_a_vpc_flow_log.rst | 38 +- .../vpc_flow_log/querying_a_vpc_flow_log.rst | 176 +-- .../vpc_flow_log/querying_vpc_flow_logs.rst | 206 ++-- .../vpc_flow_log/updating_a_vpc_flow_log.rst | 219 ++-- .../accepting_a_vpc_peering_connection.rst | 138 +-- .../creating_a_vpc_peering_connection.rst | 234 ++-- .../deleting_a_vpc_peering_connection.rst | 28 +- .../querying_a_vpc_peering_connection.rst | 160 ++- .../querying_vpc_peering_connections.rst | 200 ++-- .../refusing_a_vpc_peering_connection.rst | 138 +-- .../updating_a_vpc_peering_connection.rst | 203 ++-- .../apis/vpc_route/creating_a_vpc_route.rst | 146 +-- .../apis/vpc_route/deleting_a_vpc_route.rst | 28 +- .../apis/vpc_route/querying_a_vpc_route.rst | 98 +- .../apis/vpc_route/querying_vpc_routes.rst | 138 ++- .../batch_creating_or_deleting_vpc_tags.rst | 84 +- .../creating_a_tag_for_a_vpc.rst | 98 +- .../vpc_tag_management/deleting_a_vpc_tag.rst | 28 +- .../vpc_tag_management/querying_vpc_tags.rst | 120 +- ...erying_vpc_tags_in_a_specified_project.rst | 22 +- .../querying_vpcs_by_tag.rst | 208 ++-- api-ref/source/appendix/error_codes.rst | 668 +++++------ .../appendix/vpc_monitoring_metrics.rst | 38 +- api-ref/source/change_history.rst | 577 +++++----- api-ref/source/faqs/index.rst | 14 + ...ong_firewall_groups_policies_and_rules.rst | 164 +++ api-ref/source/index.rst | 2 + .../api_version_information/pagination.rst | 48 +- .../querying_a_specified_api_version.rst | 158 ++- .../querying_api_versions.rst | 20 +- .../firewall/creating_a_firewall_group.rst | 174 +-- .../firewall/creating_a_firewall_policy.rst | 49 +- .../firewall/creating_a_firewall_rule.rst | 49 +- .../firewall/deleting_a_firewall_group.rst | 27 +- .../firewall/deleting_a_firewall_policy.rst | 27 +- .../firewall/deleting_a_firewall_rule.rst | 27 +- .../firewall/inserting_a_firewall_rule.rst | 41 +- .../firewall/querying_a_firewall_group.rst | 93 +- .../firewall/querying_a_firewall_policy.rst | 27 +- .../firewall/querying_a_firewall_rule.rst | 53 +- .../firewall/querying_firewall_groups.rst | 118 +- .../firewall/querying_firewall_policies.rst | 52 +- .../firewall/querying_firewall_rules.rst | 100 +- .../firewall/removing_a_firewall_rule.rst | 37 +- .../firewall/updating_a_firewall_group.rst | 165 +-- .../firewall/updating_a_firewall_policy.rst | 45 +- .../firewall/updating_a_firewall_rule.rst | 41 +- .../assigning_a_floating_ip_address.rst | 33 +- .../deleting_a_floating_ip_address.rst | 23 +- .../querying_a_floating_ip_address.rst | 115 +- .../querying_floating_ip_addresses.rst | 164 +-- .../updating_a_floating_ip_address.rst | 108 +- .../network/creating_a_network.rst | 191 ++-- .../network/deleting_a_network.rst | 27 +- .../network/querying_network_details.rst | 130 ++- .../network/querying_networks.rst | 150 +-- .../network/updating_a_network.rst | 146 +-- .../port/creating_a_port.rst | 373 +++--- .../port/deleting_a_port.rst | 27 +- .../port/querying_a_port.rst | 239 ++-- .../port/querying_ports.rst | 1007 +++++++++-------- .../port/updating_a_port.rst | 347 +++--- .../adding_an_interface_to_a_router.rst | 33 +- .../router/creating_a_router.rst | 42 +- .../router/deleting_a_router.rst | 27 +- .../router/querying_a_router.rst | 27 +- .../router/querying_routers.rst | 49 +- .../removing_an_interface_from_a_router.rst | 33 +- .../router/updating_a_router.rst | 40 +- .../creating_a_security_group.rst | 45 +- .../creating_a_security_group_rule.rst | 58 +- .../deleting_a_security_group.rst | 27 +- .../deleting_a_security_group_rule.rst | 27 +- .../querying_a_security_group.rst | 33 +- .../querying_a_security_group_rule.rst | 32 +- .../querying_security_group_rules.rst | 60 +- .../querying_security_groups.rst | 51 +- .../updating_a_security_group.rst | 43 +- .../subnet/creating_a_subnet.rst | 339 +++--- .../subnet/deleting_a_subnet.rst | 27 +- .../subnet/querying_a_subnet.rst | 157 +-- .../subnet/querying_subnets.rst | 199 ++-- .../subnet/updating_a_subnet.rst | 283 +++-- .../subnet_pool/creating_a_subnet_pool.rst | 7 +- .../subnet_pool/querying_a_subnet_pool.rst | 5 +- .../subnet_pool/querying_subnet_pools.rst | 24 +- .../subnet_pool/updating_a_subnet_pool.rst | 7 +- .../{elastic_ip.rst => eip.rst} | 4 +- .../eip_v3.rst | 30 + .../firewall_openstack_neutron_api.rst | 2 +- .../index.rst | 16 +- .../introduction.rst | 24 + .../route_table.rst | 2 +- .../security_group.rst | 20 +- .../security_group_rule.rst | 20 + .../subnet_tags.rst | 24 + .../vpc_flow_log.rst | 20 + .../vpc_tags.rst | 24 + 165 files changed, 13183 insertions(+), 7833 deletions(-) create mode 100644 api-ref/source/_static/images/en-us_image_0000001487964866.png create mode 100644 api-ref/source/_static/images/en-us_image_0000001538444809.png create mode 100644 api-ref/source/_static/images/en-us_image_0000001538445357.png create mode 100644 api-ref/source/api_v3/common_pools/index.rst create mode 100644 api-ref/source/api_v3/common_pools/querying_common_pools.rst create mode 100644 api-ref/source/api_v3/eips/binding_an_eip.rst create mode 100644 api-ref/source/api_v3/eips/index.rst create mode 100644 api-ref/source/api_v3/eips/querying_all_eips.rst create mode 100644 api-ref/source/api_v3/eips/querying_eip_details.rst create mode 100644 api-ref/source/api_v3/eips/unbinding_an_eip.rst create mode 100644 api-ref/source/api_v3/index.rst rename api-ref/source/apis/{elastic_ip => eip}/assigning_an_eip.rst (55%) rename api-ref/source/apis/{elastic_ip => eip}/index.rst (94%) rename api-ref/source/apis/{elastic_ip => eip}/querying_an_eip.rst (77%) rename api-ref/source/apis/{elastic_ip => eip}/querying_eips.rst (84%) create mode 100644 api-ref/source/apis/eip/releasing_an_eip.rst rename api-ref/source/apis/{elastic_ip => eip}/updating_an_eip.rst (76%) delete mode 100644 api-ref/source/apis/elastic_ip/releasing_an_eip.rst create mode 100644 api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/creating_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/deleting_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/index.rst create mode 100644 api-ref/source/apis/route_table/querying_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/querying_route_tables.rst create mode 100644 api-ref/source/apis/route_table/updating_a_route_table.rst create mode 100644 api-ref/source/faqs/index.rst create mode 100644 api-ref/source/faqs/what_are_the_relationships_among_firewall_groups_policies_and_rules.rst rename api-ref/source/permissions_policies_and_supported_actions/{elastic_ip.rst => eip.rst} (98%) create mode 100644 api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/introduction.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/vpc_flow_log.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst diff --git a/api-ref/source/_static/images/en-us_image_0000001487964866.png b/api-ref/source/_static/images/en-us_image_0000001487964866.png new file mode 100644 index 0000000000000000000000000000000000000000..9030b9ee1b751127efea3a451733ec077f82d8be GIT binary patch literal 14175 zcmcJ0XH-*Nw=OEhhNuWg5mb6ds&wfcqy(g+K!8B#MM^+KMM~hM1f)xc(0eb+D@YA3 zv=9*Kgdze7J$K`K&KY-nW1R7wd&j+hve#Z&S#8fX_ngo3B;vWQ8s&9{>m(#3lp5;F z1|%d`a)ENsRdV2S6Zd|QgybQKhO&au>+~&bh>;PYjd+qgU$8n?FgZo~@}pUPU-r63 zbdKa8yCJW@y)>`JIY_crFOu!CI5mjA8;@pO~L1s~WkpCzjl zB$uTJ%!-8M@8J;K&cy^tNVa83FXl_~<`e6EvWvpsOkcPzt`AqPs$RM%JW&(6SRKhn z$+!9!*JlHFqAy<*Ud7nlySU!=s=B7?b`EN$PZ0a_3-ZwWq`6tR0lf)a&%pz~+Qg(A z$$`bP7j561PxO3QTb0_I=s+Ix`kS3^HMU!V8l-CdQna{rlMT{K>LxL$!6v%b*gn7J z#17&Rv+~978c${?{i4n-9Pp%=5&8k8)aG+ihnQqf-zSriV$qjTZ9$sw7~l7>^~%6z8_Za~ADVm{;Fdwmtp@G4;yb{_ zj$aNh-TA0FI>Snq%0Ztp0@XUes>J(FBJ~YUj%aOjR%q)^sjkD`}~O<*3WwSi8D{%x+y zt42;{yO+fLZxz`=5G!ey98S|OBeW4bp7jvhX#)_K4m+;qUd62~OKYSD;sEk{yd)sb zyR=BOD5&YDMSS0&$4r}%TeR$F4wUaQQsF(W?4i_*udm}ybw2Ww+2;VS=18W#d|<=h z1cE9ka-rc?lim26&=*fVI!SXD@^n#2<2m38?_Gl^=5zAm8S9+d)+91)uwo!7~df&hAmCQ6>5+8 zpNW|%9O$~W95!y^dG$7#5j>jt!T zj4vTGDW%}G#;#tTb1H*3-XKx>!g@O`^C!bb-l=gqEwM0odwzCkRpoF>WiZ-nH>dE^ z8jHMAXKSFTncA_4&&W`sW)wkiTdgwSH54F-X;H zcRNTH(*lb?5dMD;IO6lQ_@y}3UyQiqYESZ|$pvO6GhUb`A!jZmG|o0DGBY{Sdit?! zhoXQQp=SSvTB>lN=6kU^;p$+gQKRC@A|s&7%#R|+N-Ll88x3!GKQxR-3`V_b`Psv! zfs70|F7kmS-%(Funsx!phSlu|f?j5@)wGJk%#(hWl|u8M=+&moV8n%cxe^5AKL3_H zI|JJT!;_qqxmnpPeag>SHT3?~L$vH@pW$>~BQutC4vXQ|=)JX9bC0Voqjh!-w_a>A zR?jEv&i6OMq*l4{_AhtlBS`aW+G2-+9USscS1y- z|7NVWq(u66C}mhh+u>HttkXHr2nhE4R*1W!9f#};Xxv>bP{c)gYv2d*g-)0x7SjHT z0+?81_yLv>Ed_S!if!j0bljSKBRY3epzJ(bmBY}$GyZ4S;E(U4S}QjK4AN_S#3i+} zMjq;x9k`fmZ|AEzL39zGytulFpeF_!gd3tdpwu02?&YFHM)0+!lu@ageP7@l5L>gi zcqFW25`U(beQkCDx%C^g=5=Q!ZhSJ$bZ#41d!dhDcwidf8wV0^F>)v@(C`}$uQ~DU zcABf->MP?#^rsK?^<7v_BjM)mQBb>_WfK<{4+h=V{uwePCJv%&RJXS=t z)pgk+@mNa-L#Rk9;qvs~eDFleW9tjQ8ioQM3Vhm2q!S7`ej*!O| z&&5ajF4O*ny#h3N!@O}a;3!CcJLMmrTd{UB@W(BaJo;C++@vt(@W&6k6CR5EJ5T-p zz}f$Q=wcQ&qWe04;87;;#Q5WW0TdUH7^Z+LnwWuVvXwiudB;DbL|}EXzD3F?F`0r% z>vXY)G3b;AFIW46UPgIlv{lBmJjZ0;m2D_Qi`(Ty^6ZJq zZLr^89sky}BG>NuTu_b}+J2y!EgVh=@Cq#L_i9WYN(sdWjuN76twv_Yyz<@l9f^TJ zpY0WM_^ORy%Zc_X%D%PUgQY|sPhU;hr^JAqt>+P$Cv3RPruIuD+phX#xrKf#lL3Kmr92uA~G|~DvOnK$<^IO-KVZZetq_AVY--1k~iR9 zG$kZmM0VAqM3EYi5~PU^H_HvEL?_<`({5y>oXwCL{&+brEyzJmX!(? zvZivjk+;9}Q(r-elh1RlmnGn!WL}+`xsI$fYGA!}(2OveCF+A^lU;8t%8+l(iHjmi zptqU}=C#1!gAjBm(B4a9lrFKsH9ph(#ojq+Ix7F5#r1xF+R|_fai6X%us7YBKtc93 zL%1Q~GE}ndq%m0R)u*Ae&D7uu!L_V*4@3DAYZoXQbat8_Yb3Gk9N;veB#R9{!}Te& z9iH|aPbgOKly1H#OxufHo~u+8TS+({e#ri`hBlphJ<soB?y(2Yc8g2ZB&J#9Sc}*5c!6Ji8c>x;`S{nS=`fz6PEXVHzGb)nLr3XaEtwllB1RqD|0!&ld{! zErxo|ebmfcSH*q2Ot#I-tt&aY&&3ir2es~p3s&jgqopkZgJ zOoL+5UytafhBD0D=h7W+TXz9rR}O0JjA8w+;B8l9^Wk6meSy%(-^_4dkVM@W|Cx1# z&PYpzbL_4brsww4_-UnWfzFM80~k*j4ehKvGP7RPbk3CZN5 zRGkS)huO6TzS^P5o^j8-y0rX*Y5`P=G1{fF4mB$w$Q^x;n+5RohkR{P;4~Ldvjo(li0qyd9!)q{;JL=XPvbpP)eb8$|Q|L z=A8e_oI9=4S4KYcoIOYux7#1hI&d==X zc}K-sqV@z|g0roxKRL>f_u<@!Uao;@; z7GD%+o0rtzz{tkVLzwRL7)+Pem-=ljWxG9=_&(~2#LAEijs3f(&>c%HA$Md*C zz%p*>ND%Fqvw|6#T)yGP+D~2M#i5@f=t^&tQdF~iE1o(@29yfTb)rNj8fZUm{{Bc z{D^h0LEoL+aqQvxbQo>a8508$W%@`VB+uDb57i;G#UeT>L_(4i96G|a+$OH+A8)D{ zs3Sk`VX{O{k(@`9xQ}27{q=2EV=xX!mrsMjK{9A&WSSu zf%!{4_uLqhepTk;QeFiN-4FHuR&bYpD)-kJh(eS#m-+P@Hh7k>{>;9$)ZV@_JULNF zL@OoGH}ypHwY;yG!0b+o$6OE}u`8iT_UepMpB|0C!?sZ*Z5?vuhz5C;9#Q>E9I*SE z+HB9HUAG#G`kz4c+DMh|IM+!*D*a?sS$y*>88#y%yYa&%67q(k`2yUk`h-@6hOvA< zGR#CQJFDOPib4?$llAxzOF&Dy!`H->scbj#u<>4Z`_2gu8c8A9L`i)V4ZYRy0yz&q_^0xa~BC0F8=Qit2 zOoSiTF3Y%v5PuBYaQ=GCD$)XOdx!&O`inpbmnol|dOJKoSML}$wlUABu|z=y4d1Th zpQsW?@isUZYgfm}`X5dGXag2-TPJ1PEx2&!?3Z8YIU<guZirPGgp|H8$XeYV@iA1~2g zGB?Uc4#|WNzZHBid~}ve@i>=F>Xo@HaG>Y1OKCi1qHFQJcI&=(S zT=x#F)wQu6;6jeQ@KTO%N7NqldCd+VCo2MJ2haE^=c6EL+r71YRB6LpcXw02 z$zX^j8f9HQH;h35c0a1Kbvg}iX;C(bPsMtgOT=ep0PorZ6JgEP%Yv~_=7(pP)@*6y zA3s@BJsAj@>RV}!yRgBG32aw=8mu+dMQ~ZjRp`oD#mucH>Ev3CYE7Or{ATsR5d<{& zfd>59Qyr?ra%B`-U4<0D6|?)Q+rzdq;htna`lzpYV_Is3jTpSyZxzc zM~I07L3iCmEpLE3L!=Qe2hX@HTr}2sN;Fq2?IIF zvwQZlX;lXU++y^xxi@<|6z~S<55}{XMIc^fFuF4RZTaN&%j` zAavV)TsxsAcEBe@$A3GvcJEMSS(ZU^I9+Htcs+0b^|%`;bDnUuC}jRR|CC+O01#A{ zQN75vGKt9SH+`wgbPA%paP$q?%HLKF2k3q$`m@!BSh1-lZG2lbaSUZ+ci@&-G%9Sj z#AtE-~04~xyzTh1N1%BYgwZDDuUWZgYBJ%8cq?&sai!bdLReL zf;)MtHP$_JD0~tD>v&=PU~#@M`|SG8Qo4rGN|b-|CtG~)xbm`qwvnL{3a?%01wK^X zdqHs=K+CUfQ6J2VAc}ihqdT0AJ9=bYw$(BW3xeA^l<61WE`}Z;24QzmG>~sbCD7J65 z))2KEWRvbUQFY6-JPx$Aek7{jgm}+Tm#uum(3i*`Qv(GIwiZJ!GWucCu-#4UJF8n$!z97BNr1I0axtnh6L%#aJF zN?iK`Z;*`dHLTB34pbB#ow0?_wPCcpF8~M|lIDi~KP8g0pP2$|mjDKzkpH8-0cG}Nf zFOqIxMoL-#9me^uz5dT(((U%S7r^3i@Na*H+`c1wQx*1joAlytwwNny_2N7=FK^T(Dg}^SQTqsK^8M*%jeo@9AFO(f{r~;%iSMgz6{U+B(t!q zs-dA@nLoBC7VZ+XuF=aI>=Jj`#kM?f+93^8z!^zZW6Ti9_dYf)Yn#JZg2V9wUQUY< zLb(8XB;A1A6`#59>)-j%+d4$za}5>fY$LE)Xa!>?LbyX5uFnMp;Ks&3zwESR)qcpM z5rW?w@6HM?f0sfm$~%WXBC&Zcw3B<9rM4!`TO;~KzFgl!&))e%Zi~IL2o}rTP;KSR zN$}%+6WG-`7@g@hzJLk7PImLLC23BHc*f}b;DF)!*N9_JV*Onbp&#_2Yjql4b>QW@ zWu{HadV0;})~y>8>*uaB*vU89^obskm(3un3h|!AjeHYef0vT8<%pP*^2f@7qQ`|WdR%O-j z+sn+zGtX*|>A_5kOTC4?2E=UH$adO=2KnrO*;bajC4csO%KJ0b&8Y#$bmsyCA62z3 z**@v533JZy4e1rbj-BYH^6q1*vs}USg!UHCh>3yw*}!8gUii{vR^wT2z;dWesaA16 zYN|mGP8E!K?fKO9od8pLvzBnx1Bk1xVQ*Z3*qx8JTu5_B-pnl>Hh0UpTf*ITp4So2 z*Y6BkH!1IN-kgm7Hb1fUnc}dXZ^Lj=Y%?hLR-jTL?iH*Md;G0%@nFA?y&E=B=%)rU zSJ73^8u`p;pDLX7F@Y^#7jzaP*2I(uy4qAi!5R>rKwEWqiy-Zindd&j-Z}KZ=j-BMWqwa%;D_1R_G8NR? zDJD%EiloOce#utI4TqmK$LZ+2e%>Xj=rk6t#URiVHgS(-qhU3FB*aawE$vqa??EVT z!x5LO6OrB44=$-JS9nh^aMs^ZW~`ag!$dv0aQ64aUr{CSGHpBC6lgQGIilL7P9OY= zWn%r+gBjELT)1&lr0LJt06gbw)W;@0KjeM?u$0L@JD2pX$ zd@1vwXF6U#qmM-9#^-j-^MydjxUyOfB~^0Mj6z&F3~pZo`qXNvgGpC)Pp>gsjB%N0 zbtGO5*$<7e0&;HNKU*mNNXxmD6F(QQ^}0nfocb$iWFa=-=oe@GB_$e_@Aqmm3oDG) z%S_;eHmWpHiQBVtwljoea!n_D87{w!8`1L4b0NJ0-Vm2h@A+oR3qV7Eg+72}@?>n) zBwaakCUH=uq_$YhPYCzkAM32F&kY~vD&ez>$jlTK{eAf{19H4D=}`Kx!nA2=yXB2k zyl6SVSy^c$n~4e#>5B^#wlXoO55R z_+QXK7A}jcGPxEd@JEl6OVxM1t|yurB2VqL*h{=sJW?CVtd_lgUdFHh4meE>u9HA3 zYfBpYvH;f%V}3BpzpN`kw9y_i?j0x3XdB=9aAGOtr5eI~EXJNv$P~&&@*^h07q<*! zA*T}2@{=|Rffa3ZWjXHO#L2B;7#<8twLWMDpL`OM#iWOncV}Yg9^DA6*mX2f2k!%9 zi~h(mz?E8>6$Vxwa*m2Y32En$(r)3B$9%f$DNabP24ok~NWI{mU)&{@=)Q$fKTZw0 zA?sM7FX2)F!lRAq%p>wsCn*8AI@VY8{WdG(r7Eg_jlZr{SyYuP^{CdAi~d|)#n+fu zcNU~I8I_)zr@taEts^b0F_r@{X}p{K<2NlaZRKlHsk*9rYMyQN+m{J#rIP@Oi7l6y z!TZpz848=f_gOJS6?v}>tfTUl1lME3@er-`8^@O}maeO#KC!m9LpF~}KMz44PCx(l zK9Dg_2Q#9Inf&7IyFk?~Ylv|ZJPaEFUXG8xxDjylH>D2f;W^SVyT4|d9g5MVeVtdl zHTnh40=}Yg~VPL@~cOkJG+Mp}k0u3gLY!f6%wno|oqqJ^2+u@0lO-_%<2IY^a)ONWRe-vW+qR zOhvhihS2FFmg+W^Ay=&LmSUOoLFc&MfaNvn`)8@Qg=ukOR;zQte^&KDhoNEwJe7K} z3rgGhNjEp-asmEroROgR(!O}s_T(wx`0G_NCmAH%%-eQjB~8CXdA&2ubnyRl@L`VC z{(TDh{d960q2rG$6*po0jU&Cms&r%8LRWg}qmoIT`wA_TaD1LEhn-1J?88%gv=m%NuJ_|fImrmFJ8zj??G=qXL{waueHoamq?$ULwH zjhd{P^t4kVMze1p<=Cp?I+y-5gnL`-<@xJx@^R%(Dqw3}ktpeo>BHvKD0{8^zJS5B z*+={$)^W_$(fBhrq@saFte@FC{87Iq- z;@!o8kk#fhgXckP2;P(h$TNvVKrYhYiWLrV-Ea$ODNd7c+i|LHuI_@@2v{Zt*mJkN$Q0w|AbA;dLE-}=-t!m3rjh*E_5qy^+h24p2` zpfaiECS{tzxWey$xWy{xI{*c&WBd>q!E@Xo^G)LPMadk`NYvwpTa>_rhfD5?!F(bt z7KC$6Vu}u}&qY@Ffvl?G%YUW;eTQ+8744tv0%xT}MD!LFsVaB1<1>8(-@fXfqp8rrBHk zTQAAnw4yFSDS2%~b=9C(yc|Y^G(|E*Q{k7VCv#mufl0h#sj3*vOKU4G%riQ ziyDw`q?M%(T;a*0o>W;>Y?%L4Q8@%D`6Dce7p;4CfT_O60_FyUG5w$fX5S#&6fL)C z%K4bjF#aQg9&oqk7p@C+b(T2c_MUV4Hqk5_3XNmSFJAf%=u?#Eq~m4^f#Av@^PWeD zG8og5jf?fRP^$Nv7*WU2VST;*U8mFio!>{sdP|^{Y1)2+&MXO0SKeUuvys*?Jvzk? zF_~3BM7n>_T(S169JX-?mcad>q6)6TJ(J#(>1Qupi;e z$H}tO^dzDF8`LrukddnLw`g6AbA9f>*q}_D&kR5rPfPLM7M=;LKYWwA@^^970K19l zD71n%J!+NVE4g8D$p)ZUI<_O5nC`B^dCL0~HAyOVE<;DAGi8+5a$pT5RW9|{6B<~yKQ-dA~AlzOG*PcXW)k&W`Ql&zMe5r*XOK=2h#AG+B11WOvgi8Ly@+$PE?a2kC5RjvQ*ccK2K@f=&j1W}$%O_@;qQLHs# ztAziC*MPnBE#2hb1V2*fPHhzxBa0fK5;7a#1T8JjI0d#$$!MjNF z!ohW2zi9!lrW2P%JZ!2*y39>9X_`26P!9;Yz~{2qO3R~1AT71q?J+rk@4qy_ejG@S$z|dONxat#@BHp-8WgOF@Orq$Fq21 zYv(y2XVYQC+~sf=z8rVdQUlroL`BDJ8D%&~?pJ7sp|dOo;f#nysyLj5*1iqntS~>4 z1of4bnj{oHTTEsATFUz4g??H0gJP2ehZaviK{3I#WS@FnhpRjl^uJNMoAl?HYEh z%Z>)gkc9D)b@fmqQOvB>N!ML6*`klHEtDD>qPE5&%2bPMd!|r}k(zar&S1Z@RSP;Q zWfGg)8i(N{4EX87-^K;G=kB!#p;Aa$fLL3j(Xwoj%UjA&#{tSAn|lrUK*W8| z(8qD-*r2$vGi%yqo>(w6BWHdg7HgRwx7wppTpU6ExHfPzwWR3L?S~mfp!f39y!pW$ zok?P1mt~e4FGNu_M+YN_pv)rBw{h?Mv@I=5nookar^qN2R5glC`!>Fh)yN)TSp7I0$ETR{ks3rw540DJZ5wJ=TA`()4?Ij?L?+))PJ84!s2KwnV=dQz~N3f z3h(!N#?FK2uMeqpY)MrNQ+5l3Y+UX^Wg#}}VbcKpIKz)1z=bv)O*Bcwwz_mXkJvLo8hKQ{ckN^x=J!TI1?PGFv)zs zOzlCusD((oq~dX{QZ|Y}UEtu{yT1@$z9z9+?z}&rW|_+*z+Xic-^I+t{8C2=u@UgM zg)ve!#8;tXo#&0qi4o9A#X7aimel+vRlo(_aF@+Vv09bjo)*ZVeGofY7PJak7QFF* z_WV+5+i#97QfT`7ucNME$-UaRzgD)RlE_^Om6{ZGM{0@wJPG zJZiHaDJ6&75x*(7Yuk(iL)(Qo`~x3e-EXcd=fHBE+!XU~Leh~5>ro*1$q>F$brS(@3R#Y4kT8pvJZIy9Y zH8IOPTu`8lg2=XU8yv*4i8)#Xw;lQANAU;}TPR9BD0xmJ)ONkZ0Tt_(N-zsqpG&Uy2RFp(o<6FN`J4%(L9%Ph`;X1 zIU4yq;FHbTOL!U&I(_G_Zmw6;j*EIoK+AkKT`|5sZJ=AmV8Uhb_(QQ;&prMeh27w>(M zm@nVFDC0BNMN7UI)AGgM+SWB(iBnhbN?(DNOtxONJ!`(oPzZ-jSqC#csDULf3C_nP zpI+LkSut9${=8(YW0@*EnTANN*)4m3q_fF_n#)pZu%^Z@Yh!eR$AX zxai~GHcA>ka3YQqG=F`qD_j%r$McSSxXQ+uDAO`{cwgS3CY7xh^LV;NFa>0V#`9F% z+}oL5T831Ai_GmVAahIZUHh6?p6s%N<>I5-YvAu&_ThK$xb4vv!v-%2G_0HB8*CZR z@i;=MFH=IY5(;J*=tE+aw#}RMJg4Xh-0W)66xdy_OnujpwEErpGw1e2wxS%K+zCf> zzmjXk0$vXe9JiL%tT_DF2k6iI*Iu)ypk%Kq+uGg+t5&R4o!)lDQ_sxS~@8m?C2ew@6nCulcXrMm!56T`L|VLwK`V1@Bc>ZY2DdYV21X6<%Xjay%w2yeAK zqkYMSD9kx9xCzFV!9_anTPgi7R*VDvwrU2crzBK6hC2;Gxj~#EA!@716#k4xh7Roy zi=!49u=o^(LNp87IL0n9GwozPc|7!04T;L#ta>4jH7Z+H}lp9 zq5*-*Ed?4oN$f0Y%HO=%-!u117T>MXlv;_l*Iyq_8Oze>wH{@m+CnFd((PZl zJo4#2Q_9HR&ib;+{EeWMKvlN{L+99gTtHTRuXl~wF)4Czx;|M~{4&}+zYvI)0^+pxGC=XwAcJ&TaYNd+r-PV!ONWdVx!O7f zPYBe$-oVqM+obCroue5YZ<=v>UYKt3N`Jdva*3Rm&qF1~+MpwA-2($EGbZ48Ap0#e zt7vUAsNz?k7}xzKAvG1b;85Ff`;!7%$65Vk1JAcT-%!(~8(yJaT(y+vXHMHubqhm+ zCmwLm6U9l!+AQd*jZI6g`}yZ{pTWR|p0i~y4dU(PwKG_D;Vg9@6%%O48_RvZghx)L&ojcC8}<#;NR+nWSp`%uFxA3u5G_6aOR;vUJX z?1SX?t%}oe08w>Si_O3zVnV)}1k4_e*SjHhc0zs`TASnaVE&5@hq~Tk8Ip7IvC!s@ z`JkEAy`vybaruRQjNi9U#RrA$t-B>b#JP>V*c$_M!|2~q4OolJwzi%IQo)9jgZlIF zWI`CIT?V(e%irG0Qu^DiaOaSg=zAPw5=1<|f@wWJxZicQHRE4)*w{opKU?(i z6Uiv+a~=}u<2QpC&)JnU3!Bq`t%vn($D$k7H{SHEzBBSsDI$;BdF3w~?DlrNDRrRT z>OYaL#l1g3mpwikz2t(>&VU*t0A#ZI*_fxx&bu|$4J7bh5cp4Y3&i+R)0t?7)~^>g zLqLIJm5PAk%qxR4px{3Q*rfs)q~Pw{WNg_Gy*V~)-^ zu`NZZqfk%lt!WEFh;7Woid;d(zB}})D)@p+f5sx*Ay+wc>=Hz&<3^U_2fje65~t?} z8`XgQx&WvCo_%-<`J-6qwD~_5B>c~%1ON38tN$?;)>ITW@(4El54|qSemuZ6^5=g8 zpOcm8qi3Kgk3l>SFLFifrV=P;d+WT94x9lKsy4X#Jt zxCwr2vyY*K+ng{FrqyoV;N73z{b|tQT;4I_$@J}uzB_;H60dY@EZbFm980;V&`{A; KE?2a9`@aBlMU~|M literal 0 HcmV?d00001 diff --git a/api-ref/source/_static/images/en-us_image_0000001538444809.png b/api-ref/source/_static/images/en-us_image_0000001538444809.png new file mode 100644 index 0000000000000000000000000000000000000000..9030b9ee1b751127efea3a451733ec077f82d8be GIT binary patch literal 14175 zcmcJ0XH-*Nw=OEhhNuWg5mb6ds&wfcqy(g+K!8B#MM^+KMM~hM1f)xc(0eb+D@YA3 zv=9*Kgdze7J$K`K&KY-nW1R7wd&j+hve#Z&S#8fX_ngo3B;vWQ8s&9{>m(#3lp5;F z1|%d`a)ENsRdV2S6Zd|QgybQKhO&au>+~&bh>;PYjd+qgU$8n?FgZo~@}pUPU-r63 zbdKa8yCJW@y)>`JIY_crFOu!CI5mjA8;@pO~L1s~WkpCzjl zB$uTJ%!-8M@8J;K&cy^tNVa83FXl_~<`e6EvWvpsOkcPzt`AqPs$RM%JW&(6SRKhn z$+!9!*JlHFqAy<*Ud7nlySU!=s=B7?b`EN$PZ0a_3-ZwWq`6tR0lf)a&%pz~+Qg(A z$$`bP7j561PxO3QTb0_I=s+Ix`kS3^HMU!V8l-CdQna{rlMT{K>LxL$!6v%b*gn7J z#17&Rv+~978c${?{i4n-9Pp%=5&8k8)aG+ihnQqf-zSriV$qjTZ9$sw7~l7>^~%6z8_Za~ADVm{;Fdwmtp@G4;yb{_ zj$aNh-TA0FI>Snq%0Ztp0@XUes>J(FBJ~YUj%aOjR%q)^sjkD`}~O<*3WwSi8D{%x+y zt42;{yO+fLZxz`=5G!ey98S|OBeW4bp7jvhX#)_K4m+;qUd62~OKYSD;sEk{yd)sb zyR=BOD5&YDMSS0&$4r}%TeR$F4wUaQQsF(W?4i_*udm}ybw2Ww+2;VS=18W#d|<=h z1cE9ka-rc?lim26&=*fVI!SXD@^n#2<2m38?_Gl^=5zAm8S9+d)+91)uwo!7~df&hAmCQ6>5+8 zpNW|%9O$~W95!y^dG$7#5j>jt!T zj4vTGDW%}G#;#tTb1H*3-XKx>!g@O`^C!bb-l=gqEwM0odwzCkRpoF>WiZ-nH>dE^ z8jHMAXKSFTncA_4&&W`sW)wkiTdgwSH54F-X;H zcRNTH(*lb?5dMD;IO6lQ_@y}3UyQiqYESZ|$pvO6GhUb`A!jZmG|o0DGBY{Sdit?! zhoXQQp=SSvTB>lN=6kU^;p$+gQKRC@A|s&7%#R|+N-Ll88x3!GKQxR-3`V_b`Psv! zfs70|F7kmS-%(Funsx!phSlu|f?j5@)wGJk%#(hWl|u8M=+&moV8n%cxe^5AKL3_H zI|JJT!;_qqxmnpPeag>SHT3?~L$vH@pW$>~BQutC4vXQ|=)JX9bC0Voqjh!-w_a>A zR?jEv&i6OMq*l4{_AhtlBS`aW+G2-+9USscS1y- z|7NVWq(u66C}mhh+u>HttkXHr2nhE4R*1W!9f#};Xxv>bP{c)gYv2d*g-)0x7SjHT z0+?81_yLv>Ed_S!if!j0bljSKBRY3epzJ(bmBY}$GyZ4S;E(U4S}QjK4AN_S#3i+} zMjq;x9k`fmZ|AEzL39zGytulFpeF_!gd3tdpwu02?&YFHM)0+!lu@ageP7@l5L>gi zcqFW25`U(beQkCDx%C^g=5=Q!ZhSJ$bZ#41d!dhDcwidf8wV0^F>)v@(C`}$uQ~DU zcABf->MP?#^rsK?^<7v_BjM)mQBb>_WfK<{4+h=V{uwePCJv%&RJXS=t z)pgk+@mNa-L#Rk9;qvs~eDFleW9tjQ8ioQM3Vhm2q!S7`ej*!O| z&&5ajF4O*ny#h3N!@O}a;3!CcJLMmrTd{UB@W(BaJo;C++@vt(@W&6k6CR5EJ5T-p zz}f$Q=wcQ&qWe04;87;;#Q5WW0TdUH7^Z+LnwWuVvXwiudB;DbL|}EXzD3F?F`0r% z>vXY)G3b;AFIW46UPgIlv{lBmJjZ0;m2D_Qi`(Ty^6ZJq zZLr^89sky}BG>NuTu_b}+J2y!EgVh=@Cq#L_i9WYN(sdWjuN76twv_Yyz<@l9f^TJ zpY0WM_^ORy%Zc_X%D%PUgQY|sPhU;hr^JAqt>+P$Cv3RPruIuD+phX#xrKf#lL3Kmr92uA~G|~DvOnK$<^IO-KVZZetq_AVY--1k~iR9 zG$kZmM0VAqM3EYi5~PU^H_HvEL?_<`({5y>oXwCL{&+brEyzJmX!(? zvZivjk+;9}Q(r-elh1RlmnGn!WL}+`xsI$fYGA!}(2OveCF+A^lU;8t%8+l(iHjmi zptqU}=C#1!gAjBm(B4a9lrFKsH9ph(#ojq+Ix7F5#r1xF+R|_fai6X%us7YBKtc93 zL%1Q~GE}ndq%m0R)u*Ae&D7uu!L_V*4@3DAYZoXQbat8_Yb3Gk9N;veB#R9{!}Te& z9iH|aPbgOKly1H#OxufHo~u+8TS+({e#ri`hBlphJ<soB?y(2Yc8g2ZB&J#9Sc}*5c!6Ji8c>x;`S{nS=`fz6PEXVHzGb)nLr3XaEtwllB1RqD|0!&ld{! zErxo|ebmfcSH*q2Ot#I-tt&aY&&3ir2es~p3s&jgqopkZgJ zOoL+5UytafhBD0D=h7W+TXz9rR}O0JjA8w+;B8l9^Wk6meSy%(-^_4dkVM@W|Cx1# z&PYpzbL_4brsww4_-UnWfzFM80~k*j4ehKvGP7RPbk3CZN5 zRGkS)huO6TzS^P5o^j8-y0rX*Y5`P=G1{fF4mB$w$Q^x;n+5RohkR{P;4~Ldvjo(li0qyd9!)q{;JL=XPvbpP)eb8$|Q|L z=A8e_oI9=4S4KYcoIOYux7#1hI&d==X zc}K-sqV@z|g0roxKRL>f_u<@!Uao;@; z7GD%+o0rtzz{tkVLzwRL7)+Pem-=ljWxG9=_&(~2#LAEijs3f(&>c%HA$Md*C zz%p*>ND%Fqvw|6#T)yGP+D~2M#i5@f=t^&tQdF~iE1o(@29yfTb)rNj8fZUm{{Bc z{D^h0LEoL+aqQvxbQo>a8508$W%@`VB+uDb57i;G#UeT>L_(4i96G|a+$OH+A8)D{ zs3Sk`VX{O{k(@`9xQ}27{q=2EV=xX!mrsMjK{9A&WSSu zf%!{4_uLqhepTk;QeFiN-4FHuR&bYpD)-kJh(eS#m-+P@Hh7k>{>;9$)ZV@_JULNF zL@OoGH}ypHwY;yG!0b+o$6OE}u`8iT_UepMpB|0C!?sZ*Z5?vuhz5C;9#Q>E9I*SE z+HB9HUAG#G`kz4c+DMh|IM+!*D*a?sS$y*>88#y%yYa&%67q(k`2yUk`h-@6hOvA< zGR#CQJFDOPib4?$llAxzOF&Dy!`H->scbj#u<>4Z`_2gu8c8A9L`i)V4ZYRy0yz&q_^0xa~BC0F8=Qit2 zOoSiTF3Y%v5PuBYaQ=GCD$)XOdx!&O`inpbmnol|dOJKoSML}$wlUABu|z=y4d1Th zpQsW?@isUZYgfm}`X5dGXag2-TPJ1PEx2&!?3Z8YIU<guZirPGgp|H8$XeYV@iA1~2g zGB?Uc4#|WNzZHBid~}ve@i>=F>Xo@HaG>Y1OKCi1qHFQJcI&=(S zT=x#F)wQu6;6jeQ@KTO%N7NqldCd+VCo2MJ2haE^=c6EL+r71YRB6LpcXw02 z$zX^j8f9HQH;h35c0a1Kbvg}iX;C(bPsMtgOT=ep0PorZ6JgEP%Yv~_=7(pP)@*6y zA3s@BJsAj@>RV}!yRgBG32aw=8mu+dMQ~ZjRp`oD#mucH>Ev3CYE7Or{ATsR5d<{& zfd>59Qyr?ra%B`-U4<0D6|?)Q+rzdq;htna`lzpYV_Is3jTpSyZxzc zM~I07L3iCmEpLE3L!=Qe2hX@HTr}2sN;Fq2?IIF zvwQZlX;lXU++y^xxi@<|6z~S<55}{XMIc^fFuF4RZTaN&%j` zAavV)TsxsAcEBe@$A3GvcJEMSS(ZU^I9+Htcs+0b^|%`;bDnUuC}jRR|CC+O01#A{ zQN75vGKt9SH+`wgbPA%paP$q?%HLKF2k3q$`m@!BSh1-lZG2lbaSUZ+ci@&-G%9Sj z#AtE-~04~xyzTh1N1%BYgwZDDuUWZgYBJ%8cq?&sai!bdLReL zf;)MtHP$_JD0~tD>v&=PU~#@M`|SG8Qo4rGN|b-|CtG~)xbm`qwvnL{3a?%01wK^X zdqHs=K+CUfQ6J2VAc}ihqdT0AJ9=bYw$(BW3xeA^l<61WE`}Z;24QzmG>~sbCD7J65 z))2KEWRvbUQFY6-JPx$Aek7{jgm}+Tm#uum(3i*`Qv(GIwiZJ!GWucCu-#4UJF8n$!z97BNr1I0axtnh6L%#aJF zN?iK`Z;*`dHLTB34pbB#ow0?_wPCcpF8~M|lIDi~KP8g0pP2$|mjDKzkpH8-0cG}Nf zFOqIxMoL-#9me^uz5dT(((U%S7r^3i@Na*H+`c1wQx*1joAlytwwNny_2N7=FK^T(Dg}^SQTqsK^8M*%jeo@9AFO(f{r~;%iSMgz6{U+B(t!q zs-dA@nLoBC7VZ+XuF=aI>=Jj`#kM?f+93^8z!^zZW6Ti9_dYf)Yn#JZg2V9wUQUY< zLb(8XB;A1A6`#59>)-j%+d4$za}5>fY$LE)Xa!>?LbyX5uFnMp;Ks&3zwESR)qcpM z5rW?w@6HM?f0sfm$~%WXBC&Zcw3B<9rM4!`TO;~KzFgl!&))e%Zi~IL2o}rTP;KSR zN$}%+6WG-`7@g@hzJLk7PImLLC23BHc*f}b;DF)!*N9_JV*Onbp&#_2Yjql4b>QW@ zWu{HadV0;})~y>8>*uaB*vU89^obskm(3un3h|!AjeHYef0vT8<%pP*^2f@7qQ`|WdR%O-j z+sn+zGtX*|>A_5kOTC4?2E=UH$adO=2KnrO*;bajC4csO%KJ0b&8Y#$bmsyCA62z3 z**@v533JZy4e1rbj-BYH^6q1*vs}USg!UHCh>3yw*}!8gUii{vR^wT2z;dWesaA16 zYN|mGP8E!K?fKO9od8pLvzBnx1Bk1xVQ*Z3*qx8JTu5_B-pnl>Hh0UpTf*ITp4So2 z*Y6BkH!1IN-kgm7Hb1fUnc}dXZ^Lj=Y%?hLR-jTL?iH*Md;G0%@nFA?y&E=B=%)rU zSJ73^8u`p;pDLX7F@Y^#7jzaP*2I(uy4qAi!5R>rKwEWqiy-Zindd&j-Z}KZ=j-BMWqwa%;D_1R_G8NR? zDJD%EiloOce#utI4TqmK$LZ+2e%>Xj=rk6t#URiVHgS(-qhU3FB*aawE$vqa??EVT z!x5LO6OrB44=$-JS9nh^aMs^ZW~`ag!$dv0aQ64aUr{CSGHpBC6lgQGIilL7P9OY= zWn%r+gBjELT)1&lr0LJt06gbw)W;@0KjeM?u$0L@JD2pX$ zd@1vwXF6U#qmM-9#^-j-^MydjxUyOfB~^0Mj6z&F3~pZo`qXNvgGpC)Pp>gsjB%N0 zbtGO5*$<7e0&;HNKU*mNNXxmD6F(QQ^}0nfocb$iWFa=-=oe@GB_$e_@Aqmm3oDG) z%S_;eHmWpHiQBVtwljoea!n_D87{w!8`1L4b0NJ0-Vm2h@A+oR3qV7Eg+72}@?>n) zBwaakCUH=uq_$YhPYCzkAM32F&kY~vD&ez>$jlTK{eAf{19H4D=}`Kx!nA2=yXB2k zyl6SVSy^c$n~4e#>5B^#wlXoO55R z_+QXK7A}jcGPxEd@JEl6OVxM1t|yurB2VqL*h{=sJW?CVtd_lgUdFHh4meE>u9HA3 zYfBpYvH;f%V}3BpzpN`kw9y_i?j0x3XdB=9aAGOtr5eI~EXJNv$P~&&@*^h07q<*! zA*T}2@{=|Rffa3ZWjXHO#L2B;7#<8twLWMDpL`OM#iWOncV}Yg9^DA6*mX2f2k!%9 zi~h(mz?E8>6$Vxwa*m2Y32En$(r)3B$9%f$DNabP24ok~NWI{mU)&{@=)Q$fKTZw0 zA?sM7FX2)F!lRAq%p>wsCn*8AI@VY8{WdG(r7Eg_jlZr{SyYuP^{CdAi~d|)#n+fu zcNU~I8I_)zr@taEts^b0F_r@{X}p{K<2NlaZRKlHsk*9rYMyQN+m{J#rIP@Oi7l6y z!TZpz848=f_gOJS6?v}>tfTUl1lME3@er-`8^@O}maeO#KC!m9LpF~}KMz44PCx(l zK9Dg_2Q#9Inf&7IyFk?~Ylv|ZJPaEFUXG8xxDjylH>D2f;W^SVyT4|d9g5MVeVtdl zHTnh40=}Yg~VPL@~cOkJG+Mp}k0u3gLY!f6%wno|oqqJ^2+u@0lO-_%<2IY^a)ONWRe-vW+qR zOhvhihS2FFmg+W^Ay=&LmSUOoLFc&MfaNvn`)8@Qg=ukOR;zQte^&KDhoNEwJe7K} z3rgGhNjEp-asmEroROgR(!O}s_T(wx`0G_NCmAH%%-eQjB~8CXdA&2ubnyRl@L`VC z{(TDh{d960q2rG$6*po0jU&Cms&r%8LRWg}qmoIT`wA_TaD1LEhn-1J?88%gv=m%NuJ_|fImrmFJ8zj??G=qXL{waueHoamq?$ULwH zjhd{P^t4kVMze1p<=Cp?I+y-5gnL`-<@xJx@^R%(Dqw3}ktpeo>BHvKD0{8^zJS5B z*+={$)^W_$(fBhrq@saFte@FC{87Iq- z;@!o8kk#fhgXckP2;P(h$TNvVKrYhYiWLrV-Ea$ODNd7c+i|LHuI_@@2v{Zt*mJkN$Q0w|AbA;dLE-}=-t!m3rjh*E_5qy^+h24p2` zpfaiECS{tzxWey$xWy{xI{*c&WBd>q!E@Xo^G)LPMadk`NYvwpTa>_rhfD5?!F(bt z7KC$6Vu}u}&qY@Ffvl?G%YUW;eTQ+8744tv0%xT}MD!LFsVaB1<1>8(-@fXfqp8rrBHk zTQAAnw4yFSDS2%~b=9C(yc|Y^G(|E*Q{k7VCv#mufl0h#sj3*vOKU4G%riQ ziyDw`q?M%(T;a*0o>W;>Y?%L4Q8@%D`6Dce7p;4CfT_O60_FyUG5w$fX5S#&6fL)C z%K4bjF#aQg9&oqk7p@C+b(T2c_MUV4Hqk5_3XNmSFJAf%=u?#Eq~m4^f#Av@^PWeD zG8og5jf?fRP^$Nv7*WU2VST;*U8mFio!>{sdP|^{Y1)2+&MXO0SKeUuvys*?Jvzk? zF_~3BM7n>_T(S169JX-?mcad>q6)6TJ(J#(>1Qupi;e z$H}tO^dzDF8`LrukddnLw`g6AbA9f>*q}_D&kR5rPfPLM7M=;LKYWwA@^^970K19l zD71n%J!+NVE4g8D$p)ZUI<_O5nC`B^dCL0~HAyOVE<;DAGi8+5a$pT5RW9|{6B<~yKQ-dA~AlzOG*PcXW)k&W`Ql&zMe5r*XOK=2h#AG+B11WOvgi8Ly@+$PE?a2kC5RjvQ*ccK2K@f=&j1W}$%O_@;qQLHs# ztAziC*MPnBE#2hb1V2*fPHhzxBa0fK5;7a#1T8JjI0d#$$!MjNF z!ohW2zi9!lrW2P%JZ!2*y39>9X_`26P!9;Yz~{2qO3R~1AT71q?J+rk@4qy_ejG@S$z|dONxat#@BHp-8WgOF@Orq$Fq21 zYv(y2XVYQC+~sf=z8rVdQUlroL`BDJ8D%&~?pJ7sp|dOo;f#nysyLj5*1iqntS~>4 z1of4bnj{oHTTEsATFUz4g??H0gJP2ehZaviK{3I#WS@FnhpRjl^uJNMoAl?HYEh z%Z>)gkc9D)b@fmqQOvB>N!ML6*`klHEtDD>qPE5&%2bPMd!|r}k(zar&S1Z@RSP;Q zWfGg)8i(N{4EX87-^K;G=kB!#p;Aa$fLL3j(Xwoj%UjA&#{tSAn|lrUK*W8| z(8qD-*r2$vGi%yqo>(w6BWHdg7HgRwx7wppTpU6ExHfPzwWR3L?S~mfp!f39y!pW$ zok?P1mt~e4FGNu_M+YN_pv)rBw{h?Mv@I=5nookar^qN2R5glC`!>Fh)yN)TSp7I0$ETR{ks3rw540DJZ5wJ=TA`()4?Ij?L?+))PJ84!s2KwnV=dQz~N3f z3h(!N#?FK2uMeqpY)MrNQ+5l3Y+UX^Wg#}}VbcKpIKz)1z=bv)O*Bcwwz_mXkJvLo8hKQ{ckN^x=J!TI1?PGFv)zs zOzlCusD((oq~dX{QZ|Y}UEtu{yT1@$z9z9+?z}&rW|_+*z+Xic-^I+t{8C2=u@UgM zg)ve!#8;tXo#&0qi4o9A#X7aimel+vRlo(_aF@+Vv09bjo)*ZVeGofY7PJak7QFF* z_WV+5+i#97QfT`7ucNME$-UaRzgD)RlE_^Om6{ZGM{0@wJPG zJZiHaDJ6&75x*(7Yuk(iL)(Qo`~x3e-EXcd=fHBE+!XU~Leh~5>ro*1$q>F$brS(@3R#Y4kT8pvJZIy9Y zH8IOPTu`8lg2=XU8yv*4i8)#Xw;lQANAU;}TPR9BD0xmJ)ONkZ0Tt_(N-zsqpG&Uy2RFp(o<6FN`J4%(L9%Ph`;X1 zIU4yq;FHbTOL!U&I(_G_Zmw6;j*EIoK+AkKT`|5sZJ=AmV8Uhb_(QQ;&prMeh27w>(M zm@nVFDC0BNMN7UI)AGgM+SWB(iBnhbN?(DNOtxONJ!`(oPzZ-jSqC#csDULf3C_nP zpI+LkSut9${=8(YW0@*EnTANN*)4m3q_fF_n#)pZu%^Z@Yh!eR$AX zxai~GHcA>ka3YQqG=F`qD_j%r$McSSxXQ+uDAO`{cwgS3CY7xh^LV;NFa>0V#`9F% z+}oL5T831Ai_GmVAahIZUHh6?p6s%N<>I5-YvAu&_ThK$xb4vv!v-%2G_0HB8*CZR z@i;=MFH=IY5(;J*=tE+aw#}RMJg4Xh-0W)66xdy_OnujpwEErpGw1e2wxS%K+zCf> zzmjXk0$vXe9JiL%tT_DF2k6iI*Iu)ypk%Kq+uGg+t5&R4o!)lDQ_sxS~@8m?C2ew@6nCulcXrMm!56T`L|VLwK`V1@Bc>ZY2DdYV21X6<%Xjay%w2yeAK zqkYMSD9kx9xCzFV!9_anTPgi7R*VDvwrU2crzBK6hC2;Gxj~#EA!@716#k4xh7Roy zi=!49u=o^(LNp87IL0n9GwozPc|7!04T;L#ta>4jH7Z+H}lp9 zq5*-*Ed?4oN$f0Y%HO=%-!u117T>MXlv;_l*Iyq_8Oze>wH{@m+CnFd((PZl zJo4#2Q_9HR&ib;+{EeWMKvlN{L+99gTtHTRuXl~wF)4Czx;|M~{4&}+zYvI)0^+pxGC=XwAcJ&TaYNd+r-PV!ONWdVx!O7f zPYBe$-oVqM+obCroue5YZ<=v>UYKt3N`Jdva*3Rm&qF1~+MpwA-2($EGbZ48Ap0#e zt7vUAsNz?k7}xzKAvG1b;85Ff`;!7%$65Vk1JAcT-%!(~8(yJaT(y+vXHMHubqhm+ zCmwLm6U9l!+AQd*jZI6g`}yZ{pTWR|p0i~y4dU(PwKG_D;Vg9@6%%O48_RvZghx)L&ojcC8}<#;NR+nWSp`%uFxA3u5G_6aOR;vUJX z?1SX?t%}oe08w>Si_O3zVnV)}1k4_e*SjHhc0zs`TASnaVE&5@hq~Tk8Ip7IvC!s@ z`JkEAy`vybaruRQjNi9U#RrA$t-B>b#JP>V*c$_M!|2~q4OolJwzi%IQo)9jgZlIF zWI`CIT?V(e%irG0Qu^DiaOaSg=zAPw5=1<|f@wWJxZicQHRE4)*w{opKU?(i z6Uiv+a~=}u<2QpC&)JnU3!Bq`t%vn($D$k7H{SHEzBBSsDI$;BdF3w~?DlrNDRrRT z>OYaL#l1g3mpwikz2t(>&VU*t0A#ZI*_fxx&bu|$4J7bh5cp4Y3&i+R)0t?7)~^>g zLqLIJm5PAk%qxR4px{3Q*rfs)q~Pw{WNg_Gy*V~)-^ zu`NZZqfk%lt!WEFh;7Woid;d(zB}})D)@p+f5sx*Ay+wc>=Hz&<3^U_2fje65~t?} z8`XgQx&WvCo_%-<`J-6qwD~_5B>c~%1ON38tN$?;)>ITW@(4El54|qSemuZ6^5=g8 zpOcm8qi3Kgk3l>SFLFifrV=P;d+WT94x9lKsy4X#Jt zxCwr2vyY*K+ng{FrqyoV;N73z{b|tQT;4I_$@J}uzB_;H60dY@EZbFm980;V&`{A; KE?2a9`@aBlMU~|M literal 0 HcmV?d00001 diff --git a/api-ref/source/_static/images/en-us_image_0000001538445357.png b/api-ref/source/_static/images/en-us_image_0000001538445357.png new file mode 100644 index 0000000000000000000000000000000000000000..ebe7b6b2a42f27a858108790961fe600977c723c GIT binary patch literal 28901 zcmc$_XIxWH+b)U)R1hnObPI@d=>h^ay7XQGO7A_iNKq67DM|^w6FQ-U5C}~~KnNW| z=%7eT2%&`%+79Y}KWCr)?BBEB_rp2s)5=H(XM*Aae>UBX&t1?jn8ar(8e z+!bDa*fQ`?e0)oDA&>K?@0MLpUQ9bGyYlAnkYFme%$_F)A5cN&aL_~Pa*|?qB-0te zSKQe@SfBUDrwwZb29?5h%s{X=jh|6Z&H6fWJ6aoEW(dZ(`WyJZqu0$dH|WXNX>w~$ zF6P?oO5Q)W6cm@v@}2r~KT35<_3zV~Ctt4pxea!{QgQar?Mvo=TXdlKpUP4aTNR^u zUCo;W%#g#QdQZ;SP2@*?1%)m5N+b8GW$?Ls>rQw7*6}!`Ya+2c?9SccA2r)i0D942 z5!+^r?O2`cIX-*#o)}x^Y}JRqziX$-APBf~6CLSQTh?ek7F!*&&;g73Pp#6DJB8v+ zgzyqQtp4^1Q|W)+@CdN4--8ZXz2BIhOUEW@q)7bR`F`DD_b(fS@tsuye7okkT0oxV z6x+Bf#NX8;{_EFVx*M|32=o#jz?6`mUTPO(2EP$8H%d>2mxAK)re4@7RI}qu*No$o zb2tfq-Di0LDeZ=*v*q=y&s$eb$lOWEpmtcH{{5|B(w1F!obgVJLb|j$bgo0gVZg*S zHT(tiIAgaB7Rc^{`P#11+d1@>C$>Umq_5D+<<$=@<4?HOS09JOgkD#Aqx}N#&fntt zbdhEsr~OT0t5-v!daaMf;T0PJ=N${*K^;~hJN|n~!-@5Vui}REv@t}Y7Aqy+G4w#J z+|e3mj-`}7%gf1sQ_6gT!+wwBy_#9^%zH&{r&k%3!akMmagSs{pu#f2U`m>@iDbsK zI0nZSD;#a#(CPB1p~}WNo74%vkruwzvcTzI#x*d}7m5K|Ucn&whQW5R=Er&E+wAxI$?sj9Eym+7^b!%(jt2W7G3HqB$%6(~WAUm= z5W4{s6K!SRJK0Y2oK$@2G&soMN0_U_^87>2sAcDmFCiQ~lftUcIOf{62uX=4X6GR@pwfz2c79 zM6ALteW9vO^;qy7$b4J_!6XeDKBw=fv_Un$=&ac_i)M1B;yk0+tKIdI+j-K0-|(Tb zeS~h;9qE}yA#4w30bfQeX%RQ zNYglHX$IT_Z}8d76Bo_Q4v!k= zT_^anFZ7r&@A{&+RE*X_^&4S^G=XvjE;L);b@`0sTAgSX4l6lg>Hr`_o`~udDWA%( z_xc`;oVW~adbzW4*?_D~HkCL1E>;#dQgl~r{949R2k{E%-jSN18y3$3PpI-aMJULyM}Ebx(7ea$I$_oj6@{wn|SKa8`Yq+`}n0J zt!}AS^+Dg?6;-tH{uSXHb2ih7m{$92&rd`&pi`UkzBaeXYZk14gsMHYRv~-q&xF#< z>;Xy}Kuve-!HWhY+rd`B)$z3>Y2;2uy%=_}6}LTmRR@0eo+=EJsM0kwkvuRiBr{nj z#b2bUlZFXwD%n}>-_zcpf&uETp*fT%AW8hv@y%ATX47Q%rYnd0>F~C}8@TuQR41sy z3hUVmDja{D@3{bQ==@oB{I1&ZlA-tNkj7L~&xlLCZ7+~!;EFZxCd|v4FENy(Py1~Z za7{#{VkB3UURt5pR$?aNfv{M>OjAu{uw%`_MX@^*TFPUwn+$Z4XCT^n+8N%D&f4s( zWE(|{S=cCy6wJLJzh`eUc>eBbSMLEi-(AuX%Y#BronsYK@$ zWL+UvzupnQ7F;?Z8T;X@*lo$d7u(!=Pu|2o5K?~=yT>YPlAI~oB)EUoU{uyzYh?XG z2R)DVN7pyJA)mj^D~W4srsYSv2F^^mHbT;oK#`wMqlNenYhG(7SjtmHr$Lgs_fj7E z#r~=#pS(IGJUn8L$IXxq7g#=;&QF%NTNMiPl9pNIf%i@c8*d(JuaEOswrjGNdfzuIZws+ zp(@F}#K5z;RDFY&M0TqkU&Sln#*EdZ8u;zseU0U#Y0r!we$uOhI_|Dxde5|;DiaogR znS~1E1Ih6&P-I#C#02Mc+JlbF56eo`qYW>!019AmwcFIR!g8umm#M2dfHR*3!iQuo z%R7GfbwK&6(b}xNqB`P(H-Rm^-q^E7I#5i=>~Sx2!iHiXE_dIzljLJMg=!o@t>Zp+ zSjmFjCCH&pWnz)pzJpw1H-SULmCM?E2)$*j!7K8(fnQ`|(j}B2qV;>8y0MOWe-{Ji zd-@_(o|Q8)CSr<@y>ch~5-c@uFkoNO@82tR%jC<)eqnat(x7Qq=I(|55P&-At4h0Z zyph!PB)rCGY4nsep_)B=6IJdcR6$;G(G}+!edVNV!zRp3L$+onBA7c(k*}8TnTqtdb4Ti~pj8YjpNaG=`5hP7+JDe@^zx1W zTBCBoEc(-xyFKFdewUS}XD2Z*GgSA5fUjQ_?RvL;ZKViMy-j$}3q_w7Uts+9aPMUM zsdm{oFE_V5FIr2L5!1et=%vk>w7g87aJ?()Cr&|;Lg~3-zT*N{cpB%~^l=iM0-F+w z`366a>84*-xcH@N__OYOQbB9_=kECwQ0qnisRmOb^)c>jl2EvXWGA{Mp||-6InF^V(AydU`hN zgNcDlbkJlI8~dM{iUx@FFyIG zkJ>4B5@K0gSyR7s4w$uef1BXBzJk^K7(u?IAfTeV&(M5!h^(~uLH*k=M2ud&t2bSiO z%iHk~f2U`n(zMs@p6bZ&+eu-$US9Y;0{xN1%%*23ruu6YLYC)ceGPo#R)4=BH$?2t z-$E2$#GRNcs$1Vl|9!;-c0L3Cd!NF7`kz~;kYLW=Pwh0FC#naMVKWlmV*QVM(+~*} zvjROIX$#$PI*j#Vk_GAD?o05tMv{YH^a76(A%Pm@^=u`i@p(fb7%H!sf~Ym0BO;uLvxAg_`;QP?b3#v9x&=Z(>RK;RQOG z#KYj79dcgR-hk}D1qunKEP9q%n^&F7Ta0jZHWL= z#kb=Im!PYM3K~s~CQ~*$Lls%=#YwD2A?lu{eXq!Eh)i8D_ySel+@4cDX;Dhfs`v%u zxVjl~aM(a78&vJ>`Ps~muU4yMXs=Szc+)Ufzs2g2PNqWdKuY4#4rVu^p}e(OyVyh-O<3Zx?FIOs*;_os@}fuY>GrS?*_{ThynIu8LiIi zlWKLXRbt;J%$^rW>+M$+WI-=6K&%wEhfjLkpd{G%a+UB|UZ4BSaO_nWdFV(vj%m~e z`Ml;WOxv2D#Sg!w2+fgV$4AX45A{v6#x?~U*VaC&O!>AM>T@so7%?x*+v!xUcZ!&- z>$bb7d9ReDita>#fX#bF+BFvLZ*2N_F|%WbqI^q9+L>}?F0B(hz&XnDeddXv@-qv_ zSBDPn(E)GcZ*Ha65Cn!QMkxf1ay#NluPb%+ZsaR24)$=X9%~t zD|GFA&O0uLo{vRLn-0ZPWlFlPf{f-+K3LN@{`)-;Fon9KcYyaW$~ih9K1ax;yIZaA zq6nf}0R<~bnWk(f!2xr0Rl-xRw`E|rqexQIG(yiD-QB;=#a~Iu(eRkrLz<^nRIU_&Vxd$4p$d(PKq;q&wJY6znVwy?rV3sEy=v%TP$?=hiZfxx>z~;U>XI zuP<)isJk*PM6A%|C;;T^R5{23+`fo37&tOrOfD7*>j_Y|H9Qi~Z(2C<12>s9;ZW;O z$S{>;oUm7yv!6L<=^9r^iIP1ouZZ`CeNV*mHo81qo%=HOh;*mSs8UJ!*~j?p&qNw5 z8|UK1;S~Ch)eFRj@12#=Nes~rTM_ccFpKDG-QBl34^9U>B%Aj^G<>10X%MUnnXiim z*A2o6BA0g(YF372JGzEITlP=Pqg<-YHw5kzpK~=Hw^KA8D|`y24=R_liLcXVFz?Sk z<->@xMPRZKp7BVGq4inb35QkYGh0W@XR57s<$D5-m;>fL#|+|AhKyCGZ)WYx)T)L* zVG#A%6M~uEy*X<6)_rA%ODWYG^TU4Mf*|3);VjwL_wabiW^Fr3yNn3Bt0W^HxY!`R zt)DkFCQtow1t&Ad`$+vlHfT#e1CgNL65(ebeeG#f)(75xt-S8m%SnC1ESxOr=p>(> zMG-+gOEZ4`uej(%ekFUsy!)Hg1bCnM9%OSY$kVAp*j!C4Q}OOi-G|=Mdn%aQrxe|-^Kb94%u`wubM#{KzMboZySC` zOK3dzm(Na8%WjiGa351?ci@+eBLo|!Z+n>A@b<=m2}hAmshQCa^BR|h8wSiOND)9^ zqs1XJQqi94r|F`>CukcOr>nP*I~ZkYloTI5AKOe<(mS48%`iy6@$(MCF++dO^YV!o zseMcgwyv-+^Ei96z&>)%+_~vWTcn58r!90=c5G<7WHZG!Tfc#nsny<7hSGN(J*5!! z0HRwVow#^!_pb~3&EH?nXFkxT0?EO?A8goAvlrg%`xg#(;NY9<;L2Me<2X!oX-k%7+fJPLJWHI{3ubY%fr<;z$nU+CKKF%| z-s+p2$q>7FWAVG!#s1(^{E#>~rk1Fwd8sSIW_MY}A_G>@ljBx~tNi*7?y9t_i>?cn z$>I=mH)%P__gG9TWH_p$!D$8%?z$_hZ!^a;QhAy?PgU>9_Df*B4$mW_iO0qj*YY1` z6ul((_w3%s_&S%EukGq?l&)W|Hy+GtoWr_T(g5wc7$yEow{oMLG9V0)( z-ZgkZ=x;ueJifWeu$jZ@SfNvzAFW5f$WWS;ctflxvPLI$D1ng_OajIZbL;0i*7~Hg zr_LP(mRY2`Pd-!wntg0i@vSW1FvvFfKLkOIf82G67?gOX2eVdHT^_}jS?M28@;Nhq9zsK_# zecWo2`CAT{v-lF3 zD$z25^uT40T$761g^sG+i;C$y;7dgis`{x=3Ls$vkWOdv`e(#Wm4+^2XeZ_1b#%v9 zuu3Ux*8-k4X+Q`WO>E! z!)}g>)sptHxjI}QA^qp*?2Jb0RB0uqyGOhi$M{DL+V>a<5|^Jv&9z5jOR5cYL~S4` zv%f4AY@oP~yPF+320jimA^~U1zY|mnb6rW*+PFpdqoN*>m@m?X`YVgVcP2!jd9pe)|5riJt_r@^U~fS29_-flLsR8xg)$ecMBM8%5^^%1qoCjb+F!3o=`gopKw z{&;~ACplzc{bZiYlfmpb*_DY!GtY~CV5v_!3qocktjVo+tO)C7n3Ksv4ll;%47vrz zFUcz=l-~m4tj?;))Tbn-6{ZTYNc&ufrH(HCR<$y$95gKi6=;Mr8w~F6`JuV>%O7@h zPc6^0+RN>GY~O6r>)8DeEp#KSOVvaeSufrG$&39md;|Ff+QQcA|J_LA zA(DQIRf~zWLyX4tZDN-UUSeJ%1o8W_RbKOs6i`9m_Pm=3$RWK!gOJc0+|KhExO(YY z4)Ov>8y#-79hh5J&uVGrjrs6{AHM92;gBv6j=m4yz1Nn?7)myrN`0R+CI~(tmg}u1 z)!{u@p<=ynw3DTI=6GUTGrcitnr{b*X^WSsZ6x$D4}BND8A(P9t!>{A zuvR;D6;~Syir+4_Jb03;>UGqG0L+o*Av|@^Y08EDcA;#rx~-ji6p;8bS|`ah{q?tt zP60?1a1w6PfM1zE(9P>M$WK0{iEHlJM2*eKDnOm_uZ=+N^V`N;`&x2I z;bcV{&vE?z)bS1pZh+Wgk=d(RcOQLss#jnn-E!YP+}or*szKRvW-aL**P?Wf80K>7 zmAqH=0qJjY>aW=z7mjUuY~^uK!VN6sib%br1Yk72ppMH!bO%3$6|c_>CDs{u?$6t; zHn2ccuwsvt!k@HBtvWBt?l^R=O{F-w@OBQ)OFs_3-iuSl-Ap`uyVZoR50SpvXVcun z?ce))^&)wTWAT|Yc)?d8ay3WWoU?J%AQ@+h+n1-}#iQ-JSW*hbVwfj5ywor^JNl`g zU5B?1w23~_ax{B^zPVWYCS#7p3|0Rn=@)MFVaMjA!3E2ZgiQQQ!ZJA>;7m`-|7D;v zd`OgxShjjWA<{0qZ8bRhk`u)2Bl1YgHCk=J6YPGq4B#X)BcYJ!wSTAn zyg4!ki_8x9_jE#LnAk_d7|EffJRe)Kt?z2n%^)Gn(gjCgt>jj!7eC$UoNX6p@<3AwiMx7?WoESgoB;XloXio z-;`h!Ae<^Lu~=TMH7%LO!Ra;ro&)1Op+SbzG zHyTJmai{ekqVoSq3G(xhuTmQ7m^7zSL+JgZ1^C^a|IE3UF(JQfupdFIL>9e>SahfWa;)}8C^KFE4}Ez39v9lB zqj4?097FfJx~yy#Sr1dc{SDyyAjF@)z&TZ%n!uVbO<2+|pMNOo`=x57TN2((w1K;z ztFk}3hzlIgMRfJ1l?c_g|1Z`2!lN+HK3~PUne6-XFLsX+h(_KnA(VW~4XV575`zn$ z(6Es*V^X|W=l}9I(+01i>5zoj6H=d;(PrOv^M3>XC@3aw{R=oeZ}?Y~P(k}IoG@3< z(%|o4KbEQYP=61C5#`N32Y&MMbaSO8*_*$wb}d86nd#%0O(eW&)1mbjQE&Nq;nCl*;ICWb88DC29g=asKf2Od zLrL;Q`{Vh_;;`bekND5WXeV_9(Rc(*Ha-MgKb$HUJo*SnZO*Wrkny^TnW%0+X+`HU zPmw&)!Gp&Vk&$MQr9*UExmOM?2Z`ZZZ*;&$;SW@8z4*AQF z8T`twL#%4ibgI+Hd;)~%eaPcpZ=k^HKx{ghKK)C9yDp8fTzy*F*u-AKU_sM?E2r9i zS?qCa@h|g6XxWT}1O1e#IU^Vnq%*zuk`h;Y39NF86^9J=#)>)RQAx#^WW^X*@+B;N*iW;(+ zxm=mY3g$-o>0P7F0(}EA9g{6hER!YJjDl%4Cr4}~%Mtql#6b2(6AEOb z_w|F?(1;iSO|Gc>4-4Cx^8H4H6{Qr+V=4v#JiMsd7`5p>(lQQikU1BGD`2;lA@4Uk~i8(1~mzVgctY2cs$LgTMpL2ygcI_zjol zQ{HQ6r;vHA-HVNhi$~pcT}j!LGyn_?Ydf=xm_zb^C)PIUO_l&Mob!+%ZR^yNdE39% zYv0l3b@;%d%53etzRHX}?wD?QAxWiJ_pp*kInm)eJk^ zLcO(~e@45!gSa(hNuP5E;{pj9I+w}7z1vdhPg=h15Y#joBTS>~tL=bkiAif2Y+erO zL!li<4P_3u=CF`6<4dZDjeC7elVYoi_2)XU%LN_S76EzEr0Q%9ITQp0HYJA2$>?ib z#&NRlDzP)1wVUm`OYhX_O>6>Krp>`=Uf(xOczvO4>qoy<0)E}iH)A{KZZUS-e; z>Fx3U1SH4QeWXvI%YpkzlZ7kK96M|sdy5-VB81;NE`W`g?x=3-t9iiU^RK+8+6y!z z6Jd5#v?R#vKO{1o$Ex~w8HSvtmzY(1D98kRx|y& z3bO=R3{}rg7zoP|%ggFNZ%5C7ot;%$uDEK&D`{GITj(=2pE~B7dr3mY*EvbI_;R}w z8(5FV+$)fEHC(y_tQtOgRqmHUh>m3Qc+V0&G<(3kHoi=Mukedu45ZrLm{Q_=ts zlz*q99ZVH^&Ok@0?vhhgbWc**hFQ!$nzdo2-#r20IXuKicx?pxUggEJt1eHi|G{tS z={`}reuE$beUf~MP0*m;C0l`EBU({gu1>^0fv<_=pY zN(|Pm=~cBeLBu2G9c-ZIP!^PbY6tI;yN{}y;cu^ba*D|m;5Je>6@|?PtFTNr4z7RH zFx4vm@npd}JA%OF+~rQG3IaBE9$x5<;ts!oo~LK zkJy#9?LH{F37OD@+HmK0i91NvJd8z8A<2o2lo&%K=i&KF*XI@(M-`tua#gRU&= zm#4(P21A_ZGSNCu6d13^1_W(~Z7o?G+`X@k>P9MS&!*oNBbW}!tdHM2aShRkpO#$) ziohBzA6Iiz2}?sTs}yu&!^7DW_@%1)F*U8&+gLrkPrhkvxla$7PiV0zBboNzDm3r9 z>^rQ(69?U_WJP%`G~}7EW`5k-D^4Iy)-|Q~`i7e)uiQN9Wf8-b7RyIjc9~X8>8icX_SkE+u8Ge=V5oXxyyD*(5PHs-^}dW(J5T zu0{x=ErGl7BZ4)vEOKrTTJ|2h=f$9GB$a=Kyw>N8-YWV9d#Vh+WsJB&tMw{j-c^-H z_eB+=l3R_u;!I|gIX}x4?Wpp_Y`NJ6Z_fVE=Kg6sZZq!)Kzrr-Oi3IIM2SEb;greNc7Tksl=@G48~y?hI#p1i2C>#AGE(3f$SujArNGs`7Y zAgq20nw3_E7v=qEpQaDD;A8KNGzA_O2wp#G;A!~gap$$Ogu;GJ?jetOo-<}`@1^ehSviwXD_>Xq*x1H$4%wqHCSjYp znpblAv!b=_vZ+UGxt(8E+o;6awrARE&a{5|n3`Fe%fc*kAlF~=2y%~kscc7i>{`T|!iU>}jm zpHs-PQdF^=F@&$1Y4v356|6A4EbxA2BYc}Ro)o56*%Jeb7Y}HZ>P{*7oB%UtY9kJC zPUe2By!{wIk$~IH7A~?ZM8bKsGb9;RTUO6NBT@bJd~q%D_O@o9U+dZ5VN{k6i@Izb z77gmbUR)Yb!>b3*%No59N%Adtsag}k0w7F5>x8JR=fizY55r8P>E|V(YHwt>rLv>T zC&W&*EvKZ%m%R&D$l_SbwnMmI@ZsOGKK=1gWBM=I=&71+C(oa;d)u}YTXc$_&K?{qNuzwLeC%Yc~BT3w;RKU&<@fKM#{3fbR zK_-HxdVCx|q2@zd6&4G>pQ4?mD~$H}*Qj!;Ol0o01n;_DZkS^kJM-_q`&e8F7kVru<*v-aQqYIulged>8w3OrqRX z%>k(KC!B#B={GmGRf2f+_62+=W(nhn?Y{AGPHipm3;HS;WpV`jai>T%Z}R#|_wrUPY_oU-#Bt)O%iDUcJ8A z!*d=O|G7-Bq$*0d0pj9)P!xDHYg0B}t*vl*;ib%Ob>fTG{9f2Zy@>+39`Vu_>`uba zx&ic&kl#Hes*5Z|=laULSPNA1GQ{g=5w5n~*PyTNidCfGS9)QnQj;4NnrYy&`?^Um zoI}INLYrO+ocBZqs+3~o%^HIlCnqE1Ey=a_(js?qzb>lI*>YP~c=f}sJ-Ll7+GAoB zn7KC{{=uMY_9|231LM7+IZ;7LRjs+4_FI7G5h^22?_o{Yp?E>6a=h=tmO%5+gD%gVYwwG`4 z7-Z)B2g%jeCAYix#W?&z#-^pPMRl-vNw3(iVAW@_w%kvQ+A9y7+4GNvB<@>poPVEO z`Ov_Kt%D{)H*$ej#0ET2Q~zFR0y4_E@P?)D&72YABUNdK?^5EuK(O|`nEtn>D3OFz zh-jN*nc}Pvc`DE+zPO~QbgfT zHeIHI;d4(GHYG$=Jn72gtqj^B8huT_{4-h&m=`N8z@d>MB3@Ig0SzW~@H(#Fnj@Yn z*vS@lIJ5Uy^vO_DAfOY*u)O^3b3`Me-WbtPisEY4Zx1>)Dru?*4B51eI}E1Zu(k~< zTr)M)(#j@dI!hb#C@hmH!kmwc+vzTxZ3WAX&}Igj6L+P_^LPPG9;r;<_lDV-&OCs<#GP|7-iCWT43#@vBbhHGY{> z`7YaW^2t-@Lk<&Fo#Q*o{#&1w)Km^2P2Gno<%jDUv3ck2tYRX~k5$e!$>hy&9zTg4 z#;vmXOD;=DxmOtq9&GQ#=0VAO1yayaSa0HSR=5s%0dcYSfq@(0SzWjj`;bM5673ZY z>O!H`QJ|92p4gb6Wc zw%dzw{Eci=^lP4+If1R10?25T8S11m@&mLZqdu+d-!ml?6c7IA-NfDh07v~JTl>F2 zuKrWeD1BPM?2o%02?#-R@~IYwrJTQ@>2A@#pt_M;^J2bVgvsY<*dih|!zRWhyaxW7 z^}uUkWrxHkjc7Ryrk&{!*#C zYTDpr0S2GwMz8`em;8Vm5%Q zK8mWC{!bk*O&F+&i+Rfal5?@AbC2blm7|9PS{8wBpc?VlYgK_w-tcQTn(~uFq{Y3} zrbMHH=a*fp0~UnOzauh@hnnxoF&L-Re71Vs`jq-PlwJe%{A!_^wPO9`)^rIDT?k6$_FcosHJJG}OR z!i4pYnl#I()huKp<>u|DK~h14%;$>qVKarIoNKoqfW{l#Y%>nD>gn=$sXuiFBAmtThIsi zOc~Tw3F9C6ZZn~z^8yqh6YLS_FOQ2jc9a16C*g{GVZuGxkCn@*wGVbo=Gz{v+hW8-Lp8pb70mSYa(zL{hW?3sxure}@ei z_Gro+j-LoE0jQ-YebFAIm0*6N$~t@;=&vNFG>E=7@8V9$>sqwzq|yb<+?XwL@1Z*?#D!X@Gst# z#4g?35qXR-e@L!83U@z7h;M2&Wb@Gg8Nw4d3C-R%p=o8)74kkHI!6MAdIS!XnU)OkC~ zKQD~2^dNi{bY~pz+Y4QI6CipJ?%hSIc-|5%+{{0M4C&C#p@5a%<-xgy<&>!GG=M%S zOw|}Ld*;2d$*ShSOoX0d+U=`ELbN}*76dLamT1{zjVuWVriLmeEdm0=6l8=7Nhn(? zURSc~wU(Wlxuz^ta*cMlkgIz`-G6vO>b7R5ne(IF>$HIupRTU)kCjAa24o*fnQ_>F@f7xN!~WEN`%pP2M(;`Y+avDK?z72 z=d(*s;@L{QkZLloS!}C**(C=y_-akaJ+e0%*I!iaRxE5~)jM~Kz?QcZ+c>_P&5P2p zNfMyn}$Y-u-Acd&2$Q7U* z03}mr?&gT`n7|31(Nu ztn7_pWdn;Wq(pt`ONPDfO}TsOpOYo&W@dhR`xVr=_;3bcZa2k+rd%SsnFN%$-z-_g zE`1iuCQ@tY-7lQGi!i^BGf_4hN%*x&v{zU;F}Pd)bEBEGcqyOq4vrQ!>ebmm7tT6! zyMoN2+;h`xS8)vM1xI3mqxuL0uX~y6gnY>H*!R;H zBR`A;WLniCg?wr!SQINakj$>^g+HnyUl~EjU05q?lJ!ho1${%T4mTkSP|hThBPvfi z=Hl?)@!0Ys#P7mK3QA}8?REpm2D4?9;z`CRie=ip^r5VovQPHvn0vUuAuoo@o<^__ zY?t>y@vO+D?Hb$8zhwAY4rqn1jP}yNaM4Gxb@OSW;e^7@p+#|^=Mn4S?K$g1)4_A) z`k%wcz8J@+A7+2`d?hdc9%@>bgGv-Eade|S<4Llg3S(ppr(VBheqQyaLob^?g!5+FDv4jT%7ZGxri8sO!QWy#}w1Pw6pQeIXHt`z_+dc zcUC;TCCpdO#R&o~y)dDiR;~EUp%U|~nSlh>+#o#O8NhIeDj_KO>%%T5V$+y{Tr5w6 zqpXg(7)hi^+eEKFlQ`=Qd?hEyC@DM0e#JlOyrC3PbL)D7Z5dQ>=h3wi5L2n>-*WbL zIk1291GQ}bRx_Xwa*l7J#y*#PK-hK3;%~w<{FQuupoE+>(dwIpXdtiu>!biJ;BVa& za^%cW;YVXDQ)vU$Wy5JdMTsdtMMS8;-=*&H^)LS|dh*|=QvWvJ{r|lvnM$Q2%|S{? z9dbOn12^Bdj=0nnL3+(=2S?Gt;rp)yCohA31dh_|oWWclhc&v%xyfY9Opt#b*>!IZ zKGiPK=l8Nq4Ml;R)-Iyh1p#R5w+VknE*P(;ggl6$KJ;C72uT>5J%tK72+{m=z=NVc zUexMEIXT&X_fK}354mmW{{s0}*YHLBU*?KZNak!1V3pb}+g>511|F;{HgDIjw=<&= z#~SF|#VMjL3}?D*=6pDFj4qIl!F{ho#paD5sFpL{T)w}MnFG}57>P1{LZ%mc-e1pj z#N}%cmnAy9kdubqIvuOXptV;2gCFP65Ww8X<7V95Ir#@>G@bJ{CT0JoLh zNcuTc4y_g&Nq?x~A3SND!8F%a)xk~6Cg~J8MJ!yTL zzqGFmnvs3QI-QO1T&u_!;Zg?XHz}6?c%ye-P4;D-KYD_ME)Ucz2{_&=kmEjDzJM_d z0T_Gq32vQ>fe6vaVSaX$oX=U^6MP>P2xv9}X~yl7j7$fp)S`}}emx2dKO*6d^>^fs z>PeWK?Z7(Y(z5bCjQJ&>;oR#5ONjvu@Fiy!&5q#}e3Y*q*zgU%LGks= zVFkl#7};4@=2Hk^dx)`Y{h(a@%2%^PPDwQrAR=(j)sncBj?kZ8z)G@?)o8my5A~U1 zvkZRjU#WKDs9tms{c;@RUwn92*tT=loZh*A7>ICOk3TYNVjl(*LGmY!J0}JR>W`L- z?iU-`PD!68rI;CmUI5rwOFA`Z*8=5KJ+~5%>$OcjB5{d=J^i^+0Q=Oc0FcWIHSFQr zh3^7*NcL$kd08>Y*bnNO3DVr#zwChb)Lz({SuU5?bDG$hNoZ~cAJ5%<^z`EnyVsG{ zC~+ht9vgK8}s?p&(i$ zf_*{a4!SwbN8|1UmB{^l9PQ5wMf{k6iX$I20!z@eE8L@TW(Qy_Oaiv?9hmOz%VE9- zfsY=L{Qb@89dRc1mLG(>+`H#>MZ! z6WY@mtUmd-Kh3|gH!=3{Pq$~f+_%iZBC%asQ|5@O^jlh6(n^+eA&lm{06$(lwZe)t zc&r(_X2q;Yr(@5n861*(KAmzq2IPuvOej{-(=I|PPnUa=sway<1VLcXj!#fCf$$@+ z&{EM6SiI*r=h*0?zkNn^>&1_U%a@M}fk6-BzKZ4^B0U3F?+^zxYrMa9mbHxogeyac z-Tux;C3o;OM~s8Ab~{?E_=t-=2WakeuO}5%^WVzh9*%KUi!#|5y&I zAC`R_X=8o(B<9ijJGQzq@cs&HOw`4!}hS>%-nf88=|Zs zc#!Zh-LHKf2qNz$Z`rOItDyz(#l&;2-_)4l!(CTwH2H5naJwPik~+deA?~oLpEIl-9a6Huj+~&bkGshq(42wF9hOk9x2+eh3~GL z+fRWp@YOn7z1?5sXt&OTz;++_0ih{Z6?7yIxi~%}f07D3!+tHb*>$ z;h(L{;&i0OKE3<=<-^MNqsQgD;{lZtfT{7|<&B@qOA%fC^oIhaVQ>Lv*?n;?DbN&jhAVd)`p^tqkNXxq!8(o$2`7+yL^nr2JLF%?Rp0`mqAIRMhR zA%e2mZ5l4a3;gAd^FtbT?qeoWK0UjE&928voFeD2!!^|CfmwooY)WQasp_!e#DlUqN}#!cQk1mx&%^P(>z?rw$a7HyY3xA@uGUj$cOx%w=!3qsnq9qxt!L8X z=c8NSM;1n}cAH#4v8#>4;QEQHdvCyU51z+*E$3p0PCs<~y<2hP4L=NwwGQIV_P=0# z8FS9vIDYJBK7xhIiE`ej{ZJ^f;YodT@ooU1`n9qzg(Ta0HH}n3E@frOjOf!i)jV{w z#HMQNsWSb~_v(E$ubx72j0FtlW{SP5PwvSk>OZl(AsjuRAx7XW*@{;ecN%;#(aT7g zS`Dn@pm%g^y(hDQ*=r#~0zuAE-i|5xYD>Pi-5icj?YRUzro8SVDlSSGDXH({1+7v$ z^Xx;!ok`gqePkM_C+tlCNi8W`5|Lpre{}gSi&)DY{r*Bu?R0CN zp6+fBZ23~L`Ea#y3~*b!B2Xs)Hyc>O#%_BzbGmjHO)$AzWGIi~ESs2-Dwlf8slevr zdL|!a56e}JfaS1r-+G0=e*5JOU^83RJyQsO=%N?%h(l~8;U`P(na7UsKI|}Ab?wdv zgYk_n*C=dW8+6-$3IrYBpYQ1(Hi_crSLEHozOwK7XilIXv;OyJoJQEA+sW_Z&m zd~6fCv89NYIgo!h_mvp?DKoB&JlK|>fD@w1gpwko!Ou}Crd6u)CK}6Dt>W}(I{PYg zU1gP0{btmL1bfu3uWmO#~)a=a^p>8)EpQ2y}hdOfvW!f2QP4DF1B2zA2ha$H(+m4bRGZ1CLfu?x(8k(naK3*dVI6I+-QaUU4@Msgp7X~pUx!$^)mz<5b)BuN`CVLs#$&hW^ z=S#toptNr<=L@WEzZ|=OMSV1;q%H{DXvKQ^yRh4}L9-1~pqlD3wlBS!1WNVV z4OgYIdS^Cq0Ic(_J#&bz82$Qwm6=WPL8_`ag2X&7x8D9_fjTL_px)DqDmDI-%REwB)R3f?F~L7p(zP&X9^0It(HD%***(YjnlY_wH~_+ zyQ#D&Fu>LY)*tT)^p)?qZ>!He-Ou|`v2W;cKyKknHY$&C?=*4>pjU3aj`c0!wHSq@ zdvC~Y&UqHdE+1l_Ipy=!i|EMX_tnw8nufj$3Q#Pg;$2WTp*7>fj;560z3<1Xe?h?C zQWqVnzTvdnz|!x8nA z+w#aZ3u2;}+_>GYnwvE1Giu2#q*=D*Y{?V6*1DXb@c30KP7A%v3Z$thIx{p>4BDrh z6dz}kQ)XaJdMCsc>;to$W7a`Qm+TvyMm#mjS&*oeOVG9b1Hr< zEWXJ^a`1Oqbf@wJ^swwacWh^>2Qi4Pt`~xLtd8I(mmZ35c6?ln@qQJ&=e1B9=xBcp z(;r+3oe~3nAxNFuZmN?O*)Ff;d`Uhrts6^sM_|00-I_+u=qtngp^T~##&hFiSDwhB z_~hi4Ebz1eWY1`s&Uy@G{OOmk@tJy`^1*?SzOz@}d}a+|8J0bLOkqB==)45`T%5|v zGpwrkiB0E5J2}u0v(|V39WzDMnMICHT&zzwKjW8_x+(VQqphUnb9yyx!wMXKTLrpBmuhk3%IS>} zGiouw+@I{YR;Nv`#$O){H^|JN+LHasHhdverGGzI-o-D2p~)JgDh1Ym;Os~;Dqq{m#0$Kol}_x79C7wAWP zYbeqOQ9pHk-Q`8;;pO%1P(qPJ=><`m_mZr_T*W=bQ3T3vUw9h`f1PEd+vvj6K+IE6 z-_;QO3AW-;DWBcdShvJ4n|@|Y!4vKug`n7+`r%nmOqX7{8=Ozyu=R7(LNy&f@%)Zr z6f=*EqWMhgRDeB^k@4q`Q;Lj46^zI6o;KcV#zT-F7G5@2C>k#Qopf5~8j0%K&V%(d zdrGk(R_7&0W2r{q&a1GSWJ#l0Gv5qyAzSma)rBCt9T*Y53F`ElKSoe1%+v$cTB|WI zmOm!zj6^O&Y^*DLUUW$0WhU`#z7#!otL6f5(h+^dkkB9SEhR(F2=aCNP>hrgq0b*8db zU5=EvLh+S31tWcw;K2j2*O8zHb`&SI3HWwI zDA}Fo6{+eK*%Vo^v^2k{uwpK4yaT&;e&Cvg0UMmc79|33QyEu`@G42VyuD*sv+Gtr zY$K!ny&p!l+RgFkap~TcHk8@cfpN!3n}LDRrRBUF^|?@v=~H#6`i<8M zRW+32s?@=q2K@F9Dcv%VYud|+Hy19s(1-L>wFb042&(ga0rvAbB4XdEpuV{6dG)1< zcYBxDRBuqMZ+=C5S^sGE^m;!7x_dmf)X;E<$SC`%3z-&CHdepdg}Jq0{kC{}G=gt9 zJ%1F9sH7mJaPGjmAcbDS?KaX~n7dCtuZ4rip0lX7?z>r-kuCUP&%Djr1N6DLxLUj& z(&)-bPft_<4+7ejE~>c#c5D0KP?Rc9dqLEdPw?~at2ZwPzrC-1AqdziEk0odbswJ9 zqBjJUC+MNrftmG8^OBdJvi#R|kgCSN4k$93{b8p{t(p12L;m}H|-sw+Da!GUn zu`4uaA7k!fUT=~fCk+r0wrDIJLDAG^m~DoyoaCqYFWjvZ!q zxf-H(mxF{ z>OegJGZ=}}3jzG_Nk<#yN&hJ0rq_{yNL#cUpi&>7&wXDlslHqUb1|UJ6ipU$a^eqt zRNBBFx3;jN~n^nwdIv{j zLK&o~2K{3RS{+`7BGg&S3fY+!ujupkM}pfQ1Z*hbsTPI%vTVR(Sg19;pLemCfjh4r zNO|^Awqxd1+I^1Nnz0fYhr0p|Us_*o#$FnaNuQ)pp;)yLCvz5lUnWdQHx1oGd`-|GW18@7TTLFDHf*DKf{-q@C;3Mr`-liX`hwQ zmmRHe3UxHAjJZ}$H9Pkn-vj2r4v#I@F~;r37wqkbkqO3c1RVEx1}VB+S}tx4U9}@~ zg@Vq!Y;C?$fahgV{Z3xY42b@!%!%n_F48hh=n zg2kIo;>6LmEp=CCgvOWcMBDWCN^K@+UT=I;GT)VerrR?;W=(W_OOGh3Bdx8K`2e9i!X+~GT03U zs-Urjj5GQx6)<5#b?yL{$dfz&d6L@Jqggy;>0)_1y&z&fwYMP{zh3b8l8rr$Uprmo z?}r{boysTs(4T^-q_J?nbi-WgWT|b5jDxN_Qv1lS4Q8#32f%1n zi{?O|`6 z|IIAAO!e>XuBLw)=Bhm8>ool?=Vxtl@0;~w^jNNu{#oO%2lQut-{-+T6jg*jS5htx zMs|k_vRDv!LsrUXJ%2~fuX#zS{UIy*FV^{|i|oJM(*JJgeEc?n*W~*LEMEJ|a%LTY zVpZ6)V`O<-n`8`?P}wJ)-?{rI=4R5C{1WVavemhloMWa#e5sfEw{+TQXg{@+&UA=IZvoqw+u) zZ$x`V2l2?*VxBxw$$G5+nKyeq_Bd+ri&-WvL?mz9)6{o=S!DN_Hd`mdb+7}qio`w7v?7q^Tjy>-Dn1xZ2;i{NA3I3(sj|!HX>MWT$Atoz7Q~NOS z2oG^_bXg_TK4tE`!G-SZVaY32V!Hbj7 zvB%`w?}V-t75DuRJi-Y6}l*dcAq0CwUR9S#?Qioop6tDkA=%RsJ zvq$ZV>nTL;C9l(ZXVhj!(U?*V;?I1bi^0J!Ck7G$P4b}p_HOf~ckOD&IZldN-P0Vp z4V}Qt25zSs`{>E#so8P51_Llb^aqfmvP$A?WmZt5@nCLo)L|jB+t>U1?y*(8d+G5B zeK=8I#Fv1IG(?G-{7N)WlX#qjsZesnZ-5I0x zvhhXM(d+`9%83s5)LPdt{=+i;nszmT-MOH1eYQE^S2~(~fBizfLE*7XDdRG6q>J}f zcfG}AN*9n-UiaW|k))MXYR;$pQ#Z{dFrd2m0Y|dCY_y(PApJ!VO zNk%C-JIUdLCm2?X`LEK6@QS!|c0n0X{ss^6!lU36lO~^ioDOC*8y|6`x3DgfmD$Wfu~Dc&TXU`t(_u7l-OA;yRC(JI zhxdbC1;20%p&xUsGUeT>6BR&$qP~eL9AQ!r`=v^QWc}u37&zDqE2*wwq|$o3^LSe6 z#)+N7{%)Thm3&uELP%rv_@LNr{XGFHE(6QmijyY0he|Qht28kr-Ce}+p6YfXp^O9> zwt^Wkd7wzHft70kb{pab6&&qxqZi2qDB{QXDyP$pjC%-Z7Vm+g7R?JM&Vkl4ba(HD z_{WVt0GQ-Yl=qIiNLRKn4xB(F{>+Jd+!gPV! zK>6F{X`?7)_ZF7XSl{L#>C%aPnj=lC{5Ej=Cvm~jYc01=d8>c>rJ!}Vs=}n%GlGY z*c#|Oh5WpyD+p4!c|j21rlYl7=+$zS4cfF1nm(&l#2C?>D0x5-FcD*^j=Kkm8T4}YG*#5tj1_gABR+pQ z$-Vwwl~_+wdQe>3ZH+kv9R;nwY;*PaC@)#Mye$w~S0Fij*jJ($PH`sy>fKgP&Vz6O zT?TuR4pN-#BLTLBMu2!eb~r`TJ(p}6?{lb5H);W^m2PL4&FBIN<4TxoWq2iNULva) zv{$gKwB3R=Hqt7J0=jH^-SXM!P3~|{URRm}JN01}Eaydpu+d^%7sEH&D>DVH-XRYK zQqi?%h!sbCCS_~;qnVPf6BDmjN>>HU=*WU>BBjI$BuwGStU`(CseZ>69akyDh25WX zKbJ4Yu#9u^bocpOB)O9y=p8fStj%wtN1ff6;nJpgzcQr!)XqE9?(037(~3k4)L zcug#gf1*L370z$jY91Ys@(mq1L>g;GsUc2=OB2cZfRbGgaaxnqZ&sGg+#@L9mX@N# z&Sk_v?)RFJZ{!TI<%xlR_n>yzQpF+ID$1cU=!}R7Fo-(Iu`+?}aGlLfu?#$rwjsLN zgcH}=DY#42;4tad$jXlI+W>hEbAOILhl35_*v<0s2SVS`7aMopdybQ{T9|&_9XEY= z+%xWjVjmf9@cpn>-o>(zP1#Pnd$*yzJYIXkgJ$fRDd-$$9ST^%owVz=1%Dab4Nq%$ zTeFM(s?Gwf2Z-jCc*quN^`_Ba>rOOjPQvI}$K?BAxlzF!M;Ot0XVlRY@=PbuYufjv zPQZlD;4M|z-p@bZI#$ONdo$U@wzDUXdDM@GBDeum`pJ$eQIy z*Bhx=R@q*LcuS|PKvLl%PUG-q83^2r~&SfXwe0L^mh`T z+nq&2w~R$v$dc0;W#&pgQGQ<>0nTp2qMnP3GSa%?%y;%%KEBo`g}8S$GwwMxPM|5b}Llnap zUEOkzvC?dUOlDwGi%AaqGd4HVE&CwvR&InyYc$0nO?gYn1NmXc)zywtggy5&u5>jb zMV!eVtuf$fU|R?_j?h;4d?yE+rjj}$6y=UHc1Vtb)OK-aQaPTH)SQ00BKAW=paApi z?Z)9*c-=y|8c-#UuV8+cHV0cFJUwqs)0(G7t(rD|Kj+@O{`%wV{MlW%+>@dNMTbjI zhZ?rWyZ66y?QsWcQd2BENL#$yf5lHXY-~^&S{#Zu%+5zE$rp|OHdu$!-r#pOktiyA zqRth!!)BjvYEBxSVNihE#Lgl-VS$;xWKY78!4NraEnIS-rL2jYgv!RjY=( za`f~aLv9+rZNa$~olIlhygYD^TOtcE<4*ylu@$(?{cO)L>ZXjuUyxi==9z_+tEIYn zpWs9&Kke);tYa!s5RhITMo-DJxi9{m!jl_Jw*v5&?~o)j0!_aZqjOGcC0hSDw^p`q znZB_ZF~8aILAWEeI)-pW-1e)FdlldFfLW=G>Jx~qPttLf`kIfot3>GAX7>4x=jp&m z$HD`s2bP#k=R!aQ)aHJk7LQb*WuG|qdH;yaeG+TqWza6gHZBLmL0(}pRZo8rn>Ty( zp4u$@ou##v(!&#RApu4**l#Rn=2I+*X9z@{#PCjPA^q6ZNddC}@=Irsx0Kf^dS}KP zy{!+0K(?my@js=c9s3~)Q;&XFyHvlA-wOJ>Vs0FR^J|6_c)zyHVJa|f6W_m2wfedh z78c%U5cu-D%x`a{eEg#AxxNuDRjVBLeH}j~==?Z&2?bD42<)-P26y88!#U;BzbQLp zTWv(W31u`y~_4a2>tocPBU>@23x=$^NvZk*H|&} zw@AA8XCRhCP_T=|E2*AWQgnA;V17PI;@JvjwRpqb8)7QdiOptT#L;QQl5v+DS1y(Q zY`g+Mxm&G>44=h^^u4mJT;hp2-WH)HPRwVdJ{;59xLSM6lYETS;4 zU7xAJ{Gf4cTRcvmO)E7+wXs}CJW}jX9RF~&K;;OR5Ae%?9H~>iEB#*3Tjt2#BqEb2iMh!ZNQY z80<-m(u)u~sQB!cy1H`yJRfj-z}1-iW1J_%8OQBP5gD< z1YA;ch}xd5=j=+axHu}n%C%oSD0bOHiL8#<{(XkD(PyF!nR>U(4bhFGx~S+e-0&|y z&B_8rY{>I`o%N&`Ej~r5=tOQ@G#NVW5At-jkxZ=02p`Ii%ENgXyF+;6pClaCTAe}8 zhXW;*<4h#h)h1Toz9|-J=R_!@GH5yhvCk-~VbV9*3L?kKoo0fn&CjPFI(ur+^x<M|b3rXG zOjgn7&pHo>Jap5Ip!2$Dbu{|=G2Diqn*DZVNYqH*iSh?8`ZWj7Utw@S=Zo1zoH&jl zD&8mH1XCY?)Pb&^RLvaF?8Ow|5O_=5-kEtlpwG_l$X&7zUk#@{&vDuliSsZW-137W zo%^|py*563?G4>-nHU4h9mnwmS8^PO*ayll#q&j6%%@tYw(vQ!*@iPe8R%TK?{=KS zsb)|*Fnpb_TBvvUF(0MDuZH+kEGLY>maR1^wj`@&_}GMV$Pw+<6t;BUA=m?c?JWNz zkY*vA?OT8qinJ)Kuh6`cZJzufvBo7}KFcYNiFzAmc>Yi+7cjLV-jsMMWgWx|)B{%Z z;WKG>G~HRh-9kP{A(G!7aZDvv(8--8R;7sznSR62lTClz3Bz2cy8@gIUX00!F!LC) z;flw<@X~$tc`J05v7}w-V&$pY+m6X_1!>JxH5PrgcQ_E7Q&rzya*zE2{;v7(3rE3_6HKgQpY@3!?>TKaW#nWTT65#TKCdoSuQ z(Mg<yx z|J|&;Bm>eb#koN_ySl$Y%~sx=R9K>CP5~h&A^PegE=}+^Xpp7oPWsbqS(R{fFXg@a z>Hdly%ir+qiJk9)H=yj(H80BOKg5aunHY%Vz)z9z*;VrXJ=+_)6__Huy7zq=Q;HfU z!`}>eOsScnDOJRV_bYyb8J!+3In@~gP9lTfyDMFf%qw)ho>Ff&qVmsN$SHsYZm#(U zHA%OO|BU<@X<4{d_ond0`0q89gd1`H8%A-HlR5M^t($CJ6PqDhv*4c&+B|!efG&Pq z^7$V$g*On5Scr!Rq~j1LdQ;}AS-!7nr>gaS64l?=a?M3qQ&SV(oJd!*JJ(pvR9aa0 za;Dls^BD2>#a#Q!%EhIQKp@_xne#JAS+Y^e4cS~K{QhyvP4j>E6#QSJ!v7Kc`hEFb z|GN#uyu%xUKm>6}oLPYD_pt)rDgElBeu{d6WBgMMImrHw` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_common_pools diff --git a/api-ref/source/api_v3/common_pools/querying_common_pools.rst b/api-ref/source/api_v3/common_pools/querying_common_pools.rst new file mode 100644 index 0000000..588f646 --- /dev/null +++ b/api-ref/source/api_v3/common_pools/querying_common_pools.rst @@ -0,0 +1,160 @@ +:original_name: ListCommonPools.html + +.. _ListCommonPools: + +Querying Common Pools +===================== + +Function +-------- + +This API is used to query common pools. (This API is not supported in **eu-nl**.) + +URI +--- + +GET /v3/{project_id}/eip/publicip-pools/common-pools + +.. table:: **Table 1** Path parameter + + +-----------------+-----------------+-----------------+------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================+ + | project_id | Yes | String | - Project ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **32** | + +-----------------+-----------------+-----------------+------------------------+ + +.. table:: **Table 2** Query parameters + + +---------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+=================+=================+======================================================================================================================================+ + | fields | No | String | - Field. Format: "fields=id&fields=name&.." | + | | | | - Supported fields: **id**, **name**, **status**, **type**, **used**, **allow_share_bandwidth_types**, and **public_border_group**. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **1024** | + +---------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | - Common pool name. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **36** | + +---------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | No | String | - Whether the common pool is in a central region or an edge site. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **64** | + +---------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameter +----------------- + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +--------------+---------------------------------------------------------------------------------------------------------------------------------------------+--------------+ + | Parameter | Type | Description | + +==============+=============================================================================================================================================+==============+ + | common_pools | Array of :ref:`CommonPoolDict ` objects | Common pool. | + +--------------+---------------------------------------------------------------------------------------------------------------------------------------------+--------------+ + | request_id | String | Request ID. | + +--------------+---------------------------------------------------------------------------------------------------------------------------------------------+--------------+ + +.. _listcommonpools__en-us_topic_0000001543023733_en-us_topic_0000001455540341_response_commonpooldict: + +.. table:: **Table 4** CommonPoolDict + + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+=======================+=================================================================================================================================================+ + | name | String | - Common pool name. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Common pool status | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | - Common pool type, such as **bgp**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | used | Integer | - Number of used EIPs. | + | | | | + | | | Minimum value: **0** | + | | | | + | | | Maximum value: **99999** | + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | - Whether the resource is in a central region or an edge site. | + | | | - The value can be **center** or an edge site name. | + | | | - This resource can only be associated with an EIP of the same region. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | - Common pool ID. The parameter is not displayed by default. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | allow_share_bandwidth_types | Array of strings | - Types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth. | + | | | - The EIP can be added only to the shared bandwidth of these types. | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request +--------------- + +None + +Example Response +---------------- + +**Status code: 200** + +Normal response to the GET operation + +.. code-block:: + + { + "common_pools" : [ { + "name" : "5_bgp", + "status" : "active", + "type" : "bgp", + "used" : 99, + "public_border_group" : "center", + "allow_share_bandwidth_types" : [ "share" ] + } ], + "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100" + } + +Status Codes +------------ + +See :ref:`Status Codes `. + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v3/eips/binding_an_eip.rst b/api-ref/source/api_v3/eips/binding_an_eip.rst new file mode 100644 index 0000000..7c4230f --- /dev/null +++ b/api-ref/source/api_v3/eips/binding_an_eip.rst @@ -0,0 +1,491 @@ +:original_name: AssociatePublicips.html + +.. _AssociatePublicips: + +Binding an EIP +============== + +Function +-------- + +This API is used to bind an EIP. (This API is not supported in **eu-nl**.) + +URI +--- + +POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance + +.. table:: **Table 1** Path parameters + + +-----------------+-----------------+-----------------+------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================+ + | project_id | Yes | String | Project ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **32** | + +-----------------+-----------------+-----------------+------------------------+ + | publicip_id | Yes | String | EIP ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **36** | + +-----------------+-----------------+-----------------+------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameter + + +-----------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========================================================================================================================================================+=============+ + | publicip | Yes | :ref:`AssociatePublicipsOption ` object | EIP object. | + +-----------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+ + +.. _associatepublicips__en-us_topic_0000001543103905_en-us_topic_0000001403541982_request_associatepublicipsoption: + +.. table:: **Table 3** AssociatePublicipsOption + + +-------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=========================+=================+=================+==================================================================================================================+ + | associate_instance_type | Yes | String | - Type of the instance that the port belongs to. | + | | | | - The value can be **PORT**, **NATGW**, **VPN**, or **ELB**. | + | | | | - Constraints: | + | | | | | + | | | | - If neither **associate_instance_type** nor **associate_instance_id** is left empty, the instance is bound. | + | | | | - **associate_instance_type** cannot be empty. | + | | | | - A dual-stack EIP cannot have its bound instance changed. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **36** | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **PORT** | + | | | | - **NATGW** | + | | | | - **VPN** | + | | | | - **ELB** | + +-------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------+ + | associate_instance_id | Yes | String | - ID of the instance that the port belongs to, for example, RDS instance ID. | + | | | | - Constraints: | + | | | | | + | | | | - If neither **associate_instance_type** nor **associate_instance_id** is left empty, the instance is bound. | + | | | | - **associate_instance_id** cannot be empty. | + | | | | - A dual-stack EIP cannot have its bound instance changed. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **36** | + +-------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+ + | Parameter | Type | Description | + +=======================+==================================================================================================================================================+==================================+ + | request_id | String | Request ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+ + | publicip | :ref:`PublicipInstanceResp ` object | Response body of binding an EIP. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+ + +.. _associatepublicips__en-us_topic_0000001543103905_en-us_topic_0000001403541982_response_publicipinstanceresp: + +.. table:: **Table 5** PublicipInstanceResp + + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+====================================================================================================================================================+======================================================================================================================================================================================================================================+ + | id | String | - Unique ID of the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | - Project ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **32** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - IP address version. | + | | | - The value can be: | + | | | | + | | | - **4**: IPv4 EIP | + | | | - **6**: IPv6 EIP, which is not supported currently. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **4** | + | | | - **6** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | - EIP or IPv6 port address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - EIP status. | + | | | - The value can be: | + | | | | + | | | - **FREEZED** (Frozen) | + | | | - **BIND_ERROR** (Binding failed) | + | | | - **BINDING** (Binding) | + | | | - **PENDING_DELETE** (Releasing) | + | | | - **PENDING_CREATE** (Assigning) | + | | | - **NOTIFYING** | + | | | - **NOTIFY_DELETE** | + | | | - **PENDING_UPDATE** (Updating) | + | | | - **DOWN** (Unbound) | + | | | - **ACTIVE** (Bound) | + | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | + | | | - **ERROR** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **FREEZED** | + | | | - **BIND_ERROR** | + | | | - **BINDING** | + | | | - **PENDING_DELETE** | + | | | - **PENDING_CREATE** | + | | | - **NOTIFYING** | + | | | - **NOTIFY_DELETE** | + | | | - **PENDING_UPDATE** | + | | | - **DOWN** | + | | | - **ACTIVE** | + | | | - **ELB** | + | | | - **ERROR** | + | | | - **VPN** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Supplementary information about the EIP. | + | | | - This is customized by users and is not perceived by the system. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **255** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | - Whether the resource is in a central region or an edge site. | + | | | - The value can be **center** or an edge site name. | + | | | - This resource can only be associated with an EIP of the same region. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **64** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time (UTC) when an EIP is assigned. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time (UTC) when an EIP is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | - EIP type | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **EIP** | + | | | - **DUALSTACK** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic | :ref:`VnicInfo ` object | - Port information of the instance with an EIP bound. | + | | | - If the instance with an EIP bound does not depend on a port, the value is **null**. | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | :ref:`PublicipBandwidthInfo ` object | - Bandwidth bound to an EIP. | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Order information of an EIP. | + | | | - This parameter is left empty for pay-per-use resources. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lock_status | String | - Frozen status of an EIP. | + | | | - The metadata type indicates that the EIP is frozen due to arrears or abuse. | + | | | - Value range: **police** or **locked** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_type | String | - Type of the instance bound with an EIP. | + | | | - Value range: **PORT**, **NATGW**, **ELB**, **ELBV1**, **VPN** or **null** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PORT** | + | | | - **NATGW** | + | | | - **ELB** | + | | | - **ELBV1** | + | | | - **VPN** | + | | | - **null** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_id | String | - ID of the instance bound with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_id | String | - ID of the network that an EIP belongs to. Network ID corresponding to **publicip_pool_name** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_name | String | - Network type of an EIP, including public EIP pool (for example, **5_bgp** or **5_sbgp**) and dedicated EIP pool. | + | | | - For details about the dedicated EIP pool, see the APIs about **publcip_pool**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | - EIP name. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _associatepublicips__en-us_topic_0000001543103905_en-us_topic_0000001403541982_response_vnicinfo: + +.. table:: **Table 6** VnicInfo + + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================+ + | private_ip_address | String | - Private IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_id | String | - ID of the device that a port belongs to. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_owner | String | - Device that the port belongs to. | + | | | - The value can be: | + | | | | + | | | - **network:dhcp** | + | | | - **network:VIP_PORT** | + | | | - **network:router_interface_distributed** | + | | | - **network:router_centralized_snat** | + | | | | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vpc_id | String | - VPC ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_id | String | - Port ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_profile | String | - Port profile. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | mac | String | - Port MAC address. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vtep | String | - VTEP IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vni | String | - VXLAN ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_id | String | - ID of the instance that the port belongs to, for example, RDS instance ID. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_type | String | - Type of the instance that the port belongs to, for example, RDS. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +.. _associatepublicips__en-us_topic_0000001543103905_en-us_topic_0000001403541982_response_publicipbandwidthinfo: + +.. table:: **Table 7** PublicipBandwidthInfo + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================+ + | id | String | - Bandwidth ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | - Bandwidth size. | + | | | | + | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. | + | | | | + | | | Minimum value: **1** | + | | | | + | | | Maximum value: **1000** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | share_type | String | - Whether the bandwidth is shared or dedicated. | + | | | - The value can be: | + | | | | + | | | - **PER**: Dedicated bandwidth | + | | | - **WHOLE**: Shared bandwidth | + | | | | + | | | - IPv6 addresses do not support bandwidth whose type is **WHOLE**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | - Whether the billing is based on traffic or bandwidth. | + | | | - The value can be: | + | | | | + | | | - **bandwidth**: billed by bandwidth | + | | | - **traffic**: billed by traffic | + | | | - **95peak_plus**: billed by 95th percentile bandwidth (enhanced) | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Bandwidth name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Billing information. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + +Example Request +--------------- + +.. code-block:: + + { + "publicip" : { + "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", + "associate_instance_type" : "PORT" + } + } + +Example Response +---------------- + +**Status code: 200** + +Normal response to POST requests + +.. code-block:: + + { + "publicip" : { + "alias" : "abcd", + "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", + "associate_instance_type" : "PORT", + "bandwidth" : { + "billing_info" : "xxxx:xxxx:xxxx:xxxx", + "charge_mode" : "bandwidth", + "id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4", + "name" : "bandwidth-bd25-test", + "share_type" : "WHOLE", + "size" : 7 + }, + "billing_info" : null, + "created_at" : "2020-06-18T14:05:32Z", + "description" : "test!!!!", + "enterprise_project_id" : "0", + "public_border_group" : "center", + "id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7", + "ip_version" : 4, + "lock_status" : null, + "project_id" : "060576782980d5762f9ec014dd2f1148", + "public_ip_address" : "xx.xx.xx.xx", + "publicip_pool_id" : "160576782980d5762f9ec014dd2f1148", + "publicip_pool_name" : "5_mobile", + "status" : "ACTIVE", + "type" : "EIP", + "updated_at" : "2020-06-18T14:05:32Z", + "vnic" : { + "device_id" : "78aa6d7f-7111-434e-9a93-0dc6fdacff63", + "device_owner" : "network:nat_gateway", + "instance_id" : "", + "instance_type" : "", + "mac" : "fa:16:3e:83:6b:0a", + "port_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", + "port_profile" : null, + "private_ip_address" : "xx.xx.xx.xx", + "vni" : null, + "vpc_id" : "a26c231a-cf6f-48d3-83db-1e261d0e235a", + "vtep" : null + } + }, + "request_id" : "ead9f912bd1191e3d5f0037141098d91" + } + +Status Codes +------------ + +See :ref:`Status Codes `. + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v3/eips/index.rst b/api-ref/source/api_v3/eips/index.rst new file mode 100644 index 0000000..734cb2a --- /dev/null +++ b/api-ref/source/api_v3/eips/index.rst @@ -0,0 +1,20 @@ +:original_name: eip_apiv3_0100.html + +.. _eip_apiv3_0100: + +EIPs +==== + +- :ref:`Querying All EIPs ` +- :ref:`Querying EIP Details ` +- :ref:`Unbinding an EIP ` +- :ref:`Binding an EIP ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_all_eips + querying_eip_details + unbinding_an_eip + binding_an_eip diff --git a/api-ref/source/api_v3/eips/querying_all_eips.rst b/api-ref/source/api_v3/eips/querying_all_eips.rst new file mode 100644 index 0000000..79acb0f --- /dev/null +++ b/api-ref/source/api_v3/eips/querying_all_eips.rst @@ -0,0 +1,849 @@ +:original_name: ListPublicipsV3.html + +.. _ListPublicipsV3: + +Querying All EIPs +================= + +Function +-------- + +This API is used to query all EIPs. (This API is not supported in **eu-nl**.) + +URI +--- + +GET /v3/{project_id}/eip/publicips + +.. table:: **Table 1** Path parameter + + +-----------------+-----------------+-----------------+------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================+ + | project_id | Yes | String | - Project ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **32** | + +-----------------+-----------------+-----------------+------------------------+ + +.. table:: **Table 2** Query parameters + + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================================+=================+=================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | marker | No | String | - Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **36** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | - Start resource number of pagination query. | + | | | | | + | | | | Minimum value: **0** | + | | | | | + | | | | Maximum value: **99999** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | - Number of records returned on each page. | + | | | | - The value ranges from **0** to **2,000**. The maximum value varies by region. | + | | | | | + | | | | Minimum value: **0** | + | | | | | + | | | | Maximum value: **2000** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fields | No | Array | - Field. Format: "fields=id&fields=owner&..." | + | | | | - Supported fields: **id**, **project_id**, **ip_version**, **type**, **public_ip_address**, **public_ipv6_address**, **network_type**, **status**, **description**, **created_at**, **updated_at**, **vnic**, **bandwidth**, **associate_instance_type**, **associate_instance_id**, **lock_status**, **billing_info**, **tags**, **enterprise_project_id**, **allow_share_bandwidth_types**, **public_border_group**, **alias**, **publicip_pool_name**, and **publicip_pool_id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_key | No | String | - Sort. Format: "sort_key=id" | + | | | | - Supported fields: **id**, **public_ip_address**, **public_ipv6_address**, **ip_version**, **created_at**, **updated_at**, and **public_border_group**. | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **id** | + | | | | - **public_ip_address** | + | | | | - **public_ipv6_address** | + | | | | - **ip_version** | + | | | | - **created_at** | + | | | | - **updated_at** | + | | | | - **public_border_group** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | String | - Sorting direction. | + | | | | - The value can be **asc** or **desc** | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **asc** | + | | | | - **desc** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | Array | - Filter by **id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | No | Array | - Filter by **ip_version**. | + | | | | - The value can be **4** (IPv4) or **6** (IPv6). | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **4** | + | | | | - **6** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | No | Array | - Filter by **public_ip_address**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address_like | No | String | - Filter by **public_ip_address** in a fuzzy search. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **64** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ipv6_address | No | Array | - Filter by **public_ipv6_address**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ipv6_address_like | No | String | - Filter by **public_ipv6_address** in a fuzzy search. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **64** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | Array | - Filter by **type**. | + | | | | - The value can be: | + | | | | | + | | | | - **EIP**: EIP | + | | | | - **DUALSTACK**: Dual-stack IPv6 | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **EIP** | + | | | | - **DUALSTACK** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_type | No | Array | - Filter by **network_type**. | + | | | | - The value can be **5_telcom**, **5_union**, **5_bgp**, **5_sbgp**, **5_ipv6**, or **5_graybgp**. | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **5_telcom** | + | | | | - **5_union** | + | | | | - **5_bgp** | + | | | | - **5_sbgp** | + | | | | - **5_ipv6** | + | | | | - **5_graybgp** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_name | No | Array | - Filter by **publicip_pool_name**. | + | | | | - The value can be **5_telcom**, **5_union**, **5_bgp**, **5_sbgp**, **5_ipv6**, **5_graybgp**, or a dedicated pool name. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | Array | - Filter by **status**. | + | | | | - The value can be **FREEZED**, **DOWN**, **ACTIVE**, or **ERROR**. | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **FREEZED** | + | | | | - **DOWN** | + | | | | - **ACTIVE** | + | | | | - **ERROR** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias_like | No | String | - Filter by **alias** in a fuzzy search. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **64** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | No | Array | - Filter by **alias**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | Array | - Filter by **description**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.private_ip_address | No | Array | - Filter by **private_ip_address**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.private_ip_address_like | No | String | - Filter by **private_ip_address** in a fuzzy search. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **64** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.device_id | No | Array | - Filter by **device_id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.device_owner | No | Array | - Filter by **device_owner**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.vpc_id | No | Array | - Filter by **vpc_id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.port_id | No | Array | - Filter by **port_id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.device_owner_prefixlike | No | String | - Filter by **device_owner_prefixlike** in a fuzzy search. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **64** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.instance_type | No | Array | - Filter by **instance_type**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic.instance_id | No | Array | - Filter by **instance_id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth.id | No | Array | - Filter by the bandwidth ID. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth.name | No | Array | - Filter by **name**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth.name_like | No | Array | - Filter by **name** in a fuzzy search. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth.size | No | Array | - Filter by **size**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth.share_type | No | Array | - Filter by **share_type**. | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **PER** | + | | | | - **WHOLE** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth.charge_mode | No | Array | - Filter by **charge_mode**. | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **bandwidth** | + | | | | - **traffic** | + | | | | - **95peak_plus** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | No | Array | - Filter by **billing_info**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_mode | No | String | - Filter by **billing_mode**. | + | | | | - The value can be **PAY_PER_USE**. | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **PAY_PER_USE** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_type | No | Array | - Filter by **associate_instance_type**. | + | | | | - The value can be **PORT**, **NATGW**, **ELB**, **VPN**, or **ELBV1**. | + | | | | | + | | | | Enumerated values: | + | | | | | + | | | | - **PORT** | + | | | | - **NATGW** | + | | | | - **ELB** | + | | | | - **VPN** | + | | | | - **ELBV1** | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_id | No | Array | - Filter by **associate_instance_id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | Array | - Filter by **enterprise_project_id**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | No | Array | - Filter by **public_border_group**. | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allow_share_bandwidth_type_any | No | Array | - Shared bandwidth type. EIPs can be filtered by shared bandwidth type. You can specify multiple shared bandwidth types, which are separated by commas (,). | + +--------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameter +----------------- + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+ + | Parameter | Type | Description | + +=======================+=============================================================================================================================================================+=====================================+ + | request_id | String | Request ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+ + | publicips | Array of :ref:`PublicipSingleShowResp ` objects | EIP object. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+ + | page_info | :ref:`PageInfoOption ` object | Pagination page number information. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+ + | total_count | Integer | Total number of EIPs. | + | | | | + | | | Minimum value: **0** | + | | | | + | | | Maximum value: **999999** | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+ + +.. _listpublicipsv3__en-us_topic_0000001543023729_en-us_topic_0000001405620326_response_publicipsingleshowresp: + +.. table:: **Table 4** PublicipSingleShowResp + + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+=================================================================================================================================================+============================================================================================================================================================================================================================================================================================================+ + | id | String | - Unique ID of the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | - Project ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **32** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - IP address version. | + | | | - The value can be: | + | | | | + | | | - **4**: IPv4 EIP | + | | | - **6**: IPv6 EIP | + | | | | + | | | Enumerated values: | + | | | | + | | | - **4** | + | | | - **6** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | - EIP or IPv6 port address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ipv6_address | String | - Obtained EIP if IPv6 EIPs are available. This parameter does not exist if only IPv4 EIPs are available. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_type | String | - Network type of an EIP. This parameter is discarded and is not displayed by default. It is inherited by **publicip_pool_name**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - EIP status. | + | | | - The value can be: | + | | | | + | | | - **FREEZED** (Frozen) | + | | | - **BIND_ERROR** (Binding failed) | + | | | - **BINDING** (Binding) | + | | | - **PENDING_DELETE** (Releasing) | + | | | - **PENDING_CREATE** (Assigning) | + | | | - **NOTIFYING** (Notify that EIP is assigned) | + | | | - **NOTIFY_DELETE** (Notify to release an EIP) | + | | | - **PENDING_UPDATE** (Updating) | + | | | - **DOWN** (Unbound) | + | | | - **ACTIVE** (Bound) | + | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | + | | | - **ERROR** (Assignment failed) | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **FREEZED** | + | | | - **BIND_ERROR** | + | | | - **BINDING** | + | | | - **PENDING_DELETE** | + | | | - **PENDING_CREATE** | + | | | - **NOTIFYING** | + | | | - **NOTIFY_DELETE** | + | | | - **PENDING_UPDATE** | + | | | - **DOWN** | + | | | - **ACTIVE** | + | | | - **ELB** | + | | | - **VPN** | + | | | - **ERROR** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Supplementary information about the EIP. | + | | | - This is customized by users and is not perceived by the system. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | - Whether the resource is in a central region or an edge site. | + | | | - The value can be **center** or an edge site name. | + | | | - This resource can only be associated with an EIP of the same region. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time (UTC) when an EIP is assigned. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time (UTC) when an EIP is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | - EIP type. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **EIP** | + | | | - **DUALSTACK** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic | :ref:`VnicInfo ` object | - Port information of the instance with an EIP bound. | + | | | - If the instance with an EIP bound does not depend on a port, the value is **null**. | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | :ref:`PublicipBandwidthInfo ` object | Bandwidth bound to an EIP. | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Order information of an EIP. | + | | | - This parameter is left empty for pay-per-use resources. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lock_status | String | - Frozen status of an EIP. | + | | | - The metadata type indicates that the EIP is frozen due to arrears or abuse. | + | | | - The value can be: | + | | | | + | | | - **police** | + | | | - **locked** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_type | String | - Type of the instance bound with an EIP. | + | | | - The value can be: | + | | | | + | | | - **PORT** | + | | | - **NATGW** | + | | | - **ELB** | + | | | - **ELBV1** | + | | | - **VPN** | + | | | - **null** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PORT** | + | | | - **NATGW** | + | | | - **ELB** | + | | | - **ELBV1** | + | | | - **VPN** | + | | | - **null** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_id | String | - ID of the instance bound with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_id | String | - ID of the network that an EIP belongs to. It is the network ID corresponding to **publicip_pool_name**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_name | String | - Network type of an EIP, including public EIP pool (for example, **5_bgp** or **5_sbgp**) and dedicated EIP pool. | + | | | - For details about the dedicated EIP pool, see the APIs about **publcip_pool**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | - EIP name. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | profile | :ref:`ProfileInfo ` object | - EIP and metadata. (The parameter is not displayed by default.) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fake_network_type | Boolean | - Whether an EIP can change its BGP type. If the value is **true**, the EIP can change its BGP type. If the value is **false**, the EIP cannot change its BGP type. (The parameter is not displayed by default.) | + | | | | + | | | Enumerated values: | + | | | | + | | | - **true** | + | | | - **false** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of strings | - User tag. (The parameter is not displayed by default.) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_metadata | String | - Record the upper-level ownership of an instance. For example, if **associate_instance_type** is set to **PORT**, this parameter records the **device_id** and **device_owner** information of the port. (This parameter only records information in limited scenarios and is not displayed by default.) | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_mode | String | - Passthrough mode. The parameter is displayed only after the passthrough mode is enabled. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allow_share_bandwidth_types | Array of strings | - Types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth. | + | | | - The EIP can be added only to the shared bandwidth of these types. | + | | | | + | | | Maximum length: **64** | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cascade_delete_by_instance | Boolean | - Whether an EIP can be released together with its instance. (The parameter is not displayed by default.) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listpublicipsv3__en-us_topic_0000001543023729_en-us_topic_0000001405620326_response_vnicinfo: + +.. table:: **Table 5** VnicInfo + + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================+ + | private_ip_address | String | - Private IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_id | String | - ID of the device that a port belongs to. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_owner | String | - Device that the port belongs to. | + | | | - The value can be: | + | | | | + | | | - **network:dhcp** | + | | | - **network:VIP_PORT** | + | | | - **network:router_interface_distributed** | + | | | - network:router_centralized_snat | + | | | | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vpc_id | String | - VPC ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_id | String | - Port ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_profile | String | - Port profile. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | mac | String | - Port MAC address. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vtep | String | - VTEP IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vni | String | - VXLAN ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_id | String | - ID of the instance that the port belongs to, for example, RDS instance ID. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_type | String | - Type of the instance that the port belongs to, for example, RDS. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +.. _listpublicipsv3__en-us_topic_0000001543023729_en-us_topic_0000001405620326_response_publicipbandwidthinfo: + +.. table:: **Table 6** PublicipBandwidthInfo + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================+ + | id | String | - Bandwidth ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | - Bandwidth size. | + | | | - The value ranges from 5 Mbit/s to 2000 Mbit/s by default. | + | | | | + | | | Minimum value: **0** | + | | | | + | | | Maximum value: **99999** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | share_type | String | - Whether the bandwidth is shared or dedicated. | + | | | - The value can be: | + | | | | + | | | - **PER**: Dedicated bandwidth | + | | | - **WHOLE**: Shared bandwidth | + | | | | + | | | - IPv6 addresses do not support bandwidth whose type is **WHOLE**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | - Whether the billing is based on traffic or bandwidth. | + | | | - The value can be: | + | | | | + | | | - **bandwidth**: billed by bandwidth | + | | | - **traffic**: billed by traffic | + | | | - **95peak_plus**: billed by 95th percentile bandwidth (enhanced) | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Bandwidth name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Billing information. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + +.. _listpublicipsv3__en-us_topic_0000001543023729_en-us_topic_0000001405620326_response_profileinfo: + +.. table:: **Table 7** ProfileInfo + + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=========================================================================================================================================+===================================================================================================================================================================================+ + | local_network_port | String | - **port_id** in the **5**\ *\_xxx* network (for example, **5_bgp**) of an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | standalone | Boolean | - Whether an EIP is assigned together with a VM. If the value is **true**, the EIP is assigned independently. If the value is **false**, the EIP is assigned together with a VM. | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | notify_status | String | - EIP assigning status. This parameter is only for internal use of the EIP service. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PENDING_CREATE** | + | | | - **PENDING_UPDATE** | + | | | - **NOTIFYING** | + | | | - **NOTIFYED** | + | | | - **NOTIFY_DELETE** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | create_time | String | - Time when an EIP is assigned. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fake_network_type | Boolean | - Whether an EIP can change its BGP type. If the value is **true**, the EIP can change its BGP type. If the value is **false**, the EIP cannot change its BGP type. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **true** | + | | | - **false** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | create_source | String | - Type of the resource purchased together with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated value: | + | | | | + | | | - **ecs** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ecs_id | String | - ID of the ECS purchased together with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lock_status | String | - Lock status of an EIP, for example, **POLICE** (abuse), **LOCKED** (common issues), **ARREAR** (in arrears), and **DELABLE** (can be deleted). | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | freezed_status | String | - EIP frozen status. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **FREEZED** | + | | | - **UNFREEZED** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwith_info | :ref:`BandwidthInfoResp ` object | - Bandwidth bound to an EIP. | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listpublicipsv3__en-us_topic_0000001543023729_en-us_topic_0000001405620326_response_bandwidthinforesp: + +.. table:: **Table 8** BandwidthInfoResp + + +-----------------------+-----------------------+-----------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================+ + | bandwidth_name | String | - Bandwidth name. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+-----------------------------+ + | bandwidth_number | Integer | - Bandwidth size (Mbit/s). | + | | | | + | | | Minimum value: **0** | + | | | | + | | | Maximum value: **99999** | + +-----------------------+-----------------------+-----------------------------+ + | bandwidth_type | String | - Bandwidth type. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PER** | + | | | - **WHOLE** | + +-----------------------+-----------------------+-----------------------------+ + | bandwidth_id | String | - Bandwidth ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-----------------------------+ + +.. _listpublicipsv3__en-us_topic_0000001543023729_en-us_topic_0000001405620326_response_pageinfooption: + +.. table:: **Table 9** PageInfoOption + + +-----------------------+-----------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================+ + | previous_marker | String | Marker value of the previous page. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+---------------------------------------------------+ + | next_marker | String | Marker value of the next page. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+---------------------------------------------------+ + | current_count | Integer | Total number of data records on the current page. | + | | | | + | | | Minimum value: **0** | + | | | | + | | | Maximum value: **99999** | + +-----------------------+-----------------------+---------------------------------------------------+ + +Example Request +--------------- + +None + +Example Response +---------------- + +**Status code: 200** + +Normal response to the GET operation + +.. code-block:: + + { + "page_info" : { + "current_count" : 1, + "next_marker" : "0490aeae-ab8f-4764-b012-45645e9c0aa9", + "previous_marker" : "0490aeae-ab8f-4764-b012-45645e9c0aa9" + }, + "publicips" : [ { + "created_at" : "2022-03-17T09:46:22Z", + "updated_at" : "2022-03-30T02:46:04Z", + "lock_status" : null, + "allow_share_bandwidth_types" : [ "bgp", "sbgp", "share", "share_yidongdanxian", "share_youxuan" ], + "id" : "006343a1-32bf-4361-958a-efd158153dd0", + "alias" : null, + "project_id" : "060576787a80d5762fa2c00f07ddfcf4", + "ip_version" : 4, + "public_ip_address" : "88.88.1.141", + "public_ipv6_address" : null, + "status" : "DOWN", + "description" : "", + "enterprise_project_id" : "0", + "billing_info" : null, + "type" : "EIP", + "vnic" : { + "private_ip_address" : "172.16.1.235", + "device_id" : "", + "device_owner" : "", + "vpc_id" : "1c30f428-9741-48b2-a788-0b2f359705eb", + "port_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", + "mac" : "fa:16:3e:3a:22:66", + "vtep" : null, + "vni" : null, + "instance_id" : "", + "instance_type" : "", + "port_profile" : null + }, + "bandwidth" : { + "id" : "149ff19b-5de4-4436-958f-2eca39952e93", + "size" : 100, + "share_type" : "PER", + "charge_mode" : "traffic", + "name" : "bandwidth-xym-br-eqos", + "billing_info" : "" + }, + "associate_instance_type" : "PORT", + "associate_instance_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", + "publicip_pool_id" : "9af5f2e5-1765-4b86-b342-ece52e785c8b", + "publicip_pool_name" : "5_union", + "public_border_group" : "center", + "tags" : [ "key=value" ] + } ], + "request_id" : "c4962d006b34af3c2343de7f88ef65e3", + "total_count" : 100 + } + +Status Codes +------------ + +See :ref:`Status Codes `. + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v3/eips/querying_eip_details.rst b/api-ref/source/api_v3/eips/querying_eip_details.rst new file mode 100644 index 0000000..f9c712c --- /dev/null +++ b/api-ref/source/api_v3/eips/querying_eip_details.rst @@ -0,0 +1,626 @@ +:original_name: ShowPublicipV3.html + +.. _ShowPublicipV3: + +Querying EIP Details +==================== + +Function +-------- + +This API is used to query EIP details. (This API is not supported in **eu-nl**.) + +URI +--- + +GET /v3/{project_id}/eip/publicips/{publicip_id} + +.. table:: **Table 1** Path parameters + + +-----------------+-----------------+-----------------+------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================+ + | project_id | Yes | String | Project ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **32** | + +-----------------+-----------------+-----------------+------------------------+ + | publicip_id | Yes | String | EIP ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **36** | + +-----------------+-----------------+-----------------+------------------------+ + +.. table:: **Table 2** Query parameter + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | fields | No | Array | - Field. Format: "fields=id&fields=owner&..." | + | | | | - Supported fields: **id**, **project_id**, **ip_version**, **type**, **public_ip_address**, **public_ipv6_address**, **network_type**, **status**, **description**, **created_at**, **updated_at**, **vnic**, **bandwidth**, **associate_instance_type**, **associate_instance_id**, **lock_status**, **billing_info**, **tags**, **enterprise_project_id**, **publicip_pool_name**, **allow_share_bandwidth_types**, **alias**, **publicip_pool_id**, and **public_border_group**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameter +----------------- + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+ + | Parameter | Type | Description | + +=======================+==================================================================================================================================================+========================+ + | request_id | String | Request ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+ + | publicip | :ref:`PublicipSingleShowResp ` object | EIP. | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------+ + +.. _showpublicipv3__en-us_topic_0000001542903925_en-us_topic_0000001405460350_response_publicipsingleshowresp: + +.. table:: **Table 4** PublicipSingleShowResp + + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+================================================================================================================================================+============================================================================================================================================================================================================================================================================================================+ + | id | String | - Unique ID of the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | - Project ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **32** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - IP address version. | + | | | - The value can be: | + | | | | + | | | - **4**: IPv4 EIP | + | | | - **6**: IPv6 EIP | + | | | | + | | | Enumerated values: | + | | | | + | | | - **4** | + | | | - **6** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | - EIP or IPv6 port address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ipv6_address | String | - Obtained EIP if IPv6 EIPs are available. This parameter does not exist if only IPv4 EIPs are available. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_type | String | - Network type of an EIP. This parameter is discarded and is not displayed by default. It is inherited by **publicip_pool_name**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - EIP status. | + | | | - The value can be: | + | | | | + | | | - **FREEZED** (Frozen) | + | | | - **BIND_ERROR** (Binding failed) | + | | | - **BINDING** (Binding) | + | | | - **PENDING_DELETE** (Releasing) | + | | | - **PENDING_CREATE** (Assigning) | + | | | - **NOTIFYING** | + | | | - **NOTIFY_DELETE** | + | | | - **PENDING_UPDATE** (Updating) | + | | | - **DOWN** (Unbound) | + | | | - **ACTIVE** (Bound) | + | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | + | | | - **ERROR** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **FREEZED** | + | | | - **BIND_ERROR** | + | | | - **BINDING** | + | | | - **PENDING_DELETE** | + | | | - **PENDING_CREATE** | + | | | - **NOTIFYING** | + | | | - **NOTIFY_DELETE** | + | | | - **PENDING_UPDATE** | + | | | - **DOWN** | + | | | - **ACTIVE** | + | | | - **ELB** | + | | | - **VPN** | + | | | - **ERROR** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Supplementary information about the EIP. | + | | | - This is customized by users and is not perceived by the system. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | - Whether the resource is in a central region or an edge site. | + | | | - The value can be **center** or an edge site name. | + | | | - This resource can only be associated with an EIP of the same region. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time (UTC) when an EIP is assigned. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time (UTC) when an EIP is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | - EIP type. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **EIP** | + | | | - **DUALSTACK** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic | :ref:`VnicInfo ` object | - Port information of the instance with an EIP bound. | + | | | - If the instance with an EIP bound does not depend on a port, the value is **null**. | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | :ref:`PublicipBandwidthInfo ` object | Bandwidth bound to an EIP. | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Order information of an EIP. | + | | | - This parameter is left empty for pay-per-use resources. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lock_status | String | - Frozen status of an EIP. | + | | | - The metadata type indicates that the EIP is frozen due to arrears or abuse. | + | | | - The value can be: | + | | | | + | | | - **police** | + | | | - **locked** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_type | String | - Type of the instance bound with an EIP. | + | | | - The value can be: | + | | | | + | | | - **PORT** | + | | | - **NATGW** | + | | | - **ELB** | + | | | - **ELBV1** | + | | | - **VPN** | + | | | - **null** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PORT** | + | | | - **NATGW** | + | | | - **ELB** | + | | | - **ELBV1** | + | | | - **VPN** | + | | | - **null** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_id | String | - ID of the instance bound with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_id | String | - ID of the network that an EIP belongs to. It is the network ID corresponding to **publicip_pool_name**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_name | String | - Network type of an EIP, including public EIP pool (for example, **5_bgp** or **5_sbgp**) and dedicated EIP pool. | + | | | - For details about the dedicated EIP pool, see the APIs about **publcip_pool**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | - EIP name. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | profile | :ref:`ProfileInfo ` object | - EIP and metadata. (The parameter is not displayed by default.) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fake_network_type | Boolean | - Whether an EIP can change its BGP type. If the value is **true**, the EIP can change its BGP type. If the value is **false**, the EIP cannot change its BGP type. (The parameter is not displayed by default.) | + | | | | + | | | Enumerated values: | + | | | | + | | | - **true** | + | | | - **false** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of strings | - User tag. (The parameter is not displayed by default.) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_metadata | String | - Record the upper-level ownership of an instance. For example, if **associate_instance_type** is set to **PORT**, this parameter records the **device_id** and **device_owner** information of the port. (This parameter only records information in limited scenarios and is not displayed by default.) | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_mode | String | - Passthrough mode. The parameter is displayed only after the passthrough mode is enabled. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **36** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allow_share_bandwidth_types | Array of strings | - Types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth. | + | | | - The EIP can be added only to the shared bandwidth of these types. | + | | | | + | | | Maximum length: **64** | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cascade_delete_by_instance | Boolean | - Whether an EIP can be released together with its instance. (The parameter is not displayed by default.) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showpublicipv3__en-us_topic_0000001542903925_en-us_topic_0000001405460350_response_vnicinfo: + +.. table:: **Table 5** VnicInfo + + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================+ + | private_ip_address | String | - Private IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_id | String | - ID of the device that a port belongs to. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_owner | String | - Device that the port belongs to. | + | | | - The value can be: | + | | | | + | | | - **network:dhcp** | + | | | - **network:VIP_PORT** | + | | | - **network:router_interface_distributed** | + | | | - **network:router_centralized_snat** | + | | | | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vpc_id | String | - VPC ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_id | String | - Port ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_profile | String | - Port profile. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | mac | String | - Port MAC address. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vtep | String | - VTEP IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vni | String | - VXLAN ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_id | String | - ID of the instance that the port belongs to, for example, RDS instance ID. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_type | String | - Type of the instance that the port belongs to, for example, RDS. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +.. _showpublicipv3__en-us_topic_0000001542903925_en-us_topic_0000001405460350_response_publicipbandwidthinfo: + +.. table:: **Table 6** PublicipBandwidthInfo + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================+ + | id | String | - Bandwidth ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | - Bandwidth size. | + | | | - The value ranges from 5 Mbit/s to 2000 Mbit/s by default. | + | | | | + | | | Minimum value: **0** | + | | | | + | | | Maximum value: **99999** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | share_type | String | - Whether the bandwidth is shared or dedicated. | + | | | - The value can be: | + | | | | + | | | - **PER**: Dedicated bandwidth | + | | | - **WHOLE**: Shared bandwidth | + | | | | + | | | - IPv6 addresses do not support bandwidth whose type is **WHOLE**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | - Whether the billing is based on traffic or bandwidth. | + | | | - The value can be: | + | | | | + | | | - **bandwidth**: billed by bandwidth | + | | | - **traffic**: billed by traffic | + | | | - **95peak_plus**: billed by 95th percentile bandwidth (enhanced) | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Bandwidth name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Billing information. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + +.. _showpublicipv3__en-us_topic_0000001542903925_en-us_topic_0000001405460350_response_profileinfo: + +.. table:: **Table 7** ProfileInfo + + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========================================================================================================================================+===================================================================================================================================================================================+ + | local_network_port | String | - **port_id** in the **5**\ *\_xxx* network (for example, **5_bgp**) of an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | standalone | Boolean | - Whether an EIP is assigned together with a VM. If the value is **true**, the EIP is assigned independently. If the value is **false**, the EIP is assigned together with a VM. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | notify_status | String | - EIP assigning status. This parameter is only for internal use of the EIP service. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PENDING_CREATE** | + | | | - **PENDING_UPDATE** | + | | | - **NOTIFYING** | + | | | - **NOTIFYED** | + | | | - **NOTIFY_DELETE** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | create_time | String | - Time when an EIP is assigned. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fake_network_type | Boolean | - Whether an EIP can change its BGP type. If the value is **true**, the EIP can change its BGP type. If the value is **false**, the EIP cannot change its BGP type. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **true** | + | | | - **false** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | create_source | String | - Type of the resource purchased together with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated value: | + | | | | + | | | - **ecs** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ecs_id | String | - ID of the ECS purchased together with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lock_status | String | - Lock status of an EIP, for example, **POLICE** (abuse), **LOCKED** (common issues), **ARREAR** (in arrears), and **DELABLE** (can be deleted). | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | freezed_status | String | - EIP frozen status. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **FREEZED** | + | | | - **UNFREEZED** | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwith_info | :ref:`BandwidthInfoResp ` object | - Bandwidth bound to an EIP. | + +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showpublicipv3__en-us_topic_0000001542903925_en-us_topic_0000001405460350_response_bandwidthinforesp: + +.. table:: **Table 8** BandwidthInfoResp + + +-----------------------+-----------------------+-----------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================+ + | bandwidth_name | String | - Bandwidth name. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+-----------------------------+ + | bandwidth_number | Integer | - Bandwidth size (Mbit/s). | + | | | | + | | | Minimum value: **0** | + | | | | + | | | Maximum value: **99999** | + +-----------------------+-----------------------+-----------------------------+ + | bandwidth_type | String | - Bandwidth type. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PER** | + | | | - **WHOLE** | + +-----------------------+-----------------------+-----------------------------+ + | bandwidth_id | String | - Bandwidth ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-----------------------------+ + +Example Request +--------------- + +None + +Example Response +---------------- + +**Status code: 200** + +Normal response to the GET operation + +.. code-block:: + + { + "publicip" : { + "created_at" : "2022-03-17T09:46:22Z", + "updated_at" : "2022-03-30T02:46:04Z", + "lock_status" : null, + "allow_share_bandwidth_types" : [ "bgp", "sbgp", "share", "share_yidongdanxian", "share_youxuan" ], + "id" : "006343a1-32bf-4361-958a-efd158153dd0", + "alias" : null, + "project_id" : "060576787a80d5762fa2c00f07ddfcf4", + "ip_version" : 4, + "public_ip_address" : "88.88.1.141", + "public_ipv6_address" : null, + "status" : "DOWN", + "description" : "", + "enterprise_project_id" : "0", + "billing_info" : null, + "type" : "EIP", + "vnic" : { + "private_ip_address" : "172.16.1.235", + "device_id" : "", + "device_owner" : "", + "vpc_id" : "1c30f428-9741-48b2-a788-0b2f359705eb", + "port_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", + "mac" : "fa:16:3e:3a:22:66", + "vtep" : null, + "vni" : null, + "instance_id" : "", + "instance_type" : "", + "port_profile" : null + }, + "bandwidth" : { + "id" : "149ff19b-5de4-4436-958f-2eca39952e93", + "size" : 100, + "share_type" : "PER", + "charge_mode" : "traffic", + "name" : "bandwidth-xym-br-eqos", + "billing_info" : "" + }, + "associate_instance_type" : "PORT", + "associate_instance_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", + "publicip_pool_id" : "9af5f2e5-1765-4b86-b342-ece52e785c8b", + "publicip_pool_name" : "5_union", + "public_border_group" : "center", + "tags" : [ "key=value" ] + }, + "request_id" : "ce1a33a85d2e105040497a21bbe58c26" + } + +Status Codes +------------ + +See :ref:`Status Codes `. + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v3/eips/unbinding_an_eip.rst b/api-ref/source/api_v3/eips/unbinding_an_eip.rst new file mode 100644 index 0000000..9cbdf89 --- /dev/null +++ b/api-ref/source/api_v3/eips/unbinding_an_eip.rst @@ -0,0 +1,428 @@ +:original_name: DisassociatePublicips.html + +.. _DisassociatePublicips: + +Unbinding an EIP +================ + +Function +-------- + +This API is used to unbind an EIP. (This API is not supported in **eu-nl**.) + +URI +--- + +POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance + +.. table:: **Table 1** Path parameters + + +-----------------+-----------------+-----------------+------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================+ + | project_id | Yes | String | Project ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **32** | + +-----------------+-----------------+-----------------+------------------------+ + | publicip_id | Yes | String | EIP ID. | + | | | | | + | | | | Minimum length: **0** | + | | | | | + | | | | Maximum length: **36** | + +-----------------+-----------------+-----------------+------------------------+ + +Request Parameter +----------------- + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================================================================================================+====================================+ + | request_id | String | Request ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+ + | publicip | :ref:`PublicipInstanceResp ` object | Response body of unbinding an EIP. | + +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------+ + +.. _disassociatepublicips__en-us_topic_0000001543223781_en-us_topic_0000001403701958_response_publicipinstanceresp: + +.. table:: **Table 3** PublicipInstanceResp + + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+=======================================================================================================================================================+======================================================================================================================================================================================================================================+ + | id | String | - Unique ID of the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | - Project ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **32** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - IP address version. | + | | | - The value can be: | + | | | | + | | | - **4**: IPv4 EIP | + | | | - **6**: IPv6 EIP, which is not supported currently. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **4** | + | | | - **6** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | - EIP or IPv6 port address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - EIP status. | + | | | - The value can be: | + | | | | + | | | - **FREEZED** (Frozen) | + | | | - **BIND_ERROR** (Binding failed) | + | | | - **BINDING** (Binding) | + | | | - **PENDING_DELETE** (Releasing) | + | | | - **PENDING_CREATE** (Assigning) | + | | | - **NOTIFYING** | + | | | - **NOTIFY_DELETE** | + | | | - **PENDING_UPDATE** (Updating) | + | | | - **DOWN** (Unbound) | + | | | - **ACTIVE** (Bound) | + | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | + | | | - **ERROR** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **FREEZED** | + | | | - **BIND_ERROR** | + | | | - **BINDING** | + | | | - **PENDING_DELETE** | + | | | - **PENDING_CREATE** | + | | | - **NOTIFYING** | + | | | - **NOTIFY_DELETE** | + | | | - **PENDING_UPDATE** | + | | | - **DOWN** | + | | | - **ACTIVE** | + | | | - **ELB** | + | | | - **ERROR** | + | | | - **VPN** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Supplementary information about the EIP. | + | | | - This is customized by users and is not perceived by the system. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **255** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | - Whether the resource is in a central region or an edge site. | + | | | - The value can be **center** or an edge site name. | + | | | - This resource can only be associated with an EIP of the same region. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **64** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time (UTC) when an EIP is assigned. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time (UTC) when an EIP is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ssZ* | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | - EIP type. | + | | | | + | | | Minimum length: **1** | + | | | | + | | | Maximum length: **36** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **EIP** | + | | | - **DUALSTACK** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vnic | :ref:`VnicInfo ` object | - Port information of the instance with an EIP bound. | + | | | - If the instance with an EIP bound does not depend on a port, the value is **null**. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | :ref:`PublicipBandwidthInfo ` object | - Bandwidth bound to an EIP. | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Order information of an EIP. | + | | | - This parameter is left empty for pay-per-use resources. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lock_status | String | - Frozen status of an EIP. | + | | | - The metadata type indicates that the EIP is frozen due to arrears or abuse. | + | | | - Value range: **police** or **locked** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_type | String | - Type of the instance bound with an EIP. | + | | | - Value range: **PORT**, **NATGW**, **ELB**, **ELBV1**, **VPN** or **null** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + | | | | + | | | Enumerated values: | + | | | | + | | | - **PORT** | + | | | - **NATGW** | + | | | - **ELB** | + | | | - **ELBV1** | + | | | - **VPN** | + | | | - **null** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_id | String | - ID of the instance bound with an EIP. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_id | String | - ID of the network that an EIP belongs to. Network ID corresponding to **publicip_pool_name** | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_pool_name | String | - Network type of an EIP, including public EIP pool (for example, **5_bgp** or **5_sbgp**) and dedicated EIP pool. | + | | | - For details about the dedicated EIP pool, see the APIs about **publcip_pool**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | - EIP name. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _disassociatepublicips__en-us_topic_0000001543223781_en-us_topic_0000001403701958_response_vnicinfo: + +.. table:: **Table 4** VnicInfo + + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================+ + | private_ip_address | String | - Private IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_id | String | - ID of the device that a port belongs to. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | device_owner | String | - Device that the port belongs to. | + | | | - The value can be: | + | | | | + | | | - **network:dhcp** | + | | | - **network:VIP_PORT** | + | | | - **network:router_interface_distributed** | + | | | - **network:router_centralized_snat** | + | | | | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vpc_id | String | - VPC ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_id | String | - Port ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | port_profile | String | - Port profile. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | mac | String | - Port MAC address. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vtep | String | - VTEP IP address. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | vni | String | - VXLAN ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_id | String | - ID of the instance that the port belongs to, for example, RDS instance ID. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | instance_type | String | - Type of the instance that the port belongs to, for example, RDS. | + | | | - The system automatically sets this parameter. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + +.. _disassociatepublicips__en-us_topic_0000001543223781_en-us_topic_0000001403701958_response_publicipbandwidthinfo: + +.. table:: **Table 5** PublicipBandwidthInfo + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================+ + | id | String | - Bandwidth ID. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | size | Integer | - Bandwidth size. | + | | | | + | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. | + | | | | + | | | Minimum value: **1** | + | | | | + | | | Maximum value: **1000** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | share_type | String | - Whether the bandwidth is shared or dedicated. | + | | | - The value can be: | + | | | | + | | | - **PER**: Dedicated bandwidth | + | | | - **WHOLE**: Shared bandwidth | + | | | | + | | | - IPv6 addresses do not support bandwidth whose type is **WHOLE**. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | String | - Whether the billing is based on traffic or bandwidth. | + | | | - The value can be: | + | | | | + | | | - **bandwidth**: billed by bandwidth | + | | | - **traffic**: billed by traffic | + | | | - **95peak_plus**: billed by 95th percentile bandwidth (enhanced) | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **36** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Bandwidth name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **64** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | billing_info | String | - Billing information. | + | | | | + | | | Minimum length: **0** | + | | | | + | | | Maximum length: **256** | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + +Example Request +--------------- + +None + +Example Response +---------------- + +**Status code: 200** + +Normal response to POST requests + +.. code-block:: + + { + "publicip" : { + "alias" : "abcd", + "associate_instance_id" : null, + "associate_instance_type" : null, + "bandwidth" : { + "billing_info" : "xxxx:xxxx:xxxx:xxxx", + "charge_mode" : "bandwidth", + "id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4", + "name" : "bandwidth-bd25-test", + "share_type" : "WHOLE", + "size" : 7 + }, + "billing_info" : null, + "created_at" : "2020-06-18T14:05:32Z", + "description" : "test!!!!", + "enterprise_project_id" : "0", + "public_border_group" : "center", + "id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7", + "ip_version" : 4, + "lock_status" : null, + "project_id" : "060576782980d5762f9ec014dd2f1148", + "public_ip_address" : "xx.xx.xx.xx", + "publicip_pool_id" : "160576782980d5762f9ec014dd2f1148", + "publicip_pool_name" : "5_mobile", + "status" : "DOWN", + "type" : "EIP", + "updated_at" : "2020-06-18T14:05:32Z", + "vnic" : null + }, + "request_id" : "ead9f912bd1191e3d5f0037141098d91" + } + +Status Codes +------------ + +See :ref:`Status Codes `. + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v3/index.rst b/api-ref/source/api_v3/index.rst new file mode 100644 index 0000000..93fc855 --- /dev/null +++ b/api-ref/source/api_v3/index.rst @@ -0,0 +1,16 @@ +:original_name: vpc_apiv3_0000.html + +.. _vpc_apiv3_0000: + +API V3 +====== + +- :ref:`EIPs ` +- :ref:`Common Pools ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + eips/index + common_pools/index diff --git a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst index 00bc31d..28d32aa 100644 --- a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst @@ -95,10 +95,6 @@ Response Message | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | - Specifies the bandwidth status. | | | | - Possible values are as follows: | @@ -117,26 +113,26 @@ Response Message .. table:: **Table 4** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | - Specifies the IP address version. | - | | | - Possible values are as follows: | - | | | | - | | | - **4**: IPv4 | - | | | - **6**: IPv6 (IPv6 is not supported currently.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - Specifies the IP address version. | + | | | - Possible values are as follows: | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth/querying_bandwidths.rst b/api-ref/source/apis/bandwidth/querying_bandwidths.rst index ec222b9..7b9eb48 100644 --- a/api-ref/source/apis/bandwidth/querying_bandwidths.rst +++ b/api-ref/source/apis/bandwidth/querying_bandwidths.rst @@ -30,30 +30,19 @@ GET /v1/{project_id}/bandwidths | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. | | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set **all_granted_eps**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- - -- Request parameter - - None - - Example request .. code-block:: text @@ -114,10 +103,6 @@ Response Message +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set **all_granted_eps**. | | | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | - Specifies the bandwidth status. | | | | - Possible values are as follows: | @@ -136,20 +121,20 @@ Response Message .. table:: **Table 4** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response @@ -167,7 +152,7 @@ Response Message "publicip_id": "2a65923c-7133-415d-ae3b-cf9635a942c5", "publicip_address": "10.xx.xx.3", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", @@ -187,7 +172,7 @@ Response Message "publicip_id": "c754bc9a-16d5-4763-9674-d7561917aa80", "publicip_address": "10.xx.xx.9", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", @@ -207,7 +192,7 @@ Response Message "publicip_id": "cec7fb70-2f82-4561-bd83-2121fb642fdc", "publicip_address": "10.xx.xx.184", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", @@ -227,7 +212,7 @@ Response Message "publicip_id": "24232038-e178-40ad-80e4-5abb75db84be", "publicip_address": "10.xx.xx.101", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", diff --git a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst index 38521b5..14288b5 100644 --- a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst @@ -128,10 +128,6 @@ Response Message +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set **all_granted_eps**. | | | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | - Specifies the bandwidth status. | | | | - Possible values are as follows: | @@ -150,26 +146,20 @@ Response Message .. table:: **Table 6** **publicip_info** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | - Specifies the IP address version. | - | | | - Possible values are as follows: | - | | | | - | | | - **4**: IPv4 | - | | | - **6**: IPv6 (IPv6 is not supported currently.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst index db35284..f273d0d 100644 --- a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst @@ -57,18 +57,18 @@ Request Message .. table:: **Table 4** **publicip_info** object - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================+ - | publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | No | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | | - Constraints: | - | | | | | - | | | | - The configured value must be supported by the system. | - | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================+ + | publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | No | String | - Specifies the EIP type. | + | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | | - Constraints: | + | | | | | + | | | | - The configured value must be supported by the system. | + | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ - Example request @@ -111,7 +111,7 @@ Response Message | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | size | Integer | - Specifies the bandwidth size. | - | | | - The value ranges from 5 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) | + | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) | +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the bandwidth ID, which uniquely identifies the bandwidth. | +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -153,26 +153,26 @@ Response Message .. table:: **Table 7** **publicip_info** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | - Specifies the IP address version. | - | | | - Possible values are as follows: | - | | | | - | | | - **4**: IPv4 | - | | | - **6**: IPv6 (IPv6 is not supported currently.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - Specifies the IP address version. | + | | | - Possible values are as follows: | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst index 0a77506..20694d1 100644 --- a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst @@ -47,12 +47,11 @@ Request Message +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=======================+=================+=================+================================================================================================================================================================================================================+ - | name | Yes | String | Specifies the bandwidth name. | - | | | | | - | | | | The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | name | Yes | String | - Specifies the bandwidth name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | size | Yes | Integer | - Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The default minimum value is 5 Mbit/s. | - | | | | - The value ranges from 5 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) | + | | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) | | | | | - If a decimal fraction (for example **10.2**) or a character string (for example **"10"**) is specified, the specified value will be automatically converted to an integer. | | | | | - The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: | | | | | | @@ -106,7 +105,7 @@ Response Message | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | size | Integer | - Specifies the bandwidth size. | - | | | - The value ranges from 5 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) | + | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) | +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the bandwidth ID, which uniquely identifies the bandwidth. | +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -154,20 +153,20 @@ Response Message .. table:: **Table 6** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/elastic_ip/assigning_an_eip.rst b/api-ref/source/apis/eip/assigning_an_eip.rst similarity index 55% rename from api-ref/source/apis/elastic_ip/assigning_an_eip.rst rename to api-ref/source/apis/eip/assigning_an_eip.rst index 2dabcf8..20ceb47 100644 --- a/api-ref/source/apis/elastic_ip/assigning_an_eip.rst +++ b/api-ref/source/apis/eip/assigning_an_eip.rst @@ -10,7 +10,21 @@ Function This API is used to assign an EIP. -The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, load balancers, and NAT gateways. +The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers. + +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. URI --- @@ -29,99 +43,98 @@ POST /v1/{project_id}/publicips project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameter + + +-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===========+===========+=================================================================+==========================================================================================================+ + | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | + +-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth object. For details, see :ref:`Table 4 `. | + +-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +.. _en-us_topic_0020090596__table4491214: + +.. table:: **Table 3** Description of the **publicip** field + + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+===============================================================================================================================+ + | type | Yes | String | - Specifies the EIP type. | + | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | | - Constraints: | + | | | | | + | | | | - The configured value must be supported by the system. | + | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | No | Integer | - Specifies the EIP version. | + | | | | - The value can be **4** and **6**, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently. | + | | | | - Constraints: | + | | | | | + | | | | - The configured value must be supported by the system. | + | | | | - If this parameter is left blank or is an empty string, IPv4 address is created by default. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | alias | No | String | - Specifies the EIP name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + +.. _en-us_topic_0020090596__table11041789: + +.. table:: **Table 4** Description of the **bandwidth** field + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================================================================================================================================================================+ + | name | Yes | String | - Specifies the bandwidth name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Yes | Integer | - Specifies the bandwidth size. | + | | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.) | + | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | + | | | | - The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: | + | | | | | + | | | | - The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included). | + | | | | - The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included). | + | | | | - The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | String | - Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP. | + | | | | - The value can be the ID of the shared bandwidth whose type is set to **WHOLE**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | share_type | Yes | String | - Specifies the bandwidth type. | + | | | | - Possible values are as follows: | + | | | | | + | | | | - **PER**: Dedicated bandwidth | + | | | | - **WHOLE**: Shared bandwidth | + | | | | | + | | | | - If this parameter is set to **WHOLE**, the bandwidth ID must be specified. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | No | String | - The value is **traffic**, indicating that the billing is based on traffic. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter +Example request (IPv4 EIP with dedicated bandwidth) - .. table:: **Table 2** Request parameter +.. code-block:: text - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================================================================+==================================================================================================================================================+ - | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth object. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | - | | | | - When you assign an EIP, associate an enterprise project ID with the EIP. | - | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + POST https://{Endpoint}/v1/{project_id}/publicips - .. _en-us_topic_0020090596__table4491214: - - .. table:: **Table 3** Description of the **publicip** field - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================+ - | type | Yes | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | | - Constraints: | - | | | | | - | | | | - The configured value must be supported by the system. | - | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | String | - Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it. | - | | | | - The value must be a valid IPv4 address in the available IP address range. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - - .. _en-us_topic_0020090596__table11041789: - - .. table:: **Table 4** Description of the **bandwidth** field - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================================================================================================================================+ - | name | Yes | String | - Specifies the bandwidth name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes | Integer | - Specifies the bandwidth size. | - | | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.) | - | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | - | | | | - The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: | - | | | | | - | | | | - The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included). | - | | | | - The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included). | - | | | | - The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | - Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP. | - | | | | - The value can be the ID of the shared bandwidth whose type is set to **WHOLE**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | share_type | Yes | String | - Specifies the bandwidth type. | - | | | | - Possible values are as follows: | - | | | | | - | | | | - **PER**: Dedicated bandwidth | - | | | | - **WHOLE**: Shared bandwidth | - | | | | | - | | | | - If this parameter is set to **WHOLE**, the bandwidth ID must be specified. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | No | String | - The value is **traffic**, indicating that the billing is based on traffic. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request (IPv4 EIP with dedicated bandwidth) - - .. code-block:: text - - POST https://{Endpoint}/v1/{project_id}/publicips - - { - "publicip": { - "type": "5_bgp", - "ip_version": 4 - }, - "bandwidth": { - "name": "bandwidth123", - "size": 10, - "share_type": "PER" - }, - "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439" - } + { + "publicip": { + "type": "5_bgp", + "ip_version": 4 + }, + "bandwidth": { + "name": "bandwidth123", + "size": 10, + "share_type": "PER" + } + } Response Message ---------------- @@ -154,13 +167,16 @@ Response Message | | | - **PENDING_DELETE** (Releasing) | | | | - **PENDING_CREATE** (Assigning) | | | | - **PENDING_UPDATE** (Updating) | + | | | - **NOTIFYING** (Assigning) | + | | | - **NOTIFY_DELETE** (Release) | | | | - **DOWN** (Unbound) | | | | - **ACTIVE** (Bound) | | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -176,35 +192,49 @@ Response Message | tenant_id | String | Specifies the project ID. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | create_time | String | Specifies the time (UTC) when the EIP is assigned. | + | | | | + | | | Format: *yyyy-MM-dd HH:mm:ss* | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When you assign an EIP, associate an enterprise project ID with the EIP. | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Specifies whether it is in a central site or an edge site. | | | | | - | | | .. note:: | + | | | The value can be: | | | | | - | | | This parameter is unsupported. Do not use it. | + | | | - center | + | | | - *Edge site name* | + | | | | + | | | This resource can only be associated with an EIP of the same region. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -- Example response (IPv4 EIP with dedicated bandwidth) +Example Response +---------------- - .. code-block:: +Example response (IPv4 EIP with dedicated bandwidth) - { - "publicip": { - "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706", - "status": "PENDING_CREATE", - "type": "5_bgp", - "public_ip_address": "161.xx.xx.7", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "ip_version": 4, - "create_time": "2015-07-16 04:10:52", - "bandwidth_size": 0, - "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439" - } - } +.. code-block:: + + { + "publicip": { + "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706", + "alias": "tom", + "public_border_group": "center", + "status": "PENDING_CREATE", + "type": "5_bgp", + "public_ip_address": "161.xx.xx.7", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "ip_version": 4, + "create_time": "2015-07-16 04:10:52", + "bandwidth_size": 0, + "enterprise_project_id": "b261ac1f-2489-4bc7-b31b-c33c3346a439" + } + } Status Code ----------- diff --git a/api-ref/source/apis/elastic_ip/index.rst b/api-ref/source/apis/eip/index.rst similarity index 94% rename from api-ref/source/apis/elastic_ip/index.rst rename to api-ref/source/apis/eip/index.rst index 50fc1b8..beb2730 100644 --- a/api-ref/source/apis/elastic_ip/index.rst +++ b/api-ref/source/apis/eip/index.rst @@ -2,8 +2,8 @@ .. _vpc_eip_0000: -Elastic IP -========== +EIP +=== - :ref:`Assigning an EIP ` - :ref:`Querying an EIP ` diff --git a/api-ref/source/apis/elastic_ip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst similarity index 77% rename from api-ref/source/apis/elastic_ip/querying_an_eip.rst rename to api-ref/source/apis/eip/querying_an_eip.rst index db7ea0b..d39a4e9 100644 --- a/api-ref/source/apis/elastic_ip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -10,6 +10,20 @@ Function This API is used to query a specific EIP. +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + URI --- @@ -72,15 +86,20 @@ Response Message | | | - **PENDING_DELETE** (Releasing) | | | | - **PENDING_CREATE** (Assigning) | | | | - **PENDING_UPDATE** (Updating) | + | | | - **NOTIFYING** (Assigning) | + | | | - **NOTIFY_DELETE** (Releasing) | | | | - **DOWN** (Unbound) | | | | - **ACTIVE** (Bound) | | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | + | | | | + | | | This parameter is not supported currently. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -98,18 +117,20 @@ Response Message | | | | | | | .. note:: | | | | | - | | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | port_id | String | - Specifies the port ID. | | | | - This parameter is returned only when a port is associated with the EIP. | | | | | | | | .. note:: | | | | | - | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | create_time | String | Specifies the time (UTC) when the EIP is assigned. | + | | | | + | | | Format: *yyyy-MM-dd HH:mm:ss* | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_id | String | Specifies the ID of the EIP bandwidth. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -123,6 +144,8 @@ Response Message +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_name | String | Specifies the bandwidth name. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | @@ -131,6 +154,15 @@ Response Message | | | | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Specifies whether it is in a central site or an edge site. | + | | | | + | | | The value can be: | + | | | | + | | | - center | + | | | - *Edge site name* | + | | | | + | | | An EIP can only be bound to a resource of the same region. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_eip_0002__table66651219193417: @@ -153,6 +185,7 @@ Response Message "publicip": { "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568", "status": "DOWN", + "alias": "tom", "profile": {}, "type": "5_bgp", "public_ip_address": "161.xx.xx.12", diff --git a/api-ref/source/apis/elastic_ip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst similarity index 84% rename from api-ref/source/apis/elastic_ip/querying_eips.rst rename to api-ref/source/apis/eip/querying_eips.rst index 5bc28aa..66a30c5 100644 --- a/api-ref/source/apis/elastic_ip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -10,6 +10,20 @@ Function This API is used to query EIPs. +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + URI --- @@ -30,12 +44,12 @@ GET /v1/{project_id}/publicips | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -97,9 +111,11 @@ Response Message | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | + | | | | + | | | This parameter is not supported currently. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -117,18 +133,20 @@ Response Message | | | | | | | .. note:: | | | | | - | | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | port_id | String | - Specifies the port ID. | | | | - This parameter is returned only when a port is associated with the EIP. | | | | | | | | .. note:: | | | | | - | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | create_time | String | Specifies the time (UTC) when the EIP is assigned. | + | | | | + | | | Format: *yyyy-MM-dd HH:mm:ss* | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_id | String | Specifies the ID of the EIP bandwidth. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -142,6 +160,8 @@ Response Message +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_name | String | Specifies the bandwidth name. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | @@ -150,6 +170,15 @@ Response Message | | | | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Specifies whether it is in a central site or an edge site. | + | | | | + | | | The value can be: | + | | | | + | | | - center | + | | | - *Edge site name* | + | | | | + | | | An EIP can only be bound to a resource of the same region. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_eip_0003__table66651219193417: @@ -173,6 +202,7 @@ Response Message { "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", "status": "DOWN", + "alias": "tom", "profile": {}, "type": "5_bgp", "public_ip_address": "161.xx.xx.9", diff --git a/api-ref/source/apis/eip/releasing_an_eip.rst b/api-ref/source/apis/eip/releasing_an_eip.rst new file mode 100644 index 0000000..6553e6e --- /dev/null +++ b/api-ref/source/apis/eip/releasing_an_eip.rst @@ -0,0 +1,86 @@ +:original_name: vpc_eip_0005.html + +.. _vpc_eip_0005: + +Releasing an EIP +================ + +Function +-------- + +This API is used to release an EIP. + +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + +URI +--- + +DELETE /v1/{project_id}/publicips/{publicip_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_eip_0005__table45251091: + +.. table:: **Table 1** Parameter description + + =========== ========= ========================================== + Name Mandatory Description + =========== ========= ========================================== + project_id Yes Specifies the project ID. + publicip_id Yes Specifies the unique identifier of an EIP. + =========== ========= ========================================== + +Request Message +--------------- + +- Request parameter + + None + +- Example request + + .. code-block:: text + + DELETE https://{Endpoint}/v1/{project_id}/publicips/{publicip_id} + +Response Message +---------------- + +- Response parameter + + None + +- Example response + + None + + Or + + .. code-block:: + + { + "code":"xxx", + "message":"xxxxx" + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/elastic_ip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst similarity index 76% rename from api-ref/source/apis/elastic_ip/updating_an_eip.rst rename to api-ref/source/apis/eip/updating_an_eip.rst index 8dc8747..b8fff13 100644 --- a/api-ref/source/apis/elastic_ip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -12,7 +12,17 @@ This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC. .. note:: - This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer. + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. URI --- @@ -58,6 +68,9 @@ Request Message | | | | | | | | | Leaving this parameter blank does not unbind the EIP from the dedicated load balancer. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | No | String | - Specifies the EIP name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Example request 1 (Binding an EIP to a NIC) @@ -102,21 +115,26 @@ Response Message | | | - **PENDING_DELETE** (Releasing) | | | | - **PENDING_CREATE** (Assigning) | | | | - **PENDING_UPDATE** (Updating) | + | | | - **NOTIFYING** (Assigning) | + | | | - **NOTIFY_DELETE** (Releasing) | | | | - **DOWN** (Unbound) | | | | - **ACTIVE** (Bound) | | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 6 `. | + | | | | + | | | This parameter is not supported currently. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + | public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. (IPv6 is not supported currently.) | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. The value can be **4** or **6**. | | | | | @@ -128,18 +146,20 @@ Response Message | | | | | | | .. note:: | | | | | - | | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | port_id | String | - Specifies the port ID. | | | | - This parameter is returned only when a port is associated with the EIP. | | | | | | | | .. note:: | | | | | - | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | create_time | String | Specifies the time (UTC) when the EIP is assigned. | + | | | | + | | | Format: *yyyy-MM-dd HH:mm:ss* | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_id | String | Specifies the ID of the EIP bandwidth. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -151,6 +171,8 @@ Response Message | | | - **PER**: Dedicated bandwidth | | | | - **WHOLE**: Shared bandwidth | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When you assign an EIP, associate an enterprise project ID with the EIP. | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | @@ -159,6 +181,15 @@ Response Message | | | | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Specifies whether it is in a central site or an edge site. | + | | | | + | | | The value can be: | + | | | | + | | | - center | + | | | - *Edge site name* | + | | | | + | | | An EIP can only be bound to a resource of the same region. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_eip_0004__table66651219193417: @@ -181,6 +212,7 @@ Response Message "publicip": { "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb", "status": "ACTIVE", + "alias": "tom", "profile": {}, "type": "5_bgp", "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe", @@ -189,7 +221,11 @@ Response Message "tenant_id": "26ae5181a416420998eb2093aaed84d9", "create_time": "2019-03-27 01:33:18", "bandwidth_size": 7, - "ip_version": 4 + "ip_version": 4, + "bandwidth_name": "bandwidth-2aef", + "enterprise_project_id": "0", + "bandwidth_share_type": "PER", + "bandwidth_id": "7a258fff-10d8-44b8-8124-c59079eb8f4c" } } diff --git a/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst b/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst index 36c2900..4010acc 100644 --- a/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst +++ b/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst @@ -15,9 +15,9 @@ URI DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key} -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _eip_tag_0003__table27380479: +.. _eip_tag_0003__table5716115334: .. table:: **Table 1** Parameter description diff --git a/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst b/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst index ea4d515..8b7b1d5 100644 --- a/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst +++ b/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst @@ -15,9 +15,9 @@ URI GET /v2.0/{project_id}/publicips/{publicip_id}/tags -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _eip_tag_0002__table27380479: +.. _eip_tag_0002__table450964213214: .. table:: **Table 1** Parameter description diff --git a/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst b/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst index dcea71e..8b0cc2c 100644 --- a/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst @@ -63,7 +63,7 @@ Response Message | key | String | Specifies the tag key. | | | | | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -73,7 +73,7 @@ Response Message +-----------------------+-----------------------+---------------------------------------------------------------------+ | values | Array of strings | Specifies the tag value list. | | | | | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/elastic_ip/releasing_an_eip.rst b/api-ref/source/apis/elastic_ip/releasing_an_eip.rst deleted file mode 100644 index 9593e24..0000000 --- a/api-ref/source/apis/elastic_ip/releasing_an_eip.rst +++ /dev/null @@ -1,72 +0,0 @@ -:original_name: vpc_eip_0005.html - -.. _vpc_eip_0005: - -Releasing an EIP -================ - -Function --------- - -This API is used to release an EIP. - -URI ---- - -DELETE /v1/{project_id}/publicips/{publicip_id} - -:ref:`Table 1 ` describes the parameters. - -.. _vpc_eip_0005__table45251091: - -.. table:: **Table 1** Parameter description - - =========== ========= ========================================== - Name Mandatory Description - =========== ========= ========================================== - project_id Yes Specifies the project ID. - publicip_id Yes Specifies the unique identifier of an EIP. - =========== ========= ========================================== - -Request Message ---------------- - -- Request parameter - - None - -- Example request - - .. code-block:: text - - DELETE https://{Endpoint}/v1/{project_id}/publicips - -Response Message ----------------- - -- Response parameter - - None - -- Example response - - None - - Or - - .. code-block:: - - { - "code":"xxx", - "message":"xxxxx" - } - -Status Code ------------ - -See :ref:`Status Codes `. - -Error Code ----------- - -See :ref:`Error Codes `. diff --git a/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst b/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst index 52c0320..79b23a3 100644 --- a/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst +++ b/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst @@ -127,7 +127,7 @@ Response Message ], "floatingips_links": [ { - "href": "https://network.region.cn-southwest-2.hwclouds.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True", + "href": "https://vpc.region.otctest.t-systems.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True", "rel": "previous" } ] diff --git a/api-ref/source/apis/index.rst b/api-ref/source/apis/index.rst index 6371abb..69eb276 100644 --- a/api-ref/source/apis/index.rst +++ b/api-ref/source/apis/index.rst @@ -7,7 +7,7 @@ APIs - :ref:`Virtual Private Cloud ` - :ref:`Subnet ` -- :ref:`Elastic IP ` +- :ref:`EIP ` - :ref:`Floating IP Address (IPv6) ` - :ref:`Bandwidth ` - :ref:`Bandwidth (V2.0) ` @@ -16,6 +16,7 @@ APIs - :ref:`Security Group ` - :ref:`VPC Peering Connection ` - :ref:`VPC Route ` +- :ref:`Route Table ` - :ref:`VPC Tag Management ` - :ref:`Subnet Tag Management ` - :ref:`EIP Tag Management ` @@ -28,7 +29,7 @@ APIs virtual_private_cloud/index subnet/index - elastic_ip/index + eip/index floating_ip_address_ipv6/index bandwidth/index bandwidth_v2.0/index @@ -37,6 +38,7 @@ APIs security_group/index vpc_peering_connection/index vpc_route/index + route_table/index vpc_tag_management/index subnet_tag_management/index eip_tag_management/index diff --git a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst index 6a2074c..3b29478 100644 --- a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst +++ b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst @@ -27,35 +27,36 @@ POST /v1/{project_id}/privateips project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+=======================================================================+================================================================================================================+ + | privateips | Yes | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | + +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_privateip_0001__table45335391: + +.. table:: **Table 3** Description of the **privateip** field + + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+====================================================================================================================================+ + | subnet_id | Yes | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | | + | | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | No | String | - Specifies the target IP address. | + | | | | - The value can be an available IP address in the subnet. If it is not specified, the system automatically assigns an IP address. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +============+===========+=======================================================================+================================================================================================================+ - | privateips | Yes | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | - +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_privateip_0001__table45335391: - - .. table:: **Table 3** Description of the **privateip** field - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+====================================================================================================================================+ - | subnet_id | Yes | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | | - | | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | String | - Specifies the target IP address. | - | | | | - The value can be an available IP address in the subnet. If it is not specified, the system automatically assigns an IP address. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Assign two private IP addresses from the subnet whose ID is 531dec0f-3116-411b-a21b-e612e42349fd. One IP address is automatically assigned, and the other is specified to 192.168.1.17. .. code-block:: text @@ -74,71 +75,88 @@ Request Message ] } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+=======================================================================+================================================================================================================+ + | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 5 `. | + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_privateip_0001__table34571880: + +.. table:: **Table 5** Description of the **privateip** field + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | **network:nat_gateway**: IP address used by a NAT gateway | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+=======================================================================+================================================================================================================+ - | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 5 `. | - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_privateip_0001__table34571880: - - .. table:: **Table 5** Description of the **privateip** field - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================================================================================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "privateips": [ - { - "status": "DOWN", - "id": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.10" - }, - { - "status": "DOWN", - "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.17" - } - ] - } + { + "privateips": [ + { + "status": "DOWN", + "id": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.10" + }, + { + "status": "DOWN", + "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.17" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst b/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst index fa7dcdc..9dd4206 100644 --- a/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst +++ b/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst @@ -29,31 +29,27 @@ DELETE /v1/{project_id}/privateips/{privateip_id} | privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | +--------------+-----------+-----------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d - -Response Message +Example Response ---------------- -- Request parameter - - None - -- Example response - - .. code-block:: text - - None +None Status Code ----------- diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst index ca3c05c..3c18e17 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst @@ -29,75 +29,91 @@ GET /v1/{project_id}/privateips/{privateip_id} | privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | +--------------+-----------+-----------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78 + +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+=============================================================+================================================================================================================+ + | privateip | :ref:`privateip ` object | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | + +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -Response --------- +.. _vpc_privateip_0002__table23250319: -- Response parameter +.. table:: **Table 3** Description of the **privateip** field - .. table:: **Table 2** Response parameter + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | **network:nat_gateway**: IP address used by a NAT gateway | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+=============================================================+================================================================================================================+ - | privateip | :ref:`privateip ` object | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | - +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +Example Response +---------------- - .. _vpc_privateip_0002__table23250319: +.. code-block:: - .. table:: **Table 3** Description of the **privateip** field - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================================================================================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "privateip": - { - "status": "DOWN", - "id": "d600542a-b231-45ed-af05-e9930cb14f78", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.11" - } - } + { + "privateip": + { + "status": "DOWN", + "id": "d600542a-b231-45ed-af05-e9930cb14f78", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.11" + } + } Status Code ----------- diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst index d602235..a550eff 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst @@ -40,94 +40,110 @@ Example: | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Request parameter - GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+=======================================================================+================================================================================================================+ + | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_privateip_0003__table21538022: + +.. table:: **Table 3** Description of the **privateip** field + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | **network:nat_gateway**: IP address used by a NAT gateway | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Request parameter +.. code-block:: - .. table:: **Table 2** Request parameter - - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+=======================================================================+================================================================================================================+ - | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_privateip_0003__table21538022: - - .. table:: **Table 3** Description of the **privateip** field - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================================================================================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "privateips": [ - { - "status": "DOWN", - "id": "d600542a-b231-45ed-af05-e9930cb14f78", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.11" - }, - { - "status": "DOWN", - "id": "d600542a-b231-45ed-af05-e9930cb14f79", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.12" - } - ] - } + { + "privateips": [ + { + "status": "DOWN", + "id": "d600542a-b231-45ed-af05-e9930cb14f78", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.11" + }, + { + "status": "DOWN", + "id": "d600542a-b231-45ed-af05-e9930cb14f79", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.12" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst b/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst index 579a24b..44355e4 100644 --- a/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst +++ b/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst @@ -35,97 +35,95 @@ GET /v2.0/network-ip-availabilities/{network_id} network_id String Yes Specifies the network ID. ========== ====== ========= ========================= -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043 + +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+================================================================================+==============================================================================================================================+ + | network_ip_availability | :ref:`network_ip_availability ` object | Specifies the **network_ip_availability** objects. For details, see :ref:`Table 3 `. | + +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_natworkip_0001__table4952133061113: + +.. table:: **Table 3** **network_ip_availability** objects + + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +========================+========================================================================================+=========================================================================================================================+ + | network_id | String | Specifies the network ID. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | network_name | String | Specifies the network name. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | total_ips | Integer | Specifies the total number of IP addresses on a network. (System reserved IP addresses are not included.) | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | used_ips | Integer | Specifies the number of in-use IP addresses on a network. (Reserved IP addresses are not included.) | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | subnet_ip_availability | Array of :ref:`subnet_ip_availability ` objects | Specifies the subnet IP address usage objects. For details, see :ref:`Table 4 `. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_natworkip_0001__table110015141519: + +.. table:: **Table 4** Description of the **subnet_ip_availability** field + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================+ + | used_ips | Integer | Specifies the number of in-use IP addresses on a subnet. (System reserved IP addresses are not included.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the subnet ID. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | subnet_name | String | Specifies the subnet name. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP version of the subnet. Only IPv4 is supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+================================================================================+==============================================================================================================================+ - | network_ip_availability | :ref:`network_ip_availability ` object | Specifies the **network_ip_availability** objects. For details, see :ref:`Table 3 `. | - +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_natworkip_0001__table4952133061113: - - .. table:: **Table 3** **network_ip_availability** objects - - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +========================+========================================================================================+=========================================================================================================================+ - | network_id | String | Specifies the network ID. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | network_name | String | Specifies the network name. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | total_ips | Integer | Specifies the total number of IP addresses on a network. (System reserved IP addresses are not included.) | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | used_ips | Integer | Specifies the number of in-use IP addresses on a network. (Reserved IP addresses are not included.) | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | subnet_ip_availability | Array of :ref:`subnet_ip_availability ` objects | Specifies the subnet IP address usage objects. For details, see :ref:`Table 4 `. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_natworkip_0001__table110015141519: - - .. table:: **Table 4** Description of the **subnet_ip_availability** field - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================================+ - | used_ips | Integer | Specifies the number of in-use IP addresses on a subnet. (System reserved IP addresses are not included.) | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the subnet ID. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | subnet_name | String | Specifies the subnet name. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP version of the subnet. Only IPv4 is supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "network_ip_availability": { - "used_ips": 4, - "subnet_ip_availability": [ - { - "used_ips": 4, - "subnet_id": "98e343d1-3cb8-4f69-9cd1-00569819480f", - "subnet_name": "", - "ip_version": 4, - "cidr": "10.0.0.0/8", - "total_ips": 300 - } - ], - "network_id": "6b50d967-779c-40c9-a157-de1df3c17043", - "tenant_id": "7c4b23cb125d481c95cbe4f91b2c11cd", - "total_ips": 300, - "network_name": "pch_test_003" - } - } + { + "network_ip_availability": { + "used_ips": 4, + "subnet_ip_availability": [ + { + "used_ips": 4, + "subnet_id": "98e343d1-3cb8-4f69-9cd1-00569819480f", + "subnet_name": "", + "ip_version": 4, + "cidr": "10.0.0.0/8", + "total_ips": 300 + } + ], + "network_id": "6b50d967-779c-40c9-a157-de1df3c17043", + "tenant_id": "7c4b23cb125d481c95cbe4f91b2c11cd", + "total_ips": 300, + "network_name": "pch_test_003" + } + } Status Code ----------- diff --git a/api-ref/source/apis/quota/querying_quotas.rst b/api-ref/source/apis/quota/querying_quotas.rst index c99c2b3..077abd4 100644 --- a/api-ref/source/apis/quota/querying_quotas.rst +++ b/api-ref/source/apis/quota/querying_quotas.rst @@ -27,215 +27,210 @@ Example: .. table:: **Table 1** Parameter description - +-----------------+-----------------+-----------------+---------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=================================+ - | project_id | Yes | String | Specifies the project ID. | - +-----------------+-----------------+-----------------+---------------------------------+ - | type | No | String | - Specifies the resource type. | - | | | | - Values: | - | | | | | - | | | | - vpc | - | | | | - subnet | - | | | | - securityGroup | - | | | | - securityGroupRule | - | | | | - publicIp | - | | | | - vpn | - | | | | - vpngw | - | | | | - vpcPeer | - | | | | - loadbalancer | - | | | | - listener | - | | | | - physicalConnect | - | | | | - virtualInterface | - | | | | - firewall | - | | | | - shareBandwidthIP | - | | | | - shareBandwidth | - | | | | - address_group | - | | | | - flow_log | - | | | | - vpcContainRoutetable | - | | | | - routetableContainRoutes | - +-----------------+-----------------+-----------------+---------------------------------+ + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+==============================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ + | type | No | String | - Specifies the resource type. | + | | | | - Values: | + | | | | | + | | | | - **vpc**: VPC | + | | | | - **subnet**: Subnet | + | | | | - **securityGroup**: Security group | + | | | | - **securityGroupRule**: Security group rule | + | | | | - **publicIp**: EIP | + | | | | - **vpn**: VPN | + | | | | - **vpcPeer**: VPC peering connection | + | | | | - **loadbalancer**: Load balancer | + | | | | - **listener**: Load balancer listener | + | | | | - **physicalConnect**: Direct Connect connection | + | | | | - **virtualInterface**: Virtual interface | + | | | | - **firewall**: Firewall | + | | | | - **shareBandwidthIP**: IP address added to a shared bandwidth | + | | | | - **shareBandwidth**: Shared bandwidth | + | | | | - **address_group**: IP address group | + | | | | - **flow_log**: VPC fow log | + | | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | + | | | | - **routetableContainRoutes**: Number of routes in a route table | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - .. code-block:: text + GET https://{Endpoint}/v1/{project_id}/quotas - None +Response Parameters +------------------- -- Example request +.. table:: **Table 2** Response parameter - .. code-block:: text + +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +========+============================================================+====================================================================================================+ + | quotas | :ref:`quotas ` object | Specifies the quota object. For details, see :ref:`Table 3 `. | + +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ - GET https://{Endpoint}/v1/{project_id}/quotas +.. _vpc_quota_0001__table11308015155544: -Response Message +.. table:: **Table 3** Description of the **quotas** field + + +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+=================================================================+=================================================================================================+ + | resources | Array of :ref:`resource ` objects | Specifies the resource objects. For details, see :ref:`Table 4 `. | + +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + +.. _vpc_quota_0001__table8208684: + +.. table:: **Table 4** Description of the **resource** field + + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==============================================================================+ + | type | String | - Specifies the resource type. | + | | | - Values: | + | | | | + | | | - **vpc**: VPC | + | | | - **subnet**: Subnet | + | | | - **securityGroup**: Security group | + | | | - **securityGroupRule**: Security group rule | + | | | - **publicIp**: EIP | + | | | - **vpn**: VPN | + | | | - **vpcPeer**: VPC peering connection | + | | | - **loadbalancer**: Load balancer | + | | | - **listener**: Load balancer listener | + | | | - **physicalConnect**: Direct Connect connection | + | | | - **virtualInterface**: Virtual interface | + | | | - **firewall**: Firewall | + | | | - **shareBandwidthIP**: IP address added to a shared bandwidth | + | | | - **shareBandwidth**: Shared bandwidth | + | | | - **address_group**: IP address group | + | | | - **flow_log**: VPC fow log | + | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | + | | | - **routetableContainRoutes**: Number of routes in a route table | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | used | Integer | - Specifies the number of created network resources. | + | | | - The value ranges from **0** to the value of **quota**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | quota | Integer | - Specifies the maximum quota values for the resources. | + | | | - The value ranges from the default quota value to the maximum quota value. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | min | Integer | Specifies the minimum quota value allowed. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + +.. note:: + + If value **-1** is returned when you use an API to query your VPC quota, this indicates that the VPC quota is not limited. + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +========+============================================================+====================================================================================================+ - | quotas | :ref:`quotas ` object | Specifies the quota object. For details, see :ref:`Table 3 `. | - +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ - - .. _vpc_quota_0001__table11308015155544: - - .. table:: **Table 3** Description of the **quotas** field - - +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+=================================================================+=================================================================================================+ - | resources | Array of :ref:`resource ` objects | Specifies the resource objects. For details, see :ref:`Table 4 `. | - +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ - - .. _vpc_quota_0001__table8208684: - - .. table:: **Table 4** Description of the **resource** field - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=============================================================================================================+ - | type | String | - Specifies the resource type. | - | | | - Values: | - | | | | - | | | - vpc | - | | | - subnet | - | | | - securityGroup | - | | | - securityGroupRule | - | | | - publicIp | - | | | - vpn | - | | | - vpngw | - | | | - vpcPeer | - | | | - loadbalancer | - | | | - listener | - | | | - physicalConnect | - | | | - virtualInterface | - | | | - firewall | - | | | - shareBandwidthIP | - | | | - shareBandwidth | - | | | - address_group | - | | | - flow_log | - | | | - vpcContainRoutetable | - | | | - routetableContainRoutes | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ - | used | Integer | - Specifies the number of created network resources. | - | | | - The value ranges from **0** to the value of **quota**. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ - | quota | Integer | - Specifies the maximum quota values for the resources. | - | | | | - | | | - The value ranges from the default quota value to the maximum quota value. | - | | | | - | | | - The default quota values can be changed. Configure the quota values in the underlying system in advance. | - | | | | - | | | Default quota values: | - | | | | - | | | - VPC: 150 | - | | | - Subnet: 400 | - | | | - Security group: 100 | - | | | - Security group rule: 5000 | - | | | - EIPs: 10 | - | | | - VPNs: 5 | - | | | - VPC peering connections: 50 | - | | | - Load balancers: 10 | - | | | - Listeners: 10 | - | | | - Firewalls: 200 | - | | | - EIPs that can be added to a shared bandwidth: 20 | - | | | - Shared bandwidths: 5 | - | | | - IP address groups: 50 | - | | | - Route table per VPC: 1 | - | | | - Routes per route table: 200 | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ - | min | Integer | Specifies the minimum quota value allowed. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "quotas": { - "resources": [ - { - "type": "vpc", - "used": 4, - "quota": 150, - "min": 0 - }, - { - "type": "subnet", - "used": 5, - "quota": 400, - "min": 0 - }, - { - "type": "securityGroup", - "used": 1, - "quota": 100, - "min": 0 - }, - { - "type": "securityGroupRule", - "used": 6, - "quota": 5000, - "min": 0 - }, - { - "type": "publicIp", - "used": 2, - "quota": 10, - "min": 0 - }, - { - "type": "vpn", - "used": 0, - "quota": 5, - "min": 0 - }, - { - "type": "vpcPeer", - "used": 0, - "quota": 50, - "min": 0 - }, - { - "type": "firewall", - "used": 0, - "quota": 200, - "min": 0 - }, - { - "type": "shareBandwidth", - "used": 0, - "quota": 5, - "min": 0 - }, - { - "type": "shareBandwidthIP", - "used": 0, - "quota": 20, - "min": 0 - }, - { - "type": "loadbalancer", - "used": 0, - "quota": 10, - "min": 0 - }, - { - "type": "listener", - "used": 0, - "quota": 10, - "min": 0 - } - ] - } - } + { + "quotas": { + "resources": [ + { + "type": "vpc", + "used": 4, + "quota": 150, + "min": 0 + }, + { + "type": "subnet", + "used": 5, + "quota": 400, + "min": 0 + }, + { + "type": "securityGroup", + "used": 1, + "quota": 100, + "min": 0 + }, + { + "type": "securityGroupRule", + "used": 6, + "quota": 5000, + "min": 0 + }, + { + "type": "publicIp", + "used": 2, + "quota": 10, + "min": 0 + }, + { + "type": "vpn", + "used": 0, + "quota": 5, + "min": 0 + }, + { + "type": "vpcPeer", + "used": 0, + "quota": 50, + "min": 0 + }, + { + "type": "firewall", + "used": 0, + "quota": 200, + "min": 0 + }, + { + "type": "shareBandwidth", + "used": 0, + "quota": 5, + "min": 0 + }, + { + "type": "shareBandwidthIP", + "used": 0, + "quota": 20, + "min": 0 + }, + { + "type": "loadbalancer", + "used": 0, + "quota": 10, + "min": 0 + }, + { + "type": "listener", + "used": 0, + "quota": 10, + "min": 0 + }, + { + "type": "vpcContainRoutetable", + "used": 0, + "quota": 1, + "min": 0 + }, + { + "type": "routetableContainRoutes", + "used": 0, + "quota": 200, + "min": 0 + }, + { + "type": "address_group", + "used": 0, + "quota": 50, + "min": 0 + } + ] + } + } Status Code ----------- diff --git a/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst b/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst new file mode 100644 index 0000000..61c9ec6 --- /dev/null +++ b/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst @@ -0,0 +1,215 @@ +:original_name: vpc_apiroutetab_0005.html + +.. _vpc_apiroutetab_0005: + +Associating Subnets with a Route Table +====================================== + +Function +-------- + +This API is used to associate a subnet with a route table. + +If a subnet has already been associated with route table A, you can associate the subnet with route table B directly without disassociating it from route table A first. + +For details, see `Associating a Route Table with a Subnet `__. + +URI +--- + +POST /v1/{project_id}/routetables/{routetable_id}/action + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0005__table125312228469: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+====================================================================+=======================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table104243226461: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================================================================+==================================================================================================================================+ + | subnets | Yes | :ref:`subnet ` object | - Specifies the subnets associated with the route table. | + | | | | - Only subnets (specified by **network_id**) in the VPC that the route table belongs to can be associated with the route table. | + +-----------------+-----------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table12518142212468: + +.. table:: **Table 4** Description of the **subnet** field + + +--------------+-----------+------------------+----------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==============+===========+==================+==================================================================================+ + | associate | No | Array of strings | Specifies a list of IDs of the subnets to be associated with the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------------+ + | disassociate | No | Array of strings | Specifies a list of IDs of the subnets to be disassociated from the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------------+ + +Example Request +--------------- + +- Associate route table 3d42a0d4-a980-4613-ae76-a2cddecff054 with subnet 1a8b8c98-3976-401b-a735-8b058109268c. + + .. code-block:: text + + POST https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054/action + + { + "routetable": { + "subnets": { + "associate": [ + "1a8b8c98-3976-401b-a735-8b058109268c" + ] + } + } + } + +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 6 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table884119412392: + +.. table:: **Table 6** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 7 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 8 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table1687317463915: + +.. table:: **Table 7** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table17950204203919: + +.. table:: **Table 8** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/creating_a_route_table.rst b/api-ref/source/apis/route_table/creating_a_route_table.rst new file mode 100644 index 0000000..d920568 --- /dev/null +++ b/api-ref/source/apis/route_table/creating_a_route_table.rst @@ -0,0 +1,258 @@ +:original_name: vpc_apiroutetab_0003.html + +.. _vpc_apiroutetab_0003: + +Creating a Route Table +====================== + +Function +-------- + +This API is used to create a route table. + +Notes and Constraints + +- The destination CIDR block of a custom route table cannot be included in the CIDR blocks of the local route. +- Each destination CIDR block of a route in the same route table must be unique. +- No more than five routes can be created at a time. + +URI +--- + +POST /v1/{project_id}/routetables + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0003__table1211341604611: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ========================= + Name Mandatory Type Description + ========== ========= ====== ========================= + project_id Yes String Specifies the project ID. + ========== ========= ====== ========================= + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+======================================================================+=========================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0003__table18269181620462: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==========================================================================+================================================================================================================================+ + | name | No | String | - Specifies the route table name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | routes | No | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | | - Each route table can have a maximum of 200 routes. | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route table. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0003__table1539412169467: + +.. table:: **Table 4** Description of the **route** field + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +Example Request +--------------- + +- Create a route table named **routetable-1234** for the VPC whose ID is 60c809cb-6731-45d0-ace8-3bf5626421a9 and create a route with next hop type of ECS. + + .. code-block:: text + + POST https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables + + { + "routetable": { + "name": "routetable-1234", + "vpc_id": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "routes":[ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop":"7c50463d-d36c-4417-aa85-cc11fa10f341" + } + ], + "description":"abc" + } + } + +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 6 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0003__table884119412392: + +.. table:: **Table 6** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 5 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 7** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. table:: **Table 8** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/deleting_a_route_table.rst b/api-ref/source/apis/route_table/deleting_a_route_table.rst new file mode 100644 index 0000000..6bbe21f --- /dev/null +++ b/api-ref/source/apis/route_table/deleting_a_route_table.rst @@ -0,0 +1,66 @@ +:original_name: vpc_apiroutetab_0006.html + +.. _vpc_apiroutetab_0006: + +Deleting a Route Table +====================== + +Function +-------- + +This API is used to delete a custom route table. + +Constraints: + +Only custom route tables can be deleted. If a custom route table has subnets associated, disassociate the subnets with the route table and then delete the route table. + +URI +--- + +DELETE /v1/{project_id}/routetables/{routetable_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0006__table13893430173220: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Example Request +--------------- + +.. code-block:: text + + DELETE https://{Endpoint}/v1/{project_id}/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054 + +Response Parameters +------------------- + +None + +Example Response +---------------- + +None + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst b/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst new file mode 100644 index 0000000..91c8cce --- /dev/null +++ b/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst @@ -0,0 +1,219 @@ +:original_name: vpc_apiroutetab_0007.html + +.. _vpc_apiroutetab_0007: + +Disassociating Subnets from a Route Table +========================================= + +Function +-------- + +This API is used to disassociate subnets from a route table. + +For details, see `Associating a Route Table with a Subnet `__. + +URI +--- + +POST /v1/{project_id}/routetables/{routetable_id}/action + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0007__table125312228469: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+====================================================================+=======================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table104243226461: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================================================================+==================================================================================================================================+ + | subnets | Yes | :ref:`subnet ` object | - Specifies the subnets associated with the route table. | + | | | | - Only subnets (specified by **network_id**) in the VPC that the route table belongs to can be associated with the route table. | + +-----------------+-----------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table12518142212468: + +.. table:: **Table 4** Description of the **subnet** field + + +--------------+-----------+------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==============+===========+==================+============================================================================+ + | associate | No | Array of strings | Specifies the IDs of the subnets to be associated with the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------+ + | disassociate | No | Array of strings | Specifies the IDs of the subnets to be disassociated from the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------+ + +Example Request +--------------- + +- Disassociate route table 3d42a0d4-a980-4613-ae76-a2cddecff054 from subnet 815a6b9e-f766-48eb-967c-0ada72d85435. + + .. code-block:: text + + POST https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054/action + + { + "routetable": { + "subnets": { + "disassociate": [ + "815a6b9e-f766-48eb-967c-0ada72d85435" + ] + } + } + } + +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 6 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table884119412392: + +.. table:: **Table 6** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 7 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 8 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table1687317463915: + +.. table:: **Table 7** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table17950204203919: + +.. table:: **Table 8** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/index.rst b/api-ref/source/apis/route_table/index.rst new file mode 100644 index 0000000..4f107d2 --- /dev/null +++ b/api-ref/source/apis/route_table/index.rst @@ -0,0 +1,26 @@ +:original_name: vpc_apiroutetab_0000.html + +.. _vpc_apiroutetab_0000: + +Route Table +=========== + +- :ref:`Querying Route Tables ` +- :ref:`Querying a Route Table ` +- :ref:`Creating a Route Table ` +- :ref:`Updating a Route Table ` +- :ref:`Associating Subnets with a Route Table ` +- :ref:`Disassociating Subnets from a Route Table ` +- :ref:`Deleting a Route Table ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_route_tables + querying_a_route_table + creating_a_route_table + updating_a_route_table + associating_subnets_with_a_route_table + disassociating_subnets_from_a_route_table + deleting_a_route_table diff --git a/api-ref/source/apis/route_table/querying_a_route_table.rst b/api-ref/source/apis/route_table/querying_a_route_table.rst new file mode 100644 index 0000000..8390c05 --- /dev/null +++ b/api-ref/source/apis/route_table/querying_a_route_table.rst @@ -0,0 +1,201 @@ +:original_name: vpc_apiroutetab_0002.html + +.. _vpc_apiroutetab_0002: + +Querying a Route Table +====================== + +Function +-------- + +This API is used to query details about a route table. + +URI +--- + +GET /v1/{project_id}/routetables/{routetable_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0002__table12826134133917: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v1/26ae5181a416420998eb2093aaed84d9/routetables/66df8c1f-d4f6-4a63-9abb-09701fe27b39 + +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0002__table884119412392: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 5 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0002__table1687317463915: + +.. table:: **Table 4** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0002__table17950204203919: + +.. table:: **Table 5** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "05250d7e-0396-4fc9-9c9c-e4d5594784e4", + "name": "rtb-vpc-l2cg-1", + "routes": [ + { + "type": "local", + "destination": "192.168.4.0/24", + "nexthop": "-" + }, + { + "type": "local", + "destination": "192.168.1.0/24", + "nexthop": "-" + }, + { + "type": "local", + "destination": "198.19.128.0/20", + "nexthop": "-" + }, + { + "type": "local", + "destination": "127.0.0.0/8", + "nexthop": "-" + }, + { + "type": "local", + "destination": "100.64.0.0/10", + "nexthop": "-" + } + ], + "subnets": [ + { + "id": "0e0faa8f-ea73-47aa-b919-8c133e98d5ac" + }, + { + "id": "e007e005-10aa-4614-b439-c9a14e55130e" + } + ], + "vpc_id": "7978e43c-f892-49d8-9fab-9bb90a51709b", + "default": true, + "tenant_id": "05e369f07a800f802f41c002632ba5f9", + "created_at": "2022-12-15T02:56:40", + "updated_at": "2022-12-15T02:56:40" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/querying_route_tables.rst b/api-ref/source/apis/route_table/querying_route_tables.rst new file mode 100644 index 0000000..bc1dc28 --- /dev/null +++ b/api-ref/source/apis/route_table/querying_route_tables.rst @@ -0,0 +1,169 @@ +:original_name: vpc_apiroutetab_0001.html + +.. _vpc_apiroutetab_0001: + +Querying Route Tables +===================== + +Function +-------- + +This API is used to query all route tables of the tenant submitting the request. The route tables are filtered based on the filtering condition. + +URI +--- + +GET /v1/{project_id}/routetables + +Example: + +.. code-block:: text + + GET https://{Endpoint}/v1/{project_id}/routetables?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85&subnet_id=9873b33f-ac1c-4630-ad1c-7dba1ed79r78 + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0001__table135921530121310: + +.. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================================================================================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | + | | | | | + | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | + | | | | | + | | | | This parameter can work together with the parameter **limit**. | + | | | | | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | + | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | String | Specifies the route table ID, which can be used to filter the route table with the corresponding ID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | Specifies the VPC UUID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | No | String | Specifies the subnet ID. | + | | | | | + | | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v1/{project_id}/routetables?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85&subnet_id=9873b33f-ac1c-4630-ad1c-7dba1ed79r78 + +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=============+===============================================================================+=============================================================================================================+ + | routetables | Array of :ref:`routetable ` objects | Specifies the route table list. For details, see :ref:`Table 3 `. | + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0001__table5685153016131: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===========================================================================+=======================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 4 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0001__table4856530131313: + +.. table:: **Table 4** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetables": [ + { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "name": "routetable-1234", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "description": "abc", + "created_at": "2022-12-15T02:56:40", + "updated_at": "2022-12-15T02:56:40" + }, + { + "id": "3d42a0d4-a980-4613-ae76-a2cddecfff89", + "name": "routetable-5678", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f667809", + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "description": "abc", + "created_at": "2022-12-15T02:59:03", + "updated_at": "2022-12-15T02:59:03" + } + ] + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/updating_a_route_table.rst b/api-ref/source/apis/route_table/updating_a_route_table.rst new file mode 100644 index 0000000..c84cbf2 --- /dev/null +++ b/api-ref/source/apis/route_table/updating_a_route_table.rst @@ -0,0 +1,379 @@ +:original_name: vpc_apiroutetab_0004.html + +.. _vpc_apiroutetab_0004: + +Updating a Route Table +====================== + +Function +-------- + +This API is used to update a route table. + +URI +--- + +PUT /v1/{project_id}/routetables/{routetable_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0004__table13791152173213: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+====================================================================+=======================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table188071229326: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+===========================================================================================+===========================================================================================================================================================================================+ + | name | No | String | - Specifies the route table name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | No | :ref:`RouteTableRouteAction ` object | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | | - Constraints: | + | | | | | + | | | | - Each route table can have a maximum of 200 routes. | + | | | | - The destination cannot be modified directly. To modify the destination, run the **del** command to delete the corresponding route, and then run the **add** command to add a route. | + | | | | | + | | | | - Specifies the operation to perform. Possible values are as follows: | + | | | | | + | | | | - **add**: Adds a route. Parameters **type**, **destination**, and **nexthop** are mandatory. | + | | | | - **mod**: Modifies a route. Parameters **type**, **destination**, and **nexthop** are mandatory. | + | | | | - **del**: Deletes a route. Parameter **destination** is mandatory. | + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__request_routetablerouteaction: + +.. table:: **Table 4** Description of the **route** field + + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+========================================================================================+=============================================================================================+ + | add | No | Array of :ref:`AddRouteTableRoute ` objects | Add a route. For details, see :ref:`Table 5 `. | + | | | | | + | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | mod | No | Array of :ref:`ModRouteTableRoute ` objects | Modify a route. For details, see :ref:`Table 6 `. | + | | | | | + | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | del | No | Array of :ref:`DelRouteTableRoute ` objects | Delete a route. For details, see :ref:`Table 7 `. | + | | | | | + | | | | Parameter **destination** is mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table11648235202119: + +.. table:: **Table 5** Field description of adding a route + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table1294364718262: + +.. table:: **Table 6** Field description of modifying a route + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table27171519267: + +.. table:: **Table 7** Field description of deleting a route + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | No | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | No | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +Example Request +--------------- + +- Change the route table whose ID is 3d42a0d4-a980-4613-ae76-a2cddecff054, add a route with next hop type of ECS, modify the route with next hop type of ECS, and delete the route whose destination is 20.20.10.0/24. + + .. code-block:: text + + PUT https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054 + + { + "routetable": { + "name": "routertable-789", + "description": "abc", + "routes": { + "add": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "mod": [ + { + "type": "ecs", + "destination": "20.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "del": [ + { + "destination": "20.20.10.0/24" + } + ] + } + } + } + +Response Parameters +------------------- + +.. table:: **Table 8** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 9 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table884119412392: + +.. table:: **Table 9** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 5 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 10** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. table:: **Table 11** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "default": false, + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "created_at": "2022-12-15T02:56:40", + "updated_at": "2022-12-15T03:03:42" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/security_group/creating_a_security_group.rst b/api-ref/source/apis/security_group/creating_a_security_group.rst index 734d6bb..47948a2 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group.rst @@ -27,44 +27,41 @@ POST /v1/{project_id}/security-groups project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +================+===========+=================================================================+===========================================================================================================+ + | security_group | Yes | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 3 `. | + +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0001__table495783939489: + +.. table:: **Table 3** Description of **security_group** fields + + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================+====================================================================================================================================================================+ + | name | Yes | String | - Specifies the security group name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | Specifies the ID of the VPC that the security group is associated with. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | Currently, this parameter is not recommended because it is only used as a prompt and does not restrict that the security group must be associated with the VPC. | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +================+===========+=================================================================+===========================================================================================================+ - | security_group | Yes | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 3 `. | - +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0001__table495783939489: - - .. table:: **Table 3** Description of **security_group** fields - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================+===================================================================================================================================================================+ - | name | Yes | String | - Specifies the security group name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter has been discarded, it is not recommended to use it. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a security group named **sg-01** in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. .. code-block:: text @@ -72,140 +69,175 @@ Request Message { "security_group": { - "name": "qq", + "name": "sg-01", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85" "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +================+=================================================================+===========================================================================================================+ + | security_group | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 5 `. | + +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0001__table661472489489: + +.. table:: **Table 5** Description of **security_group** fields + + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+================================================================================+====================================================================================================================================================================+ + | name | String | Specifies the security group name. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the security group ID, which uniquely identifies the security group. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC that the security group is associated with. | + | | | | + | | | .. note:: | + | | | | + | | | Currently, this parameter is not recommended because it is only used as a prompt and does not restrict that the security group must be associated with the VPC. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0001__table210704979489: + +.. table:: **Table 6** **security_group_rule** objects + + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter + { + "security_group": { + "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "name": "qq", + "description": "", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "security_group_rules": [ + { + "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + } + ] + } + } - +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +================+=================================================================+===========================================================================================================+ - | security_group | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 5 `. | - +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0001__table661472489489: - - .. table:: **Table 5** Description of **security_group** fields - - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+================================================================================+===================================================================================================================================================================+ - | name | String | Specifies the security group name. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID, which uniquely identifies the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter has been discarded, it is not recommended to use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0001__table210704979489: - - .. table:: **Table 6** **security_group_rule** objects - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group": { - "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "name": "qq", - "description": "", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", - "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", - "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null - } - ] - } - } - -Status Code ------------ +Status Codes +------------ See :ref:`Status Codes `. -Error Code ----------- +Error Codes +----------- See :ref:`Error Codes `. diff --git a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst index fb9a977..77ebe67 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst @@ -15,64 +15,66 @@ URI POST /v1/{project_id}/security-group-rules -Request Message +Request Parameters +------------------ + +.. table:: **Table 1** Request parameter + + +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=====================+===========+========================================================================+==================================================================================================================+ + | security_group_rule | Yes | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | + +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0005__table40497645103533: + +.. table:: **Table 2** Description of the **security_group_rule** field + + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=========================+=================+=================+===========================================================================================================================================================================================================================================================+ + | security_group_id | Yes | String | Specifies the security group ID. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the security group rule. | + | | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Yes | String | - Access control direction specified in a security group rule. | + | | | | - The value can be: | + | | | | | + | | | | - **egress** | + | | | | - **ingress** | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | No | String | - Specifies the IP protocol version. | + | | | | - The value can be **IPv4** or **IPv6**. | + | | | | - If you do not set this parameter, **IPv4** is used by default. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | - Specifies the protocol type. | + | | | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) | + | | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | No | Integer | - Specifies the start port number. | + | | | | - The value ranges from 1 to 65535. | + | | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | No | Integer | - Specifies the end port number. | + | | | | - The value ranges from 1 to 65535. | + | | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | No | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | | - The value can be in the CIDR format or IP addresses. | + | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | No | String | - Specifies the ID of the peer security group. | + | | | | - This parameter is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | + | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 1** Request parameter - - +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=====================+===========+========================================================================+==================================================================================================================+ - | security_group_rule | Yes | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | - +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0005__table40497645103533: - - .. table:: **Table 2** Description of the **security_group_rule** field - - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=========================+=================+=================+===========================================================================================================================================================================================================================================================+ - | security_group_id | Yes | String | Specifies the security group ID. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the security group rule. | - | | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Yes | String | - The value can be: | - | | | | | - | | | | - **egress** | - | | | | - **ingress** | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | No | String | - Specifies the IP protocol version. | - | | | | - The value can be **IPv4** or **IPv6**. | - | | | | - If you do not set this parameter, **IPv4** is used by default. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | - Specifies the protocol type. | - | | | | - The value can be **tcp**, **udp**, **icmp** or an IP protocol number (0 to 255). | - | | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | No | Integer | - Specifies the start port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | No | Integer | - Specifies the end port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | No | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | | - The value can be in the CIDR format or IP addresses. | - | | | | - The parameter is exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | No | String | - Specifies the ID of the peer security group. | - | | | | - The value is exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create an inbound rule in the security group whose ID is a7734e61-b545-452d-a3cd-0189cbd9747a. .. code-block:: text @@ -86,93 +88,106 @@ Request Message "port_range_max": "80", "protocol": "tcp", "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", - "remote_address_group_id": null + "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a" } } -Response Message ----------------- + .. code-block:: text -- Response parameter - - .. table:: **Table 3** Response parameter - - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=====================+======================================================================+================================================================================================================+ - | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 4 `. | - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0005__table488727239520: - - .. table:: **Table 4** **security_group_rule** objects - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: + POST https://{Endpoint}/v1/{project_id}/security-group-rules { "security_group_rule": { "direction": "ingress", - "ethertype": "IPv4", - "id": "2bc0accf-312e-429a-956e-e4407625eb62", - "description": "", - "port_range_max": 80, - "port_range_min": 80, + "port_range_min": "80", + "ethertype": "IPv6", + "port_range_max": "90", "protocol": "tcp", - "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix": null, - "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null + "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a" } } +Response Parameters +------------------- + +.. table:: **Table 3** Response parameter + + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=====================+======================================================================+================================================================================================================+ + | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 4 `. | + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0005__table488727239520: + +.. table:: **Table 4** **security_group_rule** objects + + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "security_group_rule": { + "direction": "ingress", + "ethertype": "IPv4", + "id": "2bc0accf-312e-429a-956e-e4407625eb62", + "description": "", + "port_range_max": 80, + "port_range_min": 80, + "protocol": "tcp", + "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "remote_ip_prefix": null, + "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + } + } + Status Code ----------- diff --git a/api-ref/source/apis/security_group/deleting_a_security_group.rst b/api-ref/source/apis/security_group/deleting_a_security_group.rst index e1be1fc..b0709b8 100644 --- a/api-ref/source/apis/security_group/deleting_a_security_group.rst +++ b/api-ref/source/apis/security_group/deleting_a_security_group.rst @@ -29,29 +29,27 @@ DELETE /v1/{project_id}/security-groups/{security_group_id} | project_id | No | Specifies the project ID. | +-------------------+-----------+--------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst b/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst index 6db5701..c57ad5f 100644 --- a/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst @@ -29,29 +29,27 @@ DELETE /v1/{project_id}/security-group-rules/{security_group_rule_id} | project_id | Yes | Specifies the project ID. | +------------------------+-----------+------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/security_group/querying_security_group_details.rst b/api-ref/source/apis/security_group/querying_security_group_details.rst index 78dedfd..6ffd4d7 100644 --- a/api-ref/source/apis/security_group/querying_security_group_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_details.rst @@ -29,140 +29,178 @@ GET /v1/{project_id}/security-groups/{security_group_id} | security_group_id | Yes | Specifies the security group ID, which uniquely identifies the security group. | +-------------------+-----------+--------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6 + +----------------+-----------------------------------------------------------------+--------------------------------------+ + | Name | Type | Description | + +================+=================================================================+======================================+ + | security_group | :ref:`security_group ` object | Specifies the security group object. | + +----------------+-----------------------------------------------------------------+--------------------------------------+ -Response Message +.. _vpc_sg01_0002__table333218689520: + +.. table:: **Table 3** Description of **security_group** fields + + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+================================================================================+====================================================================================================================================================================+ + | name | String | Specifies the security group name. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the security group ID, which uniquely identifies the security group. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | + | | | | + | | | .. note:: | + | | | | + | | | Currently, this parameter is not recommended because it is only used as a prompt and does not restrict that the security group must be associated with the VPC. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0002__table488727239520: + +.. table:: **Table 4** **security_group_rule** objects + + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +----------------+-----------------------------------------------------------------+--------------------------------------+ - | Name | Type | Description | - +================+=================================================================+======================================+ - | security_group | :ref:`security_group ` object | Specifies the security group object. | - +----------------+-----------------------------------------------------------------+--------------------------------------+ - - .. _vpc_sg01_0002__table333218689520: - - .. table:: **Table 3** Description of **security_group** fields - - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+================================================================================+===================================================================================================================================================================+ - | name | String | Specifies the security group name. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID, which uniquely identifies the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter has been discarded. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0002__table488727239520: - - .. table:: **Table 4** **security_group_rule** objects - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group": { - "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "name": "qq", - "description": "qq", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "enterprise_project_id ": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", - "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", - "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - } - ] - } - } + { + "security_group": { + "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "name": "qq", + "description": "qq", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "security_group_rules": [ + { + "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + } + ] + } + } Status Code ----------- diff --git a/api-ref/source/apis/security_group/querying_security_group_rule_details.rst b/api-ref/source/apis/security_group/querying_security_group_rule_details.rst index a30405b..1cb5bf7 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rule_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rule_details.rst @@ -29,100 +29,98 @@ GET /v1/{project_id}/security-group-rules/{security_group_rule_id} | security_group_rule_id | Yes | Specifies the security group rule ID, which uniquely identifies the security group rule. | +------------------------+-----------+------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=====================+======================================================================+================================================================================================================+ + | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 3 `. | + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_sg01_0006__table488727239520: + +.. table:: **Table 3** **security_group_rule** objects + + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=====================+======================================================================+================================================================================================================+ - | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 3 `. | - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0006__table488727239520: - - .. table:: **Table 3** **security_group_rule** objects - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group_rule": { - "direction": "ingress", - "ethertype": "IPv4", - "id": "2bc0accf-312e-429a-956e-e4407625eb62", - "description":"", - "port_range_max": 80, - "port_range_min": 80, - "protocol": "tcp", - "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix": null, - "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null - } - } + { + "security_group_rule": { + "direction": "ingress", + "ethertype": "IPv4", + "id": "2bc0accf-312e-429a-956e-e4407625eb62", + "description":"", + "port_range_max": 80, + "port_range_min": 80, + "protocol": "tcp", + "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "remote_ip_prefix": null, + "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + } + } Status Code ----------- diff --git a/api-ref/source/apis/security_group/querying_security_group_rules.rst b/api-ref/source/apis/security_group/querying_security_group_rules.rst index 80427ba..dff18b2 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rules.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rules.rst @@ -36,154 +36,152 @@ Example: | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | security_group_id | No | String | Specifies the security group ID. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-group-rules -- Example request +Response Parameters +------------------- - .. code-block:: text ++----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| Name | Type | Description | ++======================+================================================================================+================================================================================================================+ +| security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | ++----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - GET https://{Endpoint}/v1/{project_id}/security-group-rules +.. _vpc_sg01_0007__table488727239520: -Response Message +.. table:: **Table 2** **security_group_rule** objects + + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - +----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +======================+================================================================================+================================================================================================================+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | - +----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0007__table488727239520: - - .. table:: **Table 2** **security_group_rule** objects - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv6", - "id": "3c0e45ff-adaf-4124-b083-bf390e5482ff", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "remote_group_id": null, - "remote_ip_prefix": null, - "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null - }, - { - "direction": "egress", - "ethertype": "IPv4", - "id": "93aa42e5-80db-4581-9391-3a608bd0e448", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "remote_group_id": null, - "remote_ip_prefix": null, - "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null - }, - { - "direction": "ingress", - "ethertype": "IPv6", - "id": "c0b09f00-1d49-4e64-a0a7-8a186d928138", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix": null, - "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "f7d45c89-008e-4bab-88ad-d6811724c51c", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "remote_ip_prefix": null, - "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null - } - ] - } + { + "security_group_rules": [ + { + "direction": "egress", + "ethertype": "IPv6", + "id": "3c0e45ff-adaf-4124-b083-bf390e5482ff", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "remote_group_id": null, + "remote_ip_prefix": null, + "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + }, + { + "direction": "egress", + "ethertype": "IPv4", + "id": "93aa42e5-80db-4581-9391-3a608bd0e448", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "remote_group_id": null, + "remote_ip_prefix": null, + "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + }, + { + "direction": "ingress", + "ethertype": "IPv6", + "id": "c0b09f00-1d49-4e64-a0a7-8a186d928138", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "remote_ip_prefix": null, + "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + }, + { + "direction": "ingress", + "ethertype": "IPv4", + "id": "f7d45c89-008e-4bab-88ad-d6811724c51c", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "remote_ip_prefix": null, + "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/security_group/querying_security_groups.rst b/api-ref/source/apis/security_group/querying_security_groups.rst index c9db829..a1a0816 100644 --- a/api-ref/source/apis/security_group/querying_security_groups.rst +++ b/api-ref/source/apis/security_group/querying_security_groups.rst @@ -27,197 +27,228 @@ Example: .. table:: **Table 1** Parameter description - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=========================+=================+=================+=====================================================================================================================================================================================================================================================================================================================================================+ - | project_id | Yes | String | Specifies the project ID. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | - | | | | | - | | | | This parameter can work together with the parameter **limit**. | - | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | - | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | - | | | | | - | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter the security groups of an enterprise project. | - | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the security groups bound to all enterprise projects of the user or to display the security group list for enterprise project member accounts, set **all_granted_eps**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================+=====================================================================================================================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | + | | | | | + | | | | This parameter can work together with the parameter **limit**. | + | | | | | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | + | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | + | | | | | + | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter the security groups of an enterprise project. | + | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the security groups bound to all enterprise projects of the user or to display the security group list for enterprise project member accounts, set **all_granted_eps**. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-groups -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/security-groups + +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=================+===========================================================================+===========================================================================================================+ + | security_groups | Array of :ref:`security_group ` objects | Specifies the security group objects. For details, see :ref:`Table 3 `. | + +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_sg01_0003__table333218689520: + +.. table:: **Table 3** Description of **security_group** fields + + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+================================================================================+====================================================================================================================================================================+ + | name | String | Specifies the security group name. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the security group ID, which uniquely identifies the security group. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | + | | | | + | | | .. note:: | + | | | | + | | | Currently, this parameter is not recommended because it is only used as a prompt and does not restrict that the security group must be associated with the VPC. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0003__table488727239520: + +.. table:: **Table 4** **security_group_rule** objects + + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=================+===========================================================================+===========================================================================================================+ - | security_groups | Array of :ref:`security_group ` objects | Specifies the security group objects. For details, see :ref:`Table 3 `. | - +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0003__table333218689520: - - .. table:: **Table 3** Description of **security_group** fields - - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+================================================================================+===================================================================================================================================================================+ - | name | String | Specifies the security group name. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID, which uniquely identifies the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter has been discarded. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0003__table488727239520: - - .. table:: **Table 4** **security_group_rule** objects - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_groups": [ + { + "security_groups": [ + { + "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "name": "qq", + "description": "qq", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "security_group_rules": [ { - "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "name": "qq", - "description": "qq", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "enterprise_project_id ": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", - "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", - "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - } - ] - }, - { - "id": "9c0f56be-a9ac-438c-8c57-fce62de19419", - "name": "default", - "description": "qq", - "vpc_id": "13551d6b-755d-4757-b956-536f674975c0", - "enterprise_project_id ": "0", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "95479e0a-e312-4844-b53d-a5e4541b783f", - "description": "", - "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431", - "description": "", - "remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419", - "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" - } - ] - } - ] - } + "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + } + ] + }, + { + "id": "9c0f56be-a9ac-438c-8c57-fce62de19419", + "name": "default", + "description": "qq", + "vpc_id": "13551d6b-755d-4757-b956-536f674975c0", + "enterprise_project_id": "0", + "security_group_rules": [ + { + "direction": "egress", + "ethertype": "IPv4", + "id": "95479e0a-e312-4844-b53d-a5e4541b783f", + "description": "", + "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" + }, + { + "direction": "ingress", + "ethertype": "IPv4", + "id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431", + "description": "", + "remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419", + "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" + } + ] + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index a4f0f5f..ab4230b 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -27,79 +27,86 @@ POST /v1/{project_id}/subnets project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========+===========+=========================================================+=========================================================================+ + | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table45596481: + +.. table:: **Table 3** **subnet** objects + + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+================================================================================+=====================================================================================================================================================================================================================================+ + | name | Yes | String | - Specifies the subnet name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the subnet. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | Yes | String | - Specifies the subnet CIDR block. | + | | | | - The value must be within the VPC CIDR block. | + | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | + | | | | - The value must be an IP address in the subnet. | + | | | | - The value must be a valid IP address. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | No | Boolean | - Specifies whether IPv6 is enabled. If IPv6 is enabled, you can use IPv6 CIDR blocks. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the system automatically sets it to **false** by default. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + | | | | | + | | | | If only **secondary_dns** is specified and **primary_dns** is not specified, **primary_dns** will automatically use the value of **secondary_dns**. | + | | | | | + | | | | If there is only one DNS server address, only **primary_dns** is displayed. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | + | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table1805181451016: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========+===========+=========================================================+=========================================================================+ - | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table45596481: - - .. table:: **Table 3** **subnet** objects - - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +===================+=================+================================================================================+======================================================================================================================================================================================================================================================================================================+ - | name | Yes | String | - Specifies the subnet name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the subnet. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | Yes | String | - Specifies the subnet CIDR block. | - | | | | - The value must be within the VPC CIDR block. | - | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | - | | | | - The value must be an IP address in the subnet. | - | | | | - The value must be a valid IP address. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | - | | | | - The value can be **true** (enabled) or **false** (disabled). | - | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | - | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | No | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | - | | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table1805181451016: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a subnet with name set to **subnet**, CIDR block set to 192.168.20.0/24, and gateway IP address set to 192.168.20.1 in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. .. code-block:: text @@ -111,6 +118,7 @@ Request Message "description": "", "cidr": "192.168.20.0/24", "gateway_ip": "192.168.20.1", + "ipv6_enable": true, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", @@ -118,7 +126,6 @@ Request Message "114.xx.xx.114", "114.xx.xx.115" ], - "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc. "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "extra_dhcp_opts": [ { @@ -129,127 +136,157 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ + | Name | Type | Description | + +========+=========================================================+=========================================================================+ + | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table54041329: + +.. table:: **Table 6** **subnet** objects + + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+==================================================================================================================================================================================================================================================+ + | id | String | Specifies the resource identifier in the form of UUID. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the subnet CIDR block. | + | | | - The value must be within the VPC CIDR block. | + | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | - Specifies the gateway of the subnet. | + | | | - The value must be an IP address in the subnet. | + | | | - The value must be a valid IP address. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | + | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + | | | | + | | | If only **secondary_dns** is specified and **primary_dns** is not specified, **primary_dns** will automatically use the value of **secondary_dns**. | + | | | | + | | | If there is only one DNS server address, only **primary_dns** is displayed. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | + | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + | | | | + | | | - The system creates a subnet and then associates the subnet with a VPC in the threads. | + | | | | + | | | In the concurrent scenario, if the CIDR block of the created subnet is the same as that of an existing subnet, the created subnet fails to associate with a VPC after underlying system verification. As a result, the subnet creation fails. | + | | | | + | | | In this scenario, the returned value of **status** is **UNKNOWN**. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 `. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | scope | String | Specifies where the subnet is used in edge cloud scenario. | + | | | | + | | | Values: | + | | | | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Project ID | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the subnet is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the subnet is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table019517383270: + +.. table:: **Table 7** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 5** Response parameter - - +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ - | Name | Type | Description | - +========+=========================================================+=========================================================================+ - | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table54041329: - - .. table:: **Table 6** **subnet** objects - - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+==================================================================================================================================================================================================================================================+ - | id | String | Specifies the resource identifier in the form of UUID. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the subnet CIDR block. | - | | | - The value must be within the VPC CIDR block. | - | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | - Specifies the gateway of the subnet. | - | | | - The value must be an IP address in the subnet. | - | | | - The value must be a valid IP address. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | - | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | - | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - | | | | - | | | - The system creates a subnet and then associates the subnet with a VPC in the threads. | - | | | | - | | | In the concurrent scenario, if the CIDR block of the created subnet is the same as that of an existing subnet, the created subnet fails to associate with a VPC after underlying system verification. As a result, the subnet creation fails. | - | | | | - | | | In this scenario, the returned value of **status** is **UNKNOWN**. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 `. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table019517383270: - - .. table:: **Table 7** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnet": { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "name": "subnet", - "description": "", - "cidr": "192.168.20.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "UNKNOWN", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.20.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc. - "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12" - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - } - ] - } - } + { + "subnet": { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "name": "subnet", + "description": "", + "cidr": "192.168.20.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "UNKNOWN", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.20.1", + "ipv6_enable": true, + "cidr_v6": "2001:db8:a583::/64", + "gateway_ip_v6": "2001:db8:a583::1", + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + } + ] + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T02:42:07", + "updated_at": "2022-12-15T02:42:07" + } + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/deleting_a_subnet.rst b/api-ref/source/apis/subnet/deleting_a_subnet.rst index e39ea29..9ad611b 100644 --- a/api-ref/source/apis/subnet/deleting_a_subnet.rst +++ b/api-ref/source/apis/subnet/deleting_a_subnet.rst @@ -33,29 +33,27 @@ DELETE /v1/{project_id}/vpcs/{vpc_id}/subnets/{subnet_id} | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index b828e87..cd1ff03 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -31,125 +31,147 @@ GET /v1/{project_id}/subnets/{subnet_id} | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d + +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ + | Name | Type | Description | + +========+==============================================================+==============================================================================+ + | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ -Response Message +.. _vpc_subnet01_0002__table6614597017585: + +.. table:: **Table 3** **subnet** objects + + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+=====================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | Specifies the subnet gateway address. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | scope | String | Specifies where the subnet is used in edge cloud scenario. | + | | | | + | | | Values: | + | | | | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Project ID | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the subnet is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the subnet is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0002__table019517383270: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ - | Name | Type | Description | - +========+==============================================================+==============================================================================+ - | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0002__table6614597017585: - - .. table:: **Table 3** **subnet** objects - - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+=====================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | Specifies the subnet gateway address. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | Identifies the AZ to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0002__table019517383270: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnet": { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "name": "subnet", - "description": "", - "cidr": "192.168.20.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "ACTIVE", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.20.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc. - "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - } - ] - } - } + { + "subnet": { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "name": "subnet", + "description": "", + "cidr": "192.168.20.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "ACTIVE", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.20.1", + "ipv6_enable": false, + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + } + ] + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T02:42:07", + "updated_at": "2022-12-15T02:42:07" + } + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/querying_subnets.rst b/api-ref/source/apis/subnet/querying_subnets.rst index 6a87e9a..31a6d1c 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -32,12 +32,12 @@ Example: | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -46,151 +46,180 @@ Example: | | | | This field is mandatory in the fine-grained authorization scenario based on enterprise projects. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/subnets -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/subnets + +---------+-----------------------------------------------------------------------+------------------------+ + | Name | Type | Description | + +=========+=======================================================================+========================+ + | subnets | Array of :ref:`subnet ` objects | Specifies the subnets. | + +---------+-----------------------------------------------------------------------+------------------------+ -Response Message +.. _vpc_subnet01_0003__table946390317596: + +.. table:: **Table 3** **subnet** objects + + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+=====================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | Specifies the subnet gateway address. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | scope | String | Specifies where the subnet is used in edge cloud scenario. | + | | | | + | | | Values: | + | | | | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Project ID | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the subnet is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the subnet is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0003__table019517383270: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +---------+-----------------------------------------------------------------------+------------------------+ - | Name | Type | Description | - +=========+=======================================================================+========================+ - | subnets | Array of :ref:`subnet ` objects | Specifies the subnets. | - +---------+-----------------------------------------------------------------------+------------------------+ - - .. _vpc_subnet01_0003__table946390317596: - - .. table:: **Table 3** **subnet** objects - - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+=====================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | Specifies the subnet gateway address. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | Identifies the AZ to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0003__table019517383270: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnets": [ - { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "name": "subnet", - "cidr": "192.168.20.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "ACTIVE", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.20.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc. - "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12" - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - } - ] - }, - { - "id": "531dec0f-3116-411b-a21b-e612e42349fd", - "name": "Subnet1", - "description": "", - "cidr": "192.168.1.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "ACTIVE", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.1.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc. - "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - } - ] - } - ] - } + { + "subnets": [ + { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "name": "subnet", + "description": "", + "cidr": "192.168.20.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "ACTIVE", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.20.1", + "ipv6_enable": true, + "cidr_v6": "2001:db8:a583::/64", + "gateway_ip_v6": "2001:db8:a583::1", + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + } + ] + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T02:42:07", + "updated_at": "2022-12-15T02:42:07" + }, + { + "id": "531dec0f-3116-411b-a21b-e612e42349fd", + "name": "Subnet1", + "description": "", + "cidr": "192.168.1.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "ACTIVE", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.1.1", + "ipv6_enable": false, + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + } + ], + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T03:41:22", + "updated_at": "2022-12-15T03:41:22" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index f53cca1..9f94ab5 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -33,66 +33,75 @@ PUT /v1/{project_id}/vpcs/{vpc_id}/subnets/{subnet_id} | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========+===========+=========================================================+=========================================================================+ + | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + +.. _vpc_subnet01_0004__table45027976: + +.. table:: **Table 3** **subnet** objects + + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+===============================================================================+======================================================================================================================================================================================================================================================================================================+ + | name | Yes | String | - Specifies the subnet name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the subnet. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | No | Boolean | - Specifies whether an IPv6 subnet can be created. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | | - The value must be a valid IP address. IPv6 addresses are not supported. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | | + | | | | - The value must be a valid IP address. IPv6 addresses are not supported. | + | | | | | + | | | | The value of **secondary_dns** must be different from that of **primary_dns**. | + | | | | | + | | | | If there is only one DNS server address, only **primary_dns** is displayed. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | + | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. IPv6 addresses are not supported. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0004__table019517383270: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========+===========+=========================================================+=========================================================================+ - | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - - .. _vpc_subnet01_0004__table45027976: - - .. table:: **Table 3** **subnet** objects - - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+===============================================================================+======================================================================================================================================================================================================================================================================================================+ - | name | Yes | String | - Specifies the subnet name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the subnet. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | - | | | | - The value can be **true** (enabled) or **false** (disabled). | - | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | | - The value must be a valid IP address. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | | - The value must be a valid IP address. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | - | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0004__table019517383270: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name of the subnet whose ID is 4779ab1c-7c1a-44b1-a02e-93dfc361b32d to **subnet02**, and also change its DNS and DHCP configurations. .. code-block:: text @@ -100,7 +109,7 @@ Request Message { "subnet": { - "name": "subnetqq", + "name": "subnet02", "ipv6_enable": true, "dhcp_enable": false, "primary_dns": "114.xx.xx.115", @@ -114,46 +123,45 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +--------+--------------------------------------------------------+-----------------------------------+ + | Name | Type | Description | + +========+========================================================+===================================+ + | subnet | :ref:`subnet ` object | Specifies the **subnet** objects. | + +--------+--------------------------------------------------------+-----------------------------------+ + +.. _vpc_subnet01_0004__table1210700: + +.. table:: **Table 6** **subnet** objects + + +-----------------------+-----------------------+----------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 5** Response parameter - - +--------+--------------------------------------------------------+-----------------------------------+ - | Name | Type | Description | - +========+========================================================+===================================+ - | subnet | :ref:`subnet ` object | Specifies the **subnet** objects. | - +--------+--------------------------------------------------------+-----------------------------------+ - - .. _vpc_subnet01_0004__table1210700: - - .. table:: **Table 6** **subnet** objects - - +-----------------------+-----------------------+----------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnet": { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "status": "ACTIVE" - } - } + { + "subnet": { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst index 5b53106..21a2b7a 100644 --- a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst @@ -39,10 +39,8 @@ POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -66,7 +64,7 @@ Request parameter +=================+=================+=================+=====================================================================+ | key | String | Yes | - Specifies the tag key. | | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | + | | | | - Contain up to 128 characters (36 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -77,7 +75,7 @@ Request parameter | | | | - The tag key of a VPC must be unique. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | + | | | | - Contain up to 255 characters (43 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -86,54 +84,56 @@ Request parameter | | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ -Request example 1: Creating tags in batches +Example Request +--------------- -.. code-block:: text +- Batch create two tags for a subnet. - POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action + .. code-block:: text - { - "action": "create", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action -Request example 2: Deleting tags in batches + { + "action": "create", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } -.. code-block:: text +- Batch delete two tags for a subnet. - POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action + .. code-block:: text - { - "action": "delete", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action -Response Message ----------------- + { + "action": "delete", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } -Response parameter +Response Parameters +------------------- None -Example response +Example Response +---------------- None diff --git a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst index 7aac7e7..6a6977e 100644 --- a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst +++ b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst @@ -31,10 +31,8 @@ POST /v2.0/{project_id}/subnets/{subnet_id}/tags | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -- Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -53,7 +51,7 @@ Request Message +=================+=================+=================+=====================================================================+ | key | String | Yes | - Specifies the tag key. | | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | + | | | | - Contain up to 128 characters (36 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -64,7 +62,7 @@ Request Message | | | | - The tag key of a VPC must be unique. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | + | | | | - Contain up to 255 characters (43 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -73,7 +71,10 @@ Request Message | | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ -- Example request +Example Request +--------------- + +- Create a tag for a subnet. The key is **key1**, and the value is **value1**. .. code-block:: text @@ -86,16 +87,15 @@ Request Message } } -Response Message +Response Parameters +------------------- + +None + +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst b/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst index 025b98b..9002e41 100644 --- a/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst @@ -33,27 +33,25 @@ DELETE /v2.0/{project_id}/subnets/{subnet_id}/tags/{key} | key | Yes | Specifies the tag key. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text DELETE https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/{key} -Response Message ----------------- - -Response parameter +Response Parameters +------------------- None -Example response +Example Response +---------------- None diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst index d443d25..fd4d35f 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst @@ -31,23 +31,20 @@ GET /v2.0/{project_id}/subnets/{subnet_id}/tags | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -66,7 +63,7 @@ Response parameter +=======================+=======================+=====================================================================+ | key | String | - Specifies the tag key. | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -77,7 +74,7 @@ Response parameter | | | - The tag key of a VPC must be unique. | +-----------------------+-----------------------+---------------------------------------------------------------------+ | value | String | - Specifies the tag value. | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -86,7 +83,8 @@ Response parameter | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------------+-----------------------+---------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst index 5e18e72..7500cac 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst @@ -27,23 +27,20 @@ GET /v2.0/{project_id}/subnets/tags project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/{project_id}/subnets/tags -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -63,7 +60,7 @@ Response parameter | key | String | Specifies the tag key. | | | | | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -73,7 +70,7 @@ Response parameter +-----------------------+-----------------------+---------------------------------------------------------------------+ | values | Array of strings | Specifies the tag value list. | | | | | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -82,7 +79,8 @@ Response parameter | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------------+-----------------------+---------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst index 7ecbfe6..cefd65c 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst @@ -27,10 +27,8 @@ POST /v2.0/{project_id}/subnets/resource_instances/action project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -54,11 +52,13 @@ Request parameter .. table:: **Table 3** Description of the **tag** field - +------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +======+===========+========+=================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | - +------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========+===========+==================+====================================================================================================================================================================================+ + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | + +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _subnet_tag_0005__table46291842142217: @@ -72,69 +72,70 @@ Request parameter | value | Yes | String | Specifies the tag value. Each value can contain a maximum of 255 Unicode characters. | +-------+-----------+--------+--------------------------------------------------------------------------------------+ -Example request 1: Setting **action** to **filter** +Example Request +--------------- -.. code-block:: text +- Filter subnets by setting **action** to **filter**. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use **matches** and **tags** to filter subnets. - POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action + .. code-block:: text - { - "offset": "0", - "limit": "100", - "action": "filter", - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ], - "tags": [ - { - "key": "key1", - "values": [ - "*value1", - "value2" - ] - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action -Example request 2: Setting **action** to **count** + { + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ], + "tags": [ + { + "key": "key1", + "values": [ + "*value1", + "value2" + ] + } + ] + } -.. code-block:: text +- Count subnets by setting **action** to **count**. Use **matches** and **tags** to filter and count VPCs. - POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action + .. code-block:: text - { - "action": "count", - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ], - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action -Response Message ----------------- + { + "action": "count", + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ] + } -Response parameter +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -166,47 +167,50 @@ Response parameter .. table:: **Table 7** Description of the **tag** field - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========+===========+==================+====================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======+===========+========+====================================================================================================================================================================================+ + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value | Yes | String | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | + +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example response 1: Setting **action** to **filter** +Example Response +---------------- -.. code-block:: +- When **action** is set to **filter**: - { - "resources": [ - { - "resource_detail": null, - "resource_id": "cdfs_cefs_wesas_12_dsad", - "resource_name": "resouece1", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value1" - } - ] - } - ], - "total_count": 1000 - } + .. code-block:: + + { + "resources": [ + { + "resource_detail": null, + "resource_id": "cdfs_cefs_wesas_12_dsad", + "resource_name": "resouece1", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value1" + } + ] + } + ], + "total_count": 1000 + } -Example response 2: Setting **action** to **count** +- When **action** is set to **count**: -.. code-block:: + .. code-block:: - { - "total_count": 1000 - } + { + "total_count": 1000 + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst index 9c501ed..2859909 100644 --- a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst @@ -27,52 +27,49 @@ POST /v1/{project_id}/vpcs project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +======+===========+===================================================+===================================================================+ + | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0001__table33750194: + +.. table:: **Table 3** VPC objects + + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================+===================================================================================================================================================================+ + | name | No | String | - Specifies the VPC name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the VPC. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | | - Possible values are as follows: | + | | | | | + | | | | - 10.0.0.0/8-24 | + | | | | - 172.16.0.0/12-24 | + | | | | - 192.168.0.0/16-24 | + | | | | | + | | | | - If **cidr** is not specified, the default value is left blank. | + | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC. | + | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +------+-----------+------------------------------------+-------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +======+===========+====================================+===================================================================+ - | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+-----------+------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0001__table33750194: - - .. table:: **Table 3** VPC objects - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================+===================================================================================================================================================================+ - | name | No | String | - Specifies the VPC name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | | - Possible values are as follows: | - | | | | | - | | | | - 10.0.0.0/8-24 | - | | | | - 172.16.0.0/12-24 | - | | | | - 192.168.0.0/16-24 | - | | | | | - | | | | - If **cidr** is not specified, the default value is left blank. | - | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC. | - | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a VPC named **vpc** and set its CIDR block to 192.168.0.0/16. .. code-block:: text @@ -87,94 +84,89 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +======+===================================================+===================================================================+ + | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0001__table39714111: + +.. table:: **Table 5** VPC objects + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the VPC name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see the description of the :ref:`route objects `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0001__table3576833291556: + +.. table:: **Table 6** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +------+------------------------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +======+====================================+===================================================================+ - | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0001__table39714111: - - .. table:: **Table 5** VPC objects - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the VPC name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see the description of the :ref:`route objects `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0001__table3576833291556: - - .. table:: **Table 6** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpc": - { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "CREATING", - "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "routes": [] - } - } + { + "vpc": + { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "CREATING", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "routes": [] + } + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst index 81f02d9..dc66cf3 100644 --- a/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst @@ -29,29 +29,27 @@ DELETE /v1/{project_id}/vpcs/{vpc_id} | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/vpcs/13551d6b-755d-4757-b956-536f674975c0 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/vpcs/13551d6b-755d-4757-b956-536f674975c0 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst index e346994..7cc6efe 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst @@ -29,107 +29,101 @@ GET /v1/{project_id}/vpcs/{vpc_id} | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 + +------+--------------------------------------------------------+------------------------------------------------------------------------+ + | Name | Type | Description | + +======+========================================================+========================================================================+ + | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+--------------------------------------------------------+------------------------------------------------------------------------+ -Response Message +.. _vpc_api01_0002__table1945411214515: + +.. table:: **Table 3** VPC objects + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the VPC name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see the description of the :ref:`route objects `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Enterprise project ID | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0002__table3576833291556: + +.. table:: **Table 4** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +------+--------------------------------------------------------+------------------------------------------------------------------------+ - | Name | Type | Description | - +======+========================================================+========================================================================+ - | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+--------------------------------------------------------+------------------------------------------------------------------------+ - - .. _vpc_api01_0002__table1945411214515: - - .. table:: **Table 3** VPC objects - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the VPC name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see the description of the :ref:`route objects `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0002__table3576833291556: - - .. table:: **Table 4** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpc": { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0" - "routes": [], - "enable_shared_snat": false - } - } + { + "vpc": { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0" + "routes": [], + "enable_shared_snat": false + } + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst index 71bbe4b..a569f8c 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst @@ -36,146 +36,137 @@ Example: | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. | | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set **all_granted_eps**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | + | | | | - If this parameter is not specified, VPCs in the default enterprise project are queried and are authenticated based on the default enterprise project. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/vpcs -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/vpcs + +------+--------------------------------------------------------------+---------------------+ + | Name | Type | Description | + +======+==============================================================+=====================+ + | vpcs | Array of :ref:`vpcs ` objects | Specifies the VPCs. | + +------+--------------------------------------------------------------+---------------------+ -Response Message +.. _vpc_api01_0003__table65129753: + +.. table:: **Table 3** Description of the **vpcs** field + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the VPC name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see :ref:`Table 4 `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0003__table3576833291556: + +.. table:: **Table 4** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +------+--------------------------------------------------------------+---------------------+ - | Name | Type | Description | - +======+==============================================================+=====================+ - | vpcs | Array of :ref:`vpcs ` objects | Specifies the VPCs. | - +------+--------------------------------------------------------------+---------------------+ - - .. _vpc_api01_0003__table65129753: - - .. table:: **Table 3** Description of the **vpcs** field - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the VPC name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see :ref:`Table 4 `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0003__table3576833291556: - - .. table:: **Table 4** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpcs": [ - { - "id": "13551d6b-755d-4757-b956-536f674975c0", - "name": "default", - "description": "test", - "cidr": "172.16.0.0/16", - "status": "OK", - "enterprise_project_id": "0", - "routes": [], - "enable_shared_snat": false - }, - { - "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "name": "222", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0635d733-c12d-4308-ba5a-4dc27ec21038", - "routes": [], - "enable_shared_snat": false - }, - { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0", - "routes": [], - "enable_shared_snat": false - } - ] - } + { + "vpcs": [ + { + "id": "13551d6b-755d-4757-b956-536f674975c0", + "name": "default", + "description": "test", + "cidr": "172.16.0.0/16", + "status": "OK", + "enterprise_project_id": "0", + "routes": [], + "enable_shared_snat": false + }, + { + "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "name": "222", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0635d733-c12d-4308-ba5a-4dc27ec21038", + "routes": [], + "enable_shared_snat": false + }, + { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0", + "routes": [], + "enable_shared_snat": false + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst index 1aaaf60..8a6812d 100644 --- a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst +++ b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst @@ -29,63 +29,70 @@ PUT /v1/{project_id}/vpcs/{vpc_id} | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +======+===========+===================================================+===================================================================+ + | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0004__table34290771: + +.. table:: **Table 3** VPC objects + + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +====================+=================+====================================================================+=======================================================================================================================================================================================+ + | name | No | String | - Specifies the VPC name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the VPC. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | | | + | | | | - Possible values are as follows: | + | | | | | + | | | | - 10.0.0.0/8-24 | + | | | | - 172.16.0.0/12-24 | + | | | | - 192.168.0.0/16-24 | + | | | | | + | | | | - If **cidr** is not specified, the default value is left blank. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The value must be in CIDR format, for example, **192.168.0.0/16**. | + | | | | | + | | | | If you want to update the CIDR block of the VPC, the new CIDR block must contain all subnets in the VPC. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | No | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | No | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0004__table1696324019336: + +.. table:: **Table 4** **route** objects + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================+ + | destination | No | String | - Specifies the destination network segment of a route. | + | | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | No | String | - Specifies the next hop of a route. | + | | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +======+===========+===================================================+===================================================================+ - | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0004__table34290771: - - .. table:: **Table 3** VPC objects - - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +====================+=================+====================================================================+=======================================================================================================================================================================================+ - | name | No | String | - Specifies the VPC name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | | - Possible values are as follows: | - | | | | | - | | | | - 10.0.0.0/8-24 | - | | | | - 172.16.0.0/12-24 | - | | | | - 192.168.0.0/16-24 | - | | | | | - | | | | - If **cidr** is not specified, the default value is left blank. | - | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | No | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | No | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0004__table1696324019336: - - .. table:: **Table 4** **route** objects - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================+ - | destination | No | String | - Specifies the destination network segment of a route. | - | | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | No | String | - Specifies the next hop of a route. | - | | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name, description, and CIDR block of the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3 to **vpc1**, **test1**, and **192.168.0.0/16**, respectively. .. code-block:: text @@ -100,92 +107,87 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +======+===================================================+===================================================================+ + | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0004__table22527411: + +.. table:: **Table 6** VPC objects + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC name. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see the description of the :ref:`route objects `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0004__table3576833291556: + +.. table:: **Table 7** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 5** Response parameter - - +------+---------------------------------------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +======+===================================================+===================================================================+ - | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+---------------------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0004__table22527411: - - .. table:: **Table 6** VPC objects - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC name. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see the description of the :ref:`route objects `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0004__table3576833291556: - - .. table:: **Table 7** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpc": { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc1", - "description": "test1", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0", - "routes": [], - "enable_shared_snat": true - } - } + { + "vpc": { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc1", + "description": "test1", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0", + "routes": [], + "enable_shared_snat": true + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst index 8708212..82dfd57 100644 --- a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst @@ -8,7 +8,7 @@ Creating a VPC Flow Log Function -------- -This API is used to create a flow log. +This API is used to create a VPC flow log. A VPC flow log captures information about the traffic going to and from your VPC. You can use flow logs to monitor network traffic, analyze network attacks, and to determine whether security group and firewall rules need to be modified. @@ -25,56 +25,63 @@ POST /v1/{project_id}/fl/flow_logs .. table:: **Table 1** Parameter description - ========== ========= ====== ========================= + ========== ========= ====== =========== Name Mandatory Type Description - ========== ========= ====== ========================= - project_id Yes String Specifies the project ID. - ========== ========= ====== ========================= + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==========+===========+===========================================================+==========================================================================================+ + | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0001__table656165873916: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+================================================================================================================================+ + | name | No | String | - Flow log name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Flow log description | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | Yes | String | - Type of the resource for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **port**: NIC | + | | | | - **vpc**: All NICs in a VPC | + | | | | - **network**: All NICs in a subnet | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | Yes | String | - ID of the resource for which that the logs to be collected. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | Yes | String | - Type of the traffic for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | Yes | String | - Log group ID | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | Yes | String | - Log topic ID | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | index_enabled | No | Boolean | Whether to enable the log index. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+===========================================================+========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0001__table656165873916: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================+ - | name | No | String | - Specifies the VPC flow log name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC flow log. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | Yes | String | Specifies the type of resource on which to create the VPC flow log. The value can be **Port**, **VPC**, and **Network**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | Yes | String | Specifies the unique resource ID. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | Yes | String | Specifies the type of traffic to log. The value can be: | - | | | | | - | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | - | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | - | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | Yes | String | Specifies the log group ID. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | Yes | String | Specifies the log topic ID. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | index_enabled | No | Boolean | Specifies whether to enable the log index. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a VPC flow log. Set the resource type to port, resource ID to 05c4052d-8d14-488f-aa00-19fea5a25fde, traffic type to reject, log group ID to 05c4052d-8d14-488f-aa00-19fea5a25fdd, and log topic ID to a9d7dee7-37d2-4cba-a208-a016252aaa63. .. code-block:: text @@ -93,81 +100,95 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+===========================================================+==========================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | + +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0001__table763920584395: + +.. table:: **Table 5** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | index_enabled | Boolean | - Whether to enable the log index function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+===========================================================+========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 5 `. | - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0001__table763920584395: - - .. table:: **Table 5** Description of the **FlowLog** field - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | index_enabled | Boolean | Specifies whether to enable the log index. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_log": { - "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", - "name": "flowlog", - "description": "just a test", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02", - "index_enabled": false, - "admin_state": true, - "status": "ACTIVE" - } - } + { + "flow_log": { + "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", + "name": "flowlog", + "description": "just a test", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T11:03:02", + "index_enabled": false, + "admin_state": true, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst index 19671ca..4889f38 100644 --- a/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst @@ -21,36 +21,34 @@ DELETE /v1/{project_id}/fl/flow_logs/{flowlog_id} .. table:: **Table 1** Parameter description - ========== ========= ====== ============================== + ========== ========= ====== =========== Name Mandatory Type Description - ========== ========= ====== ============================== - project_id Yes String Specifies the project ID. - flowlog_id Yes String Specifies the VPC flow log ID. - ========== ========= ====== ============================== + ========== ========= ====== =========== + project_id Yes String Project ID. + flowlog_id Yes String Flow log ID + ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/60c809cb-6731-45d0-ace8-3bf5626421a9 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/60c809cb-6731-45d0-ace8-3bf5626421a9 - -Response Message +Example Response ---------------- -- Request parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst index a96f6bd..f71a3a1 100644 --- a/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst @@ -21,99 +21,111 @@ GET /v1/{project_id}/fl/flow_logs/{flowlog_id} .. table:: **Table 1** Parameter description - +------------+-----------+--------+----------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +============+===========+========+============================================================================+ - | project_id | Yes | String | Specifies the project ID. | - +------------+-----------+--------+----------------------------------------------------------------------------+ - | flowlog_id | Yes | String | Specifies the VPC flow log ID, which uniquely identifies the VPC flow log. | - +------------+-----------+--------+----------------------------------------------------------------------------+ + ========== ========= ====== =========== + Name Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + flowlog_id Yes String Flow log ID + ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/1e10cd9d-742a-4d36-a9fd-aee9784336ff -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/1e10cd9d-742a-4d36-a9fd-aee9784336ff + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=============================================================+============================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_flow_0003__table17299234185110: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+==========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0003__table17299234185110: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_log": { - "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", - "name": "flow", - "description": "just a test", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02" - "status": "ACTIVE", - "admin_state": true - } - } + { + "flow_log": { + "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", + "name": "flow", + "description": "just a test", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T11:03:02", + "status": "ACTIVE", + "admin_state": true + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst b/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst index 87c5b89..2c8a5ca 100644 --- a/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst +++ b/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst @@ -30,30 +30,45 @@ Example: +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+========================================================================================================================================================================================================================+ - | project_id | Yes | String | Specifies the project ID. | + | project_id | Yes | String | - Project ID. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | Specifies the VPC flow log UUID. | + | id | No | String | - Flow log ID | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | - Specifies the VPC flow log name. | + | name | No | String | - Flow log name | | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | No | String | Specifies the type of resource on which to create the VPC flow log. | + | tenant_id | No | String | - Project ID | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | No | String | Specifies the unique resource ID. | + | description | No | String | - Flow log description | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | No | String | Specifies the type of traffic to log. | + | resource_type | No | String | - Type of the resource for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **port**: NIC | + | | | | - **vpc**: All NICs in a VPC | + | | | | - **network**: All NICs in a subnet | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | No | String | Specifies the log group ID. | + | resource_id | No | String | - ID of the resource for which that the logs to be collected. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | No | String | Specifies the log topic ID. | + | traffic_type | No | String | - Type of the traffic for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies the VPC flow log status. | + | log_group_id | No | String | - Log group ID | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | No | String | - Log topic ID | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | String | Flow log status | | | | | | | | | | - **ACTIVE**: Enabled | | | | | - **DOWN**: Disabled | - | | | | - **ERROR**: Abnormal fault | + | | | | - **ERROR**: Abnormal | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,97 +76,112 @@ Example: | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog -- Example request +Response Parameters +------------------- - None +.. table:: **Table 2** Response parameter -Response Message + +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+======================================================================+================================================================================================+ + | flow_logs | Array of :ref:`FlowLog ` objects | **FlowLog** object list. For details, see :ref:`Table 3 `. | + +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0002__table34811015184118: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+======================================================================+==============================================================================================================+ - | flow_logs | Array of :ref:`FlowLog ` objects | Specifies the **FlowLog** object list. For details, see :ref:`Table 3 `. | - +-----------+----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0002__table34811015184118: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_logs": [ - { - "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", - "name": "flow", - "description": "just a test", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02" - "status": "ACTIVE", - "admin_state": true - } - ] - } + { + "flow_logs": [ + { + "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", + "name": "flowlog", + "description": "just a test", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T11:03:02", + "status": "ACTIVE", + "admin_state": true + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst index 8dcfa6a..d8402bc 100644 --- a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst @@ -21,43 +21,44 @@ PUT /v1/{project_id}/fl/flow_logs/{flowlog_id} .. table:: **Table 1** Parameter description - ========== ========= ====== ============================== + ========== ========= ====== =========== Name Mandatory Type Description - ========== ========= ====== ============================== - project_id Yes String Specifies the project ID. - flowlog_id Yes String Specifies the VPC flow log ID. - ========== ========= ====== ============================== + ========== ========= ====== =========== + project_id Yes String Project ID. + flowlog_id Yes String Flow log ID + ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==========+===========+=============================================================+============================================================================================+ + | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0004__table13828101864013: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+================================================================================================================================+ + | name | No | String | - Flow log name | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Flow log description | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | No | Boolean | - Whether to enable the flow log function | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+==========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0004__table13828101864013: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================+ - | name | No | String | - Specifies the VPC flow log name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC flow log. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | admin_state | No | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name of the VPC flow log whose ID is f49f00f1-0f15-470a-a8c5-4e879e461c8d to **flow-log-update**. .. code-block:: text @@ -71,78 +72,92 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=============================================================+============================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0004__table17299234185110: + +.. table:: **Table 5** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+==========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 5 `. | - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0004__table17299234185110: - - .. table:: **Table 5** Description of the **FlowLog** field - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_log": { - "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", - "name": " flow-log-update", - "description": "update", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T12:03:02" - "status": "DOWN", - "admin_state": false - } - } + { + "flow_log": { + "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", + "name": " flow-log-update", + "description": "update", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T12:03:02", + "status": "DOWN", + "admin_state": false + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst index 826cc5c..e110084 100644 --- a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst @@ -27,85 +27,85 @@ PUT /v2.0/vpc/peerings/{peering_id}/accept | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter - - None - -- Example request +- Accept the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/accept -Response Message +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0004__table1125991417114: + +.. table:: **Table 3** **vpc_info** objects + + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===========================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0004__table1125991417114: - - .. table:: **Table 3** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "059a737356594b41b447b557bf0aae56" - }, - "status": "ACTIVE" - } + { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "059a737356594b41b447b557bf0aae56" + }, + "status": "ACTIVE" + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst index 10e2f83..0c46482 100644 --- a/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst @@ -19,48 +19,53 @@ URI POST /v2.0/vpc/peerings -Request Message +Request Parameters +------------------ + +.. table:: **Table 1** Request parameter + + +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==============================================================+===============================================================================================================+ + | peering | Yes | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 2 `. | + +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table1026243410414: + +.. table:: **Table 2** Description of the **peering** field + + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +==================+=================+===============================================================+====================================================================================================================+ + | name | Yes | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Provides supplementary information about the VPC peering connection. | + | | | | | + | | | | The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table1132310347417: + +.. table:: **Table 3** Description of the **vpc_info** field + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================+ + | vpc_id | Yes | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ + | tenant_id | No | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + | | | | | + | | | | This parameter is mandatory if the VPC peering connection is created between VPCs in different accounts. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 1** Request parameter - - +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==============================================================+===============================================================================================================+ - | peering | Yes | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 2 `. | - +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table1026243410414: - - .. table:: **Table 2** Description of the **peering** field - - +------------------+-----------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +==================+===========+===============================================================+====================================================================================================================+ - | name | Yes | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | - +------------------+-----------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | - +------------------+-----------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | - +------------------+-----------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table1132310347417: - - .. table:: **Table 3** Description of the **vpc_info** field - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================+ - | vpc_id | Yes | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - | tenant_id | No | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - | | | | | - | | | | This parameter is mandatory if the VPC peering connection is created between VPCs in different accounts. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a VPC peering connection. The VPC ID of the requester is 9daeac7c-a98f-430f-8e38-67f9c044e299, the VPC ID of the receiver is f583c072-0bb8-4e19-afb2-afb7c1693be5, and the VPC peering connection is named **test**. .. code-block:: text @@ -78,84 +83,83 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================+================================================================================================================+ + | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table14258131481112: + +.. table:: **Table 5** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table1125991417114: + +.. table:: **Table 6** **vpc_info** objects + + +-----------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+================================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+================================================================================================================+ - | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table14258131481112: - - .. table:: **Table 5** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table1125991417114: - - .. table:: **Table 6** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "peering": { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "status": "ACTIVE" - } - } + { + "peering": { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst index ebcaa2b..ad1e0e6 100644 --- a/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst @@ -29,29 +29,27 @@ DELETE /v2.0/vpc/peerings/{peering_id} | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v2.0/vpc/peerings/2b098395-046a-4071-b009-312bcee665cb -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v2.0/vpc/peerings/2b098395-046a-4071-b009-312bcee665cb - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst index fc825f1..3153828 100644 --- a/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst @@ -27,97 +27,95 @@ GET /v2.0/vpc/peerings/{peering_id} | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. The **peering_id** value is used as the filter. | +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1 + +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==============================================================+===========================================================================================================================+ + | peering | :ref:`peering ` object | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | + +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_peering_0002__table1026243410414: + +.. table:: **Table 3** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0002__table1132310347417: + +.. table:: **Table 4** **vpc_info** objects + + +-----------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+================================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================+===========================================================================================================================+ - | peering | :ref:`peering ` object | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | - +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0002__table1026243410414: - - .. table:: **Table 3** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0002__table1132310347417: - - .. table:: **Table 4** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "peering": { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "status": "ACTIVE" - } - } + { + "peering": { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst index 8067341..b9d8179 100644 --- a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst +++ b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst @@ -45,127 +45,125 @@ Example: | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | | | | | | | | | | The default value is **2000**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/peerings -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/peerings + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================+=================================================================================================================================================================================================================+ + | peerings | Array of :ref:`peering ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | peerings_links | Array of :ref:`peerings_link ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 5 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_peering_0001__table1026243410414: + +.. table:: **Table 3** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0001__table1132310347417: + +.. table:: **Table 4** **vpc_info** objects + + +-----------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+================================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0001__table25150247450: + +.. table:: **Table 5** **peerings_link** object + + +------+--------+----------------------------------------------------------------------+ + | Name | Type | Description | + +======+========+======================================================================+ + | href | String | Specifies the API link. | + +------+--------+----------------------------------------------------------------------+ + | rel | String | Specifies the relationship between the API link and the API version. | + +------+--------+----------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================================+======================================================================================================================================================================================================================+ - | peerings | Array of :ref:`peering ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | peerings_links | Array of :ref:`peerings_link ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 5 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0001__table1026243410414: - - .. table:: **Table 3** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0001__table1132310347417: - - .. table:: **Table 4** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0001__table25150247450: - - .. table:: **Table 5** **peerings_link** object - - +------+--------+----------------------------------------------------------------------+ - | Name | Type | Description | - +======+========+======================================================================+ - | href | String | Specifies the API link. | - +------+--------+----------------------------------------------------------------------+ - | rel | String | Specifies the relationship between the API link and the API version. | - +------+--------+----------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "peerings": [ - { - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "name": "test", - "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13", - "status": "ACTIVE" - } - ] - } + { + "peerings": [ + { + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "name": "test", + "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13", + "status": "ACTIVE" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst index 92265ff..3c78282 100644 --- a/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst @@ -27,85 +27,85 @@ PUT /v2.0/vpc/peerings/{peering_id}/reject | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter - - None - -- Example request +- Reject the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/reject -Response Message +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0005__table1125991417114: + +.. table:: **Table 3** **vpc_info** objects + + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0005__table1125991417114: - - .. table:: **Table 3** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "status": "REJECTED" - } + { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "status": "REJECTED" + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst index f9e6a56..8686121 100644 --- a/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst @@ -27,122 +27,123 @@ PUT /v2.0/vpc/peerings/{peering_id} | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==============================================================+==================================================================================================================================================================+ + | peering | Yes | :ref:`peering ` object | Updates a VPC peering connection. For details, see :ref:`Table 3 `. | + | | | | | + | | | | When updating a VPC peering connection, you must specify at least one attribute. Currently, only the VPC peering connection name and description can be updated. | + +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0006__table9931835105819: + +.. table:: **Table 3** Description of the **peering** field + + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+=======================================================================================================================================================+ + | name | No | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Provides supplementary information about the VPC peering connection. The value can contain no more than 255 characters, including letters and digits. | + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==============================================================+==================================================================================================================================================================+ - | peering | Yes | :ref:`peering ` object | Updates a VPC peering connection. For details, see :ref:`Table 3 `. | - | | | | | - | | | | When updating a VPC peering connection, you must specify at least one attribute. Currently, only the VPC peering connection name and description can be updated. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0006__table9931835105819: - - .. table:: **Table 3** Description of the **peering** field - - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=======================================================================================================================================================+ - | name | No | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Provides supplementary information about the VPC peering connection. The value can contain no more than 255 characters, including letters and digits. | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name of the VPC peering connection whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to **test2**. .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/7a9a954a-eb41-4954-a300-11ab17a361a2 + { "peering": { "name": "test2" } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================+================================================================================================================+ + | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0006__table14258131481112: + +.. table:: **Table 5** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0006__table1125991417114: + +.. table:: **Table 6** **vpc_info** objects + + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+================================================================================================================+ - | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0006__table14258131481112: - - .. table:: **Table 5** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0006__table1125991417114: - - .. table:: **Table 6** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "peering": { - "name": "test2", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "059a737356594b41b447b557bf0aae56" - }, - "status": "ACTIVE" - } - } + { + "peering": { + "name": "test2", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "059a737356594b41b447b557bf0aae56" + }, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst index 4ca471d..150ff23 100644 --- a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst @@ -15,36 +15,39 @@ URI POST /v2.0/vpc/routes -Request Message +Request Parameters +------------------ + +.. table:: **Table 1** Request parameter + + +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +===========+======================================+===========+==========================================================================================+ + | route | :ref:`route ` object | Yes | Specifies the route. For details, see :ref:`Table 2 `. | + +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ + +.. _vpc_route_0003__table05001250111: + +.. table:: **Table 2** **route** objects + + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Mandatory | Description | + +=================+=================+=================+=======================================================================================================+ + | destination | String | Yes | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | nexthop | String | Yes | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | type | String | Yes | Specifies the route type. | + | | | | | + | | | | Currently, only the **peering** type is supported, that is, the next hop is a VPC peering connection. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 1** Request parameter - - +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +===========+======================================+===========+==========================================================================================+ - | route | :ref:`route ` object | Yes | Specifies the route. For details, see :ref:`Table 2 `. | - +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ - - .. _vpc_route_0003__table05001250111: - - .. table:: **Table 2** **route** objects - - +-------------+--------+-----------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Mandatory | Description | - +=============+========+===========+================================================================================================+ - | destination | String | Yes | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-------------+--------+-----------+------------------------------------------------------------------------------------------------+ - | nexthop | String | Yes | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-------------+--------+-----------+------------------------------------------------------------------------------------------------+ - | type | String | Yes | Specifies the route type. Currently, the value can only be **peering**. | - +-------------+--------+-----------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. | - +-------------+--------+-----------+------------------------------------------------------------------------------------------------+ - -- Example request +- Create a route in the route table of the VPC whose ID is ab78be2d-782f-42a5-aa72-35879f6890ff for the VPC peering connection. The next hop is the peering connection whose ID is 60c809cb-6731-45d0-ace8-3bf5626421a9, and the destination is 192.168.200.0/24. .. code-block:: text @@ -59,53 +62,52 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 3** Response parameter + + +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================+============================================================================================+ + | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 4 `. | + +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ + +.. _vpc_route_0003__table1163544010410: + +.. table:: **Table 4** **route** objects + + +-------------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=============+========+================================================================================================+ + | id | String | Specifies the route ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | type | String | Specifies the route type. Currently, the value can only be **peering**. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 3** Response parameter - - +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+======================================+============================================================================================+ - | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 4 `. | - +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ - - .. _vpc_route_0003__table1163544010410: - - .. table:: **Table 4** **route** objects - - +-------------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=============+========+================================================================================================+ - | id | String | Specifies the route ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | type | String | Specifies the route type. Currently, the value can only be **peering**. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "route": { - "type": "peering", - "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", - "destination": "192.168.200.0/24", - "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", - "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" - } - } + { + "route": { + "type": "peering", + "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "destination": "192.168.200.0/24", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst b/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst index 4a16842..ae99eb0 100644 --- a/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst @@ -27,29 +27,27 @@ DELETE /v2.0/vpc/routes/{route_id} | route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. | +----------+-----------+--------+--------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst b/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst index a906775..229882a 100644 --- a/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst @@ -27,66 +27,64 @@ GET /v2.0/vpc/routes/{route_id} | route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. | +----------+-----------+--------+--------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 + +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================+==========================================================================================+ + | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 3 `. | + +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_route_0002__table05001250111: + +.. table:: **Table 3** **route** objects + + +-------------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=============+========+================================================================================================+ + | id | String | Specifies the route ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | type | String | Specifies the route type. Currently, the value can only be **peering**. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+======================================+==========================================================================================+ - | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 3 `. | - +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ - - .. _vpc_route_0002__table05001250111: - - .. table:: **Table 3** **route** objects - - +-------------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=============+========+================================================================================================+ - | id | String | Specifies the route ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | type | String | Specifies the route type. Currently, the value can only be **peering**. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "route": { - "type": "peering", - "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", - "destination": "192.168.200.0/24", - "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", - "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" - } - } + { + "route": { + "type": "peering", + "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "destination": "192.168.200.0/24", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/querying_vpc_routes.rst b/api-ref/source/apis/vpc_route/querying_vpc_routes.rst index 8fe2712..d27500e 100644 --- a/api-ref/source/apis/vpc_route/querying_vpc_routes.rst +++ b/api-ref/source/apis/vpc_route/querying_vpc_routes.rst @@ -45,96 +45,94 @@ Example: | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | | | | | | | | | | The default value is **2000**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========================================================================+======================================================================================================================================================================================================================+ + | routes | Array of :ref:`route ` objects | Specifies the route object list. For details, see :ref:`Table 3 `. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes_links | Array of :ref:`routes_link ` objects | Specifies the route object list. For details, see :ref:`Table 4 `. | + | | | | + | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_route_0001__table05001250111: + +.. table:: **Table 3** **route** objects + + +-------------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=============+========+================================================================================================+ + | id | String | Specifies the route ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | type | String | Specifies the route type. Currently, the value can only be **peering**. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + +.. _vpc_route_0001__table25150247450: + +.. table:: **Table 4** **routes_link** object + + +------+--------+----------------------------------------------------------------------+ + | Name | Type | Description | + +======+========+======================================================================+ + | href | String | Specifies the API link. | + +------+--------+----------------------------------------------------------------------+ + | rel | String | Specifies the relationship between the API link and the API version. | + +------+--------+----------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========================================================================+======================================================================================================================================================================================================================+ - | routes | Array of :ref:`route ` objects | Specifies the route object list. For details, see :ref:`Table 3 `. | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes_links | Array of :ref:`routes_link ` objects | Specifies the route object list. For details, see :ref:`Table 4 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_route_0001__table05001250111: - - .. table:: **Table 3** **route** objects - - +-------------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=============+========+================================================================================================+ - | id | String | Specifies the route ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | type | String | Specifies the route type. Currently, the value can only be **peering**. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - - .. _vpc_route_0001__table25150247450: - - .. table:: **Table 4** **routes_link** object - - +------+--------+----------------------------------------------------------------------+ - | Name | Type | Description | - +======+========+======================================================================+ - | href | String | Specifies the API link. | - +------+--------+----------------------------------------------------------------------+ - | rel | String | Specifies the relationship between the API link and the API version. | - +------+--------+----------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "routes": [ - { - "type": "peering", - "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", - "destination": "192.168.200.0/24", - "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", - "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" - } - ] - } + { + "routes": [ + { + "type": "peering", + "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "destination": "192.168.200.0/24", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst index 42f365c..0f5f0f9 100644 --- a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst @@ -37,10 +37,8 @@ POST /v2.0/{project_id}/vpcs/{vpc_id}/tags/action | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -64,7 +62,7 @@ Request parameter +=================+=================+=================+=====================================================================+ | key | String | Yes | - Specifies the tag key. | | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | + | | | | - Contain up to 128 characters (36 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -75,7 +73,7 @@ Request parameter | | | | - The tag key of a VPC must be unique. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | + | | | | - Contain up to 255 characters (43 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -84,54 +82,56 @@ Request parameter | | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ -Request example 1: Creating tags in batches +Example Request +--------------- -.. code-block:: text +- Batch create two tags for a VPC. - POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action + .. code-block:: text - { - "action": "create", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action -Request example 2: Deleting tags in batches + { + "action": "create", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } -.. code-block:: text +- Batch delete two tags for a VPC. - POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action + .. code-block:: text - { - "action": "delete", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action -Response Message ----------------- + { + "action": "delete", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } -Response parameter +Response Parameters +------------------- None -Example response +Example Response +---------------- None diff --git a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst index 26aab6b..f659931 100644 --- a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst +++ b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst @@ -29,49 +29,50 @@ POST /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +===========+=======================================================+===========+=====================================================================================================+ + | tag | :ref:`tag ` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 3 `. | + +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ + +.. _vpc_tag_0001__table13242848193719: + +.. table:: **Table 3** **tag** objects + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + | Attribute | Type | Mandatory | Description | + +=================+=================+=================+=====================================================================+ + | key | String | Yes | - Specifies the tag key. | + | | | | - Cannot be left blank. | + | | | | - Contain up to 128 characters (36 characters on the console). | + | | | | - Can contain only the following character types: | + | | | | | + | | | | - Uppercase letters | + | | | | - Lowercase letters | + | | | | - Digits | + | | | | - Special characters, including hyphens (-) and underscores (_) | + | | | | | + | | | | - The tag key of a VPC must be unique. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + | value | String | Yes | - Specifies the tag value. | + | | | | - Contain up to 255 characters (43 characters on the console). | + | | | | - Can contain only the following character types: | + | | | | | + | | | | - Uppercase letters | + | | | | - Lowercase letters | + | | | | - Digits | + | | | | - Special characters, including hyphens (-) and underscores (_) | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +===========+=======================================================+===========+=====================================================================================================+ - | tag | :ref:`tag ` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 3 `. | - +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ - - .. _vpc_tag_0001__table13242848193719: - - .. table:: **Table 3** **tag** objects - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Attribute | Type | Mandatory | Description | - +=================+=================+=================+=====================================================================+ - | key | String | Yes | - Specifies the tag key. | - | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | - | | | | - Can contain only the following character types: | - | | | | | - | | | | - Uppercase letters | - | | | | - Lowercase letters | - | | | | - Digits | - | | | | - Special characters, including hyphens (-) and underscores (_) | - | | | | | - | | | | - The tag key of a VPC must be unique. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | - | | | | - Can contain only the following character types: | - | | | | | - | | | | - Uppercase letters | - | | | | - Lowercase letters | - | | | | - Digits | - | | | | - Special characters, including hyphens (-) and underscores (_) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -- Example request +- Create a tag for a VPC. The key is **key1**, and the value is **value1**. .. code-block:: text @@ -84,16 +85,15 @@ Request Message } } -Response Message +Response Parameters +------------------- + +None + +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst b/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst index 1337115..39000b1 100644 --- a/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst @@ -31,29 +31,27 @@ DELETE /v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} | key | Yes | Specifies the tag key. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst index 04cf142..037b718 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst @@ -29,77 +29,75 @@ GET /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags + +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=================================================================+=========================================================================================================+ + | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 `. | + +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_tag_0002__table13242848193719: + +.. table:: **Table 3** **tag** objects + + +-----------------------+-----------------------+---------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=====================================================================+ + | key | String | - Specifies the tag key. | + | | | - Cannot be left blank. | + | | | - Contain up to 128 characters (36 characters on the console). | + | | | - Can contain only the following character types: | + | | | | + | | | - Uppercase letters | + | | | - Lowercase letters | + | | | - Digits | + | | | - Special characters, including hyphens (-) and underscores (_) | + | | | | + | | | - The tag key of a VPC must be unique. | + +-----------------------+-----------------------+---------------------------------------------------------------------+ + | value | String | - Specifies the tag value. | + | | | - Contain up to 255 characters (43 characters on the console). | + | | | - Can contain only the following character types: | + | | | | + | | | - Uppercase letters | + | | | - Lowercase letters | + | | | - Digits | + | | | - Special characters, including hyphens (-) and underscores (_) | + +-----------------------+-----------------------+---------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=================================================================+=========================================================================================================+ - | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 `. | - +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - - .. _vpc_tag_0002__table13242848193719: - - .. table:: **Table 3** **tag** objects - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=====================================================================+ - | key | String | - Specifies the tag key. | - | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | - | | | - Can contain only the following character types: | - | | | | - | | | - Uppercase letters | - | | | - Lowercase letters | - | | | - Digits | - | | | - Special characters, including hyphens (-) and underscores (_) | - | | | | - | | | - The tag key of a VPC must be unique. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | value | String | - Specifies the tag value. | - | | | - Can contain a maximum of 43 characters. | - | | | - Can contain only the following character types: | - | | | | - | | | - Uppercase letters | - | | | - Lowercase letters | - | | | - Digits | - | | | - Special characters, including hyphens (-) and underscores (_) | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + { + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst index f9d4f66..f225614 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst @@ -27,23 +27,20 @@ GET /v2.0/{project_id}/vpcs/tags project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/{project_id}/vpcs/tags -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -63,7 +60,7 @@ Response parameter | key | String | Specifies the tag key. | | | | | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -73,7 +70,7 @@ Response parameter +-----------------------+-----------------------+---------------------------------------------------------------------+ | values | Array of strings | Specifies the tag value list. | | | | | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -82,7 +79,8 @@ Response parameter | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------------+-----------------------+---------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst index e9f09ac..93a86d8 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst @@ -27,10 +27,8 @@ POST /v2.0/{project_id}/vpcs/resource_instances/action project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -54,13 +52,17 @@ Request parameter .. table:: **Table 3** Description of the **tag** field - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========+===========+==================+====================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================+=================================================================================================================================================================================================================+ + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | values | Yes | Array of strings | Specifies the tag values. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. | + | | | | | + | | | | The values are in the OR relationship. | + | | | | | + | | | | Resources that match any value can be found. For example, if resource A has a tag value of **val1** and resource B has a tag value of **val2**, resources A and B can be found by using **values={val1,val2}**. | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_tag_0005__table104959232192: @@ -74,69 +76,70 @@ Request parameter | value | Yes | String | Specifies the tag value. Each value can contain a maximum of 255 Unicode characters. | +-------+-----------+--------+--------------------------------------------------------------------------------------+ -Example request 1: Setting **action** to **filter** +Example Request +--------------- -.. code-block:: text +- Filter VPCs by setting **action** to **filter**. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use **matches** and **tags** to filter VPCs. - POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action + .. code-block:: text - { - "offset": "0", - "limit": "100", - "action": "filter", - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ], - "tags": [ - { - "key": "key1", - "values": [ - "*value1", - "value2" - ] - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action -Example request 2: Setting **action** to **count** + { + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ], + "tags": [ + { + "key": "key1", + "values": [ + "*value1", + "value2" + ] + } + ] + } -.. code-block:: text +- Count VPCs by setting **action** to **count**. Use **matches** and **tags** to filter and count VPCs. - POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action + .. code-block:: text - { - "action": "count", - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ], - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ] - } + POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action -Response Message ----------------- + { + "action": "count", + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ] + } -Response parameter +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -168,47 +171,54 @@ Response parameter .. table:: **Table 7** Description of the **tag** field - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========+===========+==================+====================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================+=================================================================================================================================================================================================================+ + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. | + | | | | | + | | | | The values are in the OR relationship. | + | | | | | + | | | | Resources that match any value can be found. For example, if resource A has a tag value of **val1** and resource B has a tag value of **val2**, resources A and B can be found by using **values={val1,val2}**. | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example response 1: Setting **action** to **filter** +Example Response +---------------- -.. code-block:: +- When **action** is set to **filter**: - { - "resources": [ - { - "resource_detail": null, - "resource_id": "cdfs_cefs_wesas_12_dsad", - "resource_name": "resouece1", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value1" - } - ] - } - ], - "total_count": 1000 - } + .. code-block:: + + { + "resources": [ + { + "resource_detail": null, + "resource_id": "cdfs_cefs_wesas_12_dsad", + "resource_name": "resouece1", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value1" + } + ] + } + ], + "total_count": 1000 + } -Example response 2: Setting **action** to **count** +- When **action** is set to **count**: -.. code-block:: + .. code-block:: - { - "total_count": 1000 - } + { + "total_count": 1000 + } Status Code ----------- diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index 8435110..a91c9e7 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -23,322 +23,352 @@ Example of Returned Error Information Error Code Description ---------------------- -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Module | Status Code | Error Code | Message | Description | Handling Measure | -+==========================================================================================+=============+============+=========================================================================================+==============================================================================================================+==============================================================================================================================+ -| Public | 400 | VPC.0002 | Available zone Name is null. | The AZ is left blank. | Check whether the **availability_zone** field in the request body for creating a subnet is left blank. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.0003 | VPC does not exist. | The VPC does not exist. | Check whether the VPC ID is correct or whether the VPC exists under the tenant. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0004 | VPC is not active, please try later. | The VPC status is abnormal. | Try again later or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 401 | VPC.0005 | Lack of user authority. | User restricted. | Check whether the account is in arrears or has not applied for the OBT permission. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 401 | VPC.0009 | real-name authentication fail. | Real-name authentication fails. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Public | 400 | VPC.0007 | urlTenantId is not equal tokenTenantId | Inconsistent tenant IDs. | The tenant ID in the URL is different from that parsed in the token. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 401 | VPC.0008 | Invalid token in the header. | Invalid token. | Check whether the token in the request header is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 403 | VPC.2701 | Token not allowed to do this action. | You do not have permission to perform this operation, or your account balance is insufficient. | Check whether the account balance is insufficient or whether your account has been frozen. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Public | 403 | VPC.0010 | Rules on xx by \*\* disallowed by policy | Insufficient permissions to make calls to the underlying system. | Obtain the required permissions. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 403 | VPC.2201 | Policy doesn't allow to be performed | Insufficient fine-grained permissions. | Obtain the required permissions. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Creating a VPC | 400 | VPC.0101 | Param is invalid. | VPC parameters are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0114 | Quota exceeded for resources: ['router']. | The number of VPCs has reached the maximum allowed limit specified by the quota. | Clear VPC resources that no longer will be used or apply for expanding the VPC resource quota. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0115 | The router name has exist. | The VPC name already exists. | Change the VPC name. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying a VPC | 400 | VPC.0101 | getVpc error vpcId is invalid. | VPC parameters are incorrect. | Ensure that the specified VPC ID is correct. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0106 | get router is null. | An error is returned for the failure to call the backend service. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying VPCs | 400 | VPC.0101 | Query vpc list error. | Failed to query the VPCs. | Check whether the parameter values are valid based on the returned error message. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0106 | query routers or getList are null. | The response result of calls to the IaaS OpenStack system is null or empty. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Deleting a VPC | 400/404 | VPC.0101 | Delete router error xx is invalid. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0102 | Delete router fail. | The interface fails to obtain the routing resources. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0103 | Resource status is busy, try it again later. | The VPC cannot be deleted because it is being created. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0104 | Router contains subnets, please delete subnet first. | The VPC cannot be deleted because it contains subnets. | Delete the subnet in the VPC. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0107 | Delete the firewall first before deleting the router. | Failed to delete the VPC because it has firewalls associated. | Delete the firewalls of the tenant first. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0108 | Router is used not allow deleted. | Failed to delete the VPC because it has EIPs associated. | Delete the EIPs of the tenant first. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0109 | Router is used not allow deleted. | Failed to delete the VPC because one or more VPNs have been created for it. | Delete VPNs of the tenant. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0110 | deleteDefaultNetworkFromRouter router status is invalid. | The VPC cannot be deleted because its status is unstable. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0111 | Database Error. | An internal VPC exception occurs. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0112 | Delete the securitygroup first before deleting the router. | The VPC cannot be deleted because it contains security groups. | Delete security groups of the tenant. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0118 | ELB exists under this router, delete ELB firstly. | The VPC cannot be deleted because it contains load balancers. | Delete load balancers in the VPC. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0119 | ELB Error. | An error occurred when the VPC service makes calls to the ELB service. | Check whether the ELB service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0120 | exroutes exists under this router, delete exroutes firstly. | The VPC cannot be deleted because it contains extension routes. | Delete extension routes in the VPC. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Updating a VPC | 400 | VPC.0101 | Update router xx is invalid. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0113 | Router status is not active. | The VPC cannot be updated because the status of the VPC is abnormal. | Try again later or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0115 | The router name has exist. | The VPC name already exists. | Change the VPC name. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0117 | Cidr can not contain subnetList cidr. | The subnet parameters are invalid. The VPC CIDR block does not contain all its subnet CIDR blocks. | Change the CIDR block of the VPC. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Creating a subnet | 400 | VPC.0201 | Subnet name is invalid. | Incorrect subnet parameters. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0202 | Create subnet failed. | An internal error occurs in the subnet. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0203 | Subnet is not in the range of VPC. | The CIDR block of the subnet is not in the range of the VPC. | Change the CIDR block of the subnet. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0204 | The subnet has already existed in the VPC, or has been in conflict with the VPC subnet. | The CIDR block of the subnet already exists in the VPC. | Change the CIDR block of the subnet. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0212 | The subnet cidr is not valid. | Invalid subnet CIDR block. | Check whether the subnet CIDR block is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying a subnet | 400 | VPC.0201 | Subnet ID is invalid. | Invalid subnet ID. | Check whether the subnet ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0202 | Query subnet fail. | Failed to query the subnet. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying subnets | 400 | VPC.0201 | Query subnets list error. | Failed to query the subnets. | Check whether the parameter values are valid based on the returned error message. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0202 | List subnets error. | Failed to query the subnets. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Deleting a subnet | 400 | VPC.0201 | Subnet ID is invalid. | Invalid subnet ID. | Check whether the parameter values are valid based on the returned error message. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0206 | Subnet has been used by VPN, please remove the subnet from the VPN and try again. | The subnet cannot be deleted because it is being used by the VPN. | Delete the subnet that is used by the VPN. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0207 | Subnet does not belong to the VPC. | This operation is not allowed because the subnet does not belong to the VPC. | Check whether the subnet is in the VPC. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0208 | Subnet is used by private IP, can not be deleted. | The subnet cannot be deleted because it is being used by the private IP address. | Delete the private IP address of the subnet. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0209 | subnet is still used ,such as computer,LB. | The subnet cannot be deleted because it is being used by an ECS or load balancer. | Delete the ECS or load balancer in the subnet. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0210 | Subnet has been used by routes, please remove the routes first and try again. | The subnet cannot be deleted because it is being used by the custom route. | Delete the custom route. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0211 | subnet is still used by LBaas. | The subnet cannot be deleted because it is being used by load balancers. | Delete load balancers in the subnet. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Updating a subnet | 400 | VPC.0201 | xx is invalid. | Incorrect subnet parameters. | Check whether the parameter values are valid based on the returned error message. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0205 | Subnet states is invalid, please try again later. | The subnet cannot be updated because it is being processed. | Try again later or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0207 | Subnet does not belong to the VPC. | This operation is not allowed because the subnet does not belong to the VPC. | Check whether the subnet is in the VPC. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Assigning an EIP | 400 | VPC.0301 | Bandwidth name or share_type is invalid. | The specified bandwidth parameter for assigning an EIP is invalid. | Check whether the specified bandwidth parameter is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0501 | Bandwidth share_type is invalid. | Invalid EIP parameters. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 403 | VPC.0502 | Tenant status is op_restricted. | You are not allowed to assign the EIP. | Check whether the account balance is insufficient or whether your account has been frozen. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0503 | Creating publicIp failed. | Failed to assign the EIP. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0504 | FloatIp is null. | Failed to assign the EIP because no IP address is found. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0508 | Port is invalid. | Port-related resources could not be found. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0510 | Floatingip has already associated with port. | The EIP has already been bound to another ECS. | Unbind the EIP from the ECS. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0511 | Port has already associated with floatingip. | The port has already been associated with an EIP. | Disassociate the port from the EIP. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0521 | Quota exceeded for resources: ['floatingip']. | Insufficient EIP quota. | Release the unbound EIPs or request to increase the EIP quota. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0522 | The IP address is in use. | The IP address is invalid or in use. | Check whether the IP address format is valid or replace it with another IP address. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0532 | No more IP addresses available on network. | Failed to assign the IP address because no IP addresses are available. | Release unbound EIPs or try again later. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying an EIP | 400 | VPC.0501 | Invalid floatingip_id. | Invalid EIP parameters. | Check whether the EIP ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.0504 | Floating IP could not be found. | The EIP could not be found. | Check whether the specified EIP ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0514 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying EIPs | 400 | VPC.0501 | Invalid limit. | Invalid EIP parameters. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Releasing an EIP | 400 | VPC.0501 | Invalid param. | Invalid EIP parameters. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.0504 | Floating IP could not be found. | The EIP could not be found. | Check whether the specified EIP ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0512 | Resource status is busy, try it again later. | The EIP status is abnormal. | Try again later or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0513 | getElementByKey error. | Network resources cannot be found. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0516 | Publicip is in used by ELB. | Failed to release the EIP because it is being used by a load balancer. | Unbind the EIP from the load balancer. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0517 | Floatingip has associated with port, please disassociate it firstly. | Failed to release the EIP because it is bound to an ECS. | Unbind the EIP from the ECS. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0518 | Public IP has firewall rules. | Failed to release the EIP because it is being used by a firewall. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Updating an EIP | 400 | VPC.0501 | Port id is invalid. | Invalid EIP parameters. | Check whether the port ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.0504 | Floating IP could not be found. | The EIP could not be found. | Check whether the specified EIP ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0509 | Floating ip double status is invalid. | The port has already been associated with an EIP. | Disassociate the port from the EIP. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0510 | Floatingip has already associated with port. | The EIP has already been bound to another ECS. | Unbind the EIP from the ECS. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0511 | Port has already associated with floatingip. | Failed to bind the EIP to the ECS because another EIP has already been bound to the ECS. | Unbind the EIP from the ECS. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0512 | Resource status is busy, try it again later. | The EIP status is abnormal. | Try again later or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0514 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying a bandwidth | 400 | VPC.0301 | getBandwidth error bandwidthId is invalid. | The bandwidth parameters are incorrect. | Check whether the bandwidth ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.0306 | No Eip bandwidth exist with id. | The bandwidth object does not exist. | The bandwidth object to be queried does not exist. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0302 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying bandwidths | 400 | VPC.0301 | Get bandwidths error limit is invalid. | The bandwidth parameters are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.0306 | No Eip bandwidth exist with id. | The bandwidth object does not exist. | The bandwidth object to be queried does not exist. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0302 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Updating a bandwidth | 400 | VPC.0301 | updateBandwidth input param is invalid. | The bandwidth parameters are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0302 | Neutron Error. | Failed to obtain underlying resources. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0305 | updateBandwidth error. | An internal error occurs during the bandwidth update. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying quotas | 400 | VPC.1207 | resource type is invalid. | The specified resource type does not exist. | Use an existing resource type. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Assigning a private IP address | 500 | VPC.0701 | The IP has been used. | The private IP address already exists. | Change another private IP address and try again. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0705 | IP address is not a valid IP for the specified subnet. | Invalid private IP address | Check whether the specified IP address in the request body is within the subnet CIDR block. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.2204 | Query resource by id fail. | The resource does not exist or the permission is insufficient. | Check whether the specified subnet in the request body exists or the current account has the permission to query the subnet. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0703 | No more IP addresses available on network xxx. | Insufficient IP addresses. | Check whether the subnet has sufficient IP addresses. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying a Private IP Address | 404 | VPC.0704 | Query resource by id fail. | The private IP address does not exist. | Check whether the private IP address exists. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying Private IP Addresses | 400 | VPC.0702 | query privateIps error. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Releasing a Private IP Address | 404 | VPC.0704 | Query resource by id fail. | The private IP address does not exist. | Check whether the private IP address exists. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0706 | Delete port fail. | An error occurs when the private IP address is being released. | Try again later or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0707 | privateIp is in use. | The private IP address is in use. | Check whether the private IP address is being used by other resource. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Creating a security group | 400 | VPC.0601 | Creating securitygroup name is invalid. | The parameters of the security group are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0602 | Add security group fail. | An internal error occurs in the security group. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0604 | Quota exceeded for resources: ['security_group']. | Insufficient security group quota. | Delete the security group that is no longer required or apply for increasing the quota. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying a security group | 400 | VPC.0601 | Securitygroup id is invalid. | The parameters of the security group are incorrect. | Check whether the security group ID is valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0602 | Query security group fail. | An internal error occurs in the security group. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.0603 | Securitygroup is not exist. | The security group does not exist. | Check whether the security group ID is correct or whether the security group exists under the tenant. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404/500 | VPC.0612 | Neutron Error. | An internal error occurs in the security group. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying security groups | 400 | VPC.0601 | Query security groups error limit is invalid. | The parameters of the security group are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0602 | Query security groups fail. | An internal error occurs in the security group. | Check whether the Neutron service is normal or contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Associating multiple NIC ports to or disassociating them from a security group at a time | 400 | VPC.0606 | Security group id is invalid | Invalid security group ID. | Use a valid security group ID. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0606 | Request is invalid | The request structure is missing. | Use a valid request body. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0606 | Request is null | The request is empty. | Use a valid request body. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0606 | Action is invalid | Invalid action value. | Use a valid action value (**add** or **remove**). | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0606 | Ports list is empty | The **ports** are an empty list. | Use a valid **ports** list. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0606 | Port id is invalid | The **ports** list contains invalid port IDs. | Use a valid **ports** list. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0609 | Ports list exceeds limit | The **ports** list contains more than 20 IDs. | Use a valid **ports** list. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.0606 | Endpoint is invalid | Invalid endpoint. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 200 | VPC.0607 | Security group of this instance doesn't exist | The security group does not exist. | Use a valid security group ID. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 200 | VPC.0607 | An instance must belong to at least one security group | Do not disassociate the instance from the security group when it is associated with only one security group. | Perform other operations. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 200 | VPC.0608 | Neutron Error | An internal error occurs when you perform batch operations. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Flow log | 400 | VPC.3001 | resource could not be found, flowlog id is invalid | Invalid parameters. | Check whether the parameters are valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.3002 | create its topic failed | An error occurred during log topic creation in LTS. | Check whether the parameters are valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.3002 | NeutronError | Failed to query the flow log. | Check whether the parameters are valid. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.3002 | NeutronError | Failed to create the flow log. | Contact technical support. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Resource tags | 400 | VPC.1801 | resource id is invalid. | Incorrect resource ID. | Use a correct resource ID. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | action is invalid. | Invalid action value. | Ensure that the value of **action** is **create** or **delete**. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | Invalid key length. The key can contain 1 to 36 characters. | Use a valid key value. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | Invalid value length. | Use a value of valid length. | -| | | | | | | -| | | | | The value can contain 0 to 43 characters. | | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Resource_type xxx is invalid. | Incorrect resource type. | Ensure that the value of **resource_type** is **vpcs**. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Tag can not be null. | The tag list contains value null. | Use valid tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | The list of matches contains null. | The matches list contains value null. | Use valid matches. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Tag value can not be null. | The tags exist, but their values are null. | Use valid tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | The value of Matches in resourceInstancesReq is null. | The matches exist, and the value is null. | Use valid matches. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | number of tags exceeds max num of 10. | The tag list contains more than 10 keys. | Use valid tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Tag key is repeated. | The tag list contains duplicate keys. | Use valid tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Value of tags in resourceInstancesReq is duplicate. | There are duplicate tag values in the tag list. | Use valid tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | number of tags exceeds max num of 10. | The tag in the tag list has more than 10 tag values. | Use valid tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | The key of matches is invalid. | The key in **matches** is not the resource name. | Use valid matches. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Limit in resourceInstancesReq is invalid. | Invalid **limit** or **offset** value. | Use valid **limit** and **offset** values. | -| | | | | | | -| | | | Offset in resourceInstancesReq is invalid. | | | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | ResourceInstancesReq is null or invalid. | The tags dictionary structure is missing. | Use a valid tags dictionary structure. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | The key in tags exceeds the maximum length or is left blank. | Use valid keys in tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | A value in tags exceeds the maximum length. | Use valid values in tags. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | ResourceInstancesReq is null or invalid. | The matches dictionary structure is missing. | Use a valid matches dictionary structure. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | The number of Matches in resourceInstancesReq is 0. | The matches are an empty list. | Use a valid matches list. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.1801 | The value's length of Matches in resourceInstancesReq is more than 255. | The matches list contains tag values that contain more than 255 Unicode characters. | Use a valid matches list. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.1801 | InvalidInput | Incorrect request body format. | Use the correct request body format. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 404 | VPC.2204 | Query subnet by id fail. | The resource does not exist or the permission is insufficient. | Use an existing resource or obtain required permission. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| Querying the network IP address usage | 400 | VPC.2301 | parameter network_id is invalid. | The request parameter is incorrect. | Enter a valid network ID. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 400 | VPC.2302 | Network xxx could not be found. | The network is not found. | Ensure that the network ID exists. | -+------------------------------------------------------------------------------------------+-------------+------------+-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Module | Status Code | Error Code | Message | Description | Handling Measure | ++==========================================================================================+=============+============+====================================================================================================================================================================+==============================================================================================================+==============================================================================================================================+ +| Public | 400 | VPC.0002 | Available zone Name is null. | The AZ is left blank. | Check whether the **availability_zone** field in the request body for creating a subnet is left blank. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.0003 | VPC does not exist. | The VPC does not exist. | Check whether the VPC ID is correct or whether the VPC exists under the tenant. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0004 | VPC is not active, please try later. | The VPC status is abnormal. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 401 | VPC.0005 | Lack of user authority. | User restricted. | Check whether the account is in arrears or has not applied for the OBT permission. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 401 | VPC.0009 | real-name authentication fail. | Real-name authentication fails. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Public | 400 | VPC.0007 | urlTenantId is not equal tokenTenantId | Inconsistent tenant IDs. | The tenant ID in the URL is different from that parsed in the token. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 401 | VPC.0008 | Invalid token in the header. | Invalid token. | Check whether the token in the request header is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 403 | VPC.2701 | Token not allowed to do this action. | You do not have permission to perform this operation, or your account balance is insufficient. | Check whether the account balance is insufficient or whether your account has been frozen. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Public | 403 | VPC.0010 | Rules on xx by \*\* disallowed by policy | Insufficient permissions to make calls to the underlying system. | Obtain the required permissions. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 403 | VPC.2201 | Policy doesn't allow to be performed | Insufficient fine-grained permissions. | Obtain the required permissions. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Creating a VPC | 400 | VPC.0101 | Param is invalid. | VPC parameters are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0114 | Quota exceeded for resources: ['router']. | The number of VPCs has reached the maximum allowed limit specified by the quota. | Clear VPC resources that no longer will be used or apply for expanding the VPC resource quota. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0115 | The router name has exist. | The VPC name already exists. | Change the VPC name. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying a VPC | 400 | VPC.0101 | getVpc error vpcId is invalid. | VPC parameters are incorrect. | Ensure that the specified VPC ID is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0106 | get router is null. | An error is returned for the failure to call the backend service. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying VPCs | 400 | VPC.0101 | Query vpc list error. | Failed to query the VPCs. | Check whether the parameter values are valid based on the returned error message. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0106 | query routers or getList are null. | The response result of calls to the IaaS OpenStack system is null or empty. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Deleting a VPC | 400/404 | VPC.0101 | Delete router error xx is invalid. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0102 | Delete router fail. | The interface fails to obtain the routing resources. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0103 | Resource status is busy, try it again later. | The VPC cannot be deleted because it is being created. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0104 | Router contains subnets, please delete subnet first. | The VPC cannot be deleted because it contains subnets. | Delete the subnet in the VPC. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0107 | Delete the firewall first before deleting the router. | Failed to delete the VPC because it has firewalls associated. | Delete the firewalls of the tenant first. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0108 | Router is used not allow deleted. | Failed to delete the VPC because it has EIPs associated. | Delete the EIPs of the tenant first. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0109 | Router is used not allow deleted. | Failed to delete the VPC because one or more VPNs have been created for it. | Delete VPNs of the tenant. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0110 | deleteDefaultNetworkFromRouter router status is invalid. | The VPC cannot be deleted because its status is unstable. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0111 | Database Error. | An internal VPC exception occurs. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0112 | Delete the securitygroup first before deleting the router. | The VPC cannot be deleted because it contains security groups. | Delete security groups of the tenant. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0118 | ELB exists under this router, delete ELB firstly. | The VPC cannot be deleted because it contains load balancers. | Delete load balancers in the VPC. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0119 | ELB Error. | An error occurred when the VPC service makes calls to the ELB service. | Check whether the ELB service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0120 | exroutes exists under this router, delete exroutes firstly. | The VPC cannot be deleted because it contains extension routes. | Delete extension routes in the VPC. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Updating a VPC | 400 | VPC.0101 | Update router xx is invalid. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0113 | Router status is not active. | The VPC cannot be updated because the status of the VPC is abnormal. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0115 | The router name has exist. | The VPC name already exists. | Change the VPC name. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0117 | Cidr can not contain subnetList cidr. | The subnet parameters are invalid. The VPC CIDR block does not contain all its subnet CIDR blocks. | Change the CIDR block of the VPC. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Creating a subnet | 400 | VPC.0201 | Subnet name is invalid. | Incorrect subnet parameters. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0202 | Create subnet failed. | An internal error occurs in the subnet. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0203 | Subnet is not in the range of VPC. | The CIDR block of the subnet is not in the range of the VPC. | Change the CIDR block of the subnet. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0204 | The subnet has already existed in the VPC, or has been in conflict with the VPC subnet. | The CIDR block of the subnet already exists in the VPC. | Change the CIDR block of the subnet. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0212 | The subnet cidr is not valid. | Invalid subnet CIDR block. | Check whether the subnet CIDR block is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying a subnet | 400 | VPC.0201 | Subnet ID is invalid. | Invalid subnet ID. | Check whether the subnet ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0202 | Query subnet fail. | Failed to query the subnet. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying subnets | 400 | VPC.0201 | Query subnets list error. | Failed to query the subnets. | Check whether the parameter values are valid based on the returned error message. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0202 | List subnets error. | Failed to query the subnets. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Deleting a subnet | 400 | VPC.0201 | Subnet ID is invalid. | Invalid subnet ID. | Check whether the parameter values are valid based on the returned error message. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0206 | Subnet has been used by VPN, please remove the subnet from the VPN and try again. | The subnet cannot be deleted because it is being used by the VPN. | Delete the subnet that is used by the VPN. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0207 | Subnet does not belong to the VPC. | This operation is not allowed because the subnet does not belong to the VPC. | Check whether the subnet is in the VPC. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0208 | Subnet is used by private IP, can not be deleted. | The subnet cannot be deleted because it is being used by the private IP address. | Delete the private IP address of the subnet. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0209 | subnet is still used ,such as computer,LB. | The subnet cannot be deleted because it is being used by an ECS or load balancer. | Delete the ECS or load balancer in the subnet. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0210 | Subnet has been used by routes, please remove the routes first and try again. | The subnet cannot be deleted because it is being used by the custom route. | Delete the custom route. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0211 | subnet is still used by LBaas. | The subnet cannot be deleted because it is being used by load balancers. | Delete load balancers in the subnet. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Updating a subnet | 400 | VPC.0201 | xx is invalid. | Incorrect subnet parameters. | Check whether the parameter values are valid based on the returned error message. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0205 | Subnet states is invalid, please try again later. | The subnet cannot be updated because it is being processed. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0207 | Subnet does not belong to the VPC. | This operation is not allowed because the subnet does not belong to the VPC. | Check whether the subnet is in the VPC. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Assigning an EIP | 400 | VPC.0301 | Bandwidth name or share_type is invalid. | The specified bandwidth parameter for assigning an EIP is invalid. | Check whether the specified bandwidth parameter is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0501 | Bandwidth share_type is invalid. | Invalid EIP parameters. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 403 | VPC.0502 | Tenant status is op_restricted. | You are not allowed to assign the EIP. | Check whether the account balance is insufficient or whether your account has been frozen. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0503 | Creating publicIp failed. | Failed to assign the EIP. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0504 | FloatIp is null. | Failed to assign the EIP because no IP address is found. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0508 | Port is invalid. | Port-related resources could not be found. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0510 | Floatingip has already associated with port. | The EIP has already been bound to another ECS. | Unbind the EIP from the ECS. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0511 | Port has already associated with floatingip. | The port has already been associated with an EIP. | Disassociate the port from the EIP. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0521 | Quota exceeded for resources: ['floatingip']. | Insufficient EIP quota. | Release the unbound EIPs or request to increase the EIP quota. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0522 | The IP address is in use. | The IP address is invalid or in use. | Check whether the IP address format is valid or replace it with another IP address. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0532 | No more IP addresses available on network. | Failed to assign the IP address because no IP addresses are available. | Release unbound EIPs or try again later. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying an EIP | 400 | VPC.0501 | Invalid floatingip_id. | Invalid EIP parameters. | Check whether the EIP ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.0504 | Floating IP could not be found. | The EIP could not be found. | Check whether the specified EIP ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0514 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying EIPs | 400 | VPC.0501 | Invalid limit. | Invalid EIP parameters. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Releasing an EIP | 400 | VPC.0501 | Invalid param. | Invalid EIP parameters. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.0504 | Floating IP could not be found. | The EIP could not be found. | Check whether the specified EIP ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0512 | Resource status is busy, try it again later. | The EIP status is abnormal. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0513 | getElementByKey error. | Network resources cannot be found. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0516 | Publicip is in used by ELB. | Failed to release the EIP because it is being used by a load balancer. | Unbind the EIP from the load balancer. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0517 | Floatingip has associated with port, please disassociate it firstly. | Failed to release the EIP because it is bound to an ECS. | Unbind the EIP from the ECS. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0518 | Public IP has firewall rules. | Failed to release the EIP because it is being used by a firewall. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Updating an EIP | 400 | VPC.0501 | Port id is invalid. | Invalid EIP parameters. | Check whether the port ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.0504 | Floating IP could not be found. | The EIP could not be found. | Check whether the specified EIP ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0509 | Floating ip double status is invalid. | The port has already been associated with an EIP. | Disassociate the port from the EIP. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0510 | Floatingip has already associated with port. | The EIP has already been bound to another ECS. | Unbind the EIP from the ECS. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0511 | Port has already associated with floatingip. | Failed to bind the EIP to the ECS because another EIP has already been bound to the ECS. | Unbind the EIP from the ECS. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0512 | Resource status is busy, try it again later. | The EIP status is abnormal. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0514 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying a bandwidth | 400 | VPC.0301 | getBandwidth error bandwidthId is invalid. | The bandwidth parameters are incorrect. | Check whether the bandwidth ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.0306 | No Eip bandwidth exist with id. | The bandwidth object does not exist. | The bandwidth object to be queried does not exist. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0302 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying bandwidths | 400 | VPC.0301 | Get bandwidths error limit is invalid. | The bandwidth parameters are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.0306 | No Eip bandwidth exist with id. | The bandwidth object does not exist. | The bandwidth object to be queried does not exist. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0302 | Neutron Error. | An exception occurs in the IaaS OpenStack system. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Updating a bandwidth | 400 | VPC.0301 | updateBandwidth input param is invalid. | The bandwidth parameters are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0302 | Neutron Error. | Failed to obtain underlying resources. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0305 | updateBandwidth error. | An internal error occurs during the bandwidth update. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying quotas | 400 | VPC.1207 | resource type is invalid. | The specified resource type does not exist. | Use an existing resource type. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Assigning a private IP address | 500 | VPC.0701 | The IP has been used. | The private IP address already exists. | Change another private IP address and try again. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0705 | IP address is not a valid IP for the specified subnet. | Invalid private IP address | Check whether the specified IP address in the request body is within the subnet CIDR block. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.2204 | Query resource by id fail. | The resource does not exist or the permission is insufficient. | Check whether the specified subnet in the request body exists or the current account has the permission to query the subnet. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0703 | No more IP addresses available on network xxx. | Insufficient IP addresses. | Check whether the subnet has sufficient IP addresses. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying a Private IP Address | 404 | VPC.0704 | Query resource by id fail. | The private IP address does not exist. | Check whether the private IP address exists. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying Private IP Addresses | 400 | VPC.0702 | query privateIps error. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Releasing a Private IP Address | 404 | VPC.0704 | Query resource by id fail. | The private IP address does not exist. | Check whether the private IP address exists. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0706 | Delete port fail. | An error occurs when the private IP address is being released. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0707 | privateIp is in use. | The private IP address is in use. | Check whether the private IP address is being used by other resource. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Creating a security group | 400 | VPC.0601 | Creating securitygroup name is invalid. | The parameters of the security group are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0602 | Add security group fail. | An internal error occurs in the security group. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.0604 | Quota exceeded for resources: ['security_group']. | Insufficient security group quota. | Delete the security group that is no longer required or apply for increasing the quota. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying a security group | 400 | VPC.0601 | Securitygroup id is invalid. | The parameters of the security group are incorrect. | Check whether the security group ID is valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0602 | Query security group fail. | An internal error occurs in the security group. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.0603 | Securitygroup is not exist. | The security group does not exist. | Check whether the security group ID is correct or whether the security group exists under the tenant. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404/500 | VPC.0612 | Neutron Error. | An internal error occurs in the security group. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying security groups | 400 | VPC.0601 | Query security groups error limit is invalid. | The parameters of the security group are incorrect. | Check whether the parameter values are valid based on the returned error message and API reference document. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.0602 | Query security groups fail. | An internal error occurs in the security group. | Check whether the Neutron service is normal or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Associating multiple NIC ports to or disassociating them from a security group at a time | 400 | VPC.0606 | Security group id is invalid | Invalid security group ID. | Use a valid security group ID. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0606 | Request is invalid | The request structure is missing. | Use a valid request body. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0606 | Request is null | The request is empty. | Use a valid request body. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0606 | Action is invalid | Invalid action value. | Use a valid action value (**add** or **remove**). | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0606 | Ports list is empty | The **ports** are an empty list. | Use a valid **ports** list. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0606 | Port id is invalid | The **ports** list contains invalid port IDs. | Use a valid **ports** list. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0609 | Ports list exceeds limit | The **ports** list contains more than 20 IDs. | Use a valid **ports** list. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.0606 | Endpoint is invalid | Invalid endpoint. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 200 | VPC.0607 | Security group of this instance doesn't exist | The security group does not exist. | Use a valid security group ID. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 200 | VPC.0607 | An instance must belong to at least one security group | Do not disassociate the instance from the security group when it is associated with only one security group. | Perform other operations. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 200 | VPC.0608 | Neutron Error | An internal error occurs when you perform batch operations. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Flow log | 400 | VPC.3001 | resource could not be found, flowlog id is invalid | Invalid parameters. | Check whether the parameters are valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.3002 | create its topic failed | An error occurred during log topic creation in LTS. | Check whether the parameters are valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.3002 | NeutronError | Failed to query the flow log. | Check whether the parameters are valid. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.3002 | NeutronError | Failed to create the flow log. | Contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Resource tags | 400 | VPC.1801 | resource id is invalid. | Incorrect resource ID. | Use a correct resource ID. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | action is invalid. | Invalid action value. | Ensure that the value of **action** is **create** or **delete**. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | Invalid key length. The key can contain 1 to 36 characters. | Use a valid key value. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | Invalid value length. | Use a value of valid length. | +| | | | | | | +| | | | | The value can contain 0 to 43 characters. | | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Resource_type xxx is invalid. | Incorrect resource type. | Ensure that the value of **resource_type** is **vpcs**. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Tag can not be null. | The tag list contains value null. | Use valid tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | The list of matches contains null. | The matches list contains value null. | Use valid matches. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Tag value can not be null. | The tags exist, but their values are null. | Use valid tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | The value of Matches in resourceInstancesReq is null. | The matches exist, and the value is null. | Use valid matches. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | number of tags exceeds max num of 10. | The tag list contains more than 10 keys. | Use valid tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Tag key is repeated. | The tag list contains duplicate keys. | Use valid tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Value of tags in resourceInstancesReq is duplicate. | There are duplicate tag values in the tag list. | Use valid tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | number of tags exceeds max num of 10. | The tag in the tag list has more than 10 tag values. | Use valid tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | The key of matches is invalid. | The key in **matches** is not the resource name. | Use valid matches. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Limit in resourceInstancesReq is invalid. | Invalid **limit** or **offset** value. | Use valid **limit** and **offset** values. | +| | | | | | | +| | | | Offset in resourceInstancesReq is invalid. | | | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | ResourceInstancesReq is null or invalid. | The tags dictionary structure is missing. | Use a valid tags dictionary structure. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | The key in tags exceeds the maximum length or is left blank. | Use valid keys in tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] | A value in tags exceeds the maximum length. | Use valid values in tags. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | ResourceInstancesReq is null or invalid. | The matches dictionary structure is missing. | Use a valid matches dictionary structure. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | The number of Matches in resourceInstancesReq is 0. | The matches are an empty list. | Use a valid matches list. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.1801 | The value's length of Matches in resourceInstancesReq is more than 255. | The matches list contains tag values that contain more than 255 Unicode characters. | Use a valid matches list. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.1801 | InvalidInput | Incorrect request body format. | Use the correct request body format. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.2204 | Query subnet by id fail. | The resource does not exist or the permission is insufficient. | Use an existing resource or obtain required permission. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying the network IP address usage | 400 | VPC.2301 | parameter network_id is invalid. | The request parameter is incorrect. | Enter a valid network ID. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.2302 | Network xxx could not be found. | The network is not found. | Ensure that the network ID exists. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Creating a VPC flow log | 400 | VPC.3001 | resource_type/log_store_type/traffic_type/log_group_id/log_topic_id is invalid | Incorrect type or ID. | Check whether the type is supported or whether the ID format is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 400 | VPC.3002 | Port does not support flow log, port id : xxx | The VPC flow log does not support this type of port. | Check whether the port is an S3, C3, or M3 ECS NIC port. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.3002 | Port/Network/Vpc xxx could not be found. | The resource does not exist. | Check whether the resource exists. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 409 | VPC.3004 | Content of flow log is duplicate: resource type xxx, reousce id xxx, traffic type all, log group id xxx, log topic id xxx, log store type xxx, log store name xxx. | This VPC flow log already exists. | Modify the parameters of the VPC flow log. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.3002 | Create flow log by xxx(tenant_id) fail. | Calling the backend service fails. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying VPC flow logs | 404 | VPC.3001 | resource could not be found, xxx(listParam) is invalid | Invalid parameters. | Check whether the parameter format is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.3002 | Neutron Error. | Calling the backend service fails. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Querying a VPC flow log | 404 | VPC.3001 | resource could not be found, flowlog id is invalid. | Invalid VPC flow log ID. | Check whether the VPC flow log ID format is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.3002 | Flow log xxx could not be found. | The VPC flow log does not exist. | Check whether the VPC flow log exists or whether its ID is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Updating a VPC flow log | 404 | VPC.3001 | resource could not be found, flowlog id is invalid. | Invalid VPC flow log ID. | Check whether the VPC flow log ID format is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.3005 | Flow log xxx could not be found. | The VPC flow log does not exist. | Check whether the VPC flow log exists or whether its ID is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.3002 | Update flow log by xxx(tenant_id) fail. | Calling the backend service fails. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Deleting a VPC flow log | 404 | VPC.3001 | resource could not be found, flowlog id is invalid. | Invalid VPC flow log ID. | Check whether the VPC flow log ID format is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 404 | VPC.3005 | Flow log xxx could not be found. | The VPC flow log does not exist. | Check whether the VPC flow log exists or whether its ID is correct. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| | 500 | VPC.3002 | Delete flow log by xxx(tenant_id) fail. | Calling the backend service fails. | Try again later or contact technical support. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/vpc_monitoring_metrics.rst b/api-ref/source/appendix/vpc_monitoring_metrics.rst index c173739..6c4cb47 100644 --- a/api-ref/source/appendix/vpc_monitoring_metrics.rst +++ b/api-ref/source/appendix/vpc_monitoring_metrics.rst @@ -20,25 +20,25 @@ Metrics .. table:: **Table 1** EIP and bandwidth metrics - +----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+ - | ID | Name | Description | Value Range | Monitored Object | Monitoring Interval (Raw Data) | - +======================+====================+=================================================+=============+==================+================================+ - | upstream_bandwidth | Outbound Bandwidth | Network rate of outbound traffic | >= 0 bit/s | Bandwidth or EIP | 1 minute | - | | | | | | | - | | | Unit: bit/s | | | | - +----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+ - | downstream_bandwidth | Inbound Bandwidth | Network rate of inbound traffic | >= 0 bit/s | Bandwidth or EIP | 1 minute | - | | | | | | | - | | | Unit: bit/s | | | | - +----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+ - | up_stream | Outbound Traffic | Network traffic going out of the cloud platform | >= 0 bytes | Bandwidth or EIP | 1 minute | - | | | | | | | - | | | Unit: byte | | | | - +----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+ - | down_stream | Inbound Traffic | Network traffic going into the cloud platform | >= 0 bytes | Bandwidth or EIP | 1 minute | - | | | | | | | - | | | Unit: byte | | | | - +----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+ + +----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ID | Name | Description | Value Range | Monitored Object | Monitoring Interval (Raw Data) | + +======================+====================+=============================================================+=============+==================+================================+ + | upstream_bandwidth | Outbound Bandwidth | Network rate of outbound traffic | >= 0 bit/s | Bandwidth or EIP | 1 minute | + | | | | | | | + | | | Unit: bit/s | | | | + +----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+ + | downstream_bandwidth | Inbound Bandwidth | Network rate of inbound traffic | >= 0 bit/s | Bandwidth or EIP | 1 minute | + | | | | | | | + | | | Unit: bit/s | | | | + +----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+ + | up_stream | Outbound Traffic | Network traffic going out of the cloud platform in a minute | >= 0 bytes | Bandwidth or EIP | 1 minute | + | | | | | | | + | | | Unit: byte | | | | + +----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+ + | down_stream | Inbound Traffic | Network traffic going into the cloud platform in a minute | >= 0 bytes | Bandwidth or EIP | 1 minute | + | | | | | | | + | | | Unit: byte | | | | + +----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+ Dimension --------- diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index a5de736..9e58222 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,259 +5,324 @@ Change History ============== -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Released On | Description | -+===================================+=============================================================================================================================================================================================================================================================================================================================================================================================================+ -| 2022-06-25 | This release incorporates the following changes: | -| | | -| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, and :ref:`Updating a Bandwidth `. | -| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2022-03-03 | This release incorporates the following changes: | -| | | -| | Added descriptions of parameters **private_ip_address** and **port_id** in :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2022-02-15 | This release incorporates the following changes: | -| | | -| | - Added **5_gray** to the value range of parameter **type** in sections :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -| | - Added **5_gray** to the value range of parameter **publicip_type** and **gray** for parameter **bandwidth_type** in sections :ref:`Querying a Bandwidth ` and :ref:`Querying Bandwidths `. | -| | - Added **5_gray** to the value range of parameter **publicip_type** in sections :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-08-25 | This release incorporates the following changes: | -| | | -| | - Modified the description about parameter **updated_at** and added parameters **billing_info** and **enterprise_project_id** in :ref:`Bandwidth ` and :ref:`Bandwidth (V2.0) `. | -| | - Changed the value range of **type** in :ref:`Querying Quotas `. | -| | - Added parameter **remote_address_group_id** to sections :ref:`Security Group ` and :ref:`Security Group `. | -| | - Deleted parameters **ipv6_address_mode** and **ipv6_ra_mode** from :ref:`Subnet `. | -| | - Added parameter **enterprise_project_id** to section :ref:`Elastic IP `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-06-22 | This release incorporates the following changes: | -| | | -| | - Added parameter **profile** to sections :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -| | - Changed the value range of the **size** parameter to 1 Mbit/s to 1000 Mbit/s in :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, and :ref:`Removing an EIP from a Shared Bandwidth `. | -| | - Changed the value range of the **size** parameter to 5 Mbit/s to 1000 Mbit/s in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | -| | - Updated response examples in sections :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | -| | - Changed the parameter of **binding:vif_details** to **primary_interface** in sections :ref:`Querying Ports `, :ref:`Querying a Port `, :ref:`Creating a Port `, and :ref:`Updating a Port `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-05-25 | This release incorporates the following changes: | -| | | -| | - Added parameter **id** to the **bandwidth** field in section :ref:`Assigning an EIP `. | -| | - Added parameter **ip_version** to sections :ref:`Elastic IP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | -| | - Added parameter **bandwidth_name** to section :ref:`Elastic IP `. | -| | - Deleted description about IP address version conversion from section :ref:`Updating an EIP `. | -| | - Added parameters **created_at**, **updated_at**, **enable_bandwidth_rules**, **rule_quota**, and **bandwidth_rules** in sections :ref:`Bandwidth ` and :ref:`Assigning a Shared Bandwidth `. | -| | - Added value **share** to the value range of parameter **bandwidth_type** in section :ref:`Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-05-10 | This release incorporates the following changes: | -| | | -| | - Added description that the IP addresses reserved by the system cannot be obtained using APIs in :ref:`Querying Private IP Address Details `. | -| | - Moved :ref:`Error Codes ` and :ref:`Status Codes ` to :ref:`Appendix `. | -| | - Added a value for the **type** parameter of the **publicip** field in section :ref:`Elastic IP ` and :ref:`Bandwidth `. | -| | - Added **WHOLE** to the value range of parameter **share_type** in section :ref:`Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-03-16 | This release incorporates the following changes: | -| | | -| | Added description that leaving parameter **port_id** blank cannot be used to unbind an EIP from a dedicated load balancer in sections :ref:`Updating an EIP ` and :ref:`Updating a Floating IP Address `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-12-16 | This release incorporates the following changes: | -| | | -| | - Modified the value range of **cidr** in section :ref:`Virtual Private Cloud `. | -| | - Changed the maximum number of tags in sections :ref:`Querying VPCs by Tag ` and :ref:`Querying Subnets by Tag `. | -| | - Added fields **port_security_enabled**, **dns_name**, and **dns_assignment** to section :ref:`Port `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-06-30 | This release incorporates the following changes: | -| | | -| | - Added the **routes** field in section :ref:`Updating VPC Information `. | -| | - Added field **index_enabled** in section :ref:`VPC Flow Log `. | -| | - Modified URI parameters in sections :ref:`Querying Security Group Rule Details ` and :ref:`Deleting a Security Group Rule `. | -| | - Modified description of the **tenant_id** field in section :ref:`Creating a VPC Peering Connection `. | -| | - Modified the **network_ip_availability** parameter type in section :ref:`Querying IP Address Usage on a Specified Network `. | -| | - Modified the **networks** parameter type in section :ref:`Querying Networks `. | -| | - Added response parameter **project_id** in sections :ref:`Adding an Interface to a Router ` and :ref:`Removing an Interface from a Router `. | -| | - Added the **device_owner** field in section :ref:`Creating a Port `. | -| | - Added information about whether the **allow_address_pair** and **extra_dhcp_opt** fields are mandatory in section :ref:`Updating a Port `. | -| | - Added or modified the **ports_links**, **binding:profile**, and **binding:vif_details** fields in section :ref:`Port `. | -| | - Added the **networks_links** field in section :ref:`Network `. | -| | - Added the **subnets_links** field in section :ref:`Subnet `. | -| | - Added the **routers_links** field in section :ref:`Router `. | -| | - Added or modified the **firewall_rules_links** and **firewall_policies** fields in section :ref:`Firewall `. | -| | - Modified the URI in sections :ref:`Querying a Security Group Rule ` and :ref:`Deleting a Security Group Rule `. | -| | - Added the **tenant_id** field in sections :ref:`Creating a Security Group ` and :ref:`Querying Security Group Rule Details `. | -| | - Added the **peerings_link** object in section :ref:`Querying VPC Peering Connections `. | -| | - Added the **routes_link** object in section :ref:`Querying VPC Routes `. | -| | - Added the **fixed_ip** field in section :ref:`Creating a Port `. | -| | - Added the **firewall_policies_link** object in section :ref:`Querying Firewall Policies `. | -| | - Added the **project_id** field in sections :ref:`Inserting a Firewall Rule ` and :ref:`Removing a Firewall Rule `. | -| | - Added the **created_at** and **updated_at** fields in sections :ref:`Querying Firewall Groups `, :ref:`Querying a Firewall Group `, :ref:`Creating a Firewall Group `, and :ref:`Updating a Firewall Group `. | -| | - Added the **firewall_groups_link** object in section :ref:`Querying Firewall Groups `. | -| | - Changed the position of the section :ref:`Permissions Policies and Supported Actions ` and adjusted the table. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-04-13 | This release incorporates the following changes: | -| | | -| | - Modified description of parameters in the **security_group_rule** field in section :ref:`Creating a Security Group Rule `. | -| | - Added URI parameter description in :ref:`Port `, :ref:`Network `, :ref:`Querying Subnets `, :ref:`Querying Routers `, :ref:`Firewall `, and :ref:`Security Group `. | -| | - Added description of discarding **vpc_id** in section :ref:`Creating a Security Group `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-03-20 | This release incorporates the following changes: | -| | | -| | Added the value of **5_mailbgp** for parameters **type** and **publicip_type** | -| | | -| | in sections :ref:`Assigning an EIP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-02-25 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Bandwidth (V2.0) `. | -| | - Added :ref:`Bandwidth (V2.0) ` in section :ref:`Permissions Policies and Supported Actions `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-09-10 | This release incorporates the following changes: | -| | | -| | - Added APIs described in section :ref:`VPC Flow Log ` and VPC flow log error codes to section :ref:`Error Codes `. | -| | - Modified the description of the **charge_mode** field and its value in the response example in :ref:`Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-11-30 | This release incorporates the following changes: | -| | | -| | - Added the **extra_dhcp_opts** field in sections :ref:`Creating a Subnet `, :ref:`Querying Subnet Details `, :ref:`Querying Subnets `, and :ref:`Updating Subnet Information `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-10-22 | This release incorporates the following changes: | -| | | -| | - Added sections :ref:`APIs ` and :ref:`Native OpenStack Neutron APIs (V2.0) ` and categorized VPC APIs and native OpenStack APIs. | -| | - Deleted description about the **Reject** rule from section :ref:`Updating a Firewall Rule `. | -| | - Added the **project_id**, **created_at**, and **updated_at** fields to and modified the example request and response in sections :ref:`Port `, :ref:`Network `, :ref:`Subnet `, :ref:`Router `, :ref:`Floating IP Address `, :ref:`Firewall `, and :ref:`Security Group `. | -| | - Modified the API format to ensure consistency. | -| | - Modified description about the **tenant_id** and **project_id** fields to ensure consistency. | -| | - Added section :ref:`VPC Peering Connection ` under **API Permissions**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-10-12 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Querying a Specified API Version `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-09-04 | This release incorporates the following changes: | -| | | -| | - Modified the response example in section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | -| | - Added error messages for associating multiple NIC ports to or disassociating them from a security group at a time in section :ref:`Error Codes `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-30 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-30 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Permissions Policies and Supported Actions `. | -| | - Deleted sections related to VPNs. An independent VPN API reference will be provided. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-11 | This release incorporates the following changes: | -| | | -| | - Modified VPC tagging description in section :ref:`Querying VPC Tags in a Specified Project `. | -| | - Modified subnet tagging description in section :ref:`Querying Subnet Tags in a Specified Project `. | -| | - Modified EIP tagging description in section :ref:`Querying EIP Tags in a Specified Project `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-04-28 | This release incorporates the following changes: | -| | | -| | - Opened APIs described in section :ref:`Floating IP Address (IPv6) `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-03-30 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Querying API Versions `. | -| | - Modified the content in section :ref:`VPC Tag Management `. | -| | - Added section :ref:`Subnet Tag Management `. | -| | - Added section :ref:`EIP Tag Management `. | -| | - Added metrics **Upstream Traffic** and **Downstream Traffic** in section :ref:`VPC Monitoring Metrics `. | -| | - Modified the content in section :ref:`API Usage Guidelines `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-28 | This release incorporates the following changes: | -| | | -| | - Modified the URI and description in the API format in section :ref:`Querying VPC Peering Connections `. | -| | - Modified the URI and description in the API format in section :ref:`Querying VPC Routes `. | -| | - Modified the response parameters and parameter examples in section :ref:`Accepting a VPC Peering Connection `. | -| | - Modified the response parameters and parameter examples in section :ref:`Refusing a VPC Peering Connection `. | -| | - Provided the address for downloading the sample code in section **Sample Code**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-14 | This release incorporates the following changes: | -| | | -| | - Modified the title of section **VPN (Native OpenStack API)**. | -| | - Linked the error codes in subsections of **VPN (Native OpenStack API)** to **Error Codes**. | -| | - Linked the error codes in subsection :ref:`Subnet Pool ` to :ref:`Status Codes `. | -| | - Linked the error codes in the tag management sections. | -| | - Adjusted the sequence of subsections under :ref:`Subnet Pool `. | -| | - Modified the description of parameters **share_type** and **charge_mode** in the **bandwidth** field in section :ref:`Assigning an EIP `. | -| | - Added the example request in section **Creating a VPN Service**. | -| | - Added the example request and example response in section **Querying VPN Endpoint Groups**. | -| | - Added the example request in section **Querying Details About a VPN Service**. | -| | - Modified the example response in section **Deleting an IKE Policy**. | -| | - Added the example request in section **Deleting a VPN Service**. | -| | - Added the example request in section **Querying Details About an IKE Policy**. | -| | - Added the example response in section **Querying Details About a VPN Endpoint Group**. | -| | - Added the example response in section **Querying Details About a VPN Service**. | -| | - Added the example response in section **Updating an IPsec Policy**. | -| | - Added the example response in section **Updating a VPN Service**. | -| | - Modified the example request and example response in section **Updating an IPsec VPN Connection**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-01-30 | This release incorporates the following changes: | -| | | -| | - Deleted the section **Port**. | -| | - Added section **VPN (Native OpenStack API)**. | -| | - Added section **Subnet Pool (Native OpenStack API)**. | -| | - Added parameters **dns_name** and **dns_domain** in the floating IP address object table in section **Floating IP Address (Native OpenStack API)**. | -| | - Added parameters **dns_name** and **dns_assignment** in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | -| | - Added the parameter **dns_domain** in the **network object** table in section **Network (Native OpenStack API)** > **Overview**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-11-30 | This release incorporates the following changes: | -| | | -| | - Added parameter **port_security_enable** in section **Creating a Subnet**. | -| | - Modified the **port_id** parameter description in the **publicip** fields in section **Binding or Unbinding an EIP** under **Elastic IP Address**. | -| | - Updated the **device_owner** parameter description in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | -| | - Added the **min** parameter to the **resources** field in the response in section **Querying Quotas**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-09-30 | This release incorporates the following changes: | -| | | -| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | -| | - Added section **VPC Peering Connection**. | -| | - Added section **VPC Route**. | -| | - Added a filter field to the URI of the APIs in sections **Querying Ports** and **Querying VPC Routes**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-08-30 | This release incorporates the following changes: | -| | | -| | Updated description in section **Updating a Network** under **Network (Native OpenStack API)**. | -| | | -| | - Added section **Elastic IP Address V2.0 (Extended OpenStack API)**. | -| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-07-30 | This release incorporates the following changes: | -| | | -| | - Changed the allowed maximum subnet mask value to 28 for CIDR blocks in the **subnet** object in section **Overview** under **Subnet (Native OpenStack API)**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-06-30 | This release incorporates the following changes: | -| | | -| | - Changed the **CRUD** value of parameter **router_id** to **R** for the **Floating IP address** object in section **Overview** under **Floating IP Address (Native OpenStack API)**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-05-30 | Added the following sections: | -| | | -| | - Network (Native OpenStack API) | -| | - Router (Native OpenStack API) | -| | - Floating IP Address (Native OpenStack API) | -| | - firewall (Native OpenStack API) | -| | - Security Group (Native OpenStack API) | -| | - Modified the request URI in section **Security Group**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-04-28 | This release incorporates the following changes: | -| | | -| | - Added monitoring metrics **up_stream** and **down_stream**. | -| | - Added field **dnsList** for APIs used to create a subnet, query a subnet, query subnets, and update a subnet. | -| | - Changed the bandwidth size value to 1 Mbit/s to 500 Mbit/s in sections **Elastic IP Address** and **Bandwidth**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-10-29 | This release incorporates the following changes: | -| | | -| | - Added the **ip_address** field to enable users to obtain a specified EIP. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-06-02 | This release incorporates the following changes: | -| | | -| | Changed the **ethertype** field for creating a security group rule to an optional field. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-04-14 | This release incorporates the following changes: | -| | | -| | - Modified the URL parameter description in section **Service Usage**. | -| | - Modified the procedure for making API calls for token authentication. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-03-09 | This issue is the first official release. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2024-02-02 | This release incorporates the following changes: | +| | | +| | - Modified the description about parameter **provider:network_type** in :ref:`Network `. | +| | - Updated the description about response parameter **{resources}_links** in :ref:`Pagination `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2024-01-18 | This release incorporates the following changes: | +| | | +| | Added the following sections: | +| | | +| | - :ref:`EIPs ` | +| | - :ref:`Common Pools ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2024-01-10 | This release incorporates the following changes: | +| | | +| | Modified the description about **ip_version** in :ref:`Creating a Subnet `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-12-15 | This release incorporates the following changes: | +| | | +| | Fixed known issues. | +| | | +| | Added parameters **address-group** and **ipv6**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-12-11 | This release incorporates the following changes: | +| | | +| | Deleted the content about lease time of **extra_dhcp_opts** from :ref:`Subnet `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-11-15 | This release incorporates the following changes: | +| | | +| | Modified the alias information in the response body in :ref:`Querying an EIP `. | +| | | +| | Modified IPv6-related fields in :ref:`Subnet `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-08-07 | This release incorporates the following changes: | +| | | +| | Added description about interconnection with IAM fine-grained authorization in :ref:`Permissions Policies and Supported Actions `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-06-20 | This release incorporates the following changes: | +| | | +| | Modified parameters in :ref:`Deleting an EIP Tag `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-06-06 | This release incorporates the following changes: | +| | | +| | Changed the value of **size** in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-05-15 | This release incorporates the following changes: | +| | | +| | Modified the following content: | +| | | +| | Modified description of **shared** and **provider:network_type** in :ref:`Network `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-03-10 | This release incorporates the following changes: | +| | | +| | - Added description that a firewall policy needs to be associated with a firewall group in :ref:`Creating a Firewall Policy `. | +| | - Added :ref:`What Are the Relationships Among Firewall Groups, Policies, and Rules? ` to describe the relationships among firewall resources and provide examples. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-02-28 | This release incorporates the following changes: | +| | | +| | - Modified description about the **limit** parameter in :ref:`Querying Firewall Groups `. | +| | - Modified description about the **router:external** parameter in :ref:`Creating a Network `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-12-12 | This release incorporates the following change: | +| | | +| | Modified the following content: | +| | | +| | Added description that EIPs of the Dedicated Load Balancer (5_gray) type cannot be created in :ref:`Assigning an EIP `, :ref:`Releasing an EIP `, :ref:`Querying Floating IP Addresses `, :ref:`Querying a Floating IP Address `, :ref:`Assigning a Floating IP Address `, :ref:`Updating a Floating IP Address `, and :ref:`Deleting a Floating IP Address `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-11-15 | This release incorporates the following changes: | +| | | +| | Added support for binding and unbinding EIPs of the Dedicated Load Balancer (5_gray) type using APIs in :ref:`Assigning an EIP `, :ref:`Releasing an EIP `, :ref:`Querying Floating IP Addresses `, :ref:`Querying a Floating IP Address `, :ref:`Assigning a Floating IP Address `, :ref:`Updating a Floating IP Address `, and :ref:`Deleting a Floating IP Address `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-09-07 | This release incorporates the following changes: | +| | | +| | - Added description about binding EIPs of the dedicated load balancer **(5_gray)** type to load balancers in :ref:`Assigning an EIP ` and :ref:`Releasing an EIP `. | +| | - Added description about binding EIPs of the dedicated load balancer **(5_gray)** type to load balancers in :ref:`Querying Floating IP Addresses `, :ref:`Querying a Floating IP Address `, :ref:`Assigning a Floating IP Address `, :ref:`Updating a Floating IP Address `, and :ref:`Deleting a Floating IP Address `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-06-25 | This release incorporates the following changes: | +| | | +| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning an EIP `. | +| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, and :ref:`Updating a Bandwidth `. | +| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-02-15 | This release incorporates the following changes: | +| | | +| | - Added **5_gray** to the value range of parameter **type** in :ref:`Assigning an EIP `. | +| | - Added **5_gray** to the value range of parameter **publicip_type** and **gray** for parameter **bandwidth_type** in sections :ref:`Querying a Bandwidth ` and :ref:`Querying Bandwidths `. | +| | - Added **5_gray** to the value range of parameter **publicip_type** in sections :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-08-25 | This release incorporates the following changes: | +| | | +| | - Modified the description about parameter **updated_at** and added parameters **billing_info** and **enterprise_project_id** in :ref:`Bandwidth ` and :ref:`Bandwidth (V2.0) `. | +| | - Changed the value range of **type** in :ref:`Querying Quotas `. | +| | - Added parameter **remote_address_group_id** to sections :ref:`Security Group ` and :ref:`Security Group `. | +| | - Deleted parameters **ipv6_address_mode** and **ipv6_ra_mode** from :ref:`Subnet `. | +| | - Added parameter **enterprise_project_id** to section :ref:`EIP `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-06-22 | This release incorporates the following changes: | +| | | +| | - Changed the value range of the **size** parameter to 1 Mbit/s to 1000 Mbit/s in :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, and :ref:`Removing an EIP from a Shared Bandwidth `. | +| | - Changed the value range of the **size** parameter to 5 Mbit/s to 1000 Mbit/s in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | +| | - Updated response examples in sections :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | +| | - Changed the parameter of **binding:vif_details** to **primary_interface** in sections :ref:`Querying Ports `, :ref:`Querying a Port `, :ref:`Creating a Port `, and :ref:`Updating a Port `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-05-25 | This release incorporates the following changes: | +| | | +| | - Added parameter **id** to the **bandwidth** field in section :ref:`Assigning an EIP `. | +| | - Added parameter **ip_version** to sections :ref:`EIP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | +| | - Added parameter **bandwidth_name** to section :ref:`EIP `. | +| | - Added parameters **created_at**, **updated_at**, **enable_bandwidth_rules**, **rule_quota**, and **bandwidth_rules** in sections :ref:`Bandwidth ` and :ref:`Assigning a Shared Bandwidth `. | +| | - Added value **share** to the value range of parameter **bandwidth_type** in section :ref:`Bandwidth `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-05-10 | This release incorporates the following changes: | +| | | +| | - Added description that the IP addresses reserved by the system cannot be obtained using APIs in :ref:`Querying Private IP Address Details `. | +| | - Moved :ref:`Error Codes ` and :ref:`Status Codes ` to :ref:`Appendix `. | +| | - Added a value for the **type** parameter of the **publicip** field in section :ref:`EIP ` and :ref:`Bandwidth `. | +| | - Added **WHOLE** to the value range of parameter **share_type** in section :ref:`Bandwidth `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-12-16 | This release incorporates the following changes: | +| | | +| | - Modified the value range of **cidr** in section :ref:`Virtual Private Cloud `. | +| | - Changed the maximum number of tags in sections :ref:`Querying VPCs by Tag ` and :ref:`Querying Subnets by Tag `. | +| | - Added fields **port_security_enabled**, **dns_name**, and **dns_assignment** to section :ref:`Port `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-06-30 | This release incorporates the following changes: | +| | | +| | - Added the **routes** field in section :ref:`Updating VPC Information `. | +| | - Added field **index_enabled** in section :ref:`VPC Flow Log `. | +| | - Modified URI parameters in sections :ref:`Querying Security Group Rule Details ` and :ref:`Deleting a Security Group Rule `. | +| | - Modified description of the **tenant_id** field in section :ref:`Creating a VPC Peering Connection `. | +| | - Modified the **network_ip_availability** parameter type in section :ref:`Querying IP Address Usage on a Specified Network `. | +| | - Modified the **networks** parameter type in section :ref:`Querying Networks `. | +| | - Added response parameter **project_id** in sections :ref:`Adding an Interface to a Router ` and :ref:`Removing an Interface from a Router `. | +| | - Added the **device_owner** field in section :ref:`Creating a Port `. | +| | - Added information about whether the **allow_address_pair** and **extra_dhcp_opt** fields are mandatory in section :ref:`Updating a Port `. | +| | - Added or modified the **ports_links**, **binding:profile**, and **binding:vif_details** fields in section :ref:`Port `. | +| | - Added the **networks_links** field in section :ref:`Network `. | +| | - Added the **subnets_links** field in section :ref:`Subnet `. | +| | - Added the **routers_links** field in section :ref:`Router `. | +| | - Added or modified the **firewall_rules_links** and **firewall_policies** fields in section :ref:`Firewall `. | +| | - Modified the URI in sections :ref:`Querying a Security Group Rule ` and :ref:`Deleting a Security Group Rule `. | +| | - Added the **tenant_id** field in sections :ref:`Creating a Security Group ` and :ref:`Querying Security Group Rule Details `. | +| | - Added the **peerings_link** object in section :ref:`Querying VPC Peering Connections `. | +| | - Added the **routes_link** object in section :ref:`Querying VPC Routes `. | +| | - Added the **fixed_ip** field in section :ref:`Creating a Port `. | +| | - Added the **firewall_policies_link** object in section :ref:`Querying Firewall Policies `. | +| | - Added the **project_id** field in sections :ref:`Inserting a Firewall Rule ` and :ref:`Removing a Firewall Rule `. | +| | - Added the **created_at** and **updated_at** fields in sections :ref:`Querying Firewall Groups `, :ref:`Querying a Firewall Group `, :ref:`Creating a Firewall Group `, and :ref:`Updating a Firewall Group `. | +| | - Added the **firewall_groups_link** object in section :ref:`Querying Firewall Groups `. | +| | - Changed the position of the section :ref:`Permissions Policies and Supported Actions ` and adjusted the table. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-04-13 | This release incorporates the following changes: | +| | | +| | - Modified description of parameters in the **security_group_rule** field in section :ref:`Creating a Security Group Rule `. | +| | - Added URI parameter description in :ref:`Port `, :ref:`Network `, :ref:`Querying Subnets `, :ref:`Querying Routers `, :ref:`Firewall `, and :ref:`Security Group `. | +| | - Added description of discarding **vpc_id** in section :ref:`Creating a Security Group `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-03-20 | This release incorporates the following changes: | +| | | +| | Added the value of **5_mailbgp** for parameters **type** and **publicip_type** | +| | | +| | in sections :ref:`Assigning an EIP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-02-25 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Bandwidth (V2.0) `. | +| | - Added :ref:`Bandwidth (V2.0) ` in section :ref:`Permissions Policies and Supported Actions `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-09-10 | This release incorporates the following changes: | +| | | +| | - Added APIs described in section :ref:`VPC Flow Log ` and VPC flow log error codes to section :ref:`Error Codes `. | +| | - Modified the description of the **charge_mode** field and its value in the response example in :ref:`Bandwidth `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-11-30 | This release incorporates the following changes: | +| | | +| | - Added the **extra_dhcp_opts** field in sections :ref:`Creating a Subnet `, :ref:`Querying Subnet Details `, :ref:`Querying Subnets `, and :ref:`Updating Subnet Information `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-10-22 | This release incorporates the following changes: | +| | | +| | - Added sections :ref:`APIs ` and :ref:`Native OpenStack Neutron APIs (V2.0) ` and categorized VPC APIs and native OpenStack APIs. | +| | - Deleted description about the **Reject** rule from section :ref:`Updating a Firewall Rule `. | +| | - Added the **project_id**, **created_at**, and **updated_at** fields to and modified the example request and response in sections :ref:`Port `, :ref:`Network `, :ref:`Subnet `, :ref:`Router `, :ref:`Floating IP Address `, :ref:`Firewall `, and :ref:`Security Group `. | +| | - Modified the API format to ensure consistency. | +| | - Modified description about the **tenant_id** and **project_id** fields to ensure consistency. | +| | - Added section :ref:`VPC Peering Connection ` under **API Permissions**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-10-12 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Querying a Specified API Version `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-09-04 | This release incorporates the following changes: | +| | | +| | - Modified the response example in section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | +| | - Added error messages for associating multiple NIC ports to or disassociating them from a security group at a time in section :ref:`Error Codes `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-08-30 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-07-30 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Permissions Policies and Supported Actions `. | +| | - Deleted sections related to VPNs. An independent VPN API reference will be provided. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-06-11 | This release incorporates the following changes: | +| | | +| | - Modified VPC tagging description in section :ref:`Querying VPC Tags in a Specified Project `. | +| | - Modified subnet tagging description in section :ref:`Querying Subnet Tags in a Specified Project `. | +| | - Modified EIP tagging description in section :ref:`Querying EIP Tags in a Specified Project `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-04-28 | This release incorporates the following changes: | +| | | +| | - Opened APIs described in section :ref:`Floating IP Address (IPv6) `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-03-30 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Querying API Versions `. | +| | - Modified the content in section :ref:`VPC Tag Management `. | +| | - Added section :ref:`Subnet Tag Management `. | +| | - Added section :ref:`EIP Tag Management `. | +| | - Added metrics **Upstream Traffic** and **Downstream Traffic** in section :ref:`VPC Monitoring Metrics `. | +| | - Modified the content in section :ref:`API Usage Guidelines `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-28 | This release incorporates the following changes: | +| | | +| | - Modified the URI and description in the API format in section :ref:`Querying VPC Peering Connections `. | +| | - Modified the URI and description in the API format in section :ref:`Querying VPC Routes `. | +| | - Modified the response parameters and parameter examples in section :ref:`Accepting a VPC Peering Connection `. | +| | - Modified the response parameters and parameter examples in section :ref:`Refusing a VPC Peering Connection `. | +| | - Provided the address for downloading the sample code in section **Sample Code**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-14 | This release incorporates the following changes: | +| | | +| | - Modified the title of section **VPN (Native OpenStack API)**. | +| | - Linked the error codes in subsections of **VPN (Native OpenStack API)** to **Error Codes**. | +| | - Linked the error codes in subsection :ref:`Subnet Pool ` to :ref:`Status Codes `. | +| | - Linked the error codes in the tag management sections. | +| | - Adjusted the sequence of subsections under :ref:`Subnet Pool `. | +| | - Modified the description of parameters **share_type** and **charge_mode** in the **bandwidth** field in section :ref:`Assigning an EIP `. | +| | - Added the example request in section **Creating a VPN Service**. | +| | - Added the example request and example response in section **Querying VPN Endpoint Groups**. | +| | - Added the example request in section **Querying Details About a VPN Service**. | +| | - Modified the example response in section **Deleting an IKE Policy**. | +| | - Added the example request in section **Deleting a VPN Service**. | +| | - Added the example request in section **Querying Details About an IKE Policy**. | +| | - Added the example response in section **Querying Details About a VPN Endpoint Group**. | +| | - Added the example response in section **Querying Details About a VPN Service**. | +| | - Added the example response in section **Updating an IPsec Policy**. | +| | - Added the example response in section **Updating a VPN Service**. | +| | - Modified the example request and example response in section **Updating an IPsec VPN Connection**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-01-30 | This release incorporates the following changes: | +| | | +| | - Deleted the section **Port**. | +| | - Added section **VPN (Native OpenStack API)**. | +| | - Added section **Subnet Pool (Native OpenStack API)**. | +| | - Added parameters **dns_name** and **dns_domain** in the floating IP address object table in section **Floating IP Address (Native OpenStack API)**. | +| | - Added parameters **dns_name** and **dns_assignment** in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | +| | - Added the parameter **dns_domain** in the **network object** table in section **Network (Native OpenStack API)** > **Overview**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-11-30 | This release incorporates the following changes: | +| | | +| | - Added parameter **port_security_enable** in section **Creating a Subnet**. | +| | - Modified the **port_id** parameter description in the **publicip** fields in section **Binding or Unbinding an EIP** under **Elastic IP Address**. | +| | - Updated the **device_owner** parameter description in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | +| | - Added the **min** parameter to the **resources** field in the response in section **Querying Quotas**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-09-30 | This release incorporates the following changes: | +| | | +| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | +| | - Added section **VPC Peering Connection**. | +| | - Added section **VPC Route**. | +| | - Added a filter field to the URI of the APIs in sections **Querying Ports** and **Querying VPC Routes**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-08-30 | This release incorporates the following changes: | +| | | +| | Updated description in section **Updating a Network** under **Network (Native OpenStack API)**. | +| | | +| | - Added section **Elastic IP Address V2.0 (Extended OpenStack API)**. | +| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-07-30 | This release incorporates the following changes: | +| | | +| | - Changed the allowed maximum subnet mask value to 28 for CIDR blocks in the **subnet** object in section **Overview** under **Subnet (Native OpenStack API)**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-06-30 | This release incorporates the following changes: | +| | | +| | - Changed the **CRUD** value of parameter **router_id** to **R** for the **Floating IP address** object in section **Overview** under **Floating IP Address (Native OpenStack API)**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-05-30 | Added the following sections: | +| | | +| | - Network (Native OpenStack API) | +| | - Router (Native OpenStack API) | +| | - Floating IP Address (Native OpenStack API) | +| | - firewall (Native OpenStack API) | +| | - Security Group (Native OpenStack API) | +| | - Modified the request URI in section **Security Group**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-04-28 | This release incorporates the following changes: | +| | | +| | - Added monitoring metrics **up_stream** and **down_stream**. | +| | - Added field **dnsList** for APIs used to create a subnet, query a subnet, query subnets, and update a subnet. | +| | - Changed the bandwidth size value to 1 Mbit/s to 500 Mbit/s in sections **Elastic IP Address** and **Bandwidth**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-10-29 | This release incorporates the following changes: | +| | | +| | - Added the **ip_address** field to enable users to obtain a specified EIP. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-06-02 | This release incorporates the following changes: | +| | | +| | Changed the **ethertype** field for creating a security group rule to an optional field. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-04-14 | This release incorporates the following changes: | +| | | +| | - Modified the URL parameter description in section **Service Usage**. | +| | - Modified the procedure for making API calls for token authentication. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-03-09 | This issue is the first official release. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/faqs/index.rst b/api-ref/source/faqs/index.rst new file mode 100644 index 0000000..a6057b6 --- /dev/null +++ b/api-ref/source/faqs/index.rst @@ -0,0 +1,14 @@ +:original_name: vpc_api_0004.html + +.. _vpc_api_0004: + +FAQs +==== + +- :ref:`What Are the Relationships Among Firewall Groups, Policies, and Rules? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + what_are_the_relationships_among_firewall_groups_policies_and_rules diff --git a/api-ref/source/faqs/what_are_the_relationships_among_firewall_groups_policies_and_rules.rst b/api-ref/source/faqs/what_are_the_relationships_among_firewall_groups_policies_and_rules.rst new file mode 100644 index 0000000..f0e4194 --- /dev/null +++ b/api-ref/source/faqs/what_are_the_relationships_among_firewall_groups_policies_and_rules.rst @@ -0,0 +1,164 @@ +:original_name: en-us_topic_0000001487936070.html + +.. _en-us_topic_0000001487936070: + +What Are the Relationships Among Firewall Groups, Policies, and Rules? +====================================================================== + +Relationships +------------- + +Firewall resources are classified into groups, policies, and rules. + +The relationships among them are as follows: + +- A firewall policy can be associated with multiple firewall rules. +- A firewall group can be associated with two firewall policies. One policy controls inbound traffic and the other controls outbound traffic. +- A firewall policy must be associated with a firewall group. + +Log in to the network console and view basic information about the firewall. You can view the name and ID of the firewall. + +|image1| + +On the **Inbound Rules** or **Outbound Rules** tab, you can add, modify, or delete firewall rules. These rules are associated with the same inbound or outbound policy. + +|image2| + +Example +------- + +The following describes how to create firewall resources. + +- Creating a firewall rule + +.. code-block:: text + + POST /v2.0/fwaas/firewall_rules + +Request body + +.. code-block:: + + { + "firewall_rule": { + "name": "fw-rule-ingress-1", + "description": "create a ingress firewall rule ", + "protocol": "TCP", + "action": "ALLOW", + "ip_version": 4, + "destination_ip_address": "192.168.22.0/24", + "source_ip_address": "0.0.0.0/0", + "enabled": true + } + } + +Response body of obtaining **firewall_rule_id**: 84d10f4a-9f8b-41b8-bdfa-5a0f18736f12 + +.. code-block:: + + { + "firewall_rule": { + "protocol": "tcp", + "description": "create a ingress firewall rule ", + "source_ip_address": "0.0.0.0/0", + "destination_ip_address": "192.168.22.0/24", + "source_port": null, + "destination_port": null, + "id": "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12", + "name": "fw-rule-ingress-1", + "tenant_id": "5f6387106c2048b589b369d96c2f23a2", + "project_id": "5f6387106c2048b589b369d96c2f23a2", + "enabled": true, + "action": "allow", + "ip_version": 4, + "public": false + } + } + +- Creating a firewall policy + +.. code-block:: text + + POST /v2.0/fwaas/firewall_policies + +Request body of associating with a firewall rule + +.. code-block:: + + { + "firewall_policy": { + "description": "create a ingress firewall policy", + "firewall_rules": [ + "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12" + ], + "name": "fw-policy-ingress" + } + } + +Response body of obtaining **firewall_policy_id**: da037721-b895-4e07-bbcc-f5f6ac2759fb + +.. code-block:: + + { + "firewall_policy": { + "id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", + "name": "fw-policy-ingress", + "project_id": "5f6387106c2048b589b369d96c2f23a2", + "tenant_id": "5f6387106c2048b589b369d96c2f23a2", + "description": "create a ingress firewall policy", + "firewall_rules": [ + "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12" + ], + "audited": false, + "public": false + } + } + +- Creating a firewall group + +.. code-block:: text + + POST /v2.0/fwaas/firewall_groups + +Request body of associating with an inbound firewall policy + +.. code-block:: + + { + "firewall_group": { + "name": "fw-group-example", + "description": "create a firewall group", + "ingress_firewall_policy_id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", + "admin_state_up": true + } + } + +Response body of obtaining **firewall_group_id**: 102493e8-fc6d-4f0d-b57f-55c5be86f5c0. + +.. code-block:: + + { + "firewall_group": { + "id": "102493e8-fc6d-4f0d-b57f-55c5be86f5c0", + "name": "fw-group-example", + "project_id": "5f6387106c2048b589b369d96c2f23a2", + "tenant_id": "5f6387106c2048b589b369d96c2f23a2", + "admin_state_up": true, + "egress_firewall_policy_id": null, + "ingress_firewall_policy_id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", + "description": "create a firewall group", + "created_at": "2023-03-09T08:54:40", + "updated_at": "2023-03-09T08:54:40", + "status": "INACTIVE", + "ports": [], + "public": false + } + } + +Log in to the network console and view the created firewall resources. + +|image3| + +.. |image1| image:: /_static/images/en-us_image_0000001487964866.png +.. |image2| image:: /_static/images/en-us_image_0000001538445357.png +.. |image3| image:: /_static/images/en-us_image_0000001538444809.png diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 231e537..ecb607b 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -7,7 +7,9 @@ Virtual Private Cloud - API Reference api_usage_guidelines apis/index + api_v3/index native_openstack_neutron_apis_v2.0/index permissions_policies_and_supported_actions/index + faqs/index appendix/index change_history diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst index 05ba1d1..134c389 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst @@ -20,10 +20,8 @@ Neutron APIs v2.0 provides the pagination function. You can set parameters **lim - Replace the value of **marker** in the original access request URL. Replace the value of **marker** to the value of **marker** in the value of **herf** if the value of **rel** in the response is **previous**. - Set the value of **page_reverse** to **True**. -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -37,26 +35,50 @@ Request parameter | page_reverse | Boolean | No | Specifies the page direction. The value can be **True** or **False**. | +--------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------+ -Example request 1 +Example Request +--------------- + +- When **page_reverse** is set to **False**: .. code-block:: text GET https://{Endpoint}/v2.0/networks?limit=2&marker=3d42a0d4-a980-4613-ae76-a2cddecff054&page_reverse=False -Example request 2 +- When **page_reverse** is set to **True**: .. code-block:: text GET https://{Endpoint}/v2.0/vpc/peerings?limit=2&marker=e5a0c88e-228e-4e62-a8b0-90825b1b7958&page_reverse=True -Response Message +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================================+================================================================================================================================================================================================================================================================================================================================================================================+ + | {resources}_links | Array of :ref:`{resources}_link ` objects | Specifies the pagination information. For details, see :ref:`Table 3 `. **{resources}** indicates the resource name, for example, **ports**, **networks**, **subnets**, **routers**, **firewall_rules**, **firewall_policies**, **firewall_groups**, **security_groups**, **subnetpools**, **floatingips**, and **security_group_rules**. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_version_0003__table109221759807: + +.. table:: **Table 3** {resources}_link object + + +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==========================================================================================================================================+ + | href | String | Specifies the API link. | + +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ + | rel | String | The API link is used to query the next or previous page. **next**: The next page is queried. **previous**: The previous page is queried. | + +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -Response parameter - -None - -Example response 1 +- When **page_reverse** is set to **False**: .. code-block:: @@ -93,7 +115,7 @@ Example response 1 ] } -Example response 2 +- When **page_reverse** is set to **True**: .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst index 85a403b..a8dd88d 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst @@ -27,96 +27,94 @@ GET /{api_version} api_version String Specifies the version number, for example **v2.0**. =========== ====== =================================================== -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0 + +-----------+-------------------------------------------------------------------------+-----------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+=========================================+ + | resources | Array of :ref:`resource ` objects | Specifies the **resource** object list. | + +-----------+-------------------------------------------------------------------------+-----------------------------------------+ -Response Message +.. _vpc_version_0002__table1195920258372: + +.. table:: **Table 3** **resource** object + + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+=====================================================================+==================================================================================================+ + | name | String | Specifies the resource name. | + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | collection | String | Specifies the resource collection name. | + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | links | Array of :ref:`link ` objects | Specifies the link list. For details, see :ref:`Table 4 `. | + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_version_0002__table4442151110172: + +.. table:: **Table 4** **link** objects + + +-----------+--------+----------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+======================================================================+ + | href | String | Specifies the API link. | + +-----------+--------+----------------------------------------------------------------------+ + | rel | String | Specifies the relationship between the API link and the API version. | + +-----------+--------+----------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+-------------------------------------------------------------------------+-----------------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================================+=========================================+ - | resources | Array of :ref:`resource ` objects | Specifies the **resource** object list. | - +-----------+-------------------------------------------------------------------------+-----------------------------------------+ - - .. _vpc_version_0002__table1195920258372: - - .. table:: **Table 3** **resource** object - - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+=====================================================================+==================================================================================================+ - | name | String | Specifies the resource name. | - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | collection | String | Specifies the resource collection name. | - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | links | Array of :ref:`link ` objects | Specifies the link list. For details, see :ref:`Table 4 `. | - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - - .. _vpc_version_0002__table4442151110172: - - .. table:: **Table 4** **link** objects - - +-----------+--------+----------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+======================================================================+ - | href | String | Specifies the API link. | - +-----------+--------+----------------------------------------------------------------------+ - | rel | String | Specifies the relationship between the API link and the API version. | - +-----------+--------+----------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "resources": [ - { - "links": [ - { - "href": "https://vpc.systems.com/v2.0/subnets", - "rel": "self" - } - ], - "name": "subnet", - "collection": "subnets" - }, - { - "links": [ - { - "href": "https://vpc.systems.com/v2.0/networks", - "rel": "self" - } - ], - "name": "network", - "collection": "networks" - }, - { - "links": [ - { - "href": "https://vpc.systems.com/v2.0/ports", - "rel": "self" - } - ], - "name": "port", - "collection": "ports" - } - ] - } + { + "resources": [ + { + "links": [ + { + "href": "https://vpc.systems.com/v2.0/subnets", + "rel": "self" + } + ], + "name": "subnet", + "collection": "subnets" + }, + { + "links": [ + { + "href": "https://vpc.systems.com/v2.0/networks", + "rel": "self" + } + ], + "name": "network", + "collection": "networks" + }, + { + "links": [ + { + "href": "https://vpc.systems.com/v2.0/ports", + "rel": "self" + } + ], + "name": "port", + "collection": "ports" + } + ] + } Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst index 9ce7c19..029ae87 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst @@ -15,23 +15,20 @@ URI GET / -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/ -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 1** Response parameter @@ -71,7 +68,8 @@ Response parameter | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: @@ -82,7 +80,7 @@ Example response "id": "v2.0", "links": [ { - "href": "https://None/v2.0", + "href": "https://{Endpoint}/v2.0", "rel": "self" } ] diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst index 0c48097..f9cffe9 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst @@ -15,8 +15,8 @@ URI POST /v2.0/fwaas/firewall_groups -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -30,32 +30,63 @@ Request Message .. table:: **Table 2** **Firewall Group** objects - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +============================+=================+==================+==============================================================+ - | name | No | String | Specifies the name of the firewall group. | - | | | | | - | | | | The value can contain a maximum of 255 characters. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | description | No | String | Provides supplementary information about the firewall group. | - | | | | | - | | | | The value can contain a maximum of 255 characters. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | ports | No | Array of strings | Specifies the list of ports bound with the firewall group. | - | | | | | - | | | | The value must be the port ID of the distributed router. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies the administrative status of the firewall. | - | | | | | - | | | | The value can be **true** or **false**. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +============================+=================+==================+=================================================================================================================================================================================================================+ + | name | No | String | Specifies the name of the firewall group. | + | | | | | + | | | | The value can contain a maximum of 255 characters. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Provides supplementary information about the firewall group. | + | | | | | + | | | | The value can contain a maximum of 255 characters. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ports | No | Array of strings | Specifies the list of ports bound with the firewall group. | + | | | | | + | | | | The value must be the port ID. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. | + | | | | | + | | | | - Call the VPC API for querying the port ID. The filtering criteria are the specified **network_id** and **device_owner**. The **network_id** is the network ID of the subnet associated with the firewall. | + | | | | | + | | | | Example: | + | | | | | + | | | | .. code:: text | + | | | | | + | | | | GET https://{Endpoint}/v1/{project_id}/ports?network_id={network_id}&device_owner=network%3Arouter_interface_distributed | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies the administrative status of the firewall. | + | | | | | + | | | | The value can be **true** or **false**. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Create an ACL group, associate it with the inbound ACL policy afc52ce9-5305-4ec9-9feb-44feb8330341, and set the port ID to c133f2bf-6937-4416-bb17-012e1be5cd2d. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/fwaas/firewall_groups + + { + "firewall_group": { + "name": "test", + "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", + "ports": [ + "c133f2bf-6937-4416-bb17-012e1be5cd2d" + ] + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -69,59 +100,42 @@ Response Message .. table:: **Table 4** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of the firewall policy. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/fwaas/firewall_groups - - { - "firewall_group": { - "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", - "ports": [ - "c133f2bf-6937-4416-bb17-012e1be5cd2d" - ] - } - } - -Example response +Example Response +---------------- .. code-block:: @@ -130,7 +144,7 @@ Example response "status": "PENDING_CREATE", "public": false, "egress_firewall_policy_id": null, - "name": "", + "name": "test", "admin_state_up": true, "ports": [ "c133f2bf-6937-4416-bb17-012e1be5cd2d" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst index 484a86d..39e4b5c 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst @@ -8,15 +8,15 @@ Creating a Firewall Policy Function -------- -This API is used to create a firewall policy. +This API is used to create a firewall policy. A firewall policy must be associated with a firewall group. You can learn more about the :ref:`relationships among network ACL groups, policies, and rules `. URI --- POST /v2.0/fwaas/firewall_policies -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -48,8 +48,26 @@ Request Message | | | | The value can be **true** or **false**. | +-----------------+-----------------+------------------+-----------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Create an ACL policy named **test-policy** and associate it with the ACL rule whose ID is b8243448-cb3c-496e-851c-dadade4c161b. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/fwaas/firewall_policies + + { + "firewall_policy": { + "name": "test-policy", + "firewall_rules": [ + "b8243448-cb3c-496e-851c-dadade4c161b" + ] + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -83,25 +101,8 @@ Response Message | project_id | String | Specifies the project ID. | +----------------+------------------+---------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/fwaas/firewall_policies - - { - "firewall_policy": { - "name": "test-policy", - "firewall_rules": [ - "b8243448-cb3c-496e-851c-dadade4c161b" - ] - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst index 8046db9..8a88cc2 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst @@ -15,8 +15,8 @@ URI POST /v2.0/fwaas/firewall_rules -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -70,8 +70,27 @@ Request Message | | | | | The value can be **true** or **false**. | +------------------------+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Create an ACL rule with **action** set to **allow**, **protocol** set to **tcp**, and destination port set to 80. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/fwaas/firewall_rules + + { + "firewall_rule": { + "action": "allow", + "enabled": true, + "destination_port": "80", + "protocol": "tcp", + "name": "ALLOW_HTTP" + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -117,26 +136,8 @@ Response Message | project_id | String | Specifies the project ID. | +------------------------+---------+-------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/fwaas/firewall_rules - - { - "firewall_rule": { - "action": "allow", - "enabled": true, - "destination_port": "80", - "protocol": "tcp", - "name": "ALLOW_HTTP" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst index 6d29bb6..8dedadf 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst @@ -27,26 +27,25 @@ DELETE /v2.0/fwaas/firewall_groups/{firewall_group_id} | firewall_group_id | Yes | String | Specifies the firewall group ID, which uniquely identifies the firewall group. | +-------------------+-----------+--------+--------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/fwaas/firewall_groups/0415f554-26ed-44e7-a881-bdf4e6216e38 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst index 8b170e9..b03a8dc 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst @@ -27,26 +27,25 @@ DELETE /v2.0/fwaas/firewall_policies/{firewall_policy_id} | firewall_policy_id | Yes | String | Specifies the firewall policy ID, which uniquely identifies the firewall policy. | +--------------------+-----------+--------+----------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst index 7425e19..f580495 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst @@ -31,26 +31,25 @@ DELETE /v2.0/fwaas/firewall_rules/{firewall_rule_id} | firewall_rule_id | Yes | String | Specifies the firewall rule ID, which uniquely identifies the firewall rule. | +------------------+-----------+--------+------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst index 7d5afc6..2f8a9c4 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst @@ -27,8 +27,8 @@ PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id}/insert_rule | firewall_policy_id | Yes | String | Specifies the firewall policy ID, which uniquely identifies the firewall policy. | +--------------------+-----------+--------+----------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -46,8 +46,23 @@ Request Message | | | | If both the **insert_after** and **insert_before** parameters are specified, the **insert_after** parameter will be ignored. | +------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Insert rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 below rule b8243448-cb3c-496e-851c-dadade4c161b in the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule + + { + "insert_after": "b8243448-cb3c-496e-851c-dadade4c161b", + "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1", + "insert_before": "" + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -71,22 +86,8 @@ Response Message | project_id | String | Specifies the project ID. | +----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule - - { - "insert_after": "b8243448-cb3c-496e-851c-dadade4c161b", - "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1", - "insert_before": "" - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst index b1569e0..5008274 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst @@ -27,13 +27,20 @@ GET /v2.0/fwaas/firewall_groups/{firewall_group_id} | firewall_group_id | Yes | String | Specifies the firewall group ID, which uniquely identifies the firewall group. The **fire_group_id** value is used as the filter. | +-------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_groups/a504a4cf-9300-40e0-b2d4-649bd157c55a + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -47,50 +54,42 @@ Response Message .. table:: **Table 3** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of the firewall policy. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_groups/a504a4cf-9300-40e0-b2d4-649bd157c55a - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst index 90307f2..1e1a54b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst @@ -27,13 +27,20 @@ GET /v2.0/fwaas/firewall_policies/{firewall_policy_id} | firewall_policy_id | Yes | String | Specifies the firewall policy ID, which uniquely identifies the firewall policy. The **firewall_policy_id** value is used as the filter. | +--------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_policies/fed2d88f-d0e7-4cc5-bd7e-c495f67037b6 + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -67,16 +74,8 @@ Response Message | project_id | String | Specifies the project ID. | +----------------+------------------+---------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_policies/fed2d88f-d0e7-4cc5-bd7e-c495f67037b6 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst index b30bcdb..fe33743 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst @@ -27,13 +27,20 @@ GET /v2.0/fwaas/firewall_rules/{firewall_rule_id} | firewall_rule_id | Yes | String | Specifies the firewall rule ID, which uniquely identifies the firewall rule. The **firewall_rule_id** value is used as the filter. | +------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_rules/514e6776-162a-4b5d-ab8b-aa36b86655ef + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -79,39 +86,27 @@ Response Message | project_id | String | Specifies the project ID. | +------------------------+---------+-------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_rules/514e6776-162a-4b5d-ab8b-aa36b86655ef - -Example response +Example Response +---------------- .. code-block:: { "firewall_rule": { "protocol": "tcp", - "name": "bobby_rule", - "mode": "normal", - "tenant_id": "4490a89232ce46d4ae4bfb227ef1a40a", - "rule_profile": "", - "enabled": true, - "source_port": null, - "source_ip_address": null, - "destination_ip_address": null, - "firewall_policy_id": null, - "action": "allow", - "position": null, - "ip_version": 4, - "shared": false, + "description": "update check parameter", + "source_ip_address": "116.66.184.0/24", + "destination_ip_address": "0.0.0.0/0", "destination_port": null, + "source_port": null, "id": "514e6776-162a-4b5d-ab8b-aa36b86655ef", - "description": "", - "project_id": "4490a89232ce46d4ae4bfb227ef1a40a" + "name": "test", + "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", + "project_id": "a1c6f90c94334bd2953d9a61b8031a68", + "enabled": true, + "action": "allow", + "ip_version": 4, + "public": false } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst index c1ec80e..0de27e0 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst @@ -46,73 +46,80 @@ Example of querying groups by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_groups + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================+======================================================================================================================================================================================================================+ - | firewall_groups | Array of :ref:`Firewall Group ` objects | Specifies the firewall group list. For details, see :ref:`Table 3 `. | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | firewall_groups_links | Array of :ref:`firewall_groups_link ` objects | Specifies the **firewall_groups_link** object list. For details, see :ref:`Table 4 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================+=================================================================================================================================================================================================================+ + | firewall_groups | Array of :ref:`Firewall Group ` objects | Specifies the firewall group list. For details, see :ref:`Table 3 `. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | firewall_groups_links | Array of :ref:`firewall_groups_link ` objects | Specifies the **firewall_groups_link** object list. For details, see :ref:`Table 4 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_firewall_0013__table31629250121127: .. table:: **Table 3** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of a firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ .. _vpc_firewall_0013__table25150247450: @@ -126,16 +133,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_groups - -Example response +Example Response +---------------- .. code-block:: @@ -174,8 +173,7 @@ Example response ], "firewall_groups_links": [ { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ - fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True" + "href": "https://{Endpoint}/v2.0/fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True" } ] } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst index f9a3392..247eb85 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst @@ -42,35 +42,42 @@ Example of querying policies by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_policies + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +-------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=====================================================================================+======================================================================================================================================================================================================================+ - | firewall_policies | Array of :ref:`firewall Policy ` object | Specifies the firewall policies. For details, see :ref:`Table 3 `. | - +-------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | firewall_policies_links | Array of :ref:`firewall_policies_link ` object | **firewall_policies_link** object For details, see :ref:`Table 4 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+=====================================================================================+=================================================================================================================================================================================================================+ + | firewall_policies | Array of :ref:`firewall Policy ` object | Specifies the firewall policies. For details, see :ref:`Table 3 `. | + +-------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | firewall_policies_links | Array of :ref:`firewall_policies_link ` object | **firewall_policies_link** object For details, see :ref:`Table 4 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_firewall_0006__table17002720121127: @@ -108,16 +115,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example -------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_policies - -Example response +Example Response +---------------- .. code-block:: @@ -150,8 +149,7 @@ Example response ], "firewall_policies_links": [ { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ - fwaas/firewall_policies?marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=True" + "href": "https://{Endpoint}/v2.0/fwaas/firewall_policies?marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=True" } ] } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst index 600e66e..6be52e7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst @@ -60,35 +60,42 @@ Example of querying rules by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_rules + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================+======================================================================================================================================================================================================================+ - | firewall_rules | Array of :ref:`Firewall Rule ` objects | Specifies the firewall rule list. For details, see :ref:`Table 4 `. | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | firewall_rules_links | Array of :ref:`firewall_rules_link ` Object | Specifies the pagination information. For details, see :ref:`Table 3 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================+=================================================================================================================================================================================================================+ + | firewall_rules | Array of :ref:`Firewall Rule ` objects | Specifies the firewall rule list. For details, see :ref:`Table 4 `. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | firewall_rules_links | Array of :ref:`firewall_rules_link ` Object | Specifies the pagination information. For details, see :ref:`Table 3 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_firewall_0001__table2049004519490: @@ -138,16 +145,8 @@ Response Message | project_id | String | Specifies the project ID. | +------------------------+---------+-------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_rules - -Example response +Example Response +---------------- .. code-block:: @@ -155,49 +154,40 @@ Example response "firewall_rules": [ { "protocol": "tcp", - "name": "crhfwruleupdate", - "mode": "normal", - "tenant_id": "f480f5d250824e5fafedcf05acf1419c", - "rule_profile": "", - "enabled": true, - "source_port": null, - "source_ip_address": null, - "destination_ip_address": null, - "firewall_policy_id": "b4f81251-c47a-4fe1-8579-6f9271d015d1", - "action": "deny", - "position": 1, - "ip_version": 4, - "shared": false, + "description": "update check parameter", + "source_ip_address": "116.66.184.0/24", + "destination_ip_address": "0.0.0.0/0", "destination_port": null, + "source_port": null, "id": "2a193015-4a88-4aa1-84ad-d4955adae707", - "description": "", - "project_id": "f480f5d250824e5fafedcf05acf1419c" + "name": "crhfwruleupdate", + "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", + "project_id": "a1c6f90c94334bd2953d9a61b8031a68", + "enabled": true, + "action": "allow", + "ip_version": 4, + "public": false }, { "protocol": "tcp", - "name": "update_firewall-role-tommy", - "mode": "mix", - "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", - "rule_profile": "", - "enabled": false, - "source_port": "20:50", + "description": "update check parameter", "source_ip_address": null, "destination_ip_address": null, - "firewall_policy_id": null, - "action": "deny", - "position": null, - "ip_version": 4, - "shared": true, "destination_port": "40:60", + "source_port": "20:50", "id": "db7a204c-9eb1-40a2-9bd6-ed5cfd3cff32", - "description": "update check parameter", - "project_id": "a1c6f90c94334bd2953d9a61b8031a68" + "name": "update_firewall-role-tommy", + "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", + "project_id": "a1c6f90c94334bd2953d9a61b8031a68", + "enabled": false, + "action": "deny", + "ip_version": 4, + "public": false } ], "firewall_rules_links": [ { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ - fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True" + "href": "https://{Endpoint}/v2.0/fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True" } ] } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst index 7036157..3cad3f7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id}/remove_rule -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -26,8 +26,21 @@ Request Message | firewall_rule_id | String | Yes | Specifies the firewall rule ID, which uniquely identifies the firewall rule. | +------------------+--------+-----------+------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Remove ACL rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 from the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule + + { + "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" + } + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -51,20 +64,8 @@ Response Message | project_id | String | Specifies the project ID. | +----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule - - { - "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst index 7369035..4c125ad 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_groups/{firewall_group_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -30,32 +30,59 @@ Request Message .. table:: **Table 2** **Firewall Group** objects - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +============================+=================+==================+==============================================================+ - | name | No | String | Specifies the name of the firewall group. | - | | | | | - | | | | The value can contain a maximum of 255 characters. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | description | No | String | Provides supplementary information about the firewall group. | - | | | | | - | | | | The value can contain a maximum of 255 characters. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | ports | No | Array of strings | Specifies the list of ports bound with the firewall group. | - | | | | | - | | | | The value must be the port ID of the distributed router. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies the administrative status of the firewall. | - | | | | | - | | | | The value can be **true** or **false**. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +============================+=================+==================+=================================================================================================================================================================================================================+ + | name | No | String | Specifies the name of the firewall group. | + | | | | | + | | | | The value can contain a maximum of 255 characters. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Provides supplementary information about the firewall group. | + | | | | | + | | | | The value can contain a maximum of 255 characters. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ports | No | Array of strings | Specifies the list of ports bound with the firewall group. | + | | | | | + | | | | The value must be the port ID. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. | + | | | | | + | | | | - Call the VPC API for querying the port ID. The filtering criteria are the specified **network_id** and **device_owner**. The **network_id** is the network ID of the subnet associated with the firewall. | + | | | | | + | | | | Example: | + | | | | | + | | | | .. code:: text | + | | | | | + | | | | GET https://{Endpoint}/v1/{project_id}/ports?network_id={network_id}&device_owner=network%3Arouter_interface_distributed | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies the administrative status of the firewall. | + | | | | | + | | | | The value can be **true** or **false**. | + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Associate the ACL group whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a with the outbound ACL policy 53f36c32-db25-4856-a0ba-e605fd88c5e9. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a + + { + "firewall_group": { + "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9" + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -69,56 +96,42 @@ Response Message .. table:: **Table 4** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of the firewall policy. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a - - { - "firewall_group": { - "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst index 5b6faa7..8a4a074 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -48,8 +48,25 @@ Request Message | | | | The value can be **true** or **false**. | +-----------------+-----------------+------------------+-----------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Associate the ACL policy whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a to the ACL rule whose ID is 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a + + { + "firewall_policy": { + "firewall_rules": [ + "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" + ] + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -83,24 +100,8 @@ Response Message | project_id | String | Specifies the project ID. | +----------------+------------------+---------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a - - { - "firewall_policy": { - "firewall_rules": [ - "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" - ] - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst index 9ec8ef6..060b39b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_rules/{firewall_rule_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -70,8 +70,23 @@ Request Message | | | | The value can be **true** or **false**. | +------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Change the **action** of the ACL rule whose ID is b94acf06-efc2-485d-ba67-a61acf2a7e28 to **deny**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 + + { + "firewall_rule": { + "action": "deny" + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -117,22 +132,8 @@ Response Message | project_id | String | Specifies the project ID. | +------------------------+---------+-------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 - - { - "firewall_rule": { - "action": "deny" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst index e6c601a..e49081b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst @@ -12,6 +12,20 @@ When assigning a floating IP address, you need to obtain the external network ID You can use **GET /v2.0/networks?router:external=True** or run the **neutron net-external-list** command to obtain the UUID of the external network required for assigning a floating IP address. +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + URI --- @@ -95,10 +109,10 @@ Response Message | dns_domain | String | Specifies the DNS domain. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ -Example: --------- +Example Request +--------------- -Example request +Create a floating IP address whose network is **0a2228f2-7f8a-45f1-8e09-9039e1d09975**. .. code-block:: text @@ -110,7 +124,12 @@ Example request } } -Example response +Example Response +---------------- + +**Status code: 201** + +Normal response to POST requests .. code-block:: @@ -120,15 +139,13 @@ Example response "status": "DOWN", "router_id": null, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address": null, "floating_ip_address": "88.88.215.205", "port_id": null, "dns_name": "ecs-80-158-78-239", - "dns_domain": "reverse.domain-name.com", - "created_at": "2018-09-20T02:10:02", - "updated_at": "2018-09-20T02:10:02" + "dns_domain": "reverse.domain-name.com" } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst index b594a38..2bc3253 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst @@ -10,6 +10,20 @@ Function This API is used to delete a floating IP address. +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + URI --- @@ -37,16 +51,17 @@ Response Message None -Example: --------- +Example Request +--------------- -Example request +Delete the floating IP address whose ID is a95ec431-8473-463b-aede-34fb048ee3a7. .. code-block:: text DELETE https://{Endpoint}/v2.0/floatingips/a95ec431-8473-463b-aede-34fb048ee3a7 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst index 8561174..23ddc9e 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst @@ -10,6 +10,20 @@ Function This API is used to query details about a specified floating IP address, including the floating IP address status, ID of the router to which the floating IP address belongs, and external network ID of the floating IP address. +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + URI --- @@ -35,62 +49,63 @@ Response Message .. table:: **Table 2** **floatingip** objects - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+================================================================================================+ - | status | String | Specifies the floating IP address status. The value can be **ACTIVE**, **DOWN**, or **ERROR**. | - | | | | - | | | - **DOWN** indicates that the floating IP address has not been bound. | - | | | - **ACTIVE** indicates that the floating IP address has been bound. | - | | | - **ERROR** indicates that the floating IP address is abnormal. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | id | String | Specifies the floating IP address ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | floating_ip_address | String | Specifies the floating IP address. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | floating_network_id | String | Specifies the external network ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | router_id | String | Specifies the ID of the belonged router. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | port_id | String | Specifies the port ID. | - | | | | - | | | .. note:: | - | | | | - | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | fixed_ip_address | String | Specifies the private IP address of the associated port. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the DNS name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the DNS domain. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time when the floating IP address was created. | - | | | | - | | | UTC time is used. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the floating IP address was updated. | - | | | | - | | | UTC time is used. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=================================================================================================================================================+ + | status | String | Specifies the floating IP address status. The value can be **ACTIVE**, **DOWN**, or **ERROR**. | + | | | | + | | | - **DOWN** indicates that the floating IP address has not been bound. | + | | | - **ACTIVE** indicates that the floating IP address has been bound. | + | | | - **ERROR** indicates that the floating IP address is abnormal. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the floating IP address ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | floating_ip_address | String | Specifies the floating IP address. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | floating_network_id | String | Specifies the external network ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | router_id | String | Specifies the ID of the belonged router. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_id | String | Specifies the port ID. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ip_address | String | Specifies the private IP address of the associated port. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the DNS name. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the DNS domain. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time when the floating IP address was created. | + | | | | + | | | UTC time is used. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time when the floating IP address was updated. | + | | | | + | | | UTC time is used. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/floatingips/1a3a2818-d9b4-4a9c-8a19-5252c499d1cd -Example response +Example Response +---------------- + +**Status code: 200** .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst index 6b4651b..bdea3b4 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst @@ -12,6 +12,20 @@ This API is used to query all floating IP addresses accessible to the tenant sub You can query the detailed information about a specified floating IP address using the API for :ref:`Querying a Floating IP Address `. +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + URI --- @@ -46,20 +60,20 @@ GET /v2.0/floatingips +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | No | String | Specifies the project ID. | +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | No | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | String | No | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | + | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | page_reverse | Boolean | No | Specifies the page direction. The value can be **True** or **False**. | + | page_reverse | No | Boolean | Specifies the page direction. The value can be **True** or **False**. | +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example: @@ -88,83 +102,91 @@ Response Message .. table:: **Table 3** **floatingip** objects - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+================================================================================================+ - | status | String | Specifies the floating IP address status. The value can be **ACTIVE**, **DOWN**, or **ERROR**. | - | | | | - | | | - **DOWN** indicates that the floating IP address has not been bound. | - | | | - **ACTIVE** indicates that the floating IP address has been bound. | - | | | - **ERROR** indicates that the floating IP address is abnormal. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | id | String | Specifies the floating IP address ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | floating_ip_address | String | Specifies the floating IP address. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | floating_network_id | String | Specifies the external network ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | router_id | String | Specifies the ID of the belonged router. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | port_id | String | Specifies the port ID. | - | | | | - | | | .. note:: | - | | | | - | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | fixed_ip_address | String | Specifies the private IP address of the associated port. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the DNS name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the DNS domain. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time when the floating IP address was created. | - | | | | - | | | UTC time is used. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the floating IP address was updated. | - | | | | - | | | UTC time is used. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================================================================================================+ + | status | String | Specifies the floating IP address status. The value can be **ACTIVE**, **DOWN**, or **ERROR**. | + | | | | + | | | - **DOWN** indicates that the floating IP address has not been bound. | + | | | - **ACTIVE** indicates that the floating IP address has been bound. | + | | | - **ERROR** indicates that the floating IP address is abnormal. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the floating IP address ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | floating_ip_address | String | Specifies the floating IP address. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | floating_network_id | String | Specifies the external network ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | router_id | String | Specifies the ID of the belonged router. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_id | String | Specifies the port ID. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ip_address | String | Specifies the private IP address of the associated port. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the DNS name. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the DNS domain. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time when the floating IP address was created. | + | | | | + | | | UTC time is used. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time when the floating IP address was updated. | + | | | | + | | | UTC time is used. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/floatingips?limit=1 -Example response +Example Response +---------------- + +**Status code: 200** + +Normal response to the GET operation .. code-block:: { - "floatingips": [ - { - "id": "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd", - "status": "DOWN", - "router_id": null, - "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", - "fixed_ip_address": null, - "floating_ip_address": "99.99.99.84", - "port_id": null, - "dns_name": "ecs-80-158-78-239", - "dns_domain": "reverse.domain-name.com", - "created_at": "2017-10-19T12:21:28", - "updated_at": "2018-07-30T12:52:13" - } - ] + "floatingips" : [ { + "id" : "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd", + "status" : "DOWN", + "router_id" : null, + "tenant_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", + "project_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", + "floating_network_id" : "0a2228f2-7f8a-45f1-8e09-9039e1d09975", + "fixed_ip_address" : null, + "floating_ip_address" : "99.99.99.84", + "port_id" : null, + "dns_name" : "ecs-88-99-103-61", + "dns_domain" : "compute.clouds-dns.com.", + "created_at" : "2017-10-19T12:21:28", + "updated_at" : "2018-07-30T12:52:13" + } ], + "floatingips_links" : [ { + "href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&marker=000a6144-5010-46f2-bf06-6a1c94477ea3&page_reverse=true", + "rel" : "previous" + }, { + "href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&marker=d445e537-bc81-4039-9c7b-f9c1f5c73c78", + "rel" : "next" + } ] } Status Code diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst index 2ce3c72..9032845 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst @@ -18,9 +18,18 @@ If **port_id** is left blank, the floating IP address has been unbound from the This API has the following constraints: - - If you want to bind a floating IP address in the **error** state, unbind the IP address first. + - If a floating IP address that you are binding is in the **error** state, unbind the IP address first. - Do not associate a port that has a floating IP address associated to another floating IP address. You must first disassociate the port from the IP address and then associate it with another IP address. - This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + + - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. + - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + + - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. URI --- @@ -107,22 +116,39 @@ Response Message | dns_domain | String | Specifies the DNS domain. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ -Example: --------- +Example Request +--------------- -Example request 1 (Binding a floating IP address to a port) +- Unbind a floating IP address from a port. -.. code-block:: text + .. code-block:: text - PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 + PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 - { - "floatingip": { - "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac" - } - } + { + "floatingip": { + "port_id": null + } + } -Example response 1 (Binding a floating IP address to a port) +- Bind a floating IP address to a port. The port ID is f91f5763-c5a2-4458-979d-61e48b3c3fac. + + .. code-block:: text + + PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 + + { + "floatingip": { + "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac" + } + } + +Example Response +---------------- + +**Status code: 200** + +(The floating IP address is unbound from the port.) .. code-block:: @@ -132,49 +158,31 @@ Example response 1 (Binding a floating IP address to a port) "status": "DOWN", "router_id": null, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", - "fixed_ip_address": "192.168.10.3", - "floating_ip_address": "88.88.215.205", - "port_id": 00587256-27e3-489b-96bf-ea80c1da4aeb, - "dns_name": "ecs-80-158-78-239", - "dns_domain": "reverse.domain-name.com", - "created_at": "2018-09-20T02:10:02", - "updated_at": "2018-09-20T02:10:07" - } - } - -Example request 2 (Unbinding a floating IP address from a port) - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 - - { - "floatingip": { - "port_id": null - } - } - -Example response 2 (Unbinding a floating IP address from a port) - -.. code-block:: - - { - "floatingip": { - "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2", - "status": "DOWN", - "router_id": null, - "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address": null, "floating_ip_address": "88.88.215.205", "port_id": null, "dns_name": "ecs-80-158-78-239", - "dns_domain": "reverse.domain-name.com", - "created_at": "2018-09-20T02:10:02", - "updated_at": "2018-09-20T02:10:07" + "dns_domain": "reverse.domain-name.com" + } + } + +(The floating IP address is bound to the port.) + +.. code-block:: + + { + "floatingip": { + "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2", + "status": "DOWN", + "router_id": null, + "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", + "fixed_ip_address": "192.168.10.3", + "floating_ip_address": "88.88.215.205", + "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac", + "dns_name": "ecs-80-158-78-239", + "dns_domain": "reverse.domain-name.com" } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst index 99a7d49..70d8443 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst @@ -15,8 +15,8 @@ URI POST /v2.0/networks -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -30,89 +30,37 @@ Request Message .. table:: **Table 2** **network** objects - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=======================+=================+=================+==========================================================================================================================================================================================+ - | name | No | String | Specifies the network name. | - | | | | | - | | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies the administrative status. | - | | | | | - | | | | The value can only be **true**. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | No | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | | - | | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=======================+=================+=================+==================================================================================================================================================================================================================+ + | name | No | String | Specifies the network name. | + | | | | | + | | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies the administrative status. | + | | | | | + | | | | The value can only be **true**. | + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | No | Boolean | Specifies whether the network can be shared by different tenants. | + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | No | String | Specifies the network type. | + | | | | | + | | | | Only the VXLAN and GENEVE networks are supported. | + | | | | | + | | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. | + | | | | | + | | | | Note: | + | | | | | + | | | | - Set this parameter to **geneve** if you want to create GENEVE networks. | + | | | | - Do not specify this parameter if you want to create VXLAN networks. | + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- -.. table:: **Table 3** Response parameter - - +-----------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================+================================================================================================+ - | network | :ref:`network ` object | Specifies the network. For details, see :ref:`Table 4 `. | - +-----------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------+ - -.. _vpc_network_0003__table6247102344219: - -.. table:: **Table 4** **network** objects - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example: --------- - -Example request +Create a network named **network-test**. .. code-block:: text @@ -126,7 +74,82 @@ Example request } } -Example response +Response Parameters +------------------- + +.. table:: **Table 3** Response parameter + + +-----------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==============================================================+================================================================================================+ + | network | :ref:`network ` object | Specifies the network. For details, see :ref:`Table 4 `. | + +-----------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + +.. _vpc_network_0003__table6247102344219: + +.. table:: **Table 4** **network** objects + + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==================================================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. The default value is **false**. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the network can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + | | | | + | | | This parameter is not mandatory when you query networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. | + | | | | + | | | Only the VXLAN and GENEVE networks are supported. | + | | | | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. | + | | | | + | | | Note: | + | | | | + | | | - Set this parameter to **geneve** if you want to create GENEVE networks. | + | | | - Do not specify this parameter if you want to create VXLAN networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + | | | | + | | | This parameter is not displayed when an external network is called and the value of **router:external** is **true**. This parameter is visible when the value of **router:external** is **false**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst index 97cc5aa..3f513a7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst @@ -27,26 +27,25 @@ DELETE /v2.0/networks/{network_id} network_id Yes Specifies the network ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/networks/60c809cb-6731-45d0-ace8-3bf5626421a9 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst index 63a40af..082f21a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst @@ -27,13 +27,20 @@ GET /v2.0/networks/{network_id} network_id Yes Specifies the network ID. ========== ========= ========================= -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/networks/0133cd73-34d4-4d4c-bf1f-e65b24603206 + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -47,62 +54,67 @@ Response Message .. table:: **Table 3** **network** objects - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==================================================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. The default value is **false**. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the network can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + | | | | + | | | This parameter is not mandatory when you query networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. | + | | | | + | | | Only the VXLAN and GENEVE networks are supported. | + | | | | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. | + | | | | + | | | Note: | + | | | | + | | | - Set this parameter to **geneve** if you want to create GENEVE networks. | + | | | - Do not specify this parameter if you want to create VXLAN networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + | | | | + | | | This parameter is not displayed when an external network is called and the value of **router:external** is **true**. This parameter is visible when the value of **router:external** is **false**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/networks/0133cd73-34d4-4d4c-bf1f-e65b24603206 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst index ab19c3a..9b4419a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst @@ -64,85 +64,103 @@ Example of querying ports by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/networks?limit=1 + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================================+======================================================================================================================================================================================================================+ - | networks | Array of :ref:`network ` objects | Specifies the network list. For details, see :ref:`Table 3 `. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | networks_links | Array of :ref:`networks_link ` objects | Specifies the pagination information. For details, see :ref:`Table 4 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================================+=================================================================================================================================================================================================================+ + | networks | Array of :ref:`network ` objects | Specifies the network list. For details, see :ref:`Table 3 `. | + +-----------------------+------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | networks_links | Array of :ref:`networks_link ` objects | Specifies the pagination information. For details, see :ref:`Table 4 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_network_0001__table49902238182444: .. table:: **Table 3** **network** object - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==================================================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies ID of the subnet associated with this network. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. The default value is **false**. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the network can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. | + | | | | + | | | Only the VXLAN and GENEVE networks are supported. | + | | | | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. | + | | | | + | | | Note: | + | | | | + | | | - Set this parameter to **geneve** if you want to create GENEVE networks. | + | | | - Do not specify this parameter if you want to create VXLAN networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + | | | | + | | | This parameter is not displayed when an external network is called and the value of **router:external** is **true**. This parameter is visible when the value of **router:external** is **false**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_network_0001__table1296611517358: @@ -156,16 +174,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/networks?limit=1 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst index 40a4414..88020d4 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst @@ -27,8 +27,8 @@ PUT /v2.0/networks/{network_id} network_id Yes Specifies the network ID. ========== ========= ========================= -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -49,7 +49,7 @@ Request Message +=======================+=================+=================+==========================================================================================================================================================================================+ | name | No | String | Specifies the network name. | | | | | | - | | | | The name cannot be the same as the **admin_external_net** value. | + | | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | admin_state_up | No | Boolean | Specifies the administrative status. | | | | | | @@ -58,8 +58,23 @@ Request Message | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Change the name of the network whose ID is c360322d-5315-45d7-b7d2-481f98c56edb to **network-test02**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb + + { + "network": { + "name": "network-test02" + } + } + +Response Parameters +------------------- .. table:: **Table 4** Response parameter @@ -73,68 +88,67 @@ Response Message .. table:: **Table 5** **network** objects - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==================================================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. The default value is **false**. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the network can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + | | | | + | | | This parameter is not mandatory when you query networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. | + | | | | + | | | Only the VXLAN and GENEVE networks are supported. | + | | | | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. | + | | | | + | | | Note: | + | | | | + | | | - Set this parameter to **geneve** if you want to create GENEVE networks. | + | | | - Do not specify this parameter if you want to create VXLAN networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + | | | | + | | | This parameter is not displayed when an external network is called and the value of **router:external** is **true**. This parameter is visible when the value of **router:external** is **false**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb - - { - "network": { - "name": "network-test02" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst index 8cdbbdd..c9b77a8 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst @@ -15,8 +15,8 @@ URI POST /v2.0/ports -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -30,59 +30,67 @@ Request Message .. table:: **Table 2** **port** objects - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=======================+=================+====================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the port name. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | Yes | String | - Specifies the ID of the network to which the port belongs. | - | | | | - The network ID must be a real one in the network environment. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | No | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 3 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | | - | | | | This parameter cannot be left blank. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | No | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | - The IP address cannot be **0.0.0.0**. | - | | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | No | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | | - | | | | Example: | - | | | | | - | | | | {"internal_elb": true} | - | | | | | - | | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | | - | | | | Example: | - | | | | | - | | | | {"disable_security_groups": true }, | - | | | | | - | | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | No | String | Specifies the type of the bound vNIC. | - | | | | | - | | | | **normal**: Softswitch | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | No | String | Specifies the device to which the port belongs. Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=======================+=================+=======================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the port name. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | Yes | String | - Specifies the ID of the network to which the port belongs. | + | | | | - The network ID must be a real one in the network environment. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies the administrative status. | + | | | | | + | | | | The default value is **true**. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | No | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 3 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | | + | | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | | + | | | | This parameter cannot be left blank. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | No | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 4 `. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | - The IP address cannot be **0.0.0.0**. | + | | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | No | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | | + | | | | Example: | + | | | | | + | | | | {"internal_elb": true} | + | | | | | + | | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | | + | | | | Example: | + | | | | | + | | | | {"disable_security_groups": true }, | + | | | | | + | | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | No | String | Specifies the type of the bound vNIC. | + | | | | | + | | | | **normal**: Softswitch | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | No | String | Specifies the device that the port belongs to. | + | | | | | + | | | | Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0003__table335683819394: @@ -102,7 +110,7 @@ Request Message .. _vpc_port02_0003__en-us_topic_0062207355_table57914257: -.. table:: **Table 4** **allow_address_pair** object +.. table:: **Table 4** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -128,8 +136,25 @@ Request Message opt_value No String Specifies the option value. ========= ========= ====== =========================== -Response Message ----------------- +Example Request +--------------- + +Create a port named **port-test** on network whose ID is 00ae08c5-f727-49ab-ad4b-b069398aa171. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/ports + + { + "port": { + "admin_state_up": true, + "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", + "name": "port-test" + } + } + +Response Parameters +------------------- .. table:: **Table 6** Response parameter @@ -143,110 +168,112 @@ Response Message .. table:: **Table 7** **port** objects - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+======================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0003__table1424105920176: @@ -266,7 +293,7 @@ Response Message .. _vpc_port02_0003__table13242185941715: -.. table:: **Table 9** **allow_address_pair** objects +.. table:: **Table 9** **allowed_address_pairs** objects +-----------------------+-----------------------+---------------------------------------+ | Attribute | Type | Description | @@ -317,24 +344,8 @@ Response Message | fqdn | String | Specifies the private network fully qualified domain name (FQDN) of the port. | +------------+--------+-------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/ports - - { - "port": { - "admin_state_up": true, - "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", - "name": "port-test" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst index 9aa1c55..9727ce3 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst @@ -32,26 +32,25 @@ DELETE /v2.0/ports/{port_id} | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | +---------+-----------+------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/ports/2b098395-046a-4071-b009-312bcee665cb -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst index 2b79154..34e277f 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst @@ -27,13 +27,20 @@ GET /v2.0/ports/{port_id} | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | +---------+-----------+------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports/791870bd-36a7-4d9b-b015-a78e9b06af08 + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -47,110 +54,112 @@ Response Message .. table:: **Table 3** **port** objects - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+====================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 8 `. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | binding:profile object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 8 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | binding:profile object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0002__table4290920914597: @@ -170,7 +179,7 @@ Response Message .. _vpc_port02_0002__en-us_topic_0062207355_table57914257: -.. table:: **Table 5** **allow_address_pair** object +.. table:: **Table 5** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -224,16 +233,8 @@ Response Message | ovs_hybrid_plug | Boolean | Specifies that OVS hybrid plug should be used by Nova APIs. | +-------------------+---------+-------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/ports/791870bd-36a7-4d9b-b015-a78e9b06af08 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst index e172adb..95df59d 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst @@ -33,175 +33,216 @@ Example of querying ports by page .. table:: **Table 1** Parameter description - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+==================+========================================================================================================================================================================================================================+ - | id | No | String | Specifies that the port ID is used as the filtering condition. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Specifies that the port name is used as the filtering condition. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies that the admin state is used as the filtering condition. | - | | | | | - | | | | The value can be **true** or **false**. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | No | String | Specifies that the network ID is used as the filtering condition. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | No | String | Specifies that the MAC address is used as the filtering condition. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | No | String | Specifies that the device ID is used as the filtering condition. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | No | String | Specifies that the device owner is used as the filtering condition. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies that the port status is used as the filtering condition. | - | | | | | - | | | | The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | No | Array of strings | Specifies that the IP address is used as the filtering condition. The value can be **fixed_ips=ip_address** or **fixed_ips=subnet_id**. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | No | String | Specifies that the project ID is used as the filtering condition. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | - | | | | | - | | | | This parameter can work together with the parameter **limit**. | - | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | - | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | - | | | | | - | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================+======================================================================================================================================================================================================================================================================================================================+ + | id | No | String | Specifies that the port ID is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Specifies that the port name is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies that the admin state is used as the filtering condition. | + | | | | | + | | | | The value can be **true** or **false**. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | No | String | Specifies that the network ID is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | No | String | Specifies that the MAC address is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | No | String | Specifies that the device ID is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | No | String | Specifies that the device owner is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | String | Specifies that the port status is used as the filtering condition. | + | | | | | + | | | | The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | No | Array of strings | Specifies that the ID of the security group is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | No | Array of strings | Filter by IP address of the port, that is **fixed_ips=ip_address={ip_address}** or **fixed_ips=subnet_id={subnet_id}**. Set *{ip_address}* to an IP address, for example, 192.168.21.22 or 2a07:b980:4030:14::1. Set *{subnet_id}* to the IPv4 or IPv6 subnet ID, for example, 011fc878-5521-4654-a1ad-f5b0b5820302. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | No | String | Specifies that the project ID is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | + | | | | | + | | | | This parameter can work together with the parameter **limit**. | + | | | | | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | + | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | + | | | | | + | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Message --------------- None +Example Request +--------------- + +Example 1 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?limit=1 + +Example 2 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?mac_address=fa:16:3e:f1:0b:09 + +Example 3 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?admin_state_up=False + +Example 4 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?device_id=e6c05704-c907-4cc1-8106-69b0996c43b9 + +Example 5 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3 + +Example 6 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?name=port_vm_50_3 + Response Parameter ------------------ .. table:: **Table 2** Response parameter - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================+======================================================================================================================================================================================================================+ - | ports | Array of :ref:`port ` objects | Specifies the port object list. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ports_links | Array of :ref:`ports_link ` objects | Specifies the pagination information. For details, see :ref:`Table 9 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=========================================================================+=================================================================================================================================================================================================================+ + | ports | Array of :ref:`port ` objects | Specifies the port object list. For details, see :ref:`Table 3 `. | + +-----------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ports_links | Array of :ref:`ports_link ` objects | Specifies the pagination information. For details, see :ref:`Table 9 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0001__table15919752145624: .. table:: **Table 3** **port** objects - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+====================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 7 `. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 7 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0001__table4290920914597: @@ -221,7 +262,7 @@ Response Parameter .. _vpc_port02_0001__en-us_topic_0062207355_table57914257: -.. table:: **Table 5** **allow_address_pair** object +.. table:: **Table 5** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -287,365 +328,343 @@ Response Parameter | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example: --------- +Example Response +---------------- -[Example 1] +Example 1 -- Example request +.. code-block:: - .. code-block:: text + { + "ports": [{ + "id": "791870bd-36a7-4d9b-b015-a78e9b06af08", + "name": "port-test", + "status": "DOWN", + "admin_state_up": true, + "fixed_ips": [], + "mac_address": "fa:16:3e:01:e0:b2", + "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", + "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", + "project_id": "db82c9e1415a464ea68048baa8acc6b8", + "device_id": "", + "device_owner": "", + "security_groups": ["d0d58aa9-cda9-414c-9c52-6c3daf8534e6"], + "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "binding:vif_details": {}, + "binding:profile": {}, + "port_security_enabled": true, + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41" + }, + { + "id": "7a8c720d-32b7-47cc-a943-23e48d69e30a", + "name": "a8d001aa-6946-4168-86d9-924c7d3ef8fb", + "status": "DOWN", + "admin_state_up": true, + "fixed_ips": [ + { + "subnet_id": "a8d001aa-6946-4168-86d9-924c7d3ef8fb", + "ip_address": "2a07:b980:4030:14::1" + } + ], + "mac_address": "fa:16:3e:57:39:c3", + "network_id": "26cf88ff-1a8c-4233-a8e6-183e1e299357", + "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", + "project_id": "db82c9e1415a464ea68048baa8acc6b8", + "device_id": "6c2fcea1-b785-4253-b84e-3d887e1c67e1", + "device_owner": "network:router_interface_distributed", + "security_groups": ["34acbeed-8f65-4875-86ca-66417b1733fd"], + "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "binding:vif_details": {}, + "binding:profile": {}, + "port_security_enabled": true, + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41" + } + ], + "ports_links": [ + { + "rel": "next", + "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=7a8c720d-32b7-47cc-a943-23e48d69e30a" + }, + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=7a8c720d-32b7-47cc-a943-23e48d69e30a&page_reverse=True" + } + ] + } - GET https://{Endpoint}/v2.0/ports?limit=1 +Example 2 -- Example response +.. code-block:: - .. code-block:: + { + "ports": [ + { + "admin_state_up": true, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "device_owner": "compute:az3.dc1", + "port_security_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "172.16.0.37", + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" + } + ], + "dns_assignment": [ + { + "hostname": "ip-172-16-0-37", + "ip_address": "172.16.0.37", + "fqdn": "ip-172-16-0-37.xxx.compute.internal." + } + ], + "dns_name": "ip-172-16-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "mac_address": "fa:16:3e:f1:0b:09", + "name": "port_vm_50_3", + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "ACTIVE", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e", + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?mac_address=fa%3A16%3A3e%3Af1%3A0b%3A09&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" + } + ] + } - { - "ports": [{ - "id": "791870bd-36a7-4d9b-b015-a78e9b06af08", - "name": "port-test", - "status": "DOWN", - "admin_state_up": true, - "fixed_ips": [], - "mac_address": "fa:16:3e:01:e0:b2", - "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", - "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", - "project_id": "db82c9e1415a464ea68048baa8acc6b8", - "device_id": "", - "device_owner": "", - "security_groups": ["d0d58aa9-cda9-414c-9c52-6c3daf8534e6"], - "extra_dhcp_opts": [], - "allowed_address_pairs": [], - "binding: vnic_type": "normal", - "binding: vif_details": {}, - "binding: profile": {}, - "port_security_enabled": true, - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - }], - "ports_links": [ - { - "rel": "next", - "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08" - }, - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08&page_reverse=True" - } - ] - } +Example 3 -[Example 2] +.. code-block:: -- Example request + { + "ports": [ - .. code-block:: text + { + "admin_state_up": false, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "", + "device_owner": "", + "port_security_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "10.100.100.62", + "subnet_id": "9b28f20c-0234-419f-a0b4-4a84f182f64b" + } + ], + "dns_name": "", + "id": "ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87", + "mac_address": "fa:16:3e:2b:bc:57", + "name": "small_net_port", + "network_id": "b299b151-7a66-4c6f-a313-cdd3b5724296", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "DOWN", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e", + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?admin_state_up=False&marker=ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87&page_reverse=True" + } + ] + } - GET https://{Endpoint}/v2.0/ports?mac_address=fa:16:3e:f1:0b:09 +Example 4 -- Example response +.. code-block:: - .. code-block:: + { + "ports": [ + { + "admin_state_up": true, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "device_owner": "compute:az3.dc1", + "port_security_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "10.1.0.37", + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" + } + ], + "dns_assignment": [ + { + "hostname": "ip-10-1-0-37", + "ip_address": "10.1.0.37", + "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. + } + ], + "dns_name": "ip-10-1-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "mac_address": "fa:16:3e:f1:0b:09", + "name": "port_vm_50_3", + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "ACTIVE", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e" , + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?device_id=77307088-ae60-49fb-9146-924dcf1d1402&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" + } + ] + } - { - "ports": [ - { - "admin_state_up": true, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "172.16.0.37", - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" - } - ], - "dns_assignment": [ - { - "hostname": "ip-172-16-0-37", - "ip_address": "172.16.0.37", - "fqdn": "ip-172-16-0-37.xxx.compute.internal." - } - ], - "dns_name": "ip-172-16-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "mac_address": "fa:16:3e:f1:0b:09", - "name": "port_vm_50_3", - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "ACTIVE", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ], - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?mac_address=fa%3A16%3A3e%3Af1%3A0b%3A09&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" - } - ] - } +Example 5 -[Example 3] +.. code-block:: -- Example request + { + "ports": [ + { + "admin_state_up": true, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "device_owner": "compute:az3.dc1", + "port_secuirty_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "10.1.0.37", + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" + } + ], + "dns_assignment": [ + { + "hostname": "ip-10-1-0-37", + "ip_address": "10.1.0.37", + "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. + } + ], + "dns_name": "ip-10-1-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "mac_address": "fa:16:3e:f1:0b:09", + "name": "port_vm_50_3", + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "ACTIVE", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e" , + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" + } + ] + } - .. code-block:: text +Example 6 - GET https://{Endpoint}/v2.0/ports?admin_state_up=False +.. code-block:: -- Example response - - .. code-block:: - - { - "ports": [ - - { - "admin_state_up": false, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "", - "device_owner": "", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "10.100.100.62", - "subnet_id": "9b28f20c-0234-419f-a0b4-4a84f182f64b" - } - ], - "dns_name": "", - "id": "ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87", - "mac_address": "fa:16:3e:2b:bc:57", - "name": "small_net_port", - "network_id": "b299b151-7a66-4c6f-a313-cdd3b5724296", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "DOWN", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ], - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?admin_state_up=False&marker=ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87&page_reverse=True" - } - ] - } - -[Example 4] - -- Example request - - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?device_id=e6c05704-c907-4cc1-8106-69b0996c43b9 - -- Example response - - .. code-block:: - - { - "ports": [ - { - "admin_state_up": true, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "10.1.0.37", - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" - } - ], - "dns_assignment": [ - { - "hostname": "ip-10-1-0-37", - "ip_address": "10.1.0.37", - "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. - } - ], - "dns_name": "ip-10-1-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "mac_address": "fa:16:3e:f1:0b:09", - "name": "port_vm_50_3", - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "ACTIVE", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e" , - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ], - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?device_id=77307088-ae60-49fb-9146-924dcf1d1402&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" - } - ] - } - -[Example 5] - -- Example request - - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3 - -- Example response - - .. code-block:: - - { - "ports": [ - { - "admin_state_up": true, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "10.1.0.37", - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" - } - ], - "dns_assignment": [ - { - "hostname": "ip-10-1-0-37", - "ip_address": "10.1.0.37", - "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. - } - ], - "dns_name": "ip-10-1-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "mac_address": "fa:16:3e:f1:0b:09", - "name": "port_vm_50_3", - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "ACTIVE", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e" , - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ] - , - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" - } - ] - } - -[Example 6] - -- Example request - - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?name=port_vm_50_3 - -- Example response - - .. code-block:: - - { - "ports": [ - { - "status": "DOWN", - "allowed_address_pairs": [], - "extra_dhcp_opts": [], - "device_owner": "", - "port_security_enabled":true, - "fixed_ips": [ - { - "subnet_id": "391c74f7-e3b1-405c-8473-2f71a0aec7dc", - "ip_address": "10.1.0.33" - } - ], - "dns_name": "", - "id": "0f405555-739f-4a19-abb7-ec11d005b3a9", - "security_groups": [ - "043548bc-1020-4be0-885a-caac8530e8f6" - ], - "device_id": "", - "port_security_enabled":true, - "name": "port_vm_50_3", - "admin_state_up": true, - "network_id": "9898a82d-7795-4ad5-bf2c-0ed8b822be4f", - "tenant_id": "3e4a1816927f405cacbc3dca1e05111e", - "project_id": "3e4a1816927f405cacbc3dca1e05111e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41", - "binding:vnic_type": "normal", - "mac_address": "fa:16:3e:b0:d9:cf" - }, - { - "status": "ACTIVE", - "allowed_address_pairs": [], - "extra_dhcp_opts": [], - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "fixed_ips": [ - { - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5", - "ip_address": "10.1.0.37" - } - ], - "dns_assignment": [ - { - "hostname": "ip-10-1-0-37", - "ip_address": "10.1.0.37", - "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. - } - ], - "dns_name": "ip-10-1-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "name": "port_vm_50_3", - "admin_state_up": true, - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "3e4a1816927f405cacbc3dca1e05111e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41", - "binding:vnic_type": "normal", - "binding:vnic_type": "normal", - "mac_address": "fa:16:3e:f1:0b:09" - } - ] - , - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?name=port_vm_50_3&marker=0f405555-739f-4a19-abb7-ec11d005b3a9&page_reverse=True" - } - ] - } + { + "ports": [ + { + "status": "DOWN", + "allowed_address_pairs": [], + "extra_dhcp_opts": [], + "device_owner": "", + "port_security_enabled":true, + "fixed_ips": [ + { + "subnet_id": "391c74f7-e3b1-405c-8473-2f71a0aec7dc", + "ip_address": "10.1.0.33" + } + ], + "dns_name": "", + "id": "0f405555-739f-4a19-abb7-ec11d005b3a9", + "security_groups": [ + "043548bc-1020-4be0-885a-caac8530e8f6" + ], + "device_id": "", + "port_security_enabled":true, + "name": "port_vm_50_3", + "admin_state_up": true, + "network_id": "9898a82d-7795-4ad5-bf2c-0ed8b822be4f", + "tenant_id": "3e4a1816927f405cacbc3dca1e05111e", + "project_id": "3e4a1816927f405cacbc3dca1e05111e", + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41", + "binding:vnic_type": "normal", + "mac_address": "fa:16:3e:b0:d9:cf" + }, + { + "status": "ACTIVE", + "allowed_address_pairs": [], + "extra_dhcp_opts": [], + "device_owner": "compute:az3.dc1", + "port_security_enabled":true, + "fixed_ips": [ + { + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5", + "ip_address": "10.1.0.37" + } + ], + "dns_assignment": [ + { + "hostname": "ip-10-1-0-37", + "ip_address": "10.1.0.37", + "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. + } + ], + "dns_name": "ip-10-1-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "name": "port_vm_50_3", + "admin_state_up": true, + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "3e4a1816927f405cacbc3dca1e05111e", + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41", + "binding:vnic_type": "normal", + "binding:vnic_type": "normal", + "mac_address": "fa:16:3e:f1:0b:09" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?name=port_vm_50_3&marker=0f405555-739f-4a19-abb7-ec11d005b3a9&page_reverse=True" + } + ] + } Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst index fac582c..d46c6ba 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst @@ -27,8 +27,8 @@ PUT /v2.0/ports/{port_id} | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | +---------+-----------+------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -44,56 +44,56 @@ Request Message .. table:: **Table 3** **port** objects - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=======================+=================+==================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the port name. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | | - | | | | This parameter cannot be left blank. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | No | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | - The IP address cannot be **0.0.0.0**. | - | | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | No | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | | - | | | | Example: | - | | | | | - | | | | {"internal_elb": true} | - | | | | | - | | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | | - | | | | Example: | - | | | | | - | | | | {"disable_security_groups": true }, | - | | | | | - | | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | No | String | Specifies the type of the bound vNIC. | - | | | | | - | | | | **normal**: Softswitch | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=======================+=================+=====================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the port name. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | | + | | | | This parameter cannot be left blank. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | No | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 4 `. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | - The IP address cannot be **0.0.0.0**. | + | | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | No | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | | + | | | | Example: | + | | | | | + | | | | {"internal_elb": true} | + | | | | | + | | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | | + | | | | Example: | + | | | | | + | | | | {"disable_security_groups": true }, | + | | | | | + | | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | No | String | Specifies the type of the bound vNIC. | + | | | | | + | | | | **normal**: Softswitch | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0004__table1389733912184: -.. table:: **Table 4** **allow_address_pair** object +.. table:: **Table 4** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -119,8 +119,23 @@ Request Message opt_value No String Specifies the option value. ========= ========= ====== =========================== -Response Message ----------------- +Example Request +--------------- + +Change the name of the port whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to **port-test02**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 + + { + "port": { + "name": "port-test02" + } + } + +Response Parameters +------------------- .. table:: **Table 6** Response parameter @@ -134,110 +149,112 @@ Response Message .. table:: **Table 7** **port** objects - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+====================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0004__table4290920914597: @@ -257,7 +274,7 @@ Response Message .. _vpc_port02_0004__en-us_topic_0062207355_table57914257: -.. table:: **Table 9** **allow_address_pair** objects +.. table:: **Table 9** **allowed_address_pairs** objects +-----------------------+-----------------------+---------------------------------------+ | Attribute | Type | Description | @@ -308,22 +325,8 @@ Response Message | fqdn | String | Specifies the private network fully qualified domain name (FQDN) of the port. | +------------+--------+-------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 - - { - "port": { - "name": "port-test02" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst index 70149a7..699ab10 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst @@ -22,8 +22,8 @@ URI PUT /v2.0/routers/{router_id}/add_router_interface -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -37,8 +37,19 @@ Request Message | port_id | String | No | Specifies the port ID. Either **subnet_id** or **port_id** is used. Use the port IP address to create a router interface. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Add an interface to the router. The router ID is i5b8e885c-1347-4ac2-baf9-2249c8ed1270, and the subnet ID is ab78be2d-782f-42a5-aa72-35879f6890ff. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface + + {"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"} + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -52,18 +63,8 @@ Response Message id String Specifies the router ID. ========== ====== ========================= -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface - - {"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"} - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst index 44cbdce..3baef80 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst @@ -15,8 +15,8 @@ URI POST /v2.0/routers -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -62,8 +62,24 @@ Request Message | | | | The default value is **false**. | +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Create a router named **router-test2**. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/routers + + { + "router": { + "name": "router-test2", + "admin_state_up": true + } + } + +Response Parameters +------------------- .. table:: **Table 4** Response parameter @@ -137,22 +153,8 @@ Response Message | nexthop | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-------------+--------+-------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/routers - { - "router": { - "name": "router-test2", - "admin_state_up": true - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst index 3061a1b..f614490 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/routers/{router_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/routers/0735a367-2caf-48fb-85aa-6082266f342e -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst index 45f2349..5b80697 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst @@ -15,13 +15,20 @@ URI GET /v2.0/routers/{router_id} -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/routers/01ab4be1-4447-45fb-94be-3ee787ed4ebe + +Response Parameters +------------------- .. table:: **Table 1** Response parameter @@ -95,16 +102,8 @@ Response Message | nexthop | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-------------+--------+-------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/routers/01ab4be1-4447-45fb-94be-3ee787ed4ebe - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst index d4aed7b..9830afb 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst @@ -52,35 +52,42 @@ Example of querying routers by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/routers?limit=1 + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +-----------------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================+======================================================================================================================================================================================================================+ - | routers | Array of :ref:`router ` objects | Specifies the router list. For details, see :ref:`Table 3 `. | - +-----------------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routers_links | Array of :ref:`routers_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==========================================================================+=================================================================================================================================================================================================================+ + | routers | Array of :ref:`router ` objects | Specifies the router list. For details, see :ref:`Table 3 `. | + +-----------------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routers_links | Array of :ref:`routers_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_router_0001__table24153696181443: @@ -160,16 +167,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example -------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/routers?limit=1 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst index 4433e4d..ad13202 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst @@ -19,8 +19,8 @@ URI PUT /v2.0/routers/{router_id}/remove_router_interface -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -34,8 +34,19 @@ Request Message | port_id | String | No | Specifies the port ID. Either **subnet_id** or **port_id** is used. Use the port IP address to create a router interface. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Remove an interface from a router. The router ID is b625c58c-0cfe-49e0-acc8-f2374f8187ff, and the subnet ID is 4b910a10-0860-428b-b463-d84dbc5e288e. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface + + {"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"} + +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -49,18 +60,8 @@ Response Message id String Specifies the router ID. ========== ====== ========================= -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface - - {"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"} - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst index a315e38..e1c350c 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/routers/{router_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -82,8 +82,23 @@ Request Message | nexthop | No | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Change the name of the router whose ID is f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 to **router-220**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 + + { + "router": { + "name": "router-220" + } + } + +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -159,21 +174,8 @@ Response Message | nexthop | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-------------+--------+-------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 - { - "router": { - "name": "router-220" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst index 1020289..db7cbce 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst @@ -15,8 +15,8 @@ URI POST /v2.0/security-groups -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -38,8 +38,23 @@ Request Message | description | No | String | Provides supplementary information about the security group. | +-------------+-----------+--------+--------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Create a security group named **sg-test**. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/security-groups + + { + "security_group": { + "name": "sg-test" + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -117,7 +132,7 @@ Response Message | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -130,22 +145,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/security-groups - - { - "security_group": { - "name": "sg-test" - } - } - -Example response +Example Response +---------------- .. code-block:: @@ -183,7 +184,7 @@ Example response "port_range_max": null, "port_range_min": null, "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", - "remote_address_group_id": null + "remote_address_group_id": null } ], "created_at": "2018-09-20T02:15:34", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst index adff74b..98bede3 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst @@ -15,8 +15,8 @@ URI POST /v2.0/security-group-rules -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -39,7 +39,7 @@ Request Message +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_group_id | No | String | Specifies the peer ID of the belonged security group. | | | | | | - | | | | Either **remote_group_id** or **remote_ip_prefix** is used. | + | | | | This parameter is mutually exclusive with **remote_ip_prefix**. | +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | direction | Yes | String | Specifies the direction of the traffic for which the security group rule takes effect. | | | | | | @@ -47,7 +47,7 @@ Request Message +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_ip_prefix | No | String | Specifies the peer IP address segment. | | | | | | - | | | | Either **remote_ip_prefix** or **remote_group_id** is used. | + | | | | This parameter is mutually exclusive with **remote_group_id**. | +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | No | String | Specifies the protocol type or the IP protocol number. | | | | | | @@ -70,11 +70,29 @@ Request Message | | | | The value can be **IPv4** or **IPv6**. | +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Create an outbound rule in the security group whose ID is 5cb9c1ee-00e0-4d0f-9623-55463cd26ff8. Set **protocol** to **tcp**, and **remote_ip_prefix** to 10.10.0.0/24. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/security-group-rules + + { + "security_group_rule": { + "security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8", + "direction": "egress", + "protocol": "tcp", + "remote_ip_prefix": "10.10.0.0/24" + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -122,7 +140,7 @@ Response Message | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -135,25 +153,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/security-group-rules - - { - "security_group_rule": { - "security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8", - "direction": "egress", - "protocol": "tcp", - "remote_ip_prefix": "10.10.0.0/24" - } - } - -Example response +Example Response +---------------- .. code-block:: @@ -172,7 +173,8 @@ Example response "id": "7c336b04-1603-4911-a6f4-f2af1d9a0488", "project_id": "6fbe9263116a4b68818cf1edce16bc4f", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst index cfd8108..06f9769 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/security-groups/{security_group_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/security-groups/a7ebb1d8-71e5-42e5-9030-4e0fca059d50 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst index 354d539..b612b63 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/security-group-rules/{security_group_rule_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/security-group-rules/07adc044-3f21-4eeb-bd57-5e5eb6024b7f -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst index d6dbb88..2d62e9b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst @@ -15,13 +15,20 @@ URI GET /v2.0/security-groups/{security_group_id} -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-groups/0431c9c5-1660-42e0-8a00-134bec7f03e2 + +Response Parameters +------------------- .. table:: **Table 1** Response parameter @@ -99,7 +106,7 @@ Response Message | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -112,16 +119,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-groups/0431c9c5-1660-42e0-8a00-134bec7f03e2 - -Example response +Example Response +---------------- .. code-block:: @@ -145,7 +144,7 @@ Example response "port_range_max": null, "port_range_min": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", - "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" + "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" }, { "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", @@ -159,7 +158,7 @@ Example response "port_range_max": null, "port_range_min": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", - "remote_address_group_id": null + "remote_address_group_id": null } ], "created_at": "2018-09-12T08:24:14", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst index e62904c..4cfd6af 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst @@ -15,13 +15,20 @@ URI GET /v2.0/security-group-rules/{security_group_rule_id} -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-group-rules/1755bc80-cf3a-4f57-8ae9-d9796482ddc0 + +Response Parameters +------------------- .. table:: **Table 1** Response parameter @@ -69,7 +76,7 @@ Response Message | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -82,16 +89,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-group-rules/1755bc80-cf3a-4f57-8ae9-d9796482ddc0 - -Example response +Example Response +---------------- .. code-block:: @@ -110,7 +109,8 @@ Example response "id": "1755bc80-cf3a-4f57-8ae9-d9796482ddc0", "project_id": "6fbe9263116a4b68818cf1edce16bc4f", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst index 4103876..3a57ee2 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst @@ -62,35 +62,42 @@ Example of querying security group rules by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-group-rules + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +----------------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+====================================================================================+======================================================================================================================================================================================================================+ - | security_group_rules | Array of :ref:`Security Group Rule ` objects | Specifies the security group rule list. For details, see :ref:`Table 3 `. | - +----------------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules_links | Array of :ref:`SecurityGroupRulesLink ` objects | Shows pagination information about security group rules. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +----------------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============================+====================================================================================+=================================================================================================================================================================================================================+ + | security_group_rules | Array of :ref:`Security Group Rule ` objects | Specifies the security group rule list. For details, see :ref:`Table 3 `. | + +----------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules_links | Array of :ref:`SecurityGroupRulesLink ` objects | Shows pagination information about security group rules. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +----------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_sg02_0006__table655457801607: @@ -130,7 +137,7 @@ Response Message | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -155,16 +162,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-group-rules - -Example response +Example Response +---------------- .. code-block:: @@ -184,7 +183,8 @@ Example response "id": "07adc044-3f21-4eeb-bd57-5e5eb6024b7f", "project_id": "6c9298ec8c874f7f99688489ab65f90e", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null }, { "remote_group_id": null, @@ -200,7 +200,8 @@ Example response "id": "09358f83-f4a5-4386-9563-a1e3c373d655", "project_id": "6c9298ec8c874f7f99688489ab65f90e", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null }, { "remote_group_id": "4c763030-366e-428c-be2b-d48f6baf5297", @@ -216,7 +217,8 @@ Example response "id": "219a6f56-1069-458b-bec0-df9270e7a074", "project_id": "6c9298ec8c874f7f99688489ab65f90e", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null } ], "security_group_rules_links": [ diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst index dc6b9e5..4467a24 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst @@ -42,35 +42,42 @@ Example of querying security groups by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-groups?limit=1 + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+======================================================================================================================================================================================================================+ - | security_groups | Array of :ref:`Security Group ` objects | Specifies the security group list. For details, see :ref:`Table 3 `. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups_links | Array of :ref:`SecurityGroupsLink ` objects | Shows pagination information about security groups. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================================+=================================================================================================================================================================================================================+ + | security_groups | Array of :ref:`Security Group ` objects | Specifies the security group list. For details, see :ref:`Table 3 `. | + +-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups_links | Array of :ref:`SecurityGroupsLink ` objects | Shows pagination information about security groups. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_sg02_0001__table513726041607: @@ -140,7 +147,7 @@ Response Message | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -165,16 +172,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-groups?limit=1 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst index 86fa75e..8553b07 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/security-groups/{security_group_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -40,8 +40,23 @@ Request Message | description | No | String | Provides supplementary information about the security group. | +-------------+-----------+--------+--------------------------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Change the name of the security group whose ID is d29ae17d-f355-4992-8747-1fb66cc9afd2 to **sg-test02**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2 + + { + "security_group": { + "name": "sg-test02" + } + } + +Response Parameters +------------------- .. table:: **Table 3** Response parameter @@ -119,7 +134,7 @@ Response Message | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Specifies the project ID. | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -132,22 +147,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2 - - { - "security_group": { - "name": "sg-test02" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst index 1ec9962..9023e2b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst @@ -10,13 +10,18 @@ Function This API is used to create a subnet. +Notes and Constraints +--------------------- + +- IPv6 subnets can be created only when IPv4 subnets have been created on the network. + URI --- POST /v2.0/subnets -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -30,53 +35,67 @@ Request Message .. table:: **Table 2** **subnet** objects - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +==================+=================+============================================================================+=================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the subnet name. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | No | Integer | Specifies the IP address version. | - | | | | | - | | | | Supported versions: IPv4 | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | Yes | String | Specifies the ID of the network to which the subnet belongs. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | Yes | String | Specifies the CIDR format. | - | | | | | - | | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | No | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | | - | | | | This attribute cannot be modified. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | | - | | | | :ref:`Table 3 ` | - | | | | | - | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | | - | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | | - | | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | | - | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | No | Array of strings | Specifies the DNS server address. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - | | | | | - | | | | A maximum of five DNS server addresses are supported. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Static routes are not supported, and entered information will be ignored. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | | - | | | | The value can only be **true**. | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +========================+=================+============================================================================+============================================================================================================================================================================================================================================+ + | name | No | String | Specifies the subnet name. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | No | Integer | Specifies the IP address version. | + | | | | | + | | | | The value can be **4** (IPv4) or **6** (IPv6). | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | No | String | Specifies the IPv6 addressing mode. | + | | | | | + | | | | Only **dhcpv6-stateful** is supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | No | String | Specifies the IPv6 route broadcast mode. | + | | | | | + | | | | Only **dhcpv6-stateful** is supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | Yes | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | Yes | String | Specifies the CIDR format. | + | | | | | + | | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | No | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | | + | | | | This attribute cannot be modified. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | + | | | | | + | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | | + | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | | + | | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | | + | | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | | + | | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | | + | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | No | Array of strings | Specifies the DNS server address. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + | | | | | + | | | | A maximum of five DNS server addresses are supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | | + | | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | | + | | | | The value can only be **true**. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | No | Boolean | Specifies whether the default address pool is used. | + | | | | | + | | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0003__table24611730: @@ -102,8 +121,43 @@ Request Message | nexthop | No | String | Specifies the next-hop IP address of a route. | +-------------+-----------+--------+-----------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Create an IPv4 subnet named **subnet-test**, set its network ID to 0133cd73-34d4-4d4c-bf1f-e65b24603206, and CIDR block to 172.16.2.0/24. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/subnets + + { + "subnet": { + "name": "subnet-test", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "cidr": "172.16.2.0/24", + "enable_dhcp": true + } + } + +Create an IPv6 subnet named **subnet-ipv6-test** and with network ID of **0133cd73-34d4-4d4c-bf1f-e65b24603206**. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/subnets + + { + "subnet": { + "name": "subnet-ipv6-test", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "ip_version": 6, + "enable_dhcp": true, + "ipv6_address_mode": "dhcpv6-stateful", + "ipv6_ra_mode": "dhcpv6-stateful", + } + } + +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -117,63 +171,83 @@ Response Message .. table:: **Table 6** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | - | | | :ref:`Table 7 ` | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. In addition, the subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | + | | | | + | | | :ref:`Table 7 ` | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0003__table1777145918276: @@ -197,25 +271,8 @@ Response Message nexthop String Specifies the next-hop IP address of a route. =========== ====== ============================================= -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/subnets - - { - "subnet": { - "name": "subnet-test", - "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", - "cidr": "172.16.2.0/24", - "enable_dhcp": true - } - } - -Example response +Example Response +---------------- .. code-block:: @@ -243,6 +300,34 @@ Example response } } +.. code-block:: + + { + "subnet": { + "id": "011fc878-5521-4654-a1ad-f5b0b58203ac", + "name": "subnet-ipv6-test", + "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "ip_version": 6, + "cidr": "2001:db8:a583:a0::/64", + "subnetpool_id": "cb03d100-8687-4c0a-9441-ea568dcae47d", + "allocation_pools": [{ + "start": "2001:db8:a583:a0::2", + "end": "2001:db8:a583:a0:ffff:ffff:ffff:fffc" + }], + "gateway_ip": "2001:db8:a583:a0::1", + "enable_dhcp": true, + "ipv6_ra_mode": "dhcpv6-stateful", + "ipv6_address_mode": "dhcpv6-stateful", + "description": "", + "dns_nameservers": [], + "host_routes": [], + "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "created_at": "2021-07-01T07:59:28", + "updated_at": "2021-07-01T07:59:28" + } + } + Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst index 1a09dbe..56a8617 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/subnets/{subnet_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/subnets/74259164-e63a-4ad9-9c77-a1bd2c9aa187 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst index 157cdc1..6ca36ed 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst @@ -15,13 +15,20 @@ URI GET /v2.0/subnets/{subnet_id} -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/subnets/011fc878-5521-4654-a1ad-f5b0b5820302 + +Response Parameters +------------------- .. table:: **Table 1** Response parameter @@ -35,61 +42,81 @@ Response Message .. table:: **Table 2** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+==========================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0002__table1777145918276: @@ -113,16 +140,8 @@ Response Message nexthop String Specifies the next-hop IP address of a route. =========== ====== ============================================= -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/subnets/011fc878-5521-4654-a1ad-f5b0b5820302 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst index ca86bf9..1a6bec9 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst @@ -58,97 +58,132 @@ Example of querying networks by page | | | | | | | | | This parameter can work together with the parameter **limit**. | | | | | | - | | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None -Response Message ----------------- +Example Request +--------------- + +Example 1 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/subnets?limit=1 + +Example 2 + +.. code-block:: text + + GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322 + +Response Parameters +------------------- .. table:: **Table 2** Response parameter - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+======================================================================================================================================================================================================================+ - | subnets | Array of :ref:`subnet ` objects | Specifies the subnet list. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets_links | Array of :ref:`subnets_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===============================================================================+=================================================================================================================================================================================================================+ + | subnets | Array of :ref:`subnet ` objects | Specifies the subnet list. For details, see :ref:`Table 3 `. | + +-----------------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets_links | Array of :ref:`subnets_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0001__table176735992713: .. table:: **Table 3** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+=================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the IPv4 mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies available IP address pools. For details, see :ref:`Table 4 `. | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 5 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+=================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies available IP address pools. For details, see :ref:`Table 4 `. | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 5 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0001__table1777145918276: @@ -184,16 +219,10 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example -------- +Example Response +---------------- -Example request 1 - -.. code-block:: text - - GET https://{Endpoint}/v2.0/subnets?limit=1 - -Example response 1 +Example 1 .. code-block:: @@ -232,13 +261,7 @@ Example response 1 ] } -Example request 2 - -.. code-block:: text - - GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322 - -Example response 2 +Example 2 .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst index 31bdf25..426fa2a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst @@ -19,8 +19,8 @@ URI PUT /v2.0/subnets/{subnet_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -36,35 +36,43 @@ Request Message .. table:: **Table 2** **subnet** objects - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +==================+=================+============================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the subnet name. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details about the **allocation_pool** objects, see :ref:`Table 3 `. | - | | | | | - | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | | - | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | | - | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | No | Array of strings | Specifies the DNS server address. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - | | | | | - | | | | A maximum of five DNS server addresses are supported. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Static routes are not supported, and entered information will be ignored. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | | - | | | | The value can only be **true**. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +========================+=================+============================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the subnet name. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details about the **allocation_pool** objects, see :ref:`Table 3 `. | + | | | | | + | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | | + | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | | + | | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | | + | | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | | + | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | No | Array of strings | Specifies the DNS server address. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + | | | | | + | | | | A maximum of five DNS server addresses are supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | | + | | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | | + | | | | The value can only be **true**. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | No | Boolean | Specifies whether the default address pool is used. | + | | | | | + | | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0004__table24611730: @@ -90,8 +98,33 @@ Request Message | nexthop | No | String | Specifies the next-hop IP address of a route. | +-------------+-----------+--------+-----------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +Change the name of the subnet whose ID is 98bac90c-0ba7-4a63-8995-097da9bead1c to **subnet-test**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/subnets/98bac90c-0ba7-4a63-8995-097da9bead1c + { + "subnet": { + "name": "subnet-test" + } + } + +Change the name of the subnet whose ID is 98bac90c-0ba7-4a63-8995-097da9bead1c to **subnet-ipv6-test**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/subnets/011fc878-5521-4654-a1ad-f5b0b58203ac + { + "subnet": { + "name": "subnet-ipv6-test" + } + } + +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -105,65 +138,85 @@ Response Message .. table:: **Table 6** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+=================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | - | | | :ref:`Table 7 ` | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+=================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | + | | | | + | | | :ref:`Table 7 ` | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0004__table1777145918276: @@ -187,22 +240,8 @@ Response Message nexthop String Specifies the next-hop IP address of a route. =========== ====== ============================================= -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/subnets/98bac90c-0ba7-4a63-8995-097da9bead1c - - { - "subnet": { - "name": "subnet-test" - } - } - -Example response +Example Response +---------------- .. code-block:: @@ -230,6 +269,34 @@ Example response } } +.. code-block:: + + { + "subnet": { + "id": "011fc878-5521-4654-a1ad-f5b0b58203ac", + "name": "subnet-ipv6-test", + "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "ip_version": 6, + "cidr": "2001:db8:a583:a0::/64", + "subnetpool_id": "cb03d100-8687-4c0a-9441-ea568dcae47d", + "allocation_pools": [{ + "start": "2001:db8:a583:a0::2", + "end": "2001:db8:a583:a0:ffff:ffff:ffff:fffc" + }], + "gateway_ip": "2001:db8:a583:a0::1", + "enable_dhcp": true, + "ipv6_ra_mode": "dhcpv6-stateful", + "ipv6_address_mode": "dhcpv6-stateful", + "description": "", + "dns_nameservers": [], + "host_routes": [], + "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "created_at": "2021-07-01T07:59:28", + "updated_at": "2021-07-01T07:59:28" + } + } + Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst index e7bde08..5b117a4 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst @@ -61,8 +61,6 @@ Request Message +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | No | Boolean | Specifies whether this is the default subnet pool. | +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | No | Integer | Specifies the revision number of the subnet pool. | - +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Message ---------------- @@ -90,7 +88,7 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 and IPv6 | + | | | The value can be **4** (IPv4) or **6** (IPv6). | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | default_quota | Integer | Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, **default_quota** is measured in units of /32. For IPv6 subnet pools, **default_quota** is measured in units of /64. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -124,8 +122,6 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -173,7 +169,6 @@ Example response "192.168.0.0/16" ], "project_id": "9fadcee8aa7c40cdb2114fff7d569c08", - "revision_number": 1, "shared": false, "tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08", "created_at": "2018-09-20T02:15:34", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst index 1bdf6a6..31e2dbc 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst @@ -46,7 +46,7 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 and IPv6 | + | | | The value can be **4** (IPv4) or **6** (IPv6). | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | default_quota | Integer | Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, **default_quota** is measured in units of /32. For IPv6 subnet pools, **default_quota** is measured in units of /64. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -80,8 +80,6 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +120,6 @@ Example response "ip_version": 6, "shared": false, "description": "", - "revision_number": 2, "tags": [] } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst index d160051..eabce00 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst @@ -37,15 +37,15 @@ Response Message .. table:: **Table 1** Response parameter - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+======================================================================================+======================================================================================================================================================================================================================+ - | subnetpools | Array of :ref:`subnetpool ` objects | Specifies the subnet pool list. For details, see :ref:`Table 2 `. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnetpools_links | Array of :ref:`SecuritypoolsLink ` objects | Shows pagination information about subnet pools. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================+=================================================================================================================================================================================================================+ + | subnetpools | Array of :ref:`subnetpool ` objects | Specifies the subnet pool list. For details, see :ref:`Table 2 `. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpools_links | Array of :ref:`SubnetpoolsLink ` objects | Shows pagination information about subnet pools. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnetpools_0002__table149662441462: @@ -62,7 +62,7 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 and IPv6 | + | | | The value can be **4** (IPv4) or **6** (IPv6). | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | default_quota | Integer | Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, **default_quota** is measured in units of /32. For IPv6 subnet pools, **default_quota** is measured in units of /64. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -96,8 +96,6 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -146,7 +144,6 @@ Example response "ip_version": 6, "shared": false, "description": "", - "revision_number": 2, "created_at": "2018-09-20T02:15:34", "updated_at": "2018-09-20T02:15:34", "tags": [] @@ -169,7 +166,6 @@ Example response "ip_version": 4, "shared": false, "description": "", - "revision_number": 2, "created_at": "2018-09-20T02:15:34", "updated_at": "2018-09-20T02:15:34", "tags": [] diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst index a9a1b7e..16badef 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst @@ -61,8 +61,6 @@ Request Message +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | No | Boolean | Specifies whether this is the default subnet pool. | +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | No | Integer | Specifies the revision number of the subnet pool. | - +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Message ---------------- @@ -90,7 +88,7 @@ Response Message +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 and IPv6 | + | | | The value can be **4** (IPv4) or **6** (IPv6). | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | default_quota | Integer | Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, default_quota is measured in units of /32. For IPv6 subnet pools, default_quota is measured in units of /64. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -124,8 +122,6 @@ Response Message +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -175,7 +171,6 @@ Example response "id": "03f761e6-eee0-43fc-a921-8acf64c14988", "max_prefixlen": 64, "description": "", - "revision_number": 2, "created_at": "2018-09-20T02:15:34", "updated_at": "2018-09-20T02:15:34", "tags": [] diff --git a/api-ref/source/permissions_policies_and_supported_actions/elastic_ip.rst b/api-ref/source/permissions_policies_and_supported_actions/eip.rst similarity index 98% rename from api-ref/source/permissions_policies_and_supported_actions/elastic_ip.rst rename to api-ref/source/permissions_policies_and_supported_actions/eip.rst index 759bf1f..df742e1 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/elastic_ip.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/eip.rst @@ -2,8 +2,8 @@ .. _vpc_permission_0002: -Elastic IP -========== +EIP +=== +-----------------+-------------------------------------------------+----------------------+ | Permission | API | Action | diff --git a/api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst b/api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst new file mode 100644 index 0000000..3800010 --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst @@ -0,0 +1,30 @@ +:original_name: vpc_permission_0031.html + +.. _vpc_permission_0031: + +EIP V3 +====== + ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Permission | API | Action | ++=======================================+=========================================================================+====================================+ +| Querying all EIPs | GET /v3/{project_id}/eip/publicips | eip:publicIps:list | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Querying the details of an EIP | GET /v3/{project_id}/eip/publicips/{publicip_id} | eip:publicIps:get | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Updating an EIP | PUT /v3/{project_id}/eip/publicips/{publicip_id} | eip:publicIps:update | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Binding an EIP to an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance | eip:publicIps:associateInstance | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Unbinding an EIP from an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance | eip:publicIps:disassociateInstance | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Adding EIPs to a shared bandwidth | POST /v3/{project_id}/eip/publicips/attach-share-bandwidth | eip:publicIps:attachBandwidth | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Querying the number of available EIPs | POST /v3/{project_id}/eip/resources/available | eip:publicIps:count | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Querying common pools | GET /v3/{project_id}/eip/publicip-pools/common-pools | eip:publicipPools:list | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Querying EIP pools | GET /v3/{project_id}/eip/publicip-pools | eip:publicipPools:list | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Querying the details of an EIP pool | GET /v3/{project_id}/eip/publicip-pools/{publicip_pool_id} | eip:publicipPools:get | ++---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst b/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst index 07d236e..7ea2dbe 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst @@ -42,5 +42,5 @@ Firewall (OpenStack Neutron API) +--------------------------------+--------------------------------------------------------------------+------------------------------------+ | Updates a firewall group. | PUT /v2.0/fwaas/firewall_groups/{firewall_group_id} | vpc:firewallGroups:update | +--------------------------------+--------------------------------------------------------------------+------------------------------------+ -| Deletes a firewall group. | DELETE /v2.0/fwaas/firewall_groups/{firewall_group_id} | vpc:firewallGroups:delete | +| Deletes a firewall group | DELETE /v2.0/fwaas/firewall_groups/{firewall_group_id} | vpc:firewallGroups:delete | +--------------------------------+--------------------------------------------------------------------+------------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/index.rst b/api-ref/source/permissions_policies_and_supported_actions/index.rst index 6194ba3..0e1c66c 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/index.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/index.rst @@ -5,17 +5,23 @@ Permissions Policies and Supported Actions ========================================== +- :ref:`Introduction ` - :ref:`VPC ` - :ref:`Subnet ` -- :ref:`Elastic IP ` +- :ref:`EIP ` - :ref:`Bandwidth ` - :ref:`Bandwidth (V2.0) ` +- :ref:`EIP V3 ` - :ref:`VPC Peering Connection ` - :ref:`VPC Route ` - :ref:`Route Table ` - :ref:`Quota ` - :ref:`Private IP Address ` - :ref:`Security Group ` +- :ref:`Security Group Rule ` +- :ref:`VPC Tags ` +- :ref:`Subnet Tags ` +- :ref:`VPC Flow Log ` - :ref:`Port (OpenStack Neutron API) ` - :ref:`Network (OpenStack Neutron API) ` - :ref:`Subnet (OpenStack Neutron API) ` @@ -29,17 +35,23 @@ Permissions Policies and Supported Actions :maxdepth: 1 :hidden: + introduction vpc subnet - elastic_ip + eip bandwidth bandwidth_v2.0 + eip_v3 vpc_peering_connection vpc_route route_table quota private_ip_address security_group + security_group_rule + vpc_tags + subnet_tags + vpc_flow_log port_openstack_neutron_api network_openstack_neutron_api subnet_openstack_neutron_api diff --git a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst new file mode 100644 index 0000000..4db4af5 --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst @@ -0,0 +1,24 @@ +:original_name: permission_0001.html + +.. _permission_0001: + +Introduction +============ + +By default, new IAM users do not have permissions assigned. You need to add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups. This way, they can perform specified operations on cloud services based on the permissions. + +Each account has all the permissions required to call all APIs, but IAM users must be assigned 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. For example, if an IAM user wants to query VPCs using an API, the user must have been granted permissions that allow the **vpc:vpcs:list** action. + +Supported Actions +----------------- + +VPC 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: statements in a policy that allow or deny certain operations +- APIs: REST APIs that can be called by a user who has been granted specific permissions +- Actions: specific operations that are allowed or denied +- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be used and applied to IAM only. + + .. note:: + + Y: supported; x: not supported diff --git a/api-ref/source/permissions_policies_and_supported_actions/route_table.rst b/api-ref/source/permissions_policies_and_supported_actions/route_table.rst index 14c6790..53d1378 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/route_table.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/route_table.rst @@ -14,7 +14,7 @@ Route Table +-------------------------------------------+----------------------------------------------------------+---------------------------+ | Creating a Route Table | POST /v1/{project_id}/routetables | vpc:routeTables:create | +-------------------------------------------+----------------------------------------------------------+---------------------------+ -| Updating a Route Table | UPDATE /v1/{project_id}/routetables/{routetable_id} | vpc:routeTables:update | +| Updating a Route Table | PUT /v1/{project_id}/routetables/{routetable_id} | vpc:routeTables:update | +-------------------------------------------+----------------------------------------------------------+---------------------------+ | Associating Subnets with a Route Table | POST /v1/{project_id}/routetables/{routetable_id}/action | vpc:routeTables:associate | +-------------------------------------------+----------------------------------------------------------+---------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/security_group.rst b/api-ref/source/permissions_policies_and_supported_actions/security_group.rst index 24c7dc5..25bc355 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/security_group.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/security_group.rst @@ -5,12 +5,14 @@ Security Group ============== -+---------------------------+----------------------------------------------------------+---------------------------+ -| Permission | API | Action | -+===========================+==========================================================+===========================+ -| Creates a security group. | POST /v1/{project_id}/security-groups | vpc:securityGroups:create | -+---------------------------+----------------------------------------------------------+---------------------------+ -| Queries a security group. | GET /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:get | -+---------------------------+----------------------------------------------------------+---------------------------+ -| Queries security groups. | GET /v1/{project_id}/security-groups | vpc:securityGroups:get | -+---------------------------+----------------------------------------------------------+---------------------------+ ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Permission | API | Action | ++===========================+=============================================================+===========================+ +| Creates a security group. | POST /v1/{project_id}/security-groups | vpc:securityGroups:create | ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Queries a security group. | GET /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:get | ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Queries security groups. | GET /v1/{project_id}/security-groups | vpc:securityGroups:get | ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Deletes a security group. | DELETE /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:delete | ++---------------------------+-------------------------------------------------------------+---------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst b/api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst new file mode 100644 index 0000000..d1889bc --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst @@ -0,0 +1,20 @@ +:original_name: vpc_permission_0009.html + +.. _vpc_permission_0009: + +Security Group Rule +=================== + ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Permission | API | Action | ++================================+=========================================================================+===============================+ +| Creates a security group rule. | POST /v1/{project_id}/security-group-rules | vpc:securityGroupRules:create | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Queries a security group rule. | GET /v1/{project_id}/security-group-rules/{rules_security_groups_id} | vpc:securityGroupRules:get | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Queries security group rules. | GET /v1/{project_id}/security-group-rules | vpc:securityGroupRules:get | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Deletes a security group rule. | DELETE /v1/{project_id}/security-group-rules/{rules_security_groups_id} | vpc:securityGroupRules:delete | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Updates a security group rule. | ``-`` | vpc:securityGroupRules:update | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst b/api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst new file mode 100644 index 0000000..c30e21b --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst @@ -0,0 +1,24 @@ +:original_name: vpc_permission_0019.html + +.. _vpc_permission_0019: + +Subnet Tags +=========== + ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Permission | API | Action | ++=============================================+===========================================================+=======================+ +| Creating a Tag for a Subnet | POST /v2.0/{project_id}/subnets/{subnet_id}/tags | vpc:subnetTags:create | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Querying Subnet Tags | GET /v2.0/{project_id}/subnets/{subnet_id}/tags | vpc:subnetTags:get | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Deleting a Subnet Tag | DELETE /v2.0/{project_id}/subnets/{subnet_id}/tags/{key} | vpc:subnetTags:delete | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Batch Creating or Deleting Subnet Tags | POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action | vpc:subnetTags:create | +| | | | +| | | vpc:subnetTags:delete | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Querying Subnets by Tag | POST /v2.0/{project_id}/subnets/resource_instances/action | vpc:subnetTags:get | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Querying Subnet Tags in a Specified Project | GET /v2.0/{project_id}/subnets/tags | vpc:subnetTags:get | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/vpc_flow_log.rst b/api-ref/source/permissions_policies_and_supported_actions/vpc_flow_log.rst new file mode 100644 index 0000000..9197398 --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/vpc_flow_log.rst @@ -0,0 +1,20 @@ +:original_name: vpc_permission_0025.html + +.. _vpc_permission_0025: + +VPC Flow Log +============ + ++-------------------------+---------------------------------------------------+---------------------+ +| Permission | API | Action | ++=========================+===================================================+=====================+ +| Creating a VPC Flow Log | POST /v1/{project_id}/fl/flow_logs | vpc:flowLogs:create | ++-------------------------+---------------------------------------------------+---------------------+ +| Querying VPC Flow Logs | GET /v1/{project_id}/fl/flow_logs | vpc:flowLogs:get | ++-------------------------+---------------------------------------------------+---------------------+ +| Querying a VPC Flow Log | GET /v1/{project_id}/fl/flow_logs/{flowlog_id} | vpc:flowLogs:get | ++-------------------------+---------------------------------------------------+---------------------+ +| Updating a VPC Flow Log | PUT /v1/{project_id}/fl/flow_logs/{flowlog_id} | vpc:flowLogs:update | ++-------------------------+---------------------------------------------------+---------------------+ +| Deleting a Flow Log | DELETE /v1/{project_id}/fl/flow_logs/{flowlog_id} | vpc:flowLogs:delete | ++-------------------------+---------------------------------------------------+---------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst b/api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst new file mode 100644 index 0000000..1b6798d --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst @@ -0,0 +1,24 @@ +:original_name: vpc_permission_0021.html + +.. _vpc_permission_0021: + +VPC Tags +======== + ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Permission | API | Action | ++==========================================+========================================================+=======================+ +| Creating a Tag for a VPC | POST /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc:vpcTags:create | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Querying VPC Tags | GET /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc:vpcTags:get | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Deleting a VPC Tag | DELETE /v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} | vpc:vpcTags:delete | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Batch Creating or Deleting VPC Tags | POST /v2.0/{project_id}/vpcs/{vpc_id}/tags/action | vpc:vpcTags:create | +| | | | +| | | vpc:vpcTags:delete | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Querying VPCs by Tag | POST /v2.0/{project_id}/vpcs/resource_instances/action | vpc:vpcTags:get | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Querying VPC Tags in a Specified Project | GET /v2.0/{project_id}/vpcs/tags | vpc:vpcTags:get | ++------------------------------------------+--------------------------------------------------------+-----------------------+