From 9ce004360767cc48af6d35adb487f49980079db5 Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Thu, 19 Sep 2024 11:37:36 +0000 Subject: [PATCH] Update content --- .../_static/images/en-us_image_0218728478.jpg | Bin 0 -> 112824 bytes .../creating_an_acl_rule.rst | 426 ++++++++-------- ....rst => deleting_acl_rules_in_batches.rst} | 96 ++-- ..._acl_rule.rst => deleting_an_acl_rule.rst} | 69 +-- ...t => deleting_the_number_of_rule_hits.rst} | 76 +-- .../source/api/acl_rule_management/index.rst | 24 +- ... => obtaining_the_number_of_rule_hits.rst} | 109 ++-- .../querying_a_protection_rule.rst | 471 ++++++++---------- ...l_rule_tags.rst => querying_rule_tags.rst} | 89 ++-- ...the_priority_of_an_acl_protection_rule.rst | 92 ++-- .../updating_an_acl_rule.rst | 421 +++++++--------- .../updating_rule_actions_in_batches.rst | 72 +-- .../adding_an_address_group.rst} | 114 ++--- .../adding_an_address_group_member.rst} | 140 +++--- ...ting_address_group_members_in_batches.rst} | 76 +-- .../deleting_an_address_group.rst} | 89 ++-- .../deleting_an_address_group_member.rst | 137 +++++ .../api/address_group_management/index.rst | 30 ++ .../querying_address_group_details.rst} | 128 +++-- .../querying_address_group_members.rst | 176 +++++++ .../querying_the_address_group_list.rst} | 193 ++++--- .../updating_address_group_information.rst} | 94 ++-- .../api/address_set_management/index.rst | 30 -- .../querying_address_set_details.rst | 156 ------ .../querying_address_set_members.rst | 180 ------- .../querying_ip_address_sets.rst | 194 -------- ...creating_a_blacklist_or_whitelist_rule.rst | 167 ------- ...reating_a_blacklist_or_whitelist_rule.rst} | 177 ++++--- ...deleting_a_blacklist_or_whitelist_rule.rst | 85 ++-- .../index.rst | 8 +- .../querying_a_blacklist_or_whitelist.rst | 185 +++++++ .../updating_a_blacklist_or_whitelist.rst} | 140 +++--- .../cancel_capture_task.rst | 120 ----- .../create_capture_task.rst | 178 ------- .../delete_capture_task.rst | 120 ----- .../source/api/capture_management/index.rst | 22 - .../adding_a_domain_name_group.rst} | 112 ++--- .../adding_a_domain_name_list.rst} | 103 ++-- .../deleting_a_domain_name_group.rst} | 75 +-- .../deleting_a_domain_name_list.rst} | 140 +++--- .../index.rst | 32 ++ ...main_name_list_in_a_domain_name_group.rst} | 108 ++-- ..._ip_address_for_domain_name_resolution.rst | 125 +++++ .../querying_the_dns_server_list.rst | 135 +++++ .../querying_the_domain_name_group_list.rst} | 130 ++--- .../updating_a_domain_name_group.rst} | 85 ++-- .../updating_the_dns_server_list.rst | 100 ++-- .../delete_domains.rst | 122 ----- .../index.rst | 32 -- ..._ip_address_for_domain_name_resolution.rst | 124 ----- ... enabling_or_disabling_eip_protection.rst} | 175 +++---- api-ref/source/api/eip_management/index.rst | 4 +- .../eip_management/querying_the_eip_list.rst | 224 ++++----- .../querying_the_number_of_eips.rst | 98 ++-- ...e_east-west_firewall_protection_status.rst | 100 ++-- .../firewall_management/create_firewall.rst | 254 ---------- .../api/firewall_management/create_tags.rst | 96 ---- .../creating_a_firewall.rst | 329 ++++++++++++ .../firewall_management/creating_a_tag.rst | 104 ++++ ...rst => creating_an_east-west_firewall.rst} | 124 ++--- .../api/firewall_management/delete_tags.rst | 97 ---- ...l_instance.rst => deleting_a_firewall.rst} | 50 +- .../firewall_management/deleting_a_tag.rst | 105 ++++ .../source/api/firewall_management/index.rst | 40 +- .../list_firewall_detail.rst | 414 --------------- .../firewall_management/list_job_status.rst | 117 ----- ...taining_east-west_firewall_information.rst | 285 ++++++----- .../obtaining_the_status_of_a_cfw_task.rst | 119 +++++ .../querying_firewall_details.rst | 360 +++++++++++++ ...lls.rst => querying_the_firewall_list.rst} | 232 ++++----- .../querying_the_number_of_protected_vpcs.rst | 116 ++--- api-ref/source/api/index.rst | 22 +- ...st => changing_the_ips_feature_status.rst} | 128 ++--- .../changing_the_protection_mode.rst} | 116 +++-- ...enabling_or_disabling_virtual_patching.rst | 138 ----- api-ref/source/api/ips_management/index.rst | 18 +- .../querying_a_protection_mode.rst | 125 +++++ .../querying_the_ips_switch_status.rst | 116 ----- ...uerying_the_status_of_the_ips_feature.rst} | 136 ++--- .../api/log_management/add_log_config.rst | 127 ----- .../adding_log_configurations.rst | 127 +++++ api-ref/source/api/log_management/index.rst | 12 +- .../obtaining_log_configurations.rst | 127 +++++ .../querying_access_control_logs.rst | 294 ++++++----- .../log_management/querying_attack_logs.rst | 372 +++++++------- .../api/log_management/querying_flow_logs.rst | 308 ++++++------ .../api/log_management/update_log_config.rst | 127 ----- .../updating_log_configurations.rst | 127 +++++ .../canceling_a_packet_capture_task.rst | 120 +++++ .../creating_a_packet_capture_task.rst | 175 +++++++ ...leting_packet_capture_tasks_in_batches.rst | 120 +++++ .../api/packet_capture_management/index.rst | 22 + .../obtaining_packet_capture_task_results.rst | 144 ++++++ .../querying_a_packet_capture_task.rst} | 174 +++---- .../adding_service_group_members.rst} | 125 +++-- .../creating_a_service_group.rst} | 110 ++-- .../deleting_a_service_group.rst | 136 +++++ .../deleting_a_service_group_member.rst} | 87 ++-- ...ting_service_group_members_in_batches.rst} | 98 ++-- .../api/service_group_management/index.rst | 30 ++ .../modifying_a_service_group.rst | 149 ++++++ .../obtaining_the_service_group_list.rst} | 153 +++--- .../querying_service_group_details.rst} | 111 +++-- ...uerying_the_service_group_member_list.rst} | 168 ++++--- .../api/service_set_management/index.rst | 30 -- .../modifying_a_service_set.rst | 157 ------ .../querying_service_set_details.rst | 157 ------ api-ref/source/appendix/index.rst | 12 + .../appendix/obtaining_a_firewall_id.rst | 13 + .../appendix/obtaining_a_project_id.rst | 23 + .../appendix/obtaining_a_user_token.rst | 11 + ..._project_region_and_agency_information.rst | 27 + .../obtaining_an_enterprise_project_id.rst | 15 + .../source/appendix/region_information.rst | 225 +++++++++ api-ref/source/change_history.rst | 12 + api-ref/source/conf.py | 2 +- 116 files changed, 7457 insertions(+), 7319 deletions(-) create mode 100644 api-ref/source/_static/images/en-us_image_0218728478.jpg rename api-ref/source/api/acl_rule_management/{batch_delete_acl_rules.rst => deleting_acl_rules_in_batches.rst} (67%) rename api-ref/source/api/acl_rule_management/{delete_acl_rule.rst => deleting_an_acl_rule.rst} (54%) rename api-ref/source/api/acl_rule_management/{deleting_the_rule_hit_count.rst => deleting_the_number_of_rule_hits.rst} (52%) rename api-ref/source/api/acl_rule_management/{obtaining_the_rule_hit_count.rst => obtaining_the_number_of_rule_hits.rst} (65%) rename api-ref/source/api/acl_rule_management/{list_acl_rule_tags.rst => querying_rule_tags.rst} (56%) rename api-ref/source/api/{address_set_management/adding_an_address_set.rst => address_group_management/adding_an_address_group.rst} (64%) rename api-ref/source/api/{address_set_management/adding_an_address_set_member.rst => address_group_management/adding_an_address_group_member.rst} (52%) rename api-ref/source/api/{address_set_management/batch_delete_address_items.rst => address_group_management/deleting_address_group_members_in_batches.rst} (53%) rename api-ref/source/api/{address_set_management/deleting_an_address_set.rst => address_group_management/deleting_an_address_group.rst} (50%) create mode 100644 api-ref/source/api/address_group_management/deleting_an_address_group_member.rst create mode 100644 api-ref/source/api/address_group_management/index.rst rename api-ref/source/api/{ips_management/querying_the_protection_mode.rst => address_group_management/querying_address_group_details.rst} (54%) create mode 100644 api-ref/source/api/address_group_management/querying_address_group_members.rst rename api-ref/source/api/{blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst => address_group_management/querying_the_address_group_list.rst} (63%) rename api-ref/source/api/{address_set_management/updating_address_set_information.rst => address_group_management/updating_address_group_information.rst} (53%) delete mode 100644 api-ref/source/api/address_set_management/index.rst delete mode 100644 api-ref/source/api/address_set_management/querying_address_set_details.rst delete mode 100644 api-ref/source/api/address_set_management/querying_address_set_members.rst delete mode 100644 api-ref/source/api/address_set_management/querying_ip_address_sets.rst delete mode 100644 api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst rename api-ref/source/api/{log_management/list_log_config.rst => blacklist_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst} (60%) rename api-ref/source/api/{blacklist_and_whitelist_management => blacklist_whitelist_management}/deleting_a_blacklist_or_whitelist_rule.rst (50%) rename api-ref/source/api/{blacklist_and_whitelist_management => blacklist_whitelist_management}/index.rst (70%) create mode 100644 api-ref/source/api/blacklist_whitelist_management/querying_a_blacklist_or_whitelist.rst rename api-ref/source/api/{blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst => blacklist_whitelist_management/updating_a_blacklist_or_whitelist.rst} (51%) delete mode 100644 api-ref/source/api/capture_management/cancel_capture_task.rst delete mode 100644 api-ref/source/api/capture_management/create_capture_task.rst delete mode 100644 api-ref/source/api/capture_management/delete_capture_task.rst delete mode 100644 api-ref/source/api/capture_management/index.rst rename api-ref/source/api/{domain_parse_and_domain_set_management/add_domain_set.rst => domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_group.rst} (73%) rename api-ref/source/api/{domain_parse_and_domain_set_management/add_domains.rst => domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_list.rst} (71%) rename api-ref/source/api/{domain_parse_and_domain_set_management/delete_domain_set.rst => domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_group.rst} (54%) rename api-ref/source/api/{domain_parse_and_domain_set_management/querying_the_dns_server_list.rst => domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_list.rst} (53%) create mode 100644 api-ref/source/api/domain_name_resolution_and_domain_name_group_management/index.rst rename api-ref/source/api/{domain_parse_and_domain_set_management/list_domains.rst => domain_name_resolution_and_domain_name_group_management/obtaining_the_domain_name_list_in_a_domain_name_group.rst} (70%) create mode 100644 api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_an_ip_address_for_domain_name_resolution.rst create mode 100644 api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_the_dns_server_list.rst rename api-ref/source/api/{domain_parse_and_domain_set_management/list_domain_sets.rst => domain_name_resolution_and_domain_name_group_management/querying_the_domain_name_group_list.rst} (71%) rename api-ref/source/api/{domain_parse_and_domain_set_management/update_domain_set.rst => domain_name_resolution_and_domain_name_group_management/updating_a_domain_name_group.rst} (53%) rename api-ref/source/api/{domain_parse_and_domain_set_management => domain_name_resolution_and_domain_name_group_management}/updating_the_dns_server_list.rst (70%) delete mode 100644 api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst delete mode 100644 api-ref/source/api/domain_parse_and_domain_set_management/index.rst delete mode 100644 api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst rename api-ref/source/api/eip_management/{enabling_or_disabling_an_eip.rst => enabling_or_disabling_eip_protection.rst} (59%) delete mode 100644 api-ref/source/api/firewall_management/create_firewall.rst delete mode 100644 api-ref/source/api/firewall_management/create_tags.rst create mode 100644 api-ref/source/api/firewall_management/creating_a_firewall.rst create mode 100644 api-ref/source/api/firewall_management/creating_a_tag.rst rename api-ref/source/api/firewall_management/{create_east_west_firewall.rst => creating_an_east-west_firewall.rst} (62%) delete mode 100644 api-ref/source/api/firewall_management/delete_tags.rst rename api-ref/source/api/firewall_management/{delete_firewall_instance.rst => deleting_a_firewall.rst} (51%) create mode 100644 api-ref/source/api/firewall_management/deleting_a_tag.rst delete mode 100644 api-ref/source/api/firewall_management/list_firewall_detail.rst delete mode 100644 api-ref/source/api/firewall_management/list_job_status.rst create mode 100644 api-ref/source/api/firewall_management/obtaining_the_status_of_a_cfw_task.rst create mode 100644 api-ref/source/api/firewall_management/querying_firewall_details.rst rename api-ref/source/api/firewall_management/{list_firewalls.rst => querying_the_firewall_list.rst} (58%) rename api-ref/source/api/ips_management/{switching_the_protection_mode.rst => changing_the_ips_feature_status.rst} (58%) rename api-ref/source/api/{address_set_management/deleting_an_address_set_member.rst => ips_management/changing_the_protection_mode.rst} (52%) delete mode 100644 api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst create mode 100644 api-ref/source/api/ips_management/querying_a_protection_mode.rst delete mode 100644 api-ref/source/api/ips_management/querying_the_ips_switch_status.rst rename api-ref/source/api/{capture_management/list_capture_task_result.rst => ips_management/querying_the_status_of_the_ips_feature.rst} (57%) delete mode 100644 api-ref/source/api/log_management/add_log_config.rst create mode 100644 api-ref/source/api/log_management/adding_log_configurations.rst create mode 100644 api-ref/source/api/log_management/obtaining_log_configurations.rst delete mode 100644 api-ref/source/api/log_management/update_log_config.rst create mode 100644 api-ref/source/api/log_management/updating_log_configurations.rst create mode 100644 api-ref/source/api/packet_capture_management/canceling_a_packet_capture_task.rst create mode 100644 api-ref/source/api/packet_capture_management/creating_a_packet_capture_task.rst create mode 100644 api-ref/source/api/packet_capture_management/deleting_packet_capture_tasks_in_batches.rst create mode 100644 api-ref/source/api/packet_capture_management/index.rst create mode 100644 api-ref/source/api/packet_capture_management/obtaining_packet_capture_task_results.rst rename api-ref/source/api/{capture_management/list_capture_task.rst => packet_capture_management/querying_a_packet_capture_task.rst} (73%) rename api-ref/source/api/{service_set_management/creating_a_service_member.rst => service_group_management/adding_service_group_members.rst} (64%) rename api-ref/source/api/{service_set_management/creating_a_service_set.rst => service_group_management/creating_a_service_group.rst} (61%) create mode 100644 api-ref/source/api/service_group_management/deleting_a_service_group.rst rename api-ref/source/api/{service_set_management/deleting_a_service_member.rst => service_group_management/deleting_a_service_group_member.rst} (54%) rename api-ref/source/api/{service_set_management/batch_delete_service_items.rst => service_group_management/deleting_service_group_members_in_batches.rst} (50%) create mode 100644 api-ref/source/api/service_group_management/index.rst create mode 100644 api-ref/source/api/service_group_management/modifying_a_service_group.rst rename api-ref/source/api/{service_set_management/obtaining_the_service_set_list.rst => service_group_management/obtaining_the_service_group_list.rst} (66%) rename api-ref/source/api/{service_set_management/deleting_a_service_set.rst => service_group_management/querying_service_group_details.rst} (50%) rename api-ref/source/api/{service_set_management/querying_the_service_set_member_list.rst => service_group_management/querying_the_service_group_member_list.rst} (53%) delete mode 100644 api-ref/source/api/service_set_management/index.rst delete mode 100644 api-ref/source/api/service_set_management/modifying_a_service_set.rst delete mode 100644 api-ref/source/api/service_set_management/querying_service_set_details.rst create mode 100644 api-ref/source/appendix/obtaining_a_firewall_id.rst create mode 100644 api-ref/source/appendix/obtaining_a_project_id.rst create mode 100644 api-ref/source/appendix/obtaining_a_user_token.rst create mode 100644 api-ref/source/appendix/obtaining_account_iam_user_group_project_region_and_agency_information.rst create mode 100644 api-ref/source/appendix/obtaining_an_enterprise_project_id.rst create mode 100644 api-ref/source/appendix/region_information.rst diff --git a/api-ref/source/_static/images/en-us_image_0218728478.jpg b/api-ref/source/_static/images/en-us_image_0218728478.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b0e263d9b79bf2d87a08575ce6509555ca60d44c GIT binary patch literal 112824 zcmeFZ2UJttn=c#$1W`n!cj?lV-it~J2uSZlL~4LY?*vdpx^(GMLJvJeYNSh-4xx8x zp?3%$?|c19UNTTJGb+{CE&KT|LuJM z9x47~=I07`$+Rp8Se(fPgJQD@SzlDPP-qYBu?f9%3BE@}NkvUV%g(|1l#5$fL{v;% zLh|J+MI~hwpsJ3pp1y&hk+J1_D{C8DJ9}3*cMnf5Z=a8!LOzFn2@8*lPe@Ek{+5!O zlbZ+2FDNW3uBxs<)FOY>)wi~_cXW3B>h2jH866v+n4Cf{E-kODuC4#s*xWxjJUTu( zJv+bni!K}h?mvavblpA#oIAJ6f=BQdT{w3<)0BCv2KV-XA@ zB!3Z`UD38d0pITg5&`}`{il5dGA|dCgBz)eu4Koq%$E5yb*qpS4U~U)GjLq=RB(*w zc-7vz$Xr<06_2G`XXDo$(5$(pSRB$C(&Mpmia>oX>@V_bevj`B1_jV>p-2$()bg1; z;l%7yuSt9%&1Qx0(U(D|O`DwhrPkT`s0r6lhD;l3>DK7G=Kb|a6G{38j!@YK3Wr9T zy$SO(*K)7WHgxEhccVvXuDnSG)vYfwyH+EebOxV9r!S?I=nHAZ>06JvMy?a2Xtge7 z6A(rBXlY+t9?Pp$XXg@>4d9k`*O-F?gm0O zH=V3A3JZxB6cTyIm4{w4=4L^CgwV zeW=Q}nR4WvDa2nM4htzVQp)3`VIRMy>K6)z59Ucq&EtAi^|q-kslgvF@iFH_Yq_az zb1~zPm>w8GCHwV0CUg5_n(^-97*HIm=xM;vwaEG=?3PeEoaD`)MzsYf#Ti6BLTf_U zB!Uk3o|LVMqD=xna3QltbJ3`^lw*g|+v~P-bn%A8W)YBQ3gn2=$++$Mw{HBup&N0B z{rJ9b9QZx^XkvC>VN~Rvh&Mdr*ijGu=vAfCPl1b9^68bw(i6gK*9CmD@FD0=o9^Yx z-e}GQ$2T~FG3wimQS*1thCFQhmDk}Yp`hZWh^60f?tWYEu~6tUXvQN0lGd8}Sgn`VSY=XQWAE)OUD{_r-)x^yy`n95K6UyyGfehiGL>cM)@ zzD#wQl)i1#; z)ptA_9jHayf|Bm1V@giq5_EG9E9b8ZB0Jw!oTW?om0ewh^8;ay9Nh z1;|AXd3nAW;kO(vvp%4_U-Z)}GVI`)*YpG2M+$hKsr$tweEHuWiuBWZ zVUnT;_3U`^$2ZYJ*?Y-B!iEJy!f;O|;IUeSzXoPO)0s_0`;k6{gX9j~P@07K^Z4)q zcUVcp$jjb7p_$jY#wV2L0!f^LWWbqSNhSIn2 zNzHhwnoXh#dbo!_%}IiKE|-9Fyx7%QwSRXSi!&C}HQqLqzoB2Ws~c&OC=9bf@%pEt zuy^|JYu>fxTVjxvf$$7KG)KW-T4$C8$~r!f zu(uJ1g%&RAP3c9F*BQuU)Ri-uUHT^bf8pHo2p$jf7L9>Gq?_qRA?8v%U716ip|U2* zPh(FXNm$MObWXP+A2Twa*o*!dq~v%K9Q`B~O`^c90hCaZHoC2PdNGp1E?2oMhTf8^Gk!~+1RAr90b-r> z;e_&PNqcMYKX2NXDfGv<<4oboi5({Db>(GOozO3C3{tQ60>V6P7Uv(nJ~fs@JCzBD zcto%F%`ALdx>R*qR01gB?GLIJ_V=iZp6=WL02?jKCGVamW@{r9du4TV@s`1StJ|~4 z@dJG`B-d8=cY)Sf0aN5&W}+js(A*T=7(3|US4sV%G$^0dv(NRbGD6q8DL3lKJZlB= zDT!|l@$9f2*h(4+w*~voN-0R$4G;DmZq8hM_$Ox{xB1L_-=v+9aBpWI6lP=>KW%C% zjhT4fAa1Sr0>=QCT48#;q9im5=qj{U9ZlJ4J^5{kM^#k|XggNpc&u4BbH%1FR}G4J zmWMqs|2Ry2XsC~s*34L&D^2Ed*kX)y>FpO{c#a9C;SHfW;~cIU zZVY-!BrT_!`iTK}Yw-jlRuPzal_DuIUsHIQSKk&HY7G^ zofLGS|NKO%GpskqXR^pPN zG3HrJEsKgoq|?G4fy6Id;igai^Q=$zFprrGsy%b}nnaFA4k{y-Wwg5t_bEECX$1-e z#y=EQm_y!aA>=vj_XL%EGMnr-Iyyxijs#~!O!;Yrx72TKeeE3Pvbp10u8Vdy<}+p>sQiIRJ|{Uf#Z%eQ4p&XJd+^;#}2=k#M$uSHCC_q9>NxxY>j&9@4&jTw zVHsZy`@IAFc`2G80y5 zxKx29zK!#b4b+WJ>^9$R&9ROimy<%BW*fn7G!Ndfp<}rLq`DqN09+Kq<}yC@K`!cE z@|)JhW;i}(%Xf436w;qTyxx8taN0%CG2xNwFk#(a+ILq1kAvey=`;FgoUV*?MTNR7 z*}q~0vmPvRy$#5{2UJc=JvFGeD@*!Q?_h1>Raa_!dC4O`>^6!TS*^%m7JEnpjI20h ze@AT@?L7EoOwtoEyX`*6rB^3|Fw%@uRlO?F8<`Cs*+1m7gFX@gQ@c&7N2j?`e9m$% z;C>xPB6=^3pT4AMkP~0!%1)ANeo%+@{4Qg45x*U$gp!X5P#J6{mw^$u;$_g_k=wpx z5K^lc>4@r2Ma#z}Xo>tW_{us^f8E{)?83i@fx(Ac$JmAvE} z&Axz?ea?2;fKqf~qrTLf$pHi2GndG$AJ+4e~dDg)9&p)?`^;b*phs%Udn28az zjaqRP>BfIr9azR3AP-_hYK&bCVg5_|g?5yZ0lAA!v^(3p*e*wx9ha({JMHvrE%)%l zR_%&C91Bnd=M3akF_y;ecKYewt9=u7;Eg%rBaDsN)@iaVMdjW~tUMoY8T*f@G0ktr z^4UQWow8cd_}anRE|NtHTq7NWlxb^mz>}(`dhb)_ea52e>e9g?sEyr)X9n_`wv~w+ zuQlY{fRmh+fu4M_a3ucZGF;t^RR7@zXY~^J_*TF9MP^p+)rSeUD4H5avDW6twIh?y zeBG+kEHTuMKYI_~e{eM&Ztc|AX~<#@TS({UKqBGhxmf|W^XhQSAMf2S$A*Zgmpjh3 z7fuPH_|FVk^WLvyOnO*m`qF<8FZ7o|VH=xv8^iyHD*V5# z>fav4|BDQUbHN9ah4TI_Jb(Mle}@hK963D(bUz`{k#`d7kHPwIuFIc;-X2=s05ZdF z0RC_2%PTS+K!-zeyV>&RR+A5g9#$1xA3c3&bKkKUt^0znhjK}1-gGhSo4hI5;k5QAc(6*^UrqQstF>%C=LR75-dm#}*H8bqGzn9?&hq7DT1OZ^ z#;sf7Sso-BWF0F*?EP=jDN$S1`nrLr>vByy}y5pzj9?eZ60hY~t zUZ-Z`(qen3dV831&s@)AoPq{g8Cr2SW@pD!}dyIY%v#D(x^M=(kr;DX;Ne?WUv?t9UJB z!p9E}6m+ zgfNMc#hUC^ZOYmBhxWfZ59+dP!}-&i!A&H>P8lT_P1m+~=%+zPs;){TJ=9z;RxpeF zbt*u&;ggS8OoNLljlUl%hjFdWDdp98xmyMjZsIWbPEbfZ?b$KC+U4nZ)4G(a-y~;8 z;oEUMR4$WQFqp|uc@|UZr#0^P07WLE0(u>kFQ)AL*dmvDx*_H`v#F$6Bf+ld027cF z36EcNDK?5|Q7mdOQ5V~S@OLK1l=~UZQMPZtIwjycpNomty_x(>XemR*?^RkmmBmi;pyz`u5#;Vy!C;#D&xJ9(n;kBb3oX6)-_{N7K{~p* zyXJg;=3CWMj+SJK`{faS?geL%7Dn>1vTT&e`yUe`aVs@1rOSNce_g~;1rnPUy-0J7 zJ5tUL>#m?te63^=m7mT(ChmENtu;Q81VzlT?lUAcEuub~KN>9v)gEQlaV}JyUNbz< zeGUP|PJLMqibiBmD;8*jUwKPQCBNNV+^1=lyw^&M=27%NInS&2d=4p>2Je0B^r797 zAtl?{}ddNvnUqg4P9sJ=wA8 z+1{*-gugy`MdFr+=jW}=meup{$$HA%0NN$nB}qac?!Dg!84`0%1wZ!gm@fFncP*Qe z#t0{9ooABV0dC%!V_22)C?lYp!R#6-5Q7>ROAI8^k2HS8Kh%O|W)#-_@d=P9l%moG^^VHq1o zjW6XVh!3Y{zfCIH5Pb?g_rdLA5F{qI({ZOY&VElLt79Tou8~+gys9BKKH&?VK9CLZ zj-ylhkr3_y_aF?a5p5Tog~sg68VL<(b9J@ieuarKdLGFElnVC z=wxsDoxI9HzMowbvvM|}HKtC3BhFh~i(iIYN85_W*vdI}Hee%LzI>u%aklf18ns;a z8agkODt-37;@jRT39vX;Jv$U7i=9=C&0L5+XG^5!js;t5aE9&)ADS}wkT%hx51MLG zGb7Xa1?tx*IJE8A4FGZju$#F7*xvwbytBY_e*JS!LRqHzez6x_d^OTBg%+ssm=YHO zn|>$rq{{VX_I*gi{9;y{x1+RL;k5Z?wONO&OI613J9j<4tw6AsPH0WWc-P26RcVv8 z*V#a%sa>HkJm=KJ<5-ed$M7s@FQ&czrB_UQZhJG+=-Pp`cRa~GJSSGRuksS~Uq84I z+|5?X@M_kxjuHJ#!nO38PcI~QyF|gv#AbS;c0w67fph-t)|^tfMdc zed)%o8=K|C)nS&$VVox@Rq}<;ac*f%H=K>e#xn3Jt$G7%qAwiU{(dl5?K;hZ(wOEw zD0MYdLrUO${rgCAyb)yj0*ex)ugl0qLbooi!lX$HXRdQD)yJ)4MOZ%!muf#}wZO%Y zT}ceyNelmQ+YhzIgOKwrLbw-s)9yqkuV5}sb%1M5or3~4)LjzuTj;82cv;U4AS%L# z?P}*t?1DH(|H~#iDxv3Vhb5kl^zIX)m%9V5zlk$k=MneHlsShGr%zF%BI|F=w4uJ> zBet4xw}@Ucs9o{oj4=VBP52_MOnVUWgZO|7^(nd9tifA^$E!DIq4M91zq$7dDtLA9 zshVXUPSQX6Cik46B0t{gmw|qrlzqMNW&}(WW?lc0{}>@um{4B$dYzup8R$EKRA>^T zuAhrU$8AKEOo|+0rXBco`W^E=h75Rd|Jm^>*K^L*%>QZ#F6;0#F8VMx-Y5Z z!)HCljr8bTqz`5BAI9iDGQ(lEQMQp0y-M(}NuKG5Pl7z8Uy0VA#J(6agM!As$uMLc zUzAKd+&bd)TRyy?aWXrQ9aFQ=!?Sj)CyN?eiYi|qg9aNH?z!oa02 z`wCq>%3rsg^j?V*&ya8~Y%C`AHt{t)9U9*m) z3yM*eYT(X;(#bf{bl!-ABsv2EXYq|LK&EpzYe@iTPp;p8>xT^AwdV~$pyheKKwg~X{4nsU>*~YlIowj7THBamj7cu6H!p#0R(5kF7a7g7IaZ?4?q7L) z9_KBLR3qBppY3R4rq@O-5ByM-vuO^Pfh!hKOuGM-WoANBMP$SLUOWia0rl=epvbc} z1(%ISO5tli#zgo;dkEK`g)#2DSf@dER8ZUirq;KB!o!EC1@sLdbQ@DoVdJ@qRlCA& z$>uWeQ$~q>p;L%>gY;K;Yt*O49ba=GJ^<{JdqLu?8}E65MLo=`O%}+UpE#}-hNV(h zuJzJ;Z`1|$Ge?kD_P}yt>2ZVgs^!ZhgZ?GRv^Xo!YDQ*usgFDWdirgb@P1?w(Ta1P zIn-0<0v1$_rgSTbJ;xwO$fxZ+E*?zi1Npi+cn+E7-bm2-IGtShtkr~n!VFJ;&zlk3 zy1r%JT4{m8xfxAp{-!#8vc4d9O=aXgiq8sNmRjso6i;se`i#YX|%LDsv_oz(s35S`<+Qib+&*luz$!+qA~c8?+BT621Y{y1_gvfXgF8HH znL@2L&eV8E8%ohT4k$QqjJ+S$d(YQ;UxC}~=g2>yEow8x&gfqeFAD;`YA=yaAm_&@un4f0u#yFB{WK+_+ zy7sejV$#m*wAkQ;`@hpOniOW_yM*KQQNAYY(1Veo6NW4?f#Z>@NB$MbO zNY^d*Ir*bAJh5pUr?PA|ESYmr`SbhT4r#$SmQ*p;LjAjeZ2wP!?W8dfva@wv+UWAd z4563t$|D$#z?a^e z`Cawc;v2PBV+8A)j+3Iqz#ayY*K~Rx&Gwp-s_o0Zf=s$3d16vt0zUYk7pF_GEe$?y zru8y?{YTTQHmg^@5a5)+oSpcRPGI)RmX`H<_TKgK(f1SwH3j@MuE)Z$EAEQa-Ijse zCTgzSVYP9*imnhL$8fJa2OFY=RA516diK-JAwIzufm~Z;y%5{D7t@9_KR+!nCBhUf z&Vm(n^(IqX@~lDOi2G4IFMc#5qS#UegY;US#QpSO9Z%O=r#`&_FpIsP3Mv3+vNw&a zH9htUzzd9(RA1+5ResZka1h0 zPXJ|AJ!a~XY%U}ZgUmZyavV*Q`lLbCA9bIY<3xIP@gmph0~N(fy7_l-hs37DPFWb_ zbfOg=Pzipo|5|~=`nKS~PoL#aoHX0ELz@i(-EyPq2Mt21Ut4eSX0USe+Kk*;5DS5= zC2z40*|f0Jws=YU>=pLOa81Gl=fsn`H>7i;)5W=;u@n}A0W!`e#@wb+-ZUKR58VrN zDs<`;It7KoyZ@M)4ZjP zW=Kmr`o}-m(xWApy)0m~jf0kds<5P;7OtpLU7&VkdR-a97?F=f$#_VVht1K}4@r~k zm9(Kh0`Z69wg#r#+J}3|VzCFiU8DL5#atRL%JA5=Hyz8>yn1|=w$s(Ck;yaLzM#Nn z(lcNs1?EqJ%(uSXrZn7 z_7Cbi7q+gT8nIA*KdxmXz8$4mGNXDkB|O|!;AeeB#`M~N$XtZo=hSqOSzDhOrf)Bw z|126jt4U@(jNZU9`S=f(mGsCxlIC1QU1flx7{Nr0LdLw&0jP`uAHMsr8@>_#Zl=AWhv}<%V#K1Q;M?Zf!^X++ab;Y$Veu6%g3shzi<=s`aW9tw$ouxsVWx_N zoHQ=ey0zhEAU7ARv@8)*P3V`Hm{(DG=cJCeQ|v!rp2n81Z8V^33U*|IPkb{wb*^Dp z_#13LmVMr_4(5Nf?Iz3CaOTPRQ-FHvO8QW-MjPGhR>rY7=k-$}J~M23xH`CKCuft< zoG1yx_@s5TUzQ^;xveS!3(`p(a_imw?4$V+%lQXo`=g>MP_gudM!+Sbcqb0PQig_# zZJnYtuS7!I_edsPgCoh`gd%>4w}8q^PVu~~X~aLeZD}BzF>3#1OBThBUb&wfUws?f z5dTi#F5czixHy7hQX{Pxk=yQ>R3yK>O3SI@24_pt?BtTS82nPX{PgxYQue_ebCi1p zpV*SH)EM=S)vmZ-mD%Wf=YisSGn#d8Bnp%sezKCtpm}Hp`n>0r?j+$-3#V|y9Pjwg z!Ve)Y>AEDJPXq|~saL<6<@I5%i-^n^@=x58`K2vKTko<8BUs1U1QiPBKv_j-ZR(+_2tbRwVc zM8}3msNDeWq(gi6Woz~^F`}rwUHu_=g%f`%12f(N)pR1wMUc6kgiF6@09V4&^2a_q zgUq2g$nXW0AmU2k43XpYa#8x?ZmAVw;wYv@5kK#%gph=_6<$zCo9IK8PM)e-Mm=s< zzLe9cU7~lc(o^qjjdkr^kUVgTxPW?|64SP`-jcIq^E1B144V$p7K+(97~9uUE$SP9 z>uScQU`Lj>dw*xP36yf-=rBmzhr-O?0gQKoj2J!b=-2D5(b4c;_rtHpMg}z z@{HoG!PHX}^OXBj;z=*HuiWaP_Ax`Nx{YwS#qQS$NWr zJU^j|32BC9>$KNRh$io4S+yU@Pm6UO2`&SJy_oAKlvv_RM;D8Z)3xH3gf{Sb+)dzTX_2e>WDBBmuN3s)o zNV-ZpF$r{9P0|46tekA76)7%|Q;%Z8WNB^ypPgjM!~~&EgtEOSATHE;nJ1=m#&NyO zwUg`e-eo|*=d8^&v1_Y~T>(sazi-*JiSJCwK4lMx_)6wX^I-vf(k_JUlq|PsCMYlb z1>x3Lx&mXjEa^?d2@W{Dhh<7n1WGX6+(SF&kHeMWzEajc6tuVdNt%ISYz6FMU0-Kw zL@6S!?M>4f+#V+b=vSn5`eeHHVGnC$^7+H@{^Uu{&iiuTrW*hi*l*WzL-H`D`!Aa` zxG#1U;Ztz!-FpN0PFv`wqG|ae&x+|0OLIs-S$6XFZVL^Q+o-NbR8RCeRl!+=HgW{+ zaP%?1CkYKgTMJ^|5yjU9=uA*AOqjh&hjDqT?IJf_bv(k&rmv=4+mJ(>&BDkgKD@XL zW}~a>SUL<1g9eG5xxKeHtH}BV%S>IJ!1_fhBge2((Gr~eHL?}W;|o7P+(%j*9& z7u6Q}*m>*ZTQY^4XBCUYpFTbWB}A$#%O?$Q8LO$OD;}{j&$eOd+jAOvS1TqJav@zvw%UvEmJJHX9I7X_|PUkY%&dKlP z$H>OIGiKXBYnMEcJk*xtu#EStk0EkmJ(`z>ESd4?royMjhvt}h{!812?}cbR=~d`e zhSBxF_&i8!?$HRx=Tl%Ms$pL^*~cwhP0V6UgHO!?z^5P`rqc)V1&` zRrJx6$-wN%@O5x`2m9>2rpZ;!yi?(k>eqiMWmvtkD4d(Nzp%=vg)^oQ|BUZXRT)Zf z1Vm!4>Z1{Ei8JMJ_+K%*$V@vew!$q0vQyZWVX~dS+Z_W*tnr)dd_I3M_O#&X2DoGz z!(N+EkDf28TbO-uvZXub$nS1=EDmoh=YAhWp|Jq$obN5#PzAaafSssn-~k~5q(FP* zX{S1!DPnXFA3mN!-p5~oVz!BN_$BR_wn~jbgsk^s{ERn7Cd@?i8)oh6>GI=EZvZ3# z&EWd0%@oX|@k_hjWIChWHf(KTVB!WK zTLjWT^A~xbdQQ&WHvF3pRmZ*$yF0qfoeUZfi{@EH<=ldNm0ps+eY8Pi{{3`EOLMM( z@Yr-da^+SBgtFVm`QL(>@;U-+b9v<~8|p^+9T8uw%rsV7L=YcMqsqcgbBX%&YOhxr zzRU;>d{Ea>gTppTr;#hC1|XJ<^t=mmfg1pu>J5O;z|4nA`We#M>+`r;Ki~H23*P6& zFCAK`rx;)8M3(vqE&_Lh(rIU#tn2^W0Hn6Y2d_?;cjz3w1Ckuw>J5%ZT)`d2yvAz@ zC($odWo_THVvuKypYsKhR27eG5jh*b?Tj5nMcY=QK4?f-&c@W;;=pJ778&*4ttwdj zx1C)YS&rd{C1BFet`KhrtW{0hnaS@{Qmw1)@p)OXQZc9mo{| zrY$k3C;biJxDGBsJ|WDQ;fE^U8X&K8%jzAxz&6%iiNIu2>{v|)Pa>w151p*Ahdv}0 zIuaZS`oCB*W?&71eA03hyWxnf-oYKim!>aQzCkd2%U=oKkbRletNS%T@>;j$p!3@4 z2A~l#dYWn`VX)4h&tEDc;f@qE*|e>_XctN|G2`_nCaQmDo!raE8rx0yGy0PSkR89& z1bf=E2{ai$b=)X%LNn_(rGjS9(f#wo{p`)*t#h_MO{1v;vBWh+5DSQl+k}K}Vwuv5 z5;r=6Z|QCixh*g)s;Vb7j&oeIW#|q?pMo`0L}EN*m*>Qz3hJAXdc-zvDLG@HZD%Z+ zZTEndcs8$yFaBrW099`YMc_OV>{6$dNg|?dhU9dc3Gnb~-t0v|Sy;{`w2jLf92@L+ zkdPO<5yB0hebfA9JC(k8IbqQ3;d05|&vzm{y1Q`E(Y_MhrynoVr;*2#Zf+TLN4F;T zK>Y?l#;IQo&UpDIX$eB63@$N#6{~0k%RMh9vkSYLG|G7r7vK_cxGtk20r5J%?SgL; zusMqZyR&TqtX1hY{Ni_(vr+}g6Uu_`iE6Il`LNlt~P;j|XlY)M8HE*j*D zy8Iv#yyu)OH2rFI6+G{>fgHvR42=H7i)U{4Il~Nr($TNumJ7SlayS=jhzw=n$kE4+Y3?ci!fgM~AaL(O!rjv# zBwjwJ#*GGEjx2)Y3Q4X*dj7XtvO9*$UArhrg6e zACa(r_0b)*_b9AC-5uSpHsvlb7ykzAp@6W>oi?m#_RFA$cE>w+ti2azpT2y_{aF;$ zaQ0hRS>fg4W!Hv+;AB!T0noy(*bbTMcy(U}-lxQs>l9f^$O0<~7b$*IL|ZcpqjI|% z8t`L3bI+xWgQYo+hray@SpF=DBXgry>+h2C^I{X>BJayd)27C2x&5853o z*3VORi*6Nb6kCfDdVF1Q?baYWgbL_ick;ZNeLjxJQqXBe3KtXK2_zjeBa-~APyHk^ z_$h9tiNDyJeg9u|hh_Y{OE2lQyDkf>2Mk6tZ?}y#gg-iejN7dvtB#A2&E16>7f6VJ|9EIV?-)p~Of(YrSo63nf7g#q z$=@U)o8LG|cD%>ID$Ttn=p0u^@5Ug5&(2Y6EnF#5m|xW2c{zoEYR|HgF*gbUC%0j@4EFnY`>`Mu^eL~)heh;R1MFE;^ zn|ykA=~8K=EdL2E+xV|-`9Fe6c17I|{alun!j`=nc{vRnzmw2+LmcUcrfusTxFj7C zEfI>31x^idew_$QbYoh*w)K?Ki-CyZ1|OeCH-J{2Md$_P5%dZt<^~XU3m%ynxzwS% z0m#8_%ar5}IhyvcAAMa;4N^JMT&0%%s?fO&Z{NO;jsJNkE{aSB1Uw0dI;Pa?ufm%VWqWZwzt7O<73OsffYY87l3jm5=SaU{?BQXVsi zX^iF=BIxd${Q8a2&7}Csbqx3j1i~YqF7do^(#>C*x1LxrsJdMTE0<(_AC5FfNt^eT z#yOHJZx@1MTUgT4Gow;RyOxSOT46@Q7oun~gT0fW(%13!7mO)|YSgVVV>zllG7-4p ztP;xB)P8MLArVnTRpI_=pm^bT(c}G%O81g)+i25&?pRxqLvxO;o%}`ibeEoTh=SdFO1OQ3dl%f?4l&Ej7DQ9Pw1ZgmE zs(ysV=Nlm zAF1Wr!dOCwowqe%IY{*{!_uGLXQfP5Gx`HLqQg8W!U}0(Ef(RlU2mwy$IGgUJfe)f z8O7E7m+2ikSUEYRPwqs&6=belP$UrrBGXg6MYlk75kDFyv$Vb3$S+L#1&4VYazTv-;23k9NJtwz! zc96@SiI4NQ-3ADRCB%LhQF1-_pH}kXWa^rGW~~;aA)T&sJ?4H4!T_@WN$a)$kN#)F z9i9d-_!n{0Y@@-WO1v)ayV?qP^o-(9m|9~5H%2ogTotCyAOBV`b8r~{l2lou)+P+^Io;EAw>2QrXy1iEox?%FSSIF8f5~2GDo|$iUe#q*EE(ms^+j)#sed z!5(7YWpwSlXEkhBx-YjT*BTKFXO^p8#2#gRy8#gK%R!j+J1Ha{+yMUZlhgRM=j75~ zogyO8RVo&S)iv>1#;#%0hunpan|_& zjQ{&5z(^s}uZKr~OmM#R7=ZB;V`gU{J^SqrDIV#+DuDmt3LErg9gd-xvE%@2&GXIq zueZDd5aPT#hWvtt0BGW|KFAfh*1!kdHvk!v1Exj!yYFwIrtou;z3;e!&_VsH(6cu< zDRS#20WYtf0{$NB@8|V5Py8)If9r|Ab>V+0+wr76PEp%${4Z;WpO5@V;~BU`{FFVl?N>CkuF?F#6J8^F9$AjyB4Mg+=uDwm1g$84zp-=|jG zKOgyglqZEZstsx0&ioF%G*0m2+CRJj&j0jw{{Ntp_CNHR{%c;u(Z9sd0*3#+sJs5k z%iuu1zn9|wesM0o$?dj~b)azJzcaKIa*!Jf2O$29P~pEO)Bgvr9>s0p#8~S8f>2f5 z0*0U78T+@YeF;+hT*G(D{kS~ez8CZHKRW%LLr?Qs6tgCG_DCDG$NfcBc<2msA3ge)eaPT`f&ra@?99U;rc! z>~S3+dM44u((s&562XpE4?uaKK5jcNy5*{ShC^XZ`dJ(iqCUs4^^p1YXUbwzc!IBk zem?kXi{T6!%Z8D!Tx`*Q*7z}6L-^2V9~>DAU|5>~i+aZq+N@8r*oqKAegTzk5~ z;1gpbId!w012X~VkepS20f^dcxfy)+572k%&%%!+YGFR>%k6CSOA}?X`+~Z%6McaV z_)ikQNUZoo_9j?*%-7c+jqD>c;HOgJEj`_SngyVPE9f16oeoNmp~>4y8nijsfNJ0S zr1pf-$eV?lLw#6~rEsRP`oRiLe1~c7)BYB?J{B~gsXP@+qok$N90QTtDu<-rRx>>G ziqQa>hKFUqao`}+2 zuwVgPH!~?1mE0tD4mFVEV`>Nbdh#W%B^GW_6_I8*?!HpY`$A8pA2mye7pSxy85tCt z%=NTY2WxhPM9$k(n9Qj)&+~u=i)RK#q}?r`lxZHR`f$pW!gD)Fp&I==rsrpdzaG9P zkmKKJxYtR&23I^haNk(B@|QL6nO5BJPJlByO`n4u1ANgZTh+BZXW0lI2$Qi_RvS9} zPpWY@UEuGiz3U8`-wp}2ClC5aaPjUa{365eS0(eU3y>ZMxf-AExH%*wx)XYU%22YI zsng}^C1;7e0?_JhVRZw;x@i1N+tOD?!J@q6l}WGgGTbgrF`%@4g8zbT z{ZG@U|4zmIUuzWZ`PuGN<%U-sO5+} z_sUjaAG*N{In#kI-T;P|B4cRm>uWQX4IieEpO!O)?qXOgfP^MtaVnyIxkW31&Y2pL zqxm-g?;C*AIT~Z&aZPzb9~aQ?2|1X)n9QY$!SEgNOc#~cG-+U@B7AL^YO8((+vX*n zyfd+$e+pQMbUAy1qvu;VU1EP(!XA*}=Hp`qcf5!2l;JIR%-99{*dwkOgXE(86u>!~ zt|H-sGNrX(h`Vf}y9HjW-MFYGKjfR>$Mnw@hg@A+8eD^ke00eIb2T0#n1gvUdgHMs z?Z_<0#2u*I;fT5q^zo)~e$ax9rhW#z+?|e&%jPaM?bF#YAn0rLBT1VznN53#1h=MS z7~0_4!Hn<_$OYaw_epg06OksJ+9dUg*QX6`ggA?IjPw$>#))MIR)pa`2-MOoYFYp4 z?(u1dqQLP6z%bHW?_-RnR;W)nhcy`NK$6CfFL#SVZI+w#Pql#C+Z;bC9Ob93Q)OuP zv)(4OTVK9m)TEvz?;8#IT_G=3ui@_Q&DT;8*baQmo*(F+m4TjjY(yR+j{H#( zjmm2`09#Xz1ht?Q z1HS&5pswWGKSF&v<&|YJRCAu)&=`Gka0zNaAY%^HmER+n*Bmzh4>(E? z`YBpjW5_+oa!KuehU9`mj-98Z^;f@Y?AJKVSL&{P9O__MxiD&dJ=20u@ldiV|LZaE z4Pbf#^=mFojq1Li*xEs3>aFa!n@83yOZn?)4*SVK^A!Z=&5Vg3zx{sqi$?h47bI7Q zu?i;-#>T!x+ArCtqdXv>_*=lx8G+nD7bT-c5+w!St^!B=A<$%!xtspn zmd(7237w4hF@(r;t7v_$6B%bF?fj9U?(3aOj8;qnLl7#$PUcUzR+<5-4t(kvg1rUw+zkYJU%0b}3bR>SJOei&UT1^S3HJPaB$EwQ@`<2hYtq{vNGGK<;hQ>gS>P z&~_!cuum0JrN{##$qFk_0u7r^5`J)|9`L8M{Yt_n$8La$+}@!;(nfif35Z8R>2YmQ z&&AfR(fpuZd0Dc-bA$}5?!@vw!Jc68lVEas z`k+TKEHQFGV1wIQu(63R$i)04&S1+WSvoc5Ag>Xf0CV)%DVumbxmT8v*IU+vO@y7L z#NC&$ymYGe4N$F4?9*yt(eoCx_X}iQo+Y<5 zWztTWjCy;Pk?{7XqXAd$ez^Di;*Wo_TZk| zCAh@5g;$$|TfX=Q@51AI1jIx2!C;jdblmh5Y}%wv&CN$fx`D``TK@)+9CbQWoH}2& zWxiYY=a~JQsDaX)*^ALOulQcKHI7TR(yV7V8hZ`SndfEa!>*AWsa3|8J=Z?w>kQmO zAx1BNw?N`VMAc>@ii~j_y(wiBGkMk59^uM#;ud??aVrU$p7Mn*jOZao$(v&8|6}jH z1De{h{qZ0O76e655D=9P0*VyrpwgvE4J9Db1w^HnAc_i7q$@~~-U0%FP!kbB=~5$s z5RhI%hY(1@?|94HJM(?>-ktmIeKYU<=C33tXP>>#K4-7J)@OazT86nYT7q(}`3-4_ z=`U0}f}}^vo3+w3)O59$F?%p8tP2(=mF(|Pge<7aHIr!VV}HSSY7N^yq1gH5)4NZf zK5Kr6^FN7xCvPHI%-bctOObXOm30qL;7M!(0pJYq2OHKPsmr^V&R=G27 zntPO%@>Dp)Rtdbn|BR2D!xlBp|1yB%L0=Kes4Z)ub30|PK5&oa79(5teb1paL~d3_ zJ6dn;YqW*1la_i=o{pz2YnpAC2u3;bPWy!N)yd`b#{&*Ul8$mUy8YhujdiYNGj*>6 zuC}({YdGm`QfFbI8YEqv1i75A)9C6v?R!Vs)$Q)19NO!xf$uM=&9tgCwQbE5n&#ys zl1Dl^`lo~7#ACgM9bMZAhATs+i;eK!{Fx}FBOktCx(_^g(($VIE@s&DQCdN#1`S!J zhqFgf*5#HJzN{gKvKdF}x^&6&MKxCBGz&orH@%z6^3mtN?GOB$-QiERJpXyar2^Iq z**x=@5J-Sp>EjvI(kdGfcWb8zjmqm1jMW-v!UO zV`<$(TG^3!okkaCi}UgfC|*Dl(5G4ltTlyHB`%+gD}QBtfMa}_nxC3y+^{OEuWuXO z?;#?(Ibs?Rij{_y?W_=n{U4TFkxtk?VCfz70rbrZAIPaxyba| zG47ISd+Z(kqUYt05~sr2=;Gfu>voHHoQ7r){e*)EGzj!VbXy*h?BhW0JU%+o=Hbbt zO`H z-XZYK!*}vjL)yD)qrHhCr#e^|nB#n#&UGny@;1V)A+zqujYzF-*EB>GVS@sY=3hZS zoX;aaTM7=sC6mj@u(ZVtx$X^bGOo5h((6<3=JnAj#Me5ABySmoW*WF!*;;9 zU9AhLO-bU1BV5izic1m)L~^3Ck2%UY`b8$l9ILG;Yp{upG-{PE5>zN7NPE|VcT17} z=aL(ya2CObdB_hT{XXyH#b`pC$|Q9RcLRj?L5Pd}?YZeXks-&Kg-X#%LPG0T&@ym5 zFHf~j(B3}CNbl)aA^t8%2~+#_Fg&?#jW*kQ|`bYHw6b^`=H%Q zARMPX`2$c*rQw zS@166yBBC3J&0P#R;Eir0=Ek|isY-dJoe_kP)(N=L%+L(M1m|RyAq&(H~;t4{rk1~ z_mcUyxcJ{8Dvu3p3! ziQ@YLpyvTv5k{cQE?fR!`b_w&vbt~K=nae z>^^ARa36GuGS&j+RU(}Pl25*5+`0ZRhDcgFO<@LbbCQ2dQFHx1=zT85mfRRY(Sq*q z0j&RXT&qv#xi*O3#7F{V0GhPLW&8}l3?6Bdn)d=&NC`mqI$RWGrHNyGO0yduAv*?; zebCy1Vll%C5EhY4e73zUOcVrqPf;R;KtHhOKznANqgJy}`=H5zpr0m=@qg943H!SA zKJ4Lem33M*}nAbbw6xHZ zKab;|XOI40H?$86h0EZca;@tGitU4J0`$mCiCvHPK|c9&C~nL*JtD{Leb6EhQoEU_ zzmr?C=r4(UiaB|{rgq??;f>y>8!uHZK2`KTB>>{i^h(|wK1gkL_zv1nF z?O(;F4HXu%_TUyAAb)t{6Ij+OqbBFK5lr9rg=9|7r%giHtb4dGmx`3Sk?=TsC+Tno z&kay}=DjP8dMv_Y)79PbxHv?SJB}aIT1nuDpBD};Bz-F*h+Q7zLk&2rF{DkvL^qb0 ztePYTTfViH@ffHXc(UFz^>aR*L=U2S+#;~o=RcQ>3mBQsMzwjd!)-E5mXM1GVh~~e zc65G$@8hOAg{|dmZ+Uf>$`N&kzNOGPcty$0in}Uo)c5Sqo63h?9d(u%wRN*VB-KM^ zvk^KzSV0nw(q6nPU~QB+wr;wPFWy?pfCvLI&>!B{5Af>ksBH>V9b#8|X13w( zf$Z5Uq<`#iK&e~Glf?ff_R*_C7p?p8eaEb^DUE1o^V^4LxM#$eskNyNzt6(1WpS}@ zv)P81f>s~16^pzGxtPi#1aV|aj=Cz#{#dKbMOvz+HWrqXIg4r*EiJ*&jJf)`TQ1pI zliOubQt~<~ad}U8cuhS6Tl3A$2CR2yl}Cn;JeC2mwdwlpS?RMvn=u87Fp9>>IGLhO*M(wdtfjh}TmbGHxVMsj-6;+oyjetsmGVb6ug^bp5DJFZ=^_ z@;B>P(o}#ka9Hm;1qpoiIi;~YOc(e?;GXyjEoR~Uug%E+e>r#mNAC6~c!9~7=>dvf zX)0w0LV3TPvCAu*N=I4I>kU?~`k1kPwPhcK1_B=DZ&rO%IJtLwMYU#6FP{9m;Aj`p zdPVw#Myh`#w4~c_zCUFyrrtoWt*p^(&3;AYQzMEtW6sWO=M?+Z3A3%!9>Qi;D%z@P zI=h;UH%!Xy1^=8()APmw%Br|q>N#yZrGfFFz#Lmy7I>r*x>+pRo#)KmEHdnx% zYN5(YD4i(_myoGqPgT&?MNxVN@A|y(!*EH7N7L?1-7LH#XEZMUrr_LeZWo)iSP&QB z;gjs$-MlOM#?O9nZkr5bERwr&7SJZ^(u-|<>(Jrgne`c0Q(E?0EbzlL9Rg+(q90G4 z3+-I;;|yW(gxj<6R_YK(^5ZCJoAB<97cmdfVdDUMna*ED1lZn<&G)QTOIwv-g(7Kc?x?#}72tS;6|+J-7g))P$z zNrJ`NUXnxc-}K5yt-tank`Sk~uiQK?HGIqU!YBUj(eX09>#QnjC#-J6pdwq=NLQcrUOjqEGQzJ&yGT<$ z8GHlm%64A=W41=Cp(!l*cMY%HyHbfqokxb0`5&16NZ(R(2LW{4l;98qe@{#~=o8KLxj z(3N5B6x=pJs&Q$1L|Y`O@=!t3^}PmE7##0~+{JFmVvk;zb*O|bs4aHO!am-*yS`1d zIImIu=FO}_fY+x+M=oy;q#Jn~(8Q+)m3WXdxP`l447%q5%fYY;wMRXV+m+p}&8Do0 zX;AJf0D^R#|Lr~qA_OcM3EhY~J?3AiEr*r>W?|e5qyMui*1ztJ{p4i<{kZ#ejLhn95c^t~f9kH?c_4$WLZl2}1J#qY8kh@R9 z(8n3Gh|Qu~o(VJk+XGd)ICxK<(HQ{yWHaTY2sb5= z1lX8Q@ZZm4%U;w6(hIDzL0>{`zM;}HC=7s&+4hXY2UaH$cK{>!@CaZ8Ur`@=I}BKP z;=p@KX=;HgD3Le;8#A8qZw43xyIu*{nD!JE^5Y1KKXgYn21p;nwffqbYhxC$G5I|J z8?%cG{LB%^65m03yhq1E+621y;-cJCnh*zU%pSnT)CI^#YblCV3_XCuBbi9I%^*w! zR>b&%5()5@*aJ3Z24G{ReYY_sf?PN=DAZ!>j7uD*8-Rw;Gyo-D0`9KkyKSxn*yeK3 zeNd~@&lAV>ziHk~RtGT)!B>a8gadTcgiZSI+L((j@l}t_i;P?{5E8t~@R~d3l~Hf9 zg0m*St4P0<{piT$%++DHBPSCqYZv6yJk#Q%c*@!_rp_y07Zyv1tH036xxaH;g|z-} zP{u(TfEQAqTK+3)HVcZo7V?)e8`Rw|C_uKhO##qG77$BW_`M_tNKclFxXAUx!3p3X z0KEWBcxa9vlA(M1%LM(8=t#eVdUym71Pfgt=U;T(|J;~&05o7`DwjXbZS*_Fd?19o z);>7P<&H@v|VQ%56`v9 zj$>x>Txq#E-F8~E<(lYy11l{lS$q^e>9r3i;ZvdF=SP;zHjy8%_R!q5QNJp0689pK z7+AL6PwGtQkLuEj`!%PODt;eS2qoyPXVSOFg@&*hY3S3a7XmMm6bv;vrbM7y&piCg zCjAHc?|#>V_&cw4F_cpBg*FkyO!a6|LHpJ_9noWa+E+`(R{93oyr{LF=W>Q)N}psT zKu`OpS!pzRp~h3mbXiYwF}TP$vexmP$EN*~#a&|Nr*`XG9Fh&v_}Xv8&&1nAWr-__ z`_Y@x({>+-H)a#$iyM?^Xj~)@RU?A*ufivNvH{St&5ba&2j2CnnGf`_b#pCjD{ux^ zMYX2#R#<}DI6Or8@5NTU!X`fA*}NNh_DYChVB6JV>^f;F4e4VI4z=D&Pk9iSxaThp zr${!yhqexFF*3TG@(+rR^kVaQb;cl+$aV1}$CLNe$otAoIXTI4Ngc^+sIB#2Qx}H& z`K&N|F9H~s@vQ;x-_eS>lQ)SU@_(98ZkDEUW?kZ}SIt$?w`|W_)r>zmX(ZQYQ-Yu1a`3wxBosZq&gD)+g z(9cIc`%r0fV)$Ki4f8_qytIM{DiOt4H+3txcdyZVLk6p4w&q=yb^V(a-!Z`wckYuT z&J{NRrf2%e_6+&YCpeSo4j$q>>ci4L-j{+8c!-+yNZh?l(kZA1FYJxs;-HEY)vjBu z{=pd!d}Hhiblmb;&O}WKJY~ONB*k@+b;9gqxrLL=)xwyD!D{z5BAz%OREAc!vx33O z+^Z>d?t3m}4EaFr$PfDVm91pS~;%eum!z|{OaTBlaP0AU?hHA7PzGpeK z5r|TN5vryOw6Rfy{?zF*qWJil5tD2Dd=kc_(2KLG9XvXw!X$C2y}g9x>B<#WFWyiV zwy8*tn+hxH&}OJk$`FPW#@~@22Mxx}=3hH8sUtB)v&Xp)+V*SMJ2bG(KaA`}Idm@L z2o#+W@8wB}i4_di%Np9JQ;b=38ysyMLc5Vr#fz>ZrQL%P8EhT0me=`G6)2gK>?6J+ z7g?^e+N3(ZYE?JpH062MCeJXCMJ#MJ87xMLfJtuEd)q=;Q}I?3h_r91du2o~7c$?o zBJkoFAWw?lBevIUJUV6U#VikPhZ7&s%^MAM-Q6OJ`@;zk^wwy-#;;a=*KZ6e`3q+J zpNse3%VWCkLn(wVWmdAp8^MkzIw4a{u4Fe_Us_1NMRUDkGORPLg=;%sOI%3_X` zcqht3vvfNj1k_ROdvR4@i@-CGMQeT!Qr6&1q^aiih9OMMm= zy4AsHXE7)qY+}-Ka?T4qs)Z9Rcjo;bc-*@~du8VHr{FIE>4!l6b}U^y6d0@66xeUQ znAA1jzVl3))U!O}P4pu9$69{HnY&>0hVSO551F5tQB`?FlZ8>W(OZ3X5w&^_i>WHw zDs;OGl;p0;#}#b_MZ4%XoEytH0u@Dh$MkY6C+BKQ_?+4Yea#!gtSmX)K=kuhAB>y6 z8G3E$W+d~*`J**=HXc7?aW-Fw--OU7y~rB2=v#Ch9npL3;p|sG@8;i#adq>OvR&Q% zisRXJcqNkm%*YouZKiR;0)EjuMgviPl}j{eQEDN8CyP9jmqF3#fYwQ^BknhjIa@is zaRb=g8y4s>RQJ@`!|z-J!g2alolwW40cYlJUE|B}pGZr?_1wG8Id^C(4lC^8J+_QC zS>LE$%pIxj2#~5Iq&6TbQ40;E=EO-7^}EvOlSg(-r$JLS011XGJ(CLPM5;?f;mn$^M9)Cq0vV{Fsuf_Joy zrCwY$HT>LjoW4GRWt8gN*=M;jR_n07`E?-2M5aHJHiW)n4gbZp`qb{{wqX`r31>tmk_bV~MkR}wM z_`Y9o)6ELgGNhQSY)p?VlQiU2$5W%+jUxgIZdXGYyK+BwBzeVR#5oRJGPw$#(28ygRuAg$%|_;^XhRD-ze?Qq&{#^Xa4C>_lz5ZOOva(#}8doVM4Av8M;qa zk~B}c&v=O3bWYcr=+X6^l`S`XlFcbPlpa&ONDvO(>}Mb+nrSY!uLPrf^ct2++#;H&h(|ut?a!1qMLA`t~i)Z&@OwYS*!PCGuRTNW!B6!jQ8SC zr1a99vxR!T%dU&28l!s8<6Y?1J-T8giiWJCx_jO_uWQ!iY`KZVAyE=YuyfuNxGc~FSt66n`C0^(?+npwbPs~XT07MmH; z9Vucfz2UhX?Wp+V*%j!z_S#9vYI}+ciR@#$ZtGd%IiJLnsT^ zRO#mW3`CS}keu>RuEhvp?^M>|u&kQYPBnVFpg2*`Ue58(D`S;U{A`)~f)^l?f|4G> znz(LkL=icsYzDRYss%Swnn9c&-GS&*I(ls@rNH*_f)1CQzYy=8=XoQrf=+th*7m+z z*j#RyKL835)4BN#79>Ir=1bH3Ro1M34O8Vj;3PLfZS^W`URFN&4_PXIXQ$>aowDy1 zzpTs>41nD_N^2Ms&gLb^CV*9NW;J=DZ1zEUsGSvnTl(tp64xdgI1IQ5zfkL@_3W;Y z0AGBWGTpWhSqfknKzBE(yd{UvrGUKttGLuZS%vs7RgXU_-u6$vuivd2{T@%)zQJHU?G(grBXC-*_unW-fIfQ4}|AjxK&mOHvN zgnJACh&;MOghx9B?$JbFU1|-vumQv`rdNFDj~?%mCT+$4z#!d#_Bbm6RMR7sIx$;6 z{CT=NmEw;ASg2I={f^|j8Q=M--w(C@$V8n-&6fPlu_PILfh*kKla;(=*Z}mZ^cdn7 znqv|pF)Mc#$&)u}HUQ64df)esxus7|QFiqJ0@Q(^EGQAr|2=VtSBhIUq2eKB?ZMK8+py!i`k_$#((HNZ<0^D7 zo%tW;)Zu46`g?4>T&n?Z>O8WzHm%TiQae;ZNLypMv~M4zzjyLURccWELEguCUG2@( z(>D2Z3RGE&TN>)bva&2_Q6(O>eLEh`D>hx74h!7&vD&mUa2aV$XRjR?(S4@xkS3ba z^=d@xg89J9+u|%=xwyml`9sAI<#YKDEf#HTuDCZwys=ai6Kfqpxnj*=_LFXx$6v45 zr5sM8EOZM8_}-~YGN1`Nqa6G8?nC}a`bQ~=JQHjL(@oQN)2C0NRXtjTAY~KxJI5qe z2f#Y%h2-2B@R)GJF?uGgmRl?3s)p^wq#Gg3tDZ*KvD{1kmi>l@z0V8=anM1aw!v5}rxH~bi844dI# z)QBY^O)=!M+%l}s4Jpc%)#=s(iMg_=E9Al@0=xN*YhFC8kzw9+L|x`L>6hO`T&Rt6 zEvnnFwoVHU3U!VDwoY>MK+dIfw18P=VC2^xe%zL9JmIV(TICw^X>)Ojhn8w&j(m*d zx~?Vm+R7W%fy%3o&`TWN4ct4N=UWEwC|jZu7d3^ST}leQ5q%F8&>ow>^J?YY8^ikq zj$~D6GE`5Y%IXWQZfS31b_5+H-Mf7SUUt^`^x3ohUfL6qC5WM{xsfJ%gbux<(v??V z@Vbnh?-`C+;yH0QNQr}6L5e{Uo-VqIZentBPN-rlPMwBcOBK$RhQf>D0=`&Q7JKe< zp|X!}WPMvATo5-jy*~dv;^ZHQG5NhB<~OvXk%lfLQ|kCBPX!LR{Nr}*Ecd`lOxVSh zNWg{5WYx@$Y-+Fi095-?oWGFAun-?~I~B0Y#E20-y54hB$!+j(SfGxFLIN6=?{aCR zsQCQ~Q|v>|>ip!Y7@l!AH`wRTEZSyy2=9LM>K0nJTCiBNWfO@^B~s38)(o!6^Nv4) z!!$h{US~>$*@>$)T_=51>~uR{!5WSA%`2J7%1|R;?DJV1^oN;hcl3#%b^`KUgSvtP z(-#$&s%jC90MZ&g)iy+uh7 zMLNib5}$_Gr6-o;rFjN;m9%)eZ`|nP5fm4f6{at^AskM{aX>0vSGh<>E`OS!uri;A zm6fhb3fG?As2W7h?)ar0`+0XUsoMvcDJD>{fPVgV40IjgGk-XH zFEpNNAOy%n9!Pcx(E>$oNq`clWXZjonFljzfbT%!U;!#PNS`*$fE#dZnxPCd?CY-o zx!TBo4$S|`fx|Hy1uuq~EH;m+)}*sr89UY;OgQ-B^XtP+^6Lwi#Qh2lbhBnKeR?w` zhKX;5J(fqN1yF4qONwmh$htdd{loSZgX5|mGManLhcDzj<6mK#dMPuDDP?l^e1iz= zwk{P_df;C=+S%<%;5~$29_ddPhu-fcOm7IdV8kM;M6^0_W(z)sBd+CE5})*+%1Ksf zhqPY^H@ougremk&>c`7+Dguh;*9_;Ds5FZyZY(VDSOxpISVB=uG8_pHaNkrhZh(p4G!g>IgvbEMIr1eJ}vc5(-bYQ z*xGgu_J_U~#_s4@JpH8CpVYmu{7HGhe5nNp(izUHgU3nhza1PXDNk;?Xmr(D*Q~!j zAzNm}@w7+0;apXP&O;w(b8bO(O*J{GoJOy@l|eZ9l)iFi|Flu zfT&w|Q^U;XEsg1#N1lRW5;W8X7t@8Zm%B6UyP%?X(8XBDYE7#9$^IO-S!Y3i(Q2SN zfOWV>(W1XY{#%t?O_uUC)sOhX!`UaYR0C#W5#9jBIstR3risqS#RyV+%|lywcerY& zam5{}Rt34Zzzgex1YSTLEFy}DfAm*+QNj}^Svi2yNi`gB=SB3pk4HGu$1jJy#y&cM z7kL@U$|TOHB2oJGP-7n=&L?pN?ErJ#Iuh3~nmsgDZ4l9)H$O%(>6?`2e(RgsY?7j| zH)l9DI-*hl?s8<=yt`muyI~jK85?4M{+^~B#l}1SrG%mL{nGMKyd(1v61<5VVY|=I zw*t@E!)kAtEV|bb8q4O+#I9NHj$(9S1*$=|G&&54Foi-yia3!z@avQ3KC7d#kJmTM z?~4V?VX@xBA|}-%Sph`mkz}6qBoo)!Ah~6EyFtKBLut zNIX@U;j1I{!1x=J#F2P+QM?4Y4I6y@t*FVHBm%OLFaV>?{zlBI>PI(c+^#iMtwpAM z6BO|lWbd?vbl!f?`8L)wU5`})FNk$QajEtPm*rK@+0#rgSYb=*{gFs-qTeg$OxI>j z$l-mEJ!55*E5KjCq~8rTjo(JW$z5ZPsU+4B1af&$!YWOQ@&N(M`UYFf_CZ)}BI9}o zT&)90wFp#Rb=68924FI*MlC|VLLBx^uRte6D7_;y`J@1HWhV|uc=X_n7e2BtdwGwY zoG45h=p%hGB@9}4O(Qzu0LB9o`a0TfjVl%7 z6W_5ga}JBN-Zvr^)+n5OVG_hy0-I{sb&8ue%n(uKsjBl?salz}cavT8mb=#LHS_ob zSYhVn#c!(<$3!Mlq@t&C>px^2FR^sT)vO$iv`epQG_Q+G(+01(jJe}N5z~3w?I*VH zJxr>D1;!(h0iq*|RjUnh<5)-a>T-Z%rat5mnWEZQ^3pk_7ari3CH8X9AJ5G2Nu?l2l38jC`b2n?=3Dyvrl<*CbEGhg-%JU zJgx_B_LV5pyD^Nu;}rLk%+-9L3Dgt55{CBy67TzGW&%R_PtR#~Pj;e3mi=1t>IUWR5?e`^&}EFEH3p z`ZM-oDe5GrDV0B+0OV|ytm_PU2<%HjBPKQgKrJ+!tiKQ0(N9@1(~c-tn@f# zU2b#0JO2pK=i9|aKpv?yl~iQZJbqrx6oobS<>2{ zNPO7exN;x;j3jn8kr!U{a3@9ZPV8iP|IiTM=p$c!P1e@?E#W+ytOrUHN`X>vHT9HJ zWPr*C+>BStcv>)cz&u9!n`|h%pzWs{GTJ>&l0mK$&!6S|Bj!`cMedce2C* zC(3xvd#`iCD4Y^FlPQE-K?lSO(nUQC`mTT+1HQ`wr?~+h^S4GCbNiqnu>nIi_n)f^ z{8QW+KL_+0{S|Vf>gwv|Qkqn~`o2P=uO{liQ*RlEs|%Vk{Eh59b?5v6w9_gaxcmQb z#DBWNO_f*z;F|5gswC?;AA26FR`Bx2ksJ_CeJ+x{A?g^xOxcWP4t59;Ks=X_yq#|h z|GfF~jQ8z2PKMfSEoB|U&bWJ2uT}WhB+R4dz8JF78Xl4l6$Ak)-w&!hRX#xcDUM$d z;Zt?*>38*M?hkw1 zCDu%Gd55r(GXU5ZwT7cKg3kA&<`EP*z)H`g-jk!GLMKsVe~>}`B*o&#uaI}pe#noY z@8Msy;{tZ9&5@swVXD9P2lY_L(HLpqtX!MZOVA$y=J#q3m*N7KQ2@tpYd$1n826XU zQ0pf5>;j}hKy-dbm?31K!%ZDY*?B4t3xgdcWv!s8)RrB}X1GZ|eg%%L_KVC5Z;VSwE z4^j)812KXC`tx8nrH}o@g(!pb-}eZrR^N`6Z*4fezG3jRE>9|`#PN%N#+M*}BjdJ& z5+779>w{_GN-*=ZWmTY=(;Q|fJE!w(_eA1@&YSn6wz$wRzETN{!u1c7 zb5&@OaFuDxO!5@Zy27V|LYLO?(c!`$D`h*+p%$igBf^tUUi)E>|1J{$aFq2oSljS4*$7>9qH|1dnc@qZ$#W`EA8(5%vttecBpWHao zJ4kpUJR-$3yrgvHPJfxmvP9H1g=b62U98@W^|pr5pNGHVyuyjP%K2P=&htBvb@a+o zn>(=N!MQ{@Q1nuwg&b~fW^HkTIqNWE3X11R$nlM4rjAe6>M-GXuh|`IKsDWaHdu;V z-3KM*iN2UrIB7h@-Dgu9?s2xwL%#CC(U*~WY*AmCK%@6Gn&{;Fbre08hfx_sXQ=Tg z|FT4e33?R21K0?1m`-3dx74v9o=u@`P>&7DqkYGnFXm|~`^4(sXXiLgv++J_w*`8o z0?@zd6;1s_3#HIjEEMuFPJZLQtpM+uJ}+T~Yb^Jpc;SmePdQbDG7 z8w`Y82pG4Rr&Vb>OIjD#MifJraB`x@B|*f0cVsftX+rthMwy< zg%tW?zeGHcXZufm-o6u`PPsh^BIL!-Bv?lat*pEYO60Bd-s^|Hl}apeK2!e6 z**`am_^4WE+x1C&hld(QmyvT`#CYiaW?y@aF zj%-|M!o^=@E$i8H%1dJF>Mqfj7SCxB#c7LKxqG@z*}LVS0;H2Mtd53&Nf;JkMC;&mlS%-}6T| zOX^500eN_eajcC&iiH8puOG>gC2G2`b+d|pwJs4q^O8b4c; z%TH6JY25`L!E|ZsspoYQ)_Gfu0%N`FoX58HbOBqVahGv5{aKM}8JK4`s8h;6{LI$k z=lrAI+B2tm)DBLZgZ6XJ-x9cb&4@6i+vVjhB#Ir1_vqGmjdBLO<5#L+@Y|!=P^GZI z*D*PBb-k-0eNSIQS+KKD4(4cWFK2g~yoBq1bc=d!1G;}D17_j+8fztX2eX{LCMMn2 zx{n{qney0Ad+@owqh$14^Ec--FyHUa6q%-X3=)rW6W;@W*3EIQL z2tsIM3t7^t5SCgI#5F5|gMPs0j^1k&?Jz6dz_F@gloh2cRNqwAFoSQ1|=Bc*@dg zm-6;)mvHm8$*Fe@Oz$4iPR^)xDs$7h(%TJ{YiYfKk$UtJpbBNBBkr#Jr?2ANje#t< z+UsLu4(^ZGos-XU4v7ZJ6pw(-hsP|eEK>bM^AHVjHyn}=<>oNl$Y|78!G1j%H4_|_YfCsWsPpt()01o8QE}i<{iV#_wC-r#}@23el$I!la?Eu=IP3_EjxjD z9(mM0-N@J0VXr`I4ZbSFSu9mjvIRevj=>nXiN>h9_k5X~)m_&`CuQu=BuhhISnm>K zQ8dHNO3!Tu0ECdGOQGtqMQow-JIwVXmFL%yW_IGoO{3})Y}UoE6!oW#5vm*U&<$*9 zotMn*l*rqIu>R^KT;;m|FvPB*K=S`tY1C59WV6hpM!!o-|2zDQUu61sUBlj0X>A>~ z47~-uew)XjhzF3SjNEI}YmI9ntqg|LQ)Mz7UgQU0bvqe_n~h?6jRPyE`aWQ1Uq8K8 zX1ky{&iFtFj$qPR@*d(ky2W-{x-PK_sjl(mvpPE0Vd27{l=b5Y%U~B`-AIMcQ8zdx zAZ9%mFaKm2>Dw+TyAvJS({z@#s@zp2_qu@X(>Md9UV+_b z(q;XbVXebwucvnB;b zHA+Sz69)q&^W7gS=NWys@vZMI#1E(A~|3gdou@ zwaUX#8SACr<1 zan_B=83%eUT&ORL<8VK8V9MhY=wZpCq6^0mfFRJK=R8!vb=I!yH@idfqP*TZi(iT! zl1Z8AiaCFKPoln`Yw0ov)GNUoCe+?n$cJywzltHQ-}@nUGZMqWd8^+6N!4_7XzX&y4Y%5a+=JO^ zY6@$*qNZL?hVw$|;+7=Uydu=~JyzSypTyI?UT>b>^7*m(5v7c1e;yX(*H zuN`UaZWU*Ztl_Z<9G1U3(cz1#K=%aT@~Y=&9S0q|x*Xt*6i6__DiEJFyls5&C&B>> zpcR_oZfV##(?@tTC?@n?v=`TyrJSLCUcly|1sF`ggT1#8x~zQW;h!fQ{#sQ0?q9!3 z%J_GHm%rZT|0ysGjl+@L@b}bwA@Wi{3D`by!PuFE#3M4d^=!ef6?)uOxt`grQeGA< z*Sx4@+YSCu*ZO>`?TG@<*Xnq0DiJ0!Xv&GjB&GlH6bbX(O{$A){+ZM}7 zQNA!0mH!S{3V6NvqKaRQ824Qi>oi~Q>Z;JLyxJ{I9XTFsR8n?t-WI*9n^<7c;s(t# zw`w{{8zGZvYWA7+pb9J9*+kR8QF6c*lcuO~xf}+paYxLRnvKQeW-G&ZP9og^{TqLW zWFl@BhgKyp<{}}YAEoPblLI4@>)aCC;h`ocl}nF?fb3!iK(zkj`f#7?^;OUK((?1X z&A_E*G9QH$ZCaY<2QG_j@oY(mhiAwbfvWl>c0jk^ ztKWSQYHpTJXIYd{^ca(d+uGO%NfX}rFN60)O7S>{XFjiIW^KAjc0PMwClx$3ojt_R z&@S=>t_KLtd488ms&g>F?1XON!MqBt|1eR zQ>l5N;OGq1`f*uCNKp*fa(ReBH6YC%pxqup`35=Dqcm)R$8dk>?6Lk^9|^nIfuk4W z+RtLymp{Glup4+YSX*zFZX6JYyYR{9!nqHR-xpah5zghE%RHuVnrxY2U?Bd@$%y$U zLHKXtWXYFS|-hj8`9q-*eQf|MUOHVh?e!{?JLaoRG+P~ zsaG=(UT(d^#B4ZjBPGKX1v(dT9(5uUM?e~E1O+*PE`6{&@hV$@;ToQmD-0wUedXNC ztYm7c^3NnEDjI`hJ5jXzpvLu>)Wt<*s;4JeBU{*%@1J&hPZFTI>G_%_jJbyOShV`2 z@}UdQJw7@~lUEV~aS$+w{?eg=sXiWgDo=ccAyCs<;bwTw^ z*0qp}&dW^Wjyq2UwQaL?e}Fw%f>(F@*n)pRs1Lty%Vcm^R}mSAV+e~Dwl7b;02F;b z<1e;btC*E#|M5$Kz)#rA(-ktH2BUB6gTAzYbp8lA*EY4DB^EhZ1v1`)lEnd}9<@6F ziYah23Os6i6?Pnm+Opp zu3bCeJm^*dhyuib`0caf@r`dl~_7$jQB1lvmJ6AltNyH|R{du6zs$2)u`BhOGRhKcGs) zFXIqB00b&R`?-GT<0g%pI<=zS50}jZ-W?ZcKjRP0bwAV;7fzQ?{dnP@Mvh>mJMDuvUk*n6>2VYE zFh`1_DY<9CRpaiB2+13ON=}t;D;URdxkIq2>qe|bIk1cTdOx}2n#{m^Jo{yRuni-) z<^oS=UB$IOQk4U60jf%+Aawlwnh_WJDpl;Huk5!o3LC4^BRRMlG3>A+;ij`>}lf2M*qxRm6G|Bx(9Wy8pe}jUrm~>%Ev%>xvrTCr zJpwMsBa2LsWbW6^za#eMWi`$TBKe%{s^!%9gZ^BJGQ<`PrJ$f1z%!isP3(kbuFeB` z6JbvtsY2Q1RGZuDL|aYFJ-OM8+-q(Kma(J2DsT%vC5RDPfoD(-#FN}L?O~RxzC+-x z+|pF(#94J7pWwUVeB=4E_SaZXS%#uMUedc-UO8 ztA{*LlY{#p##v>y1W+4vFy*-Tkt|ic2Eof&THi@@RHiU`I-`&nf{p~u!}n_Q*QlzL zg@PtDmuM0})G&zy{Zw4bXO4>tWvQzZTKM1fN-DQ@P)hohP4lSZS0X@3AuRr1s0$7Z zy{0sxu#~J238&v=5B;@u^hf>rRS4h@C67Wknu}@HKk^Os$y}4MnxEG4e&fXk8s9x) zK#@4TgW61zCJCYdcgwuzjr5CyWp^F>;P}fT6l{?d>xHBVZPi0&V`|>|D()w#RM_|n z-tr6HFYO{FCeNV1k;3@0862^^00qB|4=5mpxP)#wLqb4TqjSLbU7ZWrrR$vDjQHKA zQcB^*)$^K(c9Aagdr~Je&%}eBMiy7AxI{+u+8_Zg*tcu00Ty`#Tu?0pmW1xV_1?d= ztf;h-wu&=ubRLsBTnrYbd1y9i^Yyj{f3Rn|?1RXZ-u_6m1%=7=yJr7232&&6_h{kY zeU0R*fS$S@P~sw+UQQiU_YH$NYB3KaiaMW|O?US$b-7^83Kq@!iRE}*KAQ*zh3o6l zIhBqe8tZ-2I@KrZjf_~{TkLle8Nz>>5My>hpNW2vW8H9CL~vldwr==oB8<;0vGr2+ zJ)U>1SNd7>30stJ$zAY_j(589$=W$_#H+PIi>ic#O{)ixA(Hw;YIQ>u0`Y1=Q=#J8 z&dcl4NeqFVj!vvR9Gqh{C$-J_cKZ#9NK+!JZV@&xumiRdvY1Lhb*xm*JI-yk{>OIt zZ!G}y`(G#Vs*D{XgrHOiJ73NuFvtXqgQmLgmHn}Shuj1DgRN1Ds!&lVVMUZ z4T|umkeo}IhnDlSeZlH;vW&NMgv0AOM*Acx;L(0|@!;IswEE}%SiJ80&DnoQM#M7T zsW?tIVLtRCQHFO=d>)>YdbNwG!?J#r5}sw{EG=vJRh1FLpW_E(i=k(5tU~Y=bVe+MfxO@80T5hVD)fO zhk7Qnu5wtJjmD>8Ll$QhpbgiBad5Gr6DIAck!S&Ne$hh!1Mb-!8nfuG#FEoQX0rXpPCoQ<>RFMSty)EaW$tk zT<|+r{-8Dd5~tw-C9K4k6a7@|xrb;6L4|}c{&!49AO`rCqc>@wH9(u9a8529b9(cQ zL27of-AWxQ>sJhVNPz=jkny52L*`Mi<1Rqg@Y#(3^#X6=Po4kIfBfRlO8jPZLb66g zA2(*E?R+0`smFCX+4M+9-wk_idjE)|#%Z1{Q_?L+JSQ1_cAIntnj$#rYl+3Ea#DaW z1FXg9(HGk2Q}dFQc;WTC;rgL$kLXJnbe(fuC6RSR#Wd9TVlUV&ThC}8q>Drib>a9e zS8L1rVN?AgTUOWgDPQ*PpjWL_I9Fe`>VKw*I3HMg{Oysq{`4UN^}2#iajtp_Rx8-W zDZHB$Y@oKP5wVUL!r-D2*s*<3a}d*_T3=Z@(NR0<8bupz5&onis!4gQV}1EU=(WJ? zs~krVIou3r%=VDZ7P@rBr%)F?TN!Og^asQ3cA^ox$f zwa~AztZ&cV*Dv+on#mI6ZQlaVFV2_luGH#aH@sGeknHLax4gDvwX4BzZ2S6kY8(4_ z`Ud+juIeWDqG`80BrT=BQSpQhvvohv!$0r?V@2}PO{$Zs!nXY&0i-STTEKh(R=6p} zJ1Ir$>)65xsC|dr$F2+Y8kI6W>KF5cbY)oG>AKJ&a+-?0(?ns5bv?Zf70m~bZcCg3 z^q6_yU;AHwk<0%S=lMa98NBvV8Z7SFX3k*i>zv5aw+W$){-Mvr#<;-O#roJdKdy~@ zLaM!Al1p*6WG{ad^pIe9XZ7)NS*}xJQZwqLYINBv+dS{(2Gi4C)B|iE*W2OHTU>0gdZd1Tc`q64w^)hsfg)&TYnB*L_g* zcb1qLjcl-*{Ewl>sv#cR9zXNA-ZQ+8r2t9SIKIaxAAs5eCL;6)`k3xG_06UpfaVqr z-I~9|`AdJo0QKwVaj1qs0211++fTiOMCISH>junCAgCFHTSDyume}{^qb4j5JEZ{E z;SX2V414wqz08Ca-H#AF>#a1dME1W(tyF=UM^OMqFFNl)Y4YO?rJqJdjjH?$%MRrH zRcY}@?w#DPf~#q&tC2Uu2+N;aFGqmN{|Nj1N4ms6?0Epnd?)-^W%HNC@wXu4FE$`m zs@(^G*zxC$_dkF{evtJ?Pn~RyXTABE$2KwYT?fO|k=M*o2NMn)rUUX#YRgxwG5d0j z*|nUzEP2>ayH?7QXGC{M=sljhU|Vr8$NT)U%1xCY$4s04f>NqiQ1IGQLg>iPJ6Zi7 z9B=ZeEDPWoDQ~mpg{(%>@tafbx zwKPEK|6}hxpqgyAbx{-)6%+*v2#87t0Y!SX(S=ACB1GvBL!{RbD~dGfN|!1nASFZ+ zLTvOVHINV@T?ircKp^pE{d=!n&c5f2b@y6pmvi?RWF%pH8RN@*^Uin9XFkuI1CRN+ z2=)6E{w*Ktf4^(~zb)Or1=!ia6fc>7vHut0c18lHJ}E}OsV$#{d!bS#wUl@s+l*<# zf{8Jtc?C?=Bcl@CD~>|yFu?U~$P^#HGl?hczSE7~D=#xWH%ZzNz2m-^H~2%@O`YIh+gNy$5>1d28d}&JO!e z3@rZ$rjKx#7d$>%IPkZB6g)ot_Y9i36lU8^n&?+aNFA2NOCy*x>o>sFR0%BeoKu z?vT=(=W_Us9@;2#i5!pE&72Ea41AZXgBp}vAq^3-ucu2$sd4jG|A6QfO_d)dUpJBW z34P%kkQFZdS`{KC@sxcYxbi$yW1zGe4vO7wY0n1t9E{-U;nFJ!u5$j%|hwe{AkGxS?CC%Qs< z`A%6{1>4~PEyc}vduOK{6T(EWU^UR4(vL=wWONC1YVpn?-GWHvq z$61tkOD62vo@k8sNYW2!5)kK)yRpK}DgOFZ*R6?>#Hun~^cZw_1A{GVSwdkp`soX^ zjMJ*5kUO6egR{K!>jqc@r<;I?TK<9Wz{9B2ZxHEVe`A7?s;NSUtartpVh+o@cx~B8 z>rqPL8j9XZSvJ?-*5X}#mkBz(5d0Jm#6GF?l>o!k@2DX@>73UVQ@ebP*T@=QEaSrt zFxfC6m5gs60P(^=GXTG8r-k#5U*3;nkvZAwXA}Zp=+NOYysrhDjnUej-F#)wNtxEo z^3hjI!=3S9g}GQGCjnUd{&O0 z(T~dX<*OyJ9g^yL))$Qtb@z{i=yzHiw){L-dg{y}8*>8QejT+?7=@M+bTITU*(Cxf z%RAbmg&~N=I&ZtLBSTrnRS)wsSDcb$gOe4uZ~MQ66fJj1>=gw#ow5qbslV4tmcq|v zg2XdZ^J-v@FIc|ndztW+z)R%Nj!LR?M3$3YkMkPP%pN;*>qNV&CvSI)Max&e`0puk z`+Dvduh4zihSC?tV!$K?0=af@ZgUS64uJ%Ufv5Qz%t~R&y(7lHslG|o!y)Q#+q<}h zJ>>4BtSfce#LXNT=*sM?CL=eUkR$k!-yE7DGjq=Hmw9<+#NL)3@q5ifP$dOCpguld z|6j{!bq52=v4>?bZl+}<3p3jt+(r@0T|hzsA|P_P7TV@xf{JA-;Vm^B_swuwp4MMBz6_KmYQf_|I9# zOagn)h*bAH4WP8jYlV8VTQ)ZkO{YDrR&jM-{n*Jj{2$=L? z>|Q0`mJGsIDwH)c+w5@4;ZQ|M2^sp_7wKrKg#5Qw>hmaQRIzD(h5uUA$L4 zcDQ$g0yn3@o6+$-Api5WuBdJ_TONZNjg1d9{ZdDK8TYkP%EJ@s} zW~9qsz4o7p^Zes+{P%zQH{^P5>1pzb9A&#FYvO>3^Y`ie$B<Qf*0_v- z*(U1*6E0T{{!p&>GG`?E`Zaz+pDN<(Jz#r(mr!SI?)7{=;7S7KG^#XO1Nh;wfHaQ& zvW88`FAq^G*sAUj%Rk&l080@!2uh zJ2-Jqj~M0^i_%g+wC2;RCB7PY2|hN|_wVi^HoE40D?UMY1Y_WlVQ{7Ik~DdJr7z@l zSzPo5+x>kuLrW&ghaE{jgluQLk0iJIJ*7Uy-1S7980aca-c8Hc6Nb_`@y=)*4z9#T zI^Uvlg;0&n;AbCvPF!1W@slhtZno|cva0eg#y#;@hiLR(?Kw_&!sj$qYj` zmAPEWqQC(i(k0Icz0pBOO^KGz>~Mp=kjdoZBVPp?Mas^{i2DtnDUnqWUPn#B*JUw9 z7|vgpdk%Dm*rPI(?-3>I>-5uw(j3|~Y>)8uhVwqsD6KOO^xhlBwI={e@@()ESMRLM zVu#m3MiF7&fgS>fAFOp)&%SEk*B^Z(;ZxuHlgTDz{3^SYezB>`cXuc147&q=-kUBs z&*=4&mWUSOB{P00I@gN?S2^Bk>0ITo^Fe(oBk`&OUCZWCMI8aqIkrw+UVZ1Rw=4f* z@}hQ5N%F~;T=C`QcURl|$C=#4JZ5af$82+VbfRI68M2o#?uvVk&`IJwn@|in5kHxB zF^MCcf9dPhGz}i?V|nCbjUMTf)9qWeAb%t?VgqI^YdSCwB;j!O+f33W%{^J4!3$1C zmIkO|qhv=&@m9SV}dh;@2wDYoMq8t@!3x+$# zK;HYnj!4zsRiHr?B+X(J#XmiNpLEvHk9HmeCg&pt~>6QobhXMO<3!7D_X@olWIby!-Q!fy}RF+Be29ZQieIB4l%y3|a$* z-5vY0M?0hhALgT%U6vi-D0wXVxC1wY+bwx~^-nA+mBou=@N#|H z9Vx)I7^;5kO1@X_6L!t}FG?g2`t?(f4kJ6fLx^3MD%!sZ9hNw!$&sD-NWR#mq)>)# z0&Bba^$Sw52Zt*y=^MT%6v*RYkf2@h$-W&J_WWUCZ+yVxHX%`9+LxJiM`6sF&B_{nowSnD`IyRD75UOAbaES_&nZz6tl-HWF$> z-u6qjM9KN~fDk!*RD8s}vPp4G_3nY-K{Ib~AkLuf<1^Ez9b7AIx?SJ6YAyj&q5K*y znxA{GEo;1Yk+fWENQP)ric`#R0ruvG&i(Spo{~K868gp<$g1^)J2R&U=#XsIny0Cd z-8h>NF_Ypj<+JNkn+IPIcwV^V)hde9D<*vY^_QO1|M?lKpH}+pWUdwRO#@Rn1G`XgOE-! zfy-=I`A7jD<0zY+^7z|tj@N~Rs;^td3G%H>)UeQvLDDIoN@}zhKTtK2i_M)2c@U!Wv%i~k!kt+~W1=YsOTR|6#4@>2_maM#d zcII26|EiDF&)$=wKc)rycAYn$mv%!0{nH{Xe{$i2Zo;KL{HVE>WyhPK|I=pLs&nLI z8EL$WJ-o}3n|Y88P<>`oj9P3XY)73txcB5<>HkufW^wYdybu0|QrJkt zKm8%1xw}$*c^r1diqx7GdoubT_u$`}Y3R1P^WlufyspfCb`^XOFp&0GkG%@!`lgrm zZ2=hG4C{T>o{d70-EOYSKMp{b5*h4?E`QQWFUxap88LO>(|OEr#nYlpwrJPs|9g_r?0oh-;Ys43z1e^3J@a?H`Kzh`>0Q^`yB0c#fv^a4*r>3+2(%^0 za&F6dmJGmDF9alGvBi3j>TM!mq~)mbb-yYHgVNrHwb&Sg?{8W$&vqP^4=KcBuTPb9s9N4o^O2dzA;*}0NRu+PPC(+O8?YED^s zn^5Ljv`&@`rdor$*pYkKMMuYrTxNGqalSkv&T&wb5C5d+W|`VDQQ?NHgVF+o?f`3r zrN^BgKF2UZ1#8#L5-NRLFzuiBW{z=lmQkE+uVfFUspR#LA~OKGy>}mIg0&D;7lfIL_VE(_JW`cYw#u^;4zgb1ueDdsW9_Im}QBv}b%G?QEcJS&QUMCBPx`e~sV% zJx54c`J$SmZ7E^%@b}|TWBMCo-tJT35lKBf4l;-dcDoW7Kdv2!Fzg&*477%Qy*F|C z^y<&#UHgE*g(s97!}Vx+mf0qE0cJx2i+3%IHO<{no*O@=B@!a2-7EfGJDQL_xE5YSYyr%s~C(QArzk2{{Jn3$i)mZf@6j63hsTL#uEZD8d8VhU z$oS07eqpwT&B-g1%=xY!T;l|6-gdwCYgGJv+_Psra;dWxzWk2)#dfFiOSuDEK4of% z^P3WFYODNm@4gT#J6U)}+RbJzzpA~N4B2|6KsT1mzIsvct%#CU=#G(iO5BVq0#uVH zpJCuzQKnoW*kQ0t>)#;H&Noyvdeo}?kIVVz8pgki+0Gs+)D>E-VhoYuYSG=S^xe0J zQ08Qu%{U|5A`OlG&0&&cdan!zV9JV&hn%6K2(Wd-zK91`7gk?#9n4WERsOhX2YIHy zG>|$ot@XyvKh_(HtlzZq2lNXFwwS8S)`FeU&A6>az?>xpgUm2VQlSRiX^uy@!c1}} z=OV)PwuAQ&d2$wR%u$X=T*&K@drgc;k^VYdUKHAKnc+QdIX^obv6Y5rq8Z`8FqDcK zMCn8evrxoQu{r=&l(lW^0dD(rpxf%5IR91t&MQK##%%aZxdQG1nARik2_2dJQ1@{2SrXtU-G`GhUQ81%N z#x3@pN4^BacSF5;rh3_3V#WPZIV;_6U04KkC5@IgL9Q+F4 zp0ne`qZ}WhE-94zrGU1t8u)HO0e4c}d*qk1p$i?jV(Rv(<#}}T#|%qzBdZsPK+A~z zh;RApH`{M&Jym~{f9fH-A?uSD7K?qInKUeoPTxs@cg^d6sepY2$3P#He{qed@Hye# z0Xta>P?*k0gdsmeCsG=Zr-?k>KQrz1>*o}4ZlOB^u(LIQt61FZ2iIs}?Ut{=cdnWf z`@?|#RmEi_$+Ys{9Nulr1n23ckPOG629JlA*VyI54|7%rsrh-?N85sKhmlheC7CpZ zFi6#FrTGT5(^Qrjm=#-X9@b37J3lk#^MeNkA$&p(U1&fau$wc!VDHwYrd&Gr@X@yw zu1x%`dFXuYZvFsec#j70rJX^)Ug(0in$l*P5I6&0G<$%_KODYn$Ck=*hcg4q@mCg` zMIQ5sb~l*dJP>{=M%?>MZ}0ZiTuJHM-H(0YeI3Ap6|puDbhCAxkkF16Si|%-t}P9> z$MtypQm|j~Ftg>Ixt`SEh^*;OZ9uk+e$&I}!p1u1vPU|z0wUj7(eqS?m+C27c8rB> z!LqL^Q>E%+A*4DaiA_iPj>mXmXbna5x}psK;@PE+4?Memq95K;*XXVO0`HwmgSF^_ zEuI$HsRGZfUtU6@oWkjAxb}gjshOdfA)2uK1|8~NXOEp|puIoPq<$u(A>+jOJ>f48 z0{d&;tvGm^=g0j__#QI-<3VFT$Xi*$m&%TE+h@+#a+8Tup ztVNkk?nXBwQ!GgrUeDcFsd%c^%3;~o%me>i(ewR_RdVStl*051ob-wCLYHqvfJy}&AY+U}@v-=NQv!hFb*Ez{d zV>8~v;;plEAui9A^5>~;S@tJWd^(7XbsjHQ6e{6Rw0Qh}nchbnp9}m0Qc_4M7DrB4 z0x$mSv3mbGHvX^jYx|pbsQbrs?0=sAm;CgvH^@HG&brq9aXG)>9G^2elK(kW`mgd^ z`oGK#{>Pg2GJCA07iDz;Z99?W^R%bREdpboC82TeXsuL#pR>6fSopmP_%?L?CN1)25rJ=F+?cv{!1#W$z5mbJ7dBRRsaD1uKY6o{oQtpO zDV+s_)`PE>AE$IJNv#}y&su>?(oC=n=NNdaFQW} z-mMTKP#ga3l&9M+CUO_Z*b}n))}m(5KqYy&CyzV6%Ti0OELAM8EVns*^V8(x^FPbT$#m+*L|;=bbC&s7s$r!6P=BoZ#c2)Wsi3&SDK^i+Q#IvzglWo3Kp)X?Q) zFYfNwe%7wnmRTmREpR5tk1g2VcVt{C_d(Ka#k-Xc#sXwG_&fJWb85_UKWn{gjAS)Y zS)lMmJ^+QmO0stzwl--<0Mt4;_vz%?Vv!#~%AN$Emttq(tevI@CnrLRw8ReU*`%Us z^VW1Kj>2xSsh*FvD?xn}2Y3gR-qTiQrZ360ADWp4D}VgLE!VBf820WbS5HIxHX7pj z^MYm>EKs$_pOiuWa^rHo-7X6Xa{qbMVzF}$?ES-__HK4zmB+P5M&eHmLbDC*ibWcV z7CK50<^6lcYjx<9(kI#Zgm9nw#YDEA_Ibs3wr=(cMQmGGn%$HM^cLZZ$G>1d5gDVYr$}7W?werHSPVY*5NJx(07tjgCXIL zJ)3x=fbw+lGkS&;6Irz^%)khST=%JBTIqy(w+^6uX;dtPIMaIUQ54s>28of6gThTh&Rt{{s6vriJFQqIKDtXHK`@98(oy)O#U&tUMOiZ;tM+T_bi;R-a8} zf1I!BhDO|?V8Z7)!AAE_Wu28-_tHZ` z?9&_YX1P@YLa)-fPe@zYv;PBGGiO!;w}VPMdu|UU|FyvTGeaDLbs@DU7R^Xq!hDQiO2z zTla=FG0yh8sHZcokUsb=g z47M#-U*1f^{+b{zV}MT1(P@-vS?vf1)bb|W+nGosHe&?zVjW3g(FRvJGR z=}+>-n&nDgejZk=SsdZKMn+X9jf8?hc#mz^6s0T(VQNBUwaj$lEu3`+-ViPPl{GXd z&L!NJTe=ilENtBfGj$kr6S4t)kM`B|3jgORiA7UNaxcxS`K3JD^7ibK+b`D<{S`F; zORfp@FP3}_SMLX3-vVt5{N_+Tu=?_K%*4d`;pfu&`de|?`^Mu|^ab`-e*pwyL6`)o z!m?5f4IC9iYG7Ic3JJ`V?=EK=&#ngynul*#(4jNwTTruReZkP^YbE+8eJX{Qr&tzj znYrtZz3y!bh2NW7XXBX{pt*jYt8bp&TL>{IYQgMOIaL;)V_BP4nZT#`h|HHcdNm;OPe^~^mR%Q zw6%rsc}RxyEa=3TQN*baPZzpt>x~y5m&wcBBCS8}W2;f}9=@S(vFcOy3dlW2%#Gj_ z==z?JY6;3csNBaf(D^}@#UT&LD7*2)!WLnzhxDS0JLG&z4dCBcNAczEl3^c$;P@SV z!?+6QS;yvV^oxCh2R)c}`T5STvZfbf;tv|uqlx4nBMC=MzR*f?5lUZ>@H?;l zlg%nneT>^g>=2cz7`QFzzymUMdG+{mk>LRU_{!y%C1EW9JB$=-E@SaFNJVpm5G7uZ z*$xs8ZftPSiJx^zd(6Xb5dqVj1!(Aa3JG!XQww111BtTNHe5|%FwHE8mRVdsJvqxh zWT#%7VH}mm2%!y;$0|xp;GW>X&iAIRUu?;NK0kRIv@}GL+Vvd=Ed9di;AMz@*YX9n zUqmP|GJ_=l2%Qg}u9%8d&;oucLN=wF-S@94kKA4hb?WBU3lD0$x!swzwVcs|I<;N> zDVWsEUb$I>nEe^L0KvR;!W;jn9CJPBV~t@uFYm)nLz{#~!I@)n8$JuaIoM;93k3%7 z6eisH!(h=L-2Qz)Yiul_;f#QM?K{`lL;EyCY(yj6qhVzr8_Y|?T`AVA|50JPXSNP! z50%6jUemkJso8g1VBwaS%E=61)D^3}V*2>GWIrk!>{g}U#mc`b2osjLn69x^Zo2%9 z{ih&pmSybg%FAzKe}{BUTxZzk+4F4BO|1ai^Cjp-vpaYHEb-wwgSQ;}ER}YzWb=lN zr|%q3%F@+7B#&JNoU%$BG9ObXGWOJ^^B?@pGmZaaF8}Ad`@>fMm9E_PtbE(I&2Cjh zE4r+7fj;tsAef~1z~M;aqY#eIPd-ydQqNo}R;*4ZD}q^G{*VvFYe> zs=YMYcf9_@`PXW=%mXoLF`5ag-=9SHuV*VcA%2jg(hOubyy=8q!UC2=UnovFIS{yW zI>Q{ch-aVZs0kCPL`2Sw)u~vs*CPgRUiEzM6a9A8S9ntVp^;`+nPj2{^-g-`PSjDK zT#7*fP#yL#nwVD2^crp&A#T_W%t(I=M-F522y;)RUau?P@-1p?DLdkLLH=>CLlU4{ zgDc@{W?WcGI$FP(o=9@vjzM{3Y!(7mpz{w1@Rvx4;s{}?ztXoFF%Kv8h#QH#Nj;H2 ze(LqdTXFN=LgU(V&k1!TLf>#bad#L&{NZmxdRUdYW}*sh!C3*Jy!VjU?vRk<2Qjsu zqU~M@)S47|Lh?5)F(R97*DX7|I_2xxtWw`~-=^hyYQ8kB6;KFgo9)oz?joSnF*J7f zj*r&!vv-oUL3KtVXO7)WUNlRWU7I;}hFfqkAgLNd)1UL(k?f&kBdZ&--mQ%pC=}%N zZlOvhg4ea=lE3~rjn#yozBlT)=%=&Qd?9+FfakzmhPTRO0-$|LHE1V1Q8hSzTnzha zgq8vS!em5lz{LS|A>b(eX!K6-h9*ys_V)}uxsT{!ev%S#sTwM`9R+-Mf1m4mnqsp1 zYmR$*vk%(!TQ48{QTt&hg2KjRm(h~waKbW8E_YMaw+|MCsjD5MR*{t4OI~il3a?k) zSoit9QU{MEDwa^y*tC&!B~t%1cIf@UZs^(=FcMb$$6t`i8T zZgp-TvNi(cIi^kQmvqD1S7FkF?o3GJE*o!P%`cUtm;uNHGfv|&f2wq6ryvKPCTBwU zai79dq3e(^*hHTh1AB>iR@#PC9}I%4!xffal9KFye$;UdeI)cX z_ub4>Hvc!Gm+;BNdl3^!w$gms9BFM~M=` z;Oev4G-7GgfH)Qj)#zVxOlZRp;7>Rcqp1tZL z=I(By(Ej#&bC|HxjivpUzn2Mp{-Ua4y8|h%hO2kdD8r?-iI||8V(3$Q{3NPWC5on6 zJb_*g*S+#jppQRD5I&Q&NH&IV1P1+F)!%!)$ZlPVV_5011*j~8O+669N-wawy|1TT zD!~vPGsL2C88??cEnPX!3i@^DyLI&0A~CiYBwYXV(tE4S_m(ER1mGHYIb`QJGdDnB z=cR;M>Y;nBFv)NI;k+^9Mr8b({4#0`Z6^u z7;Q=x&8co^!jH+v6(n->Vj@YdUmg7dZ^yBtXJ7b&(J4QnRJrN6?A=G;zAr9zq9&-Syjtv$2 zN)0Ao_`RRhA)WM_s62P^0qkAZl_8}=+8;WAhV_=oa|3-LutDv~*M%mZT1c|;&byKd zfpsKuM1pa#!|4E?_K=yEGQ!K#k6I5#1T8oWeZNy?{=+)X7G)ZVndr-0Tkm&dp+rrG zJjGm!3QH)t#0dh4SQP^%`^!*$k3SW^w-X}b`}52j<-|^8`h%AcXM6hl{-yjWGI{;T z+j3?28Aq6Yx`LWxoQVW+=6S)gAn$b@&OR=B)!8(efr7HZvhJnj0dJoXyvY(qu>zlK zU1}&&KOf>*j-DX+q##i{@%2v%EgL!XA}hlKJzVr}$h5djTAIr`uRf)qP1!SvT3%HP zp*%}3+4o4ohnDwbe{)FSTl2Oie{&SZ2eMPoHThQfxIR-hM?-1n%oLp3$CR0-eAe-A zz+XN3@omBq=ILc}hV<&GrLRaC>!!u^;+583iZj(ga!fsnNbKKw6EEGP2f37%GlE*I zYz8=?Yk9y9`gOOI1WlSdKh7pTI2zxey4}NsTXb;Es5b&+(MGXLp%}FQX$|ynf z(ovDLwD_qG5iyUn2Uv6#m8QsUGX`0#?+>AQE|x^c|&axcGCJM3a4IR6?Q1X7(;$+$W< z?1R-CKyKhyuauelOKPa?z(~S%Y(4X5XTrju)8XpMZ)8QL*6ikqvKIM!JGX7VN?2WH zs=eTV^l=F!Y^qdfd^4%CutNl4Gl^Kn)&P?|N4{s>pmE(`qIbkXH$oCkL!jRfe=W^Q zgAbU!MYtu)y1h(G^Bm7+i6s@>ZMK;zU2dqV?r-g5ECy}_k&Vcmht0vJERQt* z9I4YUL<_c~w96DCcNF5tYwbEu(r?^V66&4(rTxS*7P7zo~T-1!)1Q!2CJ z4`*0|_qr9dZ?7KA3n>MWu-LEnDp&8_gt}2A3?Fu7K(9PI5JY@a5kFM^Em@!#hXGer z$x_yv(93&2CKbI6O9*7Ar6t4~JE3lRy%i;l0YxuJl13^bBF;tk6UTbaDvgoy3AUCe z?xI%qh>3IHk_yv0FenT>+nrZ>i=6)}(ht+G%?fAs?D#wkB^p7z>*a+`Qz1QFu`eIL zu{>H|n5?zm*g1S&l%l^ACOyO2Z6(h`74a9JXUizEXq!yPKzG-wN_Y+_Exx(Xljn=q zz|G)VuQl?`tCNw9c7kIjR_gFjSq+`Ip@vdL4>noKdc$0Jw&WK(il|? z!iXE%DQ82SV3+YoGFf}n1=|=V;2MoOa%^^dRDzl9>bHwX0Ze7Zp}`Z>3ZS`q6XsrO za{M&jV#FT0YM+26w9;Qcw2Txhcl6%!;US=l?ikP$#yL(N3+0H~AG`bGHwQo4@G0;L z_rQ$8y-IiQ(?7mUhZQ}${b}9JySYC=H9P4O*NjKx(mTChHZvbKzMQliI2y==5}Rr7 z0_}FM+dD`v(19!KfMD8>r}MYC?V5%&%w0byHu~QGv=$Teyi#r!;CB9##`Lq?)c2tu zJ}gABnYlAtxU{7KTKRB7DVF^36=8K^di^_1XdquB1A&M#VL2TAi-Pd!g|AZ#2enraP&p7{a6i$m4mFiQDCDM8NcU5i;&A|fR|CvOgo zih8b=u0V<}#J$r|YW9|1;i9ZOPl@A3Ap(vjoF?kIFCTI3?=BY$e5TpHlc3S> zwbxkaOVADc)j&lh@w`)rQgm?IA)1F{CWtI?r0%)aqbAgXmCY|WC&OW?qQVlfD`D8} z6_sCx@Zs`KqE2?hM1Z9Mri5-zUPV=9mjxpk$Gjb*{DL{l-KNC~Mm^$qg1nJ-?^5_CJGD-I%hp4Z|q>1oR~O&z}+ zSi#nKr=2%k3xnT5KrqfT5$a1}j^^rn30;60ES=^Ki*P!YcZuONlRVmuKU`#R5;z6< zdQH-fCwravG*s7Er?0`X?39q#91&lNX1CU>$~BNv4lM2wwNY57k7QAZ_J#dpS!ml# z2k@DGB5~(*&q+nKs#AH2g1Zg-XEqlyrx3Qo#b>00vv%uIT@j+GWrjHp{_;{8Jrnjj z)F_OQ9a<98w!g2`m!EjslTS!H`|=n@*O+&-&w?ah5ZYL=*5!eqgP~v9lPF$XQqUYq ztdEYz>`>SOelzNigptF7*L;_Ji-vhV{}>m%yW@>icW1~#U1F7AHK#lUwX6Uk&9zm;PhTUC8~UR%Na4cn4j&X7d5Z|QSFzuFLWpsWw!CN)xL8+&|Jdg3E zhf{UP8*jd2?wr2lx5yqa#D3(OTZc%>3;faANysuZ!Xy@`^%dB)RhiB)ZtP+x&PzD~ zRk-)``lI&=767SNyJf|Ame@@74@sIMQ@=W|d-$L0T5{mCko4-39`u5pKp2K?NX+tnl?oTCEgSD<(?CWKlj~{SqRPA#lwgJiA@%Is|ysTZIL>j$8(IPurLG+NQ4lVgCATL zj1*%G#k9pLMULcqMhmDf@le)ElF;Mdofuy1O&Mj~22-{uZI_g;ZfkriWU`L4)gpV75)i!)>n&$#)M3Ib-;o6PX$rE>^%wqWg_5S{aQP_6Z|FbN+5QE$`9GKZC5!n#R{9?+{inrkLXJJ8 zmh|FcEgVB+9a&F#@+GJnlI=;80d0#7yrO99l@W)*JF>8L$rbgn>c)i~b@ZB(Xcs!Y*k7qhb7m)fl{{YCck(r+fthP`B>ZQz z?XL*CriL<^<{0KeOH^f=q})A9*Q(@5(64%8p|8sB?l%!<*f-$CBrXT>2;chvlJA*- z$kNv@B~l<`3gpf0ExDdC1>hJQgr73dkAW06osf***kT1f5^hi8m6v!CTzyH9xj7^2 z?3cZ2?u5}*2eF%)>Ss#7^Iw-{mkFcD@Y#wViTBT58cp^roflZ0e!AZkEH`_-j5WSTQaeZccUCtMWXKT;i+DhsR%&-UQ zyggyoT_Pm7@6%&VTTO{$ni?fTX+{Up`d_NMK-&>QCB?^r8uDHNLvvg2N+%mDA_x=Q znZ~oWyhpCsTL?b={N%^aWvjzI@+4<1>N<7+6b>Fj2-Me;XTjRIl-r&$^UV&Ith6yy zwccxUQ*$F@9!Y}xkQTOI%XVU1ijL;Hd1e%(m@|S|IQ=)$q0Z!aCWO3c^I$~DW%XR5 zuc}6nsM_3cy2*6>wUA4ZjmnLz<-vr*zR!w}W6CtT%*CPh-Qp%sAHZL}%e zsn}zhrl)uZn$hNbKtVYf$r};r>dMkDX~nUQXA3{qKFlsSeEdZ({>c7iZf4pvN5Z_$ z?Qt*7wg|O63p6`DkDB_`Vp<-DLGbeAo$#6dY?o5BnE6fPwYSduxVCj|YAc7kv-Z&` zbg5wFEtdu~j>T0#U66*}%)A=aY85d?{LQg%4z#1#j20ExjwWbtJvB2!Ht_bx4phw4 zzdr0H2-y(^=6q@w*PLn`ABauqcfi@8P*ZyY=pTfhX4|T+f!!!Dt;Q+x4#HD}JQ|Mf z(y0)|Hr{;(Xyl2uTi0oV*h!q`a!pFUTA4pZ#RGSMEKvyj3&CY5C7EaxMGt0GyMXhK zA95rmBvz>KS3)FMH_E?Y8y-)-y>fo@h_I-ItR&5UubRBMJHiP0NGj}Mm#CsypnwgM zQ|b4HZ~D+A&OgqLPRUy0B?FNJgsW^l70p}it+2GChdR$f=&S0e7nr=JP)q44 z-4t`?2y|VxI@YrCnc|Cz93$$%(S^r1w_ZGY(hKZftNB>rOHR1fYas(uKn%hqmgq|x zgUy*fsw0djl>Go%zj6HWc1;PEtu`|pQQ3w}*1vVqcz*h-Nxjt9mM87!XTuM+t)x3@ ztb?eMln8hxc4+{%{ARhjbPPIx-<`;GTwp-mLTicCg_V4U%z;d&G-Cd!*Dj4xh7F+5u z{PJAZkB`uQrY~mwrBmhiz*!*pnDRjbh>S)%GoVEAue2xb|vh)Vz8cK67n%B#Q`i&;~lM zCFWqo@+kef=g_D0CzWnRgOFZlhY5uXDQd-g)BohdaRa*saDH#p@r8P{4^v~ zo@8Iqmv_IT&Fg>A&}U+^x|kZ3F}OE^kzf3QMCGD`2935$nh3#-0oO+6hx3PWHnOnV zOCid@_qoP-y~I6mO%~_q&k!oZFLk^!TW98khqO<4$4T3{Yq#)KH?Txp9t z4Ld#Hf!gc#(SV)vowSAZ^q)^nZDt>ka*+Rp^G&smM^u# z<;k7ol}nu_jsDf!a7v%GPUzSEOUsH?^;o-Mahv2*=@Lo-0$TaWs&>*s?wt*IAt7f2 zYjdv=lqo4I*cp^)c(}AY+yS#uYY%5D@xfbO@p-#T@mX| zNY@6)ANmQbr}$by&E!%b({#$VK5YK-_vd5#umKnA_8YtTAvqgtRtyX;TBywZWH{+% z_)s<$O0q{(-k*|fd*@5_#ZYFqDO}vTgtD5?Yx*UV1KuJeTT5qZcvMkoGsrmcN=qm-nh= zsyjBYP45a3VBABohaUx>yTcdMv>>d*S?(JFIQNZ8nLh*p~yrM z`y%-1_h$*T86*@%89TZv_R6)t>O6|oJrs1fB--Jt<3;|O);rq#ONH@2r^~)@N^?}X zRZYbBG9;^TFRRn4eJr7nEi()YvoK#{rzGg8V{Z}IV}4FDhB|$vgff)&y0!m7`?t$& zy?3hZj%b$qB@YlLMkq+88lc+H)X&>QKd6FS3dpk^1Xi$h3R4x?3&}ult%7mYb)u7Z z@kR9mFEH(8n6NlFr!OC>#?R!dMK7oJy3Ys zd$>)8`?Q#u77oB`;UywX1yKfyK~u3r4lHp9w+W*FeTZ zVGu)geCXNt%Vw24d>km@T>AkhZ%)_~QF)oHs*y6) z53|dxW)MEZ=^Xm_VwCLDZ*~!!#ft$&O8n!bTQM`l7!5<0dsl=g^;blVIWsTNnh9%r zOF7LUCSlL1r{MB?NX(7{D?_oW&Zon7O0!0HXr$}&WWl<+Kp%jlrdL?%F5PuTdO(M) zpf750rh8y{>4DL7mwoLS*K2q#Lz3do>+=Q`yzkoAuhs|3v+DW}%~e^>W^?OkU|sH` z(9Wy#$Vx!KG>`mUny;b?(@z%S5_8Hn#FhdKNds+0K2Q?aKbdTJ5?a0I;ob`C|mzf2{cD-yzccuXKZb ztLHL=^Su)>}?)FuPL^SqHAk|Az8LBFKij}QXy zd@HW0LG7~3u-;w4&CcA{9D+X*G&@AHpS3CiGK)%BBg~EFzPa6vB~RfGMI`DrIf6lC zGzK+kJndW?(aw+Y6FE_J;m+|}9KSw^Oy_ePv2SX`HJ8%;*`(fN+MJ@30uwKW%L46X zK`*AG3b~UfS{$d0FhkC>W9Oj?59DJkiTMXiERzpQ+<)Y4eXojV2MW*5&S1|JhD(l? zEtc#OCLCo@bP!0}*LyqB6gwn2SQWVY|Frj=0Zn$f(odph)VBD5fC9L3Ib9U zkgg!zfb<%IC@NjLf`CdBFd#KRfT$={YABKbq4y975K0R7)o(t(Ip@x~cjlfmGiUDM z9|>>v-r3oE?X}nQtY<9*YDb=UB+ZSFY95U43VqYH7Br)rUzl&*Qv4O%<-6ez1@B4f zcv^IWpfDglR$U!pK5{9*fB!5C*ZD^x!lO#8@e_G%UvIqOzV>NxgOWM&zTS-C-gs~F zg4?D_EZXzzb}I>M7OR0izH&c3cl4 zYM7)%F^GaKbN11E<)gNo)uCyyK)p4AUN4vY_g+=+*BL9T(626DU-plfyxKjM@?dnS zC=_eM{{ls+vKQ1_+h=uIpg?t<*#VVy5aTD=3L=u z0;kaPtbi|jmL$Rmq0S;0X-x{fo|=>}H$ zJwU1YdpRP!(E&!@X_-prckhV}?TGV@!RJvXI=UXU6G~F)`Hl;DV2U`lR z$W}Gz2z-3*$z%bX}zKo{CfRSY+&$Vy|og<4OOxpDP`LV zhp@nQ(u$QX6-&j`&a^Ew%HX*69|6c!iSep{*Sf8yA8#q@jviA z6;=+nqqJIk7sITKD&R$F{1s(-KH2qacpz7)XxpW)F-Q!`pNoOm9PP1j$}U5gU(!C& zT!gxmwme&J3!&p&uC|TwNEf&$nTAVA@)t8B&Es?D+;VFy9NOdrDwZh21R`=^03s{5 z=v7>bYw(^S5Z@=GUB5Xvbu7-TQCAgm@V7xYkE97bZb80BK0Biwgf!awvBlLhQ>wakn?J=x%xs}30t=VQ zSp@Dh&f0ajw7_l4g#pX*u8!rIhexm1xICNb8C?~8;{WzT&)0I-m6WZLx^Qvc_^&Y< z7I#?86tMTOKj1e9lzw@bobih!mHe>rvY^%K0dk!3Nvtyr*c9%sObTU4ywKMPNLAa zO7ya3ux1c}`0>=M!vh7e z{BhcrD;ketN?pTiO1-L(F=Keb`{?$vuxA>T*Efo2X-{y@m0DqmChc9gN2o9`? z{)9MUtm*W2-q`HEA%+^iau&^HkTtZ(DjZeFLC-h(eBxL$|Gk0|QiQ(Su**!KIZQUG zFL{I@Jf}TaA(@YB3&c*Ltv0IBPW@=CxkPzF6Tf?7TvMg=dyqbx?!>E%09LOVxTP=N zA~TRCcn5Q@a;?P+~*hQ zIyj|H`;6xn7;#Jw=cXj}r6IChg6r@Qeu7|s`!JQ#Pi{-j;3BI;Uq~lWNA4ZzA`snU z1&lnShem$2y_4(DV09OMiVtwCj>p`xX!%>+Up3*a)i5JyL+s~g&vuOK4rp~$U;}^fJXgO5q!05rYuYta~ zCc3q@Pyz@{PbN_KzvX{YPZZHM;&L6>gls6}4Rm(!jiulI$}>Zn`p}=eI9$>EK}8K5 zf0t#-KP{9IKYi~NrQs5PqU8iIW}ozJpVBQWl5d^$*D0dbHWZKR!(eU$d7bJSVK=t( zUV3!j5K1&3y%eu=GADFt>z04umC2PDT}4gdL5+Lk!1Qn{f+_nDbJ*88{vy_ZRo{G9 zTrDtvIoFR}_ruDgg)YpjGi#59cw|p>fC@W0rA|?1PW5J;FsC?M`$}eRNz(4M z1BKlr!LSRcE%{MH#PTpD;FX8w`@-*+eU*EUj1RCKzbiOObZY?FDLp8B_-V-hO;c)G z*L7CL@HM@l!b znST{go=iObAS9?;22?7k%OW_|%*`c>Q>wuxp&CVkQeB6)8TCBc;P_2VRH};+x z*vWlCJFA=sg~yCYOr96Jb51=`@~g+*Gulk2C-=JtwdYU+d=ci5UV$Y5IvUVRt_hg6 z-vNF09eV`C<`Ci$bgkblF04-;xgpe1_^3MN4ER}umS#42kdo0(vT|+CzhdCCP(Uc? zhRX+=r{t|jMza+%rEW;SoDn_LgE4+A!&*@O=7w{7T$nw>OP@iU`L$&y=%U zz%S;IZH^HHwm=bmT@7ZwvjG>#gTs%3kAJ2v^V{wHR;849*yQ9x-T8JBtq55x=e-fymxH678qviJ&YPT)?$XV0 zyNbYG9nnjmrg@U0zYo*0+E&jariT&7W)!B=&;XwsSGf@AihON`gy~X|i=_I_GINMRKIew^0Ps4cSWK+8z~AS}{kDz_Xj z>`{-P1mK`bPQlc24z*gx#OtK_CL^*7qtEFxi)_qtr`pX9%~k_RUao<#IUpNMng^$} zAgM=5i3f^dY9pEpUpv;|;Y&$evuNX{>tS&C4$#^MloOzvP3^G`+ zRBW$xVzZ69LTjb85wAzf8Y*K0>VwOn=?rrny-?`uCh@+;?d`%w#hW*|egQ;`vdF#o zp)?)QK*e);@sJ1I04hgu~ktaoOcfOiR4)sDIqqLim&!fmW&hwMBTQMKFHBK05hZ|N@4&>WxDLNj&+Zjk{epbE_>+apr_b2aS%II zfaqc!D}b-ZQ;U1p1{So|}Lq79G6I{I9b^!PYgu)$NUB`RUQl|~-TqC%Vwy#B;KRy3Lql`HFI2EDYaxLbpI00K^^Xb8S%BWiazy* zG3vs0RGgl;ek1&1$+x1T(*o{I%8H7lH|1CwYOH2%lavHo=$o6dg9MNWK5>_K8EOAC zM%peNa(D6VF24V^5-7VI^Z%HZziYa7P1pZ7ri)Hom1~l|9psp?GBCp+~FUMNU^B?`2nOb_)rB`;1qQ+hvr9A}-FNJ2(hAm&c0B^1ER>R`fP%E4Tur8$?(5Fo5J6OXx zDJmOKH;NHVt%%+S#0=($;xC6*XehHqUT?SZNT6t7@6oq>Sgn3Gl*|P)cS_CiO1Y{ZBO@0DmG|#AQ zlt;9)NqXDNuuUN1SHZq%&$t76^Bp#t2c&izv;cB~nTNWc0(0Slp z{>HKcQu_dWRY1VbH7kJ`2zm2uNDIq~SJ06w|!;0kR=44xWlFskblQajAQVs{Dr@`l-F3H)B@2@H+$?*u3nk}4a zdimv~{_0|e?yVtzQ8m1$+wpoW?5V*DDD#wgW;zo<(@z4OFzE`u1%g;#-qNT0@ekGA zw|D1ccR}p#2EY_>Z+|8ve;&FNm%SmtPaJw9dN!^ku6asB3uL_*2;Q250*ZI5KrJ~h z5X^QEFtyqQ3VY@bDDpKu`BWz@z#29Rq-0VoLA>8du+<(ipoR;`aE#A_Xia51po|pU zCNFpgbX1j@q?}1v11dLt+}Z(c)_}kzi-2{{*`P54l9*q+=%}%PK~|PREvvw2k|FH7 zUH?~4I6U9$fx;}@~j;nsPz>jjrtznnVO#T5N#MMxPwP|@qJ*&Kl6-uS$+ zPBO#1^|o|Jbq;NXS2NgMIhB_vR164diooXNVsdNrj(uKk=|i7U~mVE(& zpDD3fu=r3CLkn!{J#T&^jw^;)k~_{+pDuxq=VQpDs$=}eV_bkmKQN3W_WB^VtXG^j zux&J+gWBVGCS_4&%_7O5Y60S5Iy=Q`X2q z)e2M!6s$s3S`+;=0X;SI<+xRxeaZl{VW^XBx_B;e;=FVrU-}DmhUcH2iK-q5ZDrBI z7xf350o%g_>)tl}REF?l7|SZUWIjWQEA}f!jfuwKvr586^mmqqI_5PjZ1*b#^u!eC zRiF&*vSQPJO2qT^%3*mfZm&qW#Tkx_aGP;f#^s!{tr21LtSzxDh(MOITYhAOs`yZ( z0H_+>Rb*L9*fd|l&3G!&IHGyhCC;{Dc(iQuTlk$DbgE8ipPszV>K|Pe^%SG3sK8}l z0jT<=kyEW_g4<2!yAP*```6-UDoEtIn>F1s@3IZroPmJ!EsEj}=uW!!4oKZ}Ko&K^ zHz(C0RHjC|3TP=TOi57%OL_-1C-yGB%lRH=#Ld69Co%hNTHu*%Y^frSX)|=fIAW!O z0r4;k>$&$v5yZ~2Tjm~hk%?igH6vX#bt-Ho%S^i^JB^%RtrRiWI~9|UpDDDCG_leN zh%H&kd_p)|ovgGGA?Bykpy>_~-@C$Ue;sqp;H-zry&=VuL}8~KpIUf7!49%M=v3J4 zELMnJncKkUS$grfO&r+c!jgt7ANrj9^=gU5?M~J$&&OXRL)C{ojyk7*xnrMTtO@Yw zo?@YZG}m3Yx%Ki00yAxAO{N!y15 zIco7y<2i4AQLWM`a~t~>n1$!5*q|w{Eol}W-%dnzzr%UVtYg+9u{nBLuXFpO(wR}= zPZGTkR3+-Kk2tq4)=&m~vEBp5y=EIZj(A)iZqUWI3`j6Z&{+Tm1rzmWua=JR%P&&+;yhUpwlxxl$i*Z$(%e8S+GXa{Lwb1@^bC>k<+qNGOi zc*_Z~ERa#+?$$x9Z+(UW%S)gA6m8Ec|(6~Xm5fcI^$@%6yA&< zQZ#NSn%DJe*)hQMsW}VVo4c|L3?}_OTCF^`rngEArT22r#jGvv5um;^cbDrc&;)N+ zaD<-R0hQ{?2j8msZql=;xvq18Ia#q7C_7=|^~}z)Rrz{HV1&+~qSx_}hMw(~_wj3% zY9t5H`<#zAGd+z2S{FYlEuODXmV+42Rj^z`cvjfSNH(g3%rGTYd|;2KH7dq)OG)%- zG=6cqCF79GA#jW_QrCt2`9=-K# z;0RTn$%9|$waU)>R(yD=YC$lC^O*7#_F58zOIfwB^|2Bq=h)J$~D0huh}jSaKfHroeyjKx=}^sH(6j~ zSQe;YgHE?sq>}b^xxJDqosh%Vjx#(ze#Fbj5FK zNznFw>xWmgX%7crn$%KmMOuKG9!Q?OjZbU2{VY+5X^{A2i$0;cif7rYE=SSOb)ddp z2a1OW2)G(S@iqA^3Vmk8oIJ}D!N~)48(l4^WeQ>$hxzE{iUV}qr~DvNBRx)^zc+>% z-?9_^4*hsU|2pV7n~P~@Mphx@M9Rd*eV`!OP0w%Vm zy33749c67Z-z^vRERnAIbze=JewoF(pAOO9*rV%7L~rs2<{{KEP)N7SjEkjMcoB51 z%zRx_)2pst0(|0xfLvN8$Lz)S#&B_Ai6VSnxa(P;%EPicCp1?c+{bzGxmuV|bVEGjlFJMf+~6jqjw(s-LXhia$$bE`Du2_H_UU2@Evl@@30AAoWBp3c{wXDV0r0L`t+#b- z^NSK1&r=*+V6ZVHTuE0l!HTic$skeoJd!c~GBT>*$mu(i55L~X`qpbT43$T8x@FXG zaVuD9dn1bVs^=+j->f!e%wkAJv0nmm^O>@8^>QtgF_=ckLqnUmpch%q2deHYfdRoh z+1yu&YbNn}R&Zqwq7!m^f7-1nUG2rX+6*A!`5hLhiGv zC8+h+eOY`}?Wvqsvg?AKLJ}*HBx)JEJ zknii0$W>8UC+kE)>EMZ?rn7LnoD;K`c#F&N0fI!km3?XY78)N^wgg3JEqY2$R=Rp^ zw+JW9JKdDrpljN7sm7KDc7lW{RMJRt9fDYg32+lwM@1ZN?4Kd?>R0vOL-@s$`nMSz z_xYTUOtdMfG7^h_tCtqsHzRm2)hC8zwgzzvu0+`d!XzJ_GA@=VTANS646AHlD3~(0 z#^YiOsa7xTe4P%=3s7qZ+$%3gziB(k(cJ0kNw|f_kI9unwgXGGXM9jHVAyvBL?OVa z>v@YCeHmTkXR8l6yU@`8pj|LAz9I0=nOYZz$hIU)xLP5zsyk7dI+UcazdEf>K*A!J zlHukCG zK5xStrC~Rd^|?BHUp>?{OuXgq9fb9*d%M2W*E1}^vn?FuKiOMuJiG{pQ#mwo1G%K! zo(df)jh^5Aw)G5jo1w>wHqg=t*5EVbrUEg``* z<1u=A(t?b&HVg>eCG!0t&GvuwS@s{#qrjZ3*GahTvu2<)qX^A4WR;C&k0yOV)C7P2 zo`k*wjvX-ad299f4t6$Zyl>c{N$j5Rb8T@+Ho6b=RFb@pC!)yo0 zuE~R~F>T*3(*lZaV;{r3slG({Vmp#&!sU%!cI2->BVn1qb%qt*NiO482U#K2ow&sUDWjwyr6Eeslu#KqKf_mQ$X4r(L&=RYNFTP27fk^##LTwMfQNCbb>Fj#gAs@^H)2;y zIoi$jzKw8-;bl*!lMbzZsunU1?%v|eij1C}&Q*oVL7Ahdw(Z`;1U=e_btI+T4=-6; zn8t)wbBp&iuk>o_L^80~A*V5Z^z_BfjSoDsC;HoAR>;&(#CEW(o*evZNBCWOOi~Dd((tg2l%kB@FLaw*iG)f<$xeIA1kX3ryTEt&mozk^85J!*uqw(+?1m72t z@L^tY)SA=N7=SvEsVA}WBk=;;n~(p84qO8%FgAki_gdf&8T8w z%L{S_A(HTrQnc;joSYJYUL=XUVib{DfuA;5vZxjaJ+^_HS?J6Hg|mS1c( zN+F}2eT!oNNLfupt)({Iv=oZ^340zi9mJT1U(0!aWZcQj>8e2(j?bgRy)V|oU)D?e z?SWxH1oX?=FNl~~;%{sH7k+9|Us76sJDJomGOH%qelYdi7{7JR1m6>$XOjl~RJANi zZkykWI{fjC{?RfWW(q0@X^U(UC4&&LbjfzhjSflFlFwi#~2Mx|k4Kqx*{p1MaIyvz;$ z4205kPS746;oW4-90Q{8g3$mb8_7;#(pv^1_#Em0ihJ!Tjb3O|pN<-y1?xHsK)rMc z6k!nUOE+rv&|M%QsfES~g4sCY*7gEG>BoCJp#4Dfez&{7VKV8uoy;uQ1Rv>?MO>S* zJZ;1`tNMDM?3heo7R=k_$@=`UBr~;WyzL*(@Y$e-;q_qu4;fM0L zKXxcHIv7S@L;(UOCQ1+dlVuoTg+_@|DDhWrkYf8{mojQiYdy*5X#||Li14ECfwjJPE$vhgf)GGVtm3m$P za8DWoa2^f~KxoNe{Suf$w)S9Oj|H?ZUe{!9p8TPUyMGht@rnu1`LYi1fkPUbe}E*K+cEEtWSbG%vhZ@v9QX5Mo`IHq=kP zVZDZ?QRO#{^D=myB5A2G9Ka;l4^lxNrONJrP&&W{hUQ9bI|0&mX~5S0^}IeE=>=*o zkGky!7z6xy7+R0Kh6Ahw#%2eUo4GNE0?bGG*By`!n1KFaS9aUpos->l^4nh9-8;MX zWY@;-o(;R_<*pC$|KL~AyK@9(eQTL`@g1fGg8VuEMrLTQg-C>YbB76UZx;g$V!bsc zPgA1Ff}jIR6)2M#8c@L#9!fYgG|0Fa|)mIjP0G8 zBKMf={UYQQJ(uhrB0zRdu3TSi5@>7h@8~2TX5RF4oq4v{b3Io`H5>FL3e4U7sS}~_ zhMrfIHRkrD!|h3p^OXbpJ#LMjnbO(?ea?SkD1wi-KwvMD7T*yxz z!I(c~cz@k8WFbVxwC`R1r}o99w#O$Y-`2bc=2^KikH$8rgcmqTc{5`qf(Iw#E*_{B zwTb)4=ke+S`z88E(K*aV#y8B18&;`GS#kox`S48Zq#Y37>vzKUBs-3k>m51vj#cCI zsVs(N7+7D}oPG!jGU$`jHa~EjVB{lXj%nhL_vb&aBvZxa{`~T>PO~FLVn}U51?n7O z3ih$3X2scj{%BWaSYcgq#+c+f!@(CeN?a{s)Bf3v?(qjV)?_uz<#X1op(we5zQF@U z7}Ok4m2b=0>&_EU=-x}AA{7vBk=%bKahN69dOnuiOQ-znqDQB@K?OJ+J|U-nVz&m} zE2#ront`c4NtEIAI`1;`K_{rV(@iK0=_XM;M=GvZr`a?;Tod*RFIR+@mpMo@MybCY zKMUtCoV>rPIa$S|D(}IhI%;C1UR}VyR)e7F_%2l7EG0z(J6{rtC$@d?UAO@+79OkX z*{`HExw*YYOLstkZe4~LNESa9F~a$T^Y+B$Fr$-ns_cIaqW+(RasTbd_j1s#aKHwH zcR*?AS;_3RC+;eTm-{}V-ynO}CCp%gf#LAAt$zLpW~tK*jM0|$#tI|ty{D?=q7rU9 z!f|JCdm0+LmoJ1K6f~8Fnjf$!u1U$ z^TSV01Lf(jj3)BYd*RAaShV>zpn_acT$f9-cO9y6;&H8CN~^C#>jY-KTTafj%UcNM zBda7<-n6h5@3~%?ar>35<|7nHaTui_#PDk3(ig9sV@0oU+c)Rt+}d7elp^O-rrbJ! zlwd>brppb;J!f^v;FZWtmK{(ar-k_apEXE-5nz6jZT{Y`7>?i;mQV}t0Gt)D$nBP< zYlUB~iMP{-=}T*3{EF^dSiIAb0N`7`ASJE$=1VA<@Yv4-2Ac;ak-Zh^diuv@E;E?0 z98ZI;6ir@@kZrS5ZDYC{<&cmu-@o19TQ^xjoYwP3_`0^0v|UEsNiascsTkKR^yALg z3v{n71TI9{EmKylj&VAAVh3g5@AKUGufKkF!hfjatM4Ag`!*%nIIzRFdV_MWxurtw zVSG-7dc3BDcXWlxh)KW((s-jr*%cwY8Pm8#9Ml$gkMRmfB4qM3MqbE$a#NUyZ3*uy zRS5#0@x-2va#G^&r>)o4ZF$$nx_~W>JDo;|dSt}v1|PbBxYmtXP}3@@d}>?{z{F2A zP`wo}$?vAtEX;z!pHDxqV{KzQsdVwB${qLBHRX$nniA_MdpJ=C=9`7A%sm`D50!Yk zxU}t>F|tY=P}gKiV9aaaJve7(9MvDcgt9JcxM#C^42c(gqrQCWHET6<2s`In+>#qQ zVamRE4vr-^Nku>b+7wsbm|OF6XDJ8hI8?$5Za7XN&UhC@U$k`-c5!@e53Scf@sL@f zk)7++82(+LK;DbyoZ$ zasA@k{2iC$QE^ls@5Z}50l$(=_N33c$=WEMn3{igoyrKh3;_HYK#u)y7&Cz9uQtMd z!p2OzG(RAj^9RIC_e4-eyk4hq$}np~C&nF*S7rZ!@pJEhegetIU|SR5pQtma@ZjZ8 z8+L<9#HOK>oc+G<-@4a$z?y(E_r`07eRdPr!Zy`=IQhY^#d3Xj3kvUUl7F>L@{c?e?zv0LMxCi@ ztDJa|*2S*p3=00^1pNM{H#&H=4?0+r#4n)^e z<=Ab+k(gFDMarRce%pT4CY}E%f4}TqoohF<*K>4`H4h+_qgY7gx;=t&#tclM`6U26 zS7o&wP^>Y^=qVsa_E4MB2_^?}Q4)W$kZGy_Eg9fI&#ZpQ+%%Zyr3AzlGyoTek2$ov z)Vc_o7Hm^67EmGMT@C|+ajRS7dKBSxcABzA-(BD$I0|GuoTH6=g$aOv5}%&~ROoWp z7G*_<#u)&(PN%ZwKP&(vU2V0p}DP$w;fcB(pJtdLE zwnTvMlM1GUz&>*UgY29M2QO#!f;ZQBf1kI8-D%sMw*N7!jax-@nVK7EYxmA+`$>Ju zzCx#N+Nxz;(*C+d;rV7_(jB802QM#}8o$lY5k>?y;kCC?Ue4N8C*82q?1t}ml}tCu z5p^2AnWiJhfYuSpQYu(dx%~%}_FrdrBiw3L5<#th1Y>^Y3ex}Speghf4?n&4`>{?f zP$ZrM23rG&{%_p~v`~PzuR{fbi2zGE9EIB64??(pTP{4`0-jJk{J&*y{T-u8e>6>Z zUh^5p zBi~02>os>jI5x1#)c75U)6!%=>f!gHki3(y#t;s&I&7(Fi+2S`x%&MtrgW_!YV*%0 zK`HvbPTG*B;C z!(xAQ%S!9cB$v=MD2~SlZ|7w=;IQ&oJqN5hNQ-AhKCs+SQHVq*j z6hKdtrIW%6{QOnLG0i=VrXkD<<00o%_+ZT_mmSbuxEN5y_{e&D#OBfWu(j+!MRsy8 zAPhC^MwOAt2J|5Q9!aEU(+KQ2AnA}_Z71{A1eb%hf7?|e)==79=6H*9<`PmsJKDy1uqQqQf271HfSo=%QT~|&SOuW9|Gg#t~0!5 zN(BkiJ%t0YYz#5IR*B)g$*&vCFSnWa$C{ugMTL0vNV)wB42T*RH^S*_C89zt76Y?#82-iJltv zW08x1l%(f6=WQnC^iMWdVVldj^ubM@K!6{}ZX8qHM-t22ngQ+rK*rnGAMc`oHxFEp zH{AgN%#~Pn!0Il_Td%eO4mZ}=(0*CsOX%pSLrA;7f;Q~dPz zz|%j1=YI~5oh%MqEjrgZ_cvJejK=W&>_TSI1pKpSPS*RC@;9mu`O=nuSocWs#Z{Ug z;N$=3Qa#fj_%^VgeZm|@V4b`aKUg$K&&AFo4WSV=u^9%^AvvL{w5-#X#}<;K5a-~Y{z{GZ(w z^{ckYMnXgSd;AT6d6K2P0}+9{NQM(2#5x6BT`r-CujyN3Y5sXrs%#*-5YVa6KTP)D zJe2>`2M#6OzMFV%gA;@kl-ioi+-QDH-x5jl7ork{K|~-sG6T4^1x0|2V&oKW_wwos z)AjyCLAqaVl_!i1Hfdc0mI{_FM$YXT{06=Cc8B8$(l2>;>vpWa7>)>B)FYpGl0&;OOySsbW!tGl5f5nsT zB-T$`XVpGlWL?|y5>a=~?LAKI)YeJl^Kb>DHknf(Zn^e#GhYaB3EvZsn+_BMH+nQm z>-%U5&KV|@8)};{4aaL6^Dc)E!a8X{=>8EE@D$^P|HD{$dI|*yC!jXLy|Asb|53Dm zx3PbNFYM0QA3)IV()j;pX|Rk*D0PHt3iU}|3eQSEJaM}|Re7b#OW>3T{E3mm>8J>m zLftvQri>Z}27Q{@>@Zaq-9MMxCu-mm?==59wFctYk${(n;U3YbnKV)0%B+I+rEY== zgFuCgcObG3ZetX2{EF}YV_OkIke@F6j;qn_4E`@ivD|(D literal 0 HcmV?d00001 diff --git a/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst b/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst index 0a57040..1046f34 100644 --- a/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst @@ -17,264 +17,231 @@ POST /v1/{project_id}/acl-rule .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Yes | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **2** | - +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rules | Yes | Array of :ref:`rules ` objects | Rules | - +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+===========================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | Yes | Integer | Rule type: **0** (Internet border rule), **1** (inter-VPC rule), or **2** (NAT rule). When **type** is set to **0**, the source and destination addresses of the rule must be EIPs or domain names of the public network. For an inter-VPC rule, the source and destination addresses must be private IP addresses. For a NAT rule, the source address must be a private IP address, and the destination address must be an EIP or domain name of the public network. | + +-----------+-----------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rules | Yes | Array of :ref:`rules ` objects | Rule list in a rule addition request. | + +-----------+-----------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_rules: .. table:: **Table 5** rules - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=======================================================================================+=================================================================================================================================+ - | name | Yes | String | Rule name | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | sequence | Yes | :ref:`OrderRuleAclDto ` object | Rule sequence | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Yes | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | action_type | Yes | Integer | Action type: 0 (allow), 1 (deny). Enumeration values: - 0 - 1 | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | status | Yes | Integer | Rule delivery status: 0 (disabled), 1 (enabled). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | applications | No | Array of strings | applications | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | applicationsJsonString | No | String | applications json string | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time | No | Long | Persistent connection duration | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_hour | No | Long | Persistent connection duration (hour) | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_minute | No | Long | Persistent connection duration (minute) | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_second | No | Long | Persistent Connection Duration (second) | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_enable | Yes | Integer | Whether to support persistent connections: 0 (not supported), 1 (supported). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | source | Yes | :ref:`RuleAddressDtoForRequest ` object | Source address transmission object | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | destination | Yes | :ref:`RuleAddressDtoForRequest ` object | Destination address transmission object | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service | Yes | :ref:`RuleServiceDto ` object | Service object | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tag | No | :ref:`TagsVO ` object | Tag value | - +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+===========+=======================================================================================+=====================================================================================================================================================================================================================+ + | name | Yes | String | Rule name. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sequence | Yes | :ref:`OrderRuleAclDto ` object | Request body for changing the rule sequence. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Yes | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action_type | Yes | Integer | Rule action: **0** (permit), **1** (deny). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Yes | Integer | Rule status: **0** (disabled), **1** (enabled). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | applications | No | Array of strings | Rule application list. Rule application type: **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, \*\* IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | applicationsJsonString | No | String | JSON string converted from the **applications** field in the application list. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time | No | Long | Persistent connection duration. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_hour | No | Long | Persistent connection duration (hour). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_minute | No | Long | Persistent connection duration (minute). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_second | No | Long | Persistent connection duration (second). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_enable | Yes | Integer | Whether to support persistent connections: **0** (no), **1** (yes). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | No | Integer | Direction: **0** (inbound) or **1** (outbound). This parameter is mandatory when **type** is set to **0** (Internet rule) or **2** (NAT rule). | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source | Yes | :ref:`RuleAddressDtoForRequest ` object | Source address DTO. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | destination | Yes | :ref:`RuleAddressDtoForRequest ` object | Destination address DTO. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service | Yes | :ref:`RuleServiceDto ` object | Service object. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tag | No | :ref:`TagsVO ` object | Tag object attached to a rule. | + +--------------------------+-----------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_orderruleacldto: .. table:: **Table 6** OrderRuleAclDto - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+==========================================================================================================================================================================+ - | dest_rule_id | No | String | ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top. | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | top | No | Integer | Whether to pin on top. The options are as follows: 0 (no), 1 (yes). | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0 (no), 1 (yes). | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================+ + | dest_rule_id | No | String | ID of the target rule. The added rule is placed after this rule. This parameter cannot be left blank when the added rule is not pinned on top, and can be left blank when the added rule is pinned on top. The rule ID can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | top | No | Integer | Whether to pin on top: **0** (no), **1** (yes). | + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bottom | No | Integer | Whether to pin to bottom: **0** (no), **1** (yes). | + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_ruleaddressdtoforrequest: .. table:: **Table 7** RuleAddressDtoForRequest - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+=======================================================================+====================================================================================================================================================================================================================+ - | type | Yes | Integer | address source type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (region), 4 (domain set), 5 (multi object), 6 (domain set dns), 7 (domain url profile). | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Address type: 0 (IPv4), 1 (IPv6). | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | No | String | IP address group name. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list_json | No | String | JSON value of the rule region list. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | No | String | Domain set id. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | No | String | Domain set name. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | Array of strings | IP address list. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | Predefined group. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | No | Array of strings | Address group. | - +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+===========+=======================================================================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | type | Yes | Integer | Address type: **0** (manual input), **1** (associated IP address group), **2** (domain name), **3** (geographical location), **4** (domain name group) **5** (multiple objects), **6** (domain name group - network), **7** (domain name group - application). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). If its value is **0**, the input cannot be left blank. | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | IP address information. It cannot be left blank if **type** is set to **0**. | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_id | No | String | ID of an associated IP address group. This parameter cannot be left blank when **type** is set to **1**. You can obtain the value by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_name | No | String | Name of an associated IP address group. This parameter cannot be left blank when **type** is set to **1**. You can obtain the value by calling the :ref:`API for querying the address group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_address_name | No | String | Name of a domain name address. This parameter is valid when **type** is set to **2** (domain name) or **7** (application domain name group). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list_json | No | String | JSON value of the rule region list. | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list | No | Array of :ref:`IpRegionDto ` objects | Rule region list. | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_id | No | String | Domain group ID. The value cannot be left blank when **type** is set to **4** (domain name group) or **7** (domain name group - application). Its value can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_name | No | String | Domain group name. The value cannot be left blank when **type** is set to **4** (domain name group) or **7** (domain name group - application). Its value can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | No | Array of strings | IP address list. This parameter cannot be left blank when **type** is set to **5** (multiple objects). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | No | Integer | Address group type. It cannot be left blank when **type** is set to **1** (associated IP address group). It value can be **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | Pre-defined address group ID list. This parameter cannot be left blank when **type** is set to **5** (multiple objects). Its value can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_address_set_type** must be set to **1** (predefined address group). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group | No | Array of strings | Address group ID list. This parameter cannot be left blank when **type** is set to **5** (multiple objects). Its value can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_address_set_type** must be set to **0** (user-defined address group). | + +---------------------+-----------+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_ipregiondto: .. table:: **Table 8** IpRegionDto - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+=========+=============================================================================+ - | region_id | No | String | Region id,it can be obtained from the Import and export template. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | description_cn | No | String | CN description of the region, it is only applied when the Country is China. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | description_en | No | String | EN description of the region. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | region_type | No | Integer | Region type, 0 means country, 1 means province, 2 means continent. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+=========+=========================================================================================================================================================+ + | region_id | No | String | Region ID. You can obtain the ID by referring to [Obtaining Information About Account, IAM User, Group, Project, Region, and Agency] (cfw_02_0030.xml). | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description_cn | No | String | Region description in Chinese, which is used only for China regions and can be obtained from the :ref:`region information table `. | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description_en | No | String | Region description in English, which is used only for non-China regions and can be obtained from the :ref:`region information table `. | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_type | No | Integer | Region type: **0** (country), **1** (province), and **2** (continent). It can be obtained from the :ref:`region information table `. | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_ruleservicedto: .. table:: **Table 9** RuleServiceDto - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+=============================================================================+==================================================================================================================================================================================================================+ - | type | Yes | Integer | Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | Array of protocol types. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | Source port. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | Destination port. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_id | No | String | Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_name | No | String | Service group name. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_service | No | Array of :ref:`ServiceItem ` objects | Custom service. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | Predefined group includes following: Web Service, Remote Login and Ping, Database. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group | No | Array of strings | List of service groups. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | List of service group names. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_type | No | Integer | Predefined service set type: 1 indicates Web Service, 2 indicates Remote login and Ping, 3 indicates Databases. | - +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+===========+=============================================================================+=========================================================================================================================================================================================================================================================================================================================================================================+ + | type | Yes | Integer | Service input type: **0** (manual), **1** (automatic). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | Protocol list. Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | No | String | Source port. | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | No | String | Destination port. | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_id | No | String | Service group ID. This parameter cannot be left blank when **type** is set to **1** (associated IP address group). Its value can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_name | No | String | Service group name. This parameter cannot be left blank when **type** is set to **1** (associated IP address group). Its value can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | custom_service | No | Array of :ref:`ServiceItem ` objects | Custom service. | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | Predefined service group ID list. The service group ID can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_service_set_type** must be set to **1** (predefined service group). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_group | No | Array of strings | Service group ID list. The service group ID can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_service_set_type** must be set to **0** (user-defined service group). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | Service group name list. | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Service group type: **0** (user-defined service group), **1** (common web service), **2** (common remote login and ping), or **3** (common database). | + +---------------------+-----------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_serviceitem: .. table:: **Table 10** ServiceItem - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+=========+==================================================================================================================================================================================================================+ - | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | Source port. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | Destination port. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description of service item. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Name of service item. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+=========+==========================================================================================================================================================================+ + | protocol | No | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **RuleServiceDto.type** is set to **0** (manual). | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | No | String | Source port. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | No | String | Destination port. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Service member description. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Service member name. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_servicegroupvo: .. table:: **Table 11** ServiceGroupVO - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+===================+===========================================================================================+ - | name | No | String | Service group name. | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | Array of protocol types,the value can be 1(ICMP),6(TCP),17(UDP),58(ICMPV6). | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | set_id | No | String | Service set id. | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+===================+======================================================================================================================================================================================================================================+ + | name | No | String | Service group name. | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | Protocol list. Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Service group type: **0** (user-defined service group), **1** (predefined service group). | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | No | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_tagsvo: .. table:: **Table 12** TagsVO - ========= ========= ====== =========== + ========= ========= ====== =============== Parameter Mandatory Type Description - ========= ========= ====== =========== - tag_id No String Tag id. - tag_key No String Tag key. - tag_value No String Tag value. - ========= ========= ====== =========== + ========= ========= ====== =============== + tag_key No String Rule tag key. + tag_value No String Rule tag value. + ========= ========= ====== =============== Response Parameters ------------------- @@ -283,21 +250,21 @@ Response Parameters .. table:: **Table 13** Response body parameters - +-----------+------------------------------------------------------------+--------------+ - | Parameter | Type | Description | - +===========+============================================================+==============+ - | data | :ref:`RuleIdList ` object | Rule ID list | - +-----------+------------------------------------------------------------+--------------+ + +-----------+------------------------------------------------------------+-----------------------------------------------+ + | Parameter | Type | Description | + +===========+============================================================+===============================================+ + | data | :ref:`RuleIdList ` object | Data of the return value for creating a rule. | + +-----------+------------------------------------------------------------+-----------------------------------------------+ .. _addaclrule__response_ruleidlist: .. table:: **Table 14** RuleIdList - +-----------+--------------------------------------------------------------+--------------+ - | Parameter | Type | Description | - +===========+==============================================================+==============+ - | rules | Array of :ref:`RuleId ` objects | Rule ID list | - +-----------+--------------------------------------------------------------+--------------+ + +-----------+--------------------------------------------------------------+---------------+ + | Parameter | Type | Description | + +===========+==============================================================+===============+ + | rules | Array of :ref:`RuleId ` objects | Rule ID list. | + +-----------+--------------------------------------------------------------+---------------+ .. _addaclrule__response_ruleid: @@ -314,17 +281,17 @@ Response Parameters .. table:: **Table 16** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -The following example shows how to add an IPv4 inbound rule. The rule name is TestRule, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled. +The following example shows how to add an IPv4 inbound rule. The rule name is **Test rule**, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled. .. code-block:: @@ -333,7 +300,7 @@ The following example shows how to add an IPv4 inbound rule. The rule name is Te { "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "rules" : [ { - "name" : "TestRule", + "name" : "Test rule.", "status" : 1, "action_type" : 0, "description" : "", @@ -371,14 +338,15 @@ Example Responses **Status code: 200** -Response to the request for adding an ACL +Response to the request for creating an ACL rule. .. code-block:: { "data" : { "rules" : [ { - "id" : "0475c516-0e41-4caf-990b-0c504eebd73f" + "id" : "0475c516-0e41-4caf-990b-0c504eebd73f", + "name" : "testName" } ] } } @@ -391,22 +359,22 @@ Bad Request { "error_code" : "CFW.00900016", - "error_msg" : "The import task is in progress. Please operate after the task is completed" + "error_msg" : "Import is in progress. Please wait until it is complete." } Status Codes ------------ -=========== ========================================= +=========== ================================================= Status Code Description -=========== ========================================= -200 Response to the request for adding an ACL +=========== ================================================= +200 Response to the request for creating an ACL rule. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ========================================= +=========== ================================================= Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/batch_delete_acl_rules.rst b/api-ref/source/api/acl_rule_management/deleting_acl_rules_in_batches.rst similarity index 67% rename from api-ref/source/api/acl_rule_management/batch_delete_acl_rules.rst rename to api-ref/source/api/acl_rule_management/deleting_acl_rules_in_batches.rst index c4d674b..6dd8a5c 100644 --- a/api-ref/source/api/acl_rule_management/batch_delete_acl_rules.rst +++ b/api-ref/source/api/acl_rule_management/deleting_acl_rules_in_batches.rst @@ -2,13 +2,13 @@ .. _BatchDeleteAclRules: -Batch Delete Acl Rules -====================== +Deleting ACL Rules in Batches +============================= Function -------- -Batch Delete ACL Rules +This API is used to delete ACL rules in batches. URI --- @@ -17,42 +17,42 @@ DELETE /v1/{project_id}/acl-rule .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_ids | Yes | Array of strings | Array of Rule IDs. | - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_ids | Yes | Array of strings | Rule ID list, which is the ID list transferred when rules are deleted in batches. Rule IDs can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -61,37 +61,37 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+---------------------------------------------------------------------------------------------------------------+--------------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================================================================+======================================+ - | data | :ref:`BatchDeleteAclRulesResponseData ` object | Batch delete acl rules response data | - +-----------+---------------------------------------------------------------------------------------------------------------+--------------------------------------+ + +-----------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================================================================+==================================================+ + | data | :ref:`BatchDeleteAclRulesResponseData ` object | Returned data for deleting ACL rules in batches. | + +-----------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------+ .. _batchdeleteaclrules__response_batchdeleteaclrulesresponsedata: .. table:: **Table 6** BatchDeleteAclRulesResponseData - +---------------+-------------------------------------------------------------------------------------------------+--------------------------------------+ - | Parameter | Type | Description | - +===============+=================================================================================================+======================================+ - | responseDatas | Array of :ref:`BatchDeleteRuleInfo ` objects | batch delete acl rules response data | - +---------------+-------------------------------------------------------------------------------------------------+--------------------------------------+ + +---------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +===============+=================================================================================================+==================================================+ + | responseDatas | Array of :ref:`BatchDeleteRuleInfo ` objects | Data returned when rules are deleted in batches. | + +---------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------+ .. _batchdeleteaclrules__response_batchdeleteruleinfo: .. table:: **Table 7** BatchDeleteRuleInfo - ========= ====== =========== + ========= ====== ================================================ Parameter Type Description - ========= ====== =========== - name String rule name - id String rule id - ========= ====== =========== + ========= ====== ================================================ + name String Names of the ACL rules to be deleted in batches. + id String IDs of the ACL rules to be deleted in batches. + ========= ====== ================================================ Example Requests ---------------- -Delete the rule with the object id ae42418e-f077-41a0-9d3b-5b2f5ad9102b under the project id 9d80d070b6d44942af73c9c3d38e0429, the rule id is 0475c516-0e41-4caf-990b-0c504eebd73f and 8 662868e-fe7e-4dfc-bfb1-ca4d73081ca6 +Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -107,7 +107,7 @@ Example Responses **Status code: 200** -Batch Delete Acl Rules Response Body +Return value for deleting rules in batches. .. code-block:: @@ -126,11 +126,11 @@ Batch Delete Acl Rules Response Body Status Codes ------------ -=========== ==================================== +=========== =========================================== Status Code Description -=========== ==================================== -200 Batch Delete Acl Rules Response Body -=========== ==================================== +=========== =========================================== +200 Return value for deleting rules in batches. +=========== =========================================== Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/delete_acl_rule.rst b/api-ref/source/api/acl_rule_management/deleting_an_acl_rule.rst similarity index 54% rename from api-ref/source/api/acl_rule_management/delete_acl_rule.rst rename to api-ref/source/api/acl_rule_management/deleting_an_acl_rule.rst index 8aae139..5c90a7e 100644 --- a/api-ref/source/api/acl_rule_management/delete_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/deleting_an_acl_rule.rst @@ -2,13 +2,13 @@ .. _DeleteAclRule: -Delete ACL Rule -=============== +Deleting an ACL Rule +==================== Function -------- -This API is used to delete an ACL rule group. +This API is used to delete an ACL rule. URI --- @@ -17,33 +17,34 @@ DELETE /v1/{project_id}/acl-rule/{acl_rule_id} .. table:: **Table 1** Path Parameters - =========== ========= ====== =========== - Parameter Mandatory Type Description - =========== ========= ====== =========== - project_id Yes String Project ID - acl_rule_id Yes String Rule ID - =========== ========= ====== =========== + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+=====================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | acl_rule_id | Yes | String | Rule ID, which can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -55,7 +56,7 @@ Response Parameters +-----------+-------------------------------------------------------+-------------+ | Parameter | Type | Description | +===========+=======================================================+=============+ - | data | :ref:`RuleId ` object | Rule Id | + | data | :ref:`RuleId ` object | Rule ID. | +-----------+-------------------------------------------------------+-------------+ .. _deleteaclrule__response_ruleid: @@ -73,17 +74,17 @@ Response Parameters .. table:: **Table 6** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Delete the rule whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and rule ID is ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031. +Delete the rule ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031 from project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -94,7 +95,7 @@ Example Responses **Status code: 200** -OK +Data returned for rule deletion. .. code-block:: @@ -113,22 +114,22 @@ Bad Request { "error_code" : "CFW.00900016", - "error_msg" : "The import task is in progress. Please operate after the task is completed" + "error_msg" : "Import is in progress. Please wait until it is complete." } Status Codes ------------ -=========== ===================== +=========== ================================ Status Code Description -=========== ===================== -200 OK +=========== ================================ +200 Data returned for rule deletion. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ================================ Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/deleting_the_rule_hit_count.rst b/api-ref/source/api/acl_rule_management/deleting_the_number_of_rule_hits.rst similarity index 52% rename from api-ref/source/api/acl_rule_management/deleting_the_rule_hit_count.rst rename to api-ref/source/api/acl_rule_management/deleting_the_number_of_rule_hits.rst index 73d7e20..625b7f7 100644 --- a/api-ref/source/api/acl_rule_management/deleting_the_rule_hit_count.rst +++ b/api-ref/source/api/acl_rule_management/deleting_the_number_of_rule_hits.rst @@ -2,13 +2,13 @@ .. _DeleteAclRuleHitCount: -Deleting the Rule Hit Count -=========================== +Deleting the Number of Rule Hits +================================ Function -------- -This API is used to delete the rule hit count. +This API is used to delete the number of rule hits. URI --- @@ -17,59 +17,69 @@ DELETE /v1/{project_id}/acl-rule/count .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project id - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - ========= ========= ================ ============ - Parameter Mandatory Type Description - ========= ========= ================ ============ - rule_ids Yes Array of strings Rule ID list - ========= ========= ================ ============ + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==================+===============================================================================================================================================================================================================================================================+ + | rule_ids | Yes | Array of strings | List of rules deleted during rule hit deletion. Rule IDs can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- -**Status code: 400** +**Status code: 200** .. table:: **Table 5** Response body parameters - ========== ====== =========== + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + ``-`` String + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Clear the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 in the project whose ID is 0b2179bbe180d3762fb0c01a2d5725c7. +Clear the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 whose project ID is 0b2179bbe180d3762fb0c01a2d5725c7. .. code-block:: @@ -98,7 +108,7 @@ Bad Request { "error_code" : "CFW.00400006", - "error_msg" : "clear rule hit count param error." + "error_msg" : "Error occurred when deleting the rule hit count." } Status Codes diff --git a/api-ref/source/api/acl_rule_management/index.rst b/api-ref/source/api/acl_rule_management/index.rst index 0ead640..04cd1ce 100644 --- a/api-ref/source/api/acl_rule_management/index.rst +++ b/api-ref/source/api/acl_rule_management/index.rst @@ -6,27 +6,27 @@ ACL Rule Management =================== - :ref:`Creating an ACL Rule ` -- :ref:`Batch Delete Acl Rules ` +- :ref:`Deleting an ACL Rule ` +- :ref:`Deleting ACL Rules in Batches ` +- :ref:`Deleting the Number of Rule Hits ` - :ref:`Updating an ACL Rule ` - :ref:`Updating Rule Actions in Batches ` -- :ref:`List Acl Rule Tags ` -- :ref:`Obtaining the Rule Hit Count ` -- :ref:`Deleting the Rule Hit Count ` -- :ref:`Delete ACL Rule ` -- :ref:`Querying a Protection Rule ` - :ref:`Setting the Priority of an ACL Protection Rule ` +- :ref:`Querying a Protection Rule ` +- :ref:`Querying Rule Tags ` +- :ref:`Obtaining the Number of Rule Hits ` .. toctree:: :maxdepth: 1 :hidden: creating_an_acl_rule - batch_delete_acl_rules + deleting_an_acl_rule + deleting_acl_rules_in_batches + deleting_the_number_of_rule_hits updating_an_acl_rule updating_rule_actions_in_batches - list_acl_rule_tags - obtaining_the_rule_hit_count - deleting_the_rule_hit_count - delete_acl_rule - querying_a_protection_rule setting_the_priority_of_an_acl_protection_rule + querying_a_protection_rule + querying_rule_tags + obtaining_the_number_of_rule_hits diff --git a/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst b/api-ref/source/api/acl_rule_management/obtaining_the_number_of_rule_hits.rst similarity index 65% rename from api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst rename to api-ref/source/api/acl_rule_management/obtaining_the_number_of_rule_hits.rst index ef2aed0..5a98015 100644 --- a/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst +++ b/api-ref/source/api/acl_rule_management/obtaining_the_number_of_rule_hits.rst @@ -2,13 +2,13 @@ .. _ListAclRuleHitCount: -Obtaining the Rule Hit Count -============================ +Obtaining the Number of Rule Hits +================================= Function -------- -This API is used to obtain the rule hit count. +This API is used to obtain the number of rule hits. URI --- @@ -17,40 +17,40 @@ POST /v1/{project_id}/acl-rule/count .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------+-----------+------------------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+====================================================================================+ - | rule_ids | Yes | Array of strings | Rule ID list, obtain the ID by calling the API used for querying a protection rule | - +-----------+-----------+------------------+------------------------------------------------------------------------------------+ + +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==================+====================================================================================================================================================================================================================================+ + | rule_ids | Yes | Array of strings | List of rule IDs. You can obtain the rule IDs by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -59,11 +59,11 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+---------------------------------------------------------------------------------------+----------------+ - | Parameter | Type | Description | - +===========+=======================================================================================+================+ - | data | :ref:`RuleHitCountRecords ` object | Rule hit count | - +-----------+---------------------------------------------------------------------------------------+----------------+ + +-----------+---------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=======================================================================================+================================================================+ + | data | :ref:`RuleHitCountRecords ` object | Response to the request for obtaining the number of rule hits. | + +-----------+---------------------------------------------------------------------------------------+----------------------------------------------------------------+ .. _listaclrulehitcount__response_rulehitcountrecords: @@ -72,30 +72,31 @@ Response Parameters +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +===========+===============================================================================================+=================================================================================================================================================+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of records. | + | total | Integer | Obtain the total number of rule hits. | +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`RuleHitCountObject ` objects | Rule hit count list | + | records | Array of :ref:`RuleHitCountObject ` objects | List of rule hits. | +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrulehitcount__response_rulehitcountobject: .. table:: **Table 7** RuleHitCountObject - ============== ======= ============== - Parameter Type Description - ============== ======= ============== - rule_id String Rule ID - rule_hit_count Integer Rule Hit Count - ============== ======= ============== + +----------------+---------+----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+=========+============================================================================================================================+ + | rule_id | String | Rule ID. | + +----------------+---------+----------------------------------------------------------------------------------------------------------------------------+ + | rule_hit_count | Integer | Number of hits of a rule. When an ACL rule is triggered, the number of hits of the corresponding rule ID increases by one. | + +----------------+---------+----------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- -Query the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 in the project whose ID is 0b2179bbe180d3762fb0c01a2d5725c7. +Query the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 whose project ID is 0b2179bbe180d3762fb0c01a2d5725c7. .. code-block:: @@ -110,7 +111,7 @@ Example Responses **Status code: 200** -Response to the request for obtaining the number of rule hits +Response to the request for obtaining the number of rule hits. .. code-block:: @@ -129,19 +130,19 @@ Response to the request for obtaining the number of rule hits Status Codes ------------ -+-------------+---------------------------------------------------------------+ -| Status Code | Description | -+=============+===============================================================+ -| 200 | Response to the request for obtaining the number of rule hits | -+-------------+---------------------------------------------------------------+ -| 401 | Unauthorized | -+-------------+---------------------------------------------------------------+ -| 403 | Forbidden | -+-------------+---------------------------------------------------------------+ -| 404 | Not Found | -+-------------+---------------------------------------------------------------+ -| 500 | Internal Server Error | -+-------------+---------------------------------------------------------------+ ++-------------+----------------------------------------------------------------+ +| Status Code | Description | ++=============+================================================================+ +| 200 | Response to the request for obtaining the number of rule hits. | ++-------------+----------------------------------------------------------------+ +| 401 | Unauthorized | ++-------------+----------------------------------------------------------------+ +| 403 | Forbidden | ++-------------+----------------------------------------------------------------+ +| 404 | Not Found | ++-------------+----------------------------------------------------------------+ +| 500 | Internal Server Error | ++-------------+----------------------------------------------------------------+ Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst b/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst index 6748fbd..232e60a 100644 --- a/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst +++ b/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst @@ -20,74 +20,48 @@ GET /v1/{project_id}/acl-rules ========== ========= ====== =========== Parameter Mandatory Type Description ========== ========= ====== =========== - project_id Yes String Project ID + project_id Yes String Project ID. ========== ========= ====== =========== .. table:: **Table 2** Query Parameters - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Specifies the rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **2** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip | No | String | IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | Integer | Direction parameter can have following values: 0 (inbound), 1 (outbound). | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Indicates the rule delivery status. 0: disabled; 1: enabled. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action_type | No | Integer | Action type parameter can have following values: 0 (allow), 1 (deny). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4), 1 (IPV6). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags_id | No | String | Tags ID. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | No | String | Source address. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | destination | No | String | Destination address. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service | No | String | Service port. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | application | No | String | Application protocol, such as HTTP, TLS, etc. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | Integer | Rule type: **0** (Internet rule), **1** (VPC rule), or **2** (NAT rule). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip | No | String | IP address | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Rule name. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | No | Integer | Direction: **0** (inbound), **1** (outbound). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | Integer | Rule delivery status: **0** (disabled), **1** (enabled). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action_type | No | Integer | Action: **0** (allow), **1** (deny). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags_id | No | String | Rule tag ID, which is generated when a rule is created. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source | No | String | Source IP address. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | destination | No | String | Destination IP address. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service | No | String | Service port. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | application | No | String | Rule application type. Its value can be **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, **IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -107,258 +81,243 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+--------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +===========+==================================================+===================================+ - | data | :ref:`data ` object | Result of querying acl rule list. | - +-----------+--------------------------------------------------+-----------------------------------+ + +-----------+--------------------------------------------------+------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================+==========================================+ + | data | :ref:`data ` object | Return value for querying the rule list. | + +-----------+--------------------------------------------------+------------------------------------------+ .. _listaclrules__response_data: .. table:: **Table 5** data - +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024. | - +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of queried records. | - +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Records of acl rule. | - +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Query the total number of rules in the rule list. | + +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the :ref:`API for querying a firewall instance `. Note that the value **0** indicates the ID of a protected object on the Internet border, and the value **1** indicates the ID of a protected object on the VPC border. | + +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | Query the rule list. | + +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_records: .. table:: **Table 6** records - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+============================================================================================+=================================================================================================================================+ - | rule_id | String | Rule ID | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Address type can have following values: 0 (IPv4), 1 (IPv6). | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Rule name | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | direction | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | action_type | Integer | Action type parameter can have following values: 0 (allow), 1 (deny). | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Rule delivery status can have the following values: 0 (disabled), 1 (enabled). | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of the acl rule. | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time | Long | Persistent connection duration | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_enable | Integer | Persistent connection support | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_hour | Long | Persistent connection duration (hour) | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_minute | Long | Persistent connection duration (hour) | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_second | Long | Persistent connection duration (hour) | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | source | :ref:`RuleAddressDtoForResponse ` object | Source address transmission object | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | destination | :ref:`RuleAddressDtoForResponse ` object | destination | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service | :ref:`RuleServiceDtoForResponse ` object | service | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - | | | | - | | | - **2** | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | created_date | String | Created time | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | last_open_time | String | Last open time | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tag | :ref:`TagsVO ` object | tag | - +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+============================================================================================+==========================================================================+ + | rule_id | String | Rule ID. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | address_type | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | name | String | Rule name. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | direction | Integer | Rule direction: **0** (inbound), **1** (outbound). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | action_type | Integer | Action: **0** (allow), **1** (deny). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | status | Integer | Rule delivery status: **0** (disabled), **1** (enabled). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | description | String | Description. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | long_connect_time | Long | Persistent connection duration. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | long_connect_enable | Integer | Persistent connection support. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | long_connect_time_hour | Long | Persistent connection duration (hour). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | long_connect_time_minute | Long | Persistent connection duration (minute). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | long_connect_time_second | Long | Persistent connection duration (second). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | source | :ref:`RuleAddressDtoForResponse ` object | Source address object. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | destination | :ref:`RuleAddressDtoForResponse ` object | Destination address object. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | service | :ref:`RuleServiceDtoForResponse ` object | Service object. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | type | Integer | Rule type: **0** (Internet rule), **1** (VPC rule), or **2** (NAT rule). | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | created_date | String | Rule creation time, for example, 2024-08-12 08:40:00. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | last_open_time | String | Last time when the rule was enabled, for example, 2024-08-12 08:40:00. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | tag | :ref:`TagsVO ` object | Tag object attached to a rule. | + +--------------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ .. _listaclrules__response_ruleaddressdtoforresponse: .. table:: **Table 7** RuleAddressDtoForResponse - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+================================================================================+====================================================================================================================================================================================================================+ - | type | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Source type. 0: IPv4; 1: IPv6 | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_id | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | String | IP address group name | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_address_name | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list_json | String | JSON value of the rule region list. | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list | Array of :ref:`IpRegionDto ` objects | Region list of a rule | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | String | domain set id | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | String | domain set name | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | Array of strings | IP address list | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | Array of strings | address group | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group_names | Array of :ref:`AddressGroupVO ` objects | Address set list | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+================================================================================+================================================================================================================================================================================================================================================================+ + | type | Integer | Address type: **0** (manual input), **1** (associated IP address group), **2** (domain name), **3** (geographical location), **4** (domain name group) **5** (multiple objects), **6** (domain name group - network), **7** (domain name group - application). | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | Address type: **0** (IPv4), **1** (IPv6). If its value is **0**, the input cannot be left blank. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | String | IP address information. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_id | String | ID of an associated IP address group. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_name | String | IP address group name. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_address_name | String | Name of a domain name address. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list_json | String | JSON value of the rule region list. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list | Array of :ref:`IpRegionDto ` objects | Rule region list. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_id | String | Domain name group ID | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_name | String | Domain name group name. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | Array of strings | IP address list. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group | Array of strings | Address group ID list. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group_names | Array of :ref:`AddressGroupVO ` objects | Address group name list. | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | Integer | Address group type: **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +---------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_ipregiondto: .. table:: **Table 8** IpRegionDto - +----------------+---------+-----------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+=============================================================================+ - | region_id | String | Region id,it can be obtained from the Import and export template. | - +----------------+---------+-----------------------------------------------------------------------------+ - | description_cn | String | CN description of the region, it is only applied when the Country is China. | - +----------------+---------+-----------------------------------------------------------------------------+ - | description_en | String | EN description of the region. | - +----------------+---------+-----------------------------------------------------------------------------+ - | region_type | Integer | Region type, 0 means country, 1 means province, 2 means continent. | - +----------------+---------+-----------------------------------------------------------------------------+ + +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+=========+=========================================================================================================================================================+ + | region_id | String | Region ID. You can obtain the ID by referring to [Obtaining Information About Account, IAM User, Group, Project, Region, and Agency] (cfw_02_0030.xml). | + +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description_cn | String | Region description in Chinese, which is used only for China regions and can be obtained from the :ref:`region information table `. | + +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description_en | String | Region description in English, which is used only for non-China regions and can be obtained from the :ref:`region information table `. | + +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_type | Integer | Region type: **0** (country), **1** (province), and **2** (continent). It can be obtained from the :ref:`region information table `. | + +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_addressgroupvo: .. table:: **Table 9** AddressGroupVO - +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+=========+====================================================================================================================================================================================================================+ - | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Address set name. | - +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | String | Address set id, it can be obtained by calling the ListAddressSets API. | - +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=========+==========================================================================================================================================================================================================================================================+ + | address_set_type | Integer | Address group type: **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Name of an associated IP address group, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | String | ID of an associated IP address group, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_ruleservicedtoforresponse: .. table:: **Table 10** RuleServiceDtoForResponse - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+================================================================================+==================================================================================================================================================================================================================+ - | type | Integer | Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input. | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocols | Array of integers | Protocols | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | String | Source port | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | String | Destination port | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_id | String | Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type. | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_name | String | Service group name | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_service | Array of :ref:`ServiceItem ` objects | custom service | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group | Array of strings | Service group list | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | Array of :ref:`ServiceGroupVO ` objects | Service group name list | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_type | Integer | predefined service set type, 1 indicates Web Service, 2 indicates Remote login and PING, 3 indicates Databases | - +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+================================================================================+===========================================================================================================================================================================================================================================+ + | type | Integer | Service input type: **0** (manual), **1** (automatic). | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | Array of integers | Protocol list. Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | String | Source port. | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | String | Destination port. | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_id | String | Service group ID. | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_name | String | Service group name. | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | custom_service | Array of :ref:`ServiceItem ` objects | Custom service. | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_group | Array of strings | Service group ID list. | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_group_names | Array of :ref:`ServiceGroupVO ` objects | Service group name list. | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Service group type: **0** (user-defined service group), **1** (common web service), **2** (common remote login and ping), or **3** (common database). | + +---------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_serviceitem: .. table:: **Table 11** ServiceItem - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+==================================================================================================================================================================================================================+ - | protocol | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | String | Source port. | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | String | Destination port. | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of service item. | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of service item. | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+=========+==========================================================================================================================================================================+ + | protocol | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **RuleServiceDto.type** is set to **0** (manual). | + +-------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | String | Source port. | + +-------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | String | Destination port. | + +-------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Service member description. | + +-------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Service member name. | + +-------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_servicegroupvo: .. table:: **Table 12** ServiceGroupVO - +------------------+-------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+===================+===========================================================================================+ - | name | String | Service group name. | - +------------------+-------------------+-------------------------------------------------------------------------------------------+ - | protocols | Array of integers | Array of protocol types,the value can be 1(ICMP),6(TCP),17(UDP),58(ICMPV6). | - +------------------+-------------------+-------------------------------------------------------------------------------------------+ - | service_set_type | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | - +------------------+-------------------+-------------------------------------------------------------------------------------------+ - | set_id | String | Service set id. | - +------------------+-------------------+-------------------------------------------------------------------------------------------+ + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================+======================================================================================================================================================================================================================================+ + | name | String | Service group name. | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | Array of integers | Protocol list. Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Service group type: **0** (user-defined service group), **1** (predefined service group). | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_tagsvo: .. table:: **Table 13** TagsVO - ========= ====== =========== + ========= ====== =============== Parameter Type Description - ========= ====== =========== - tag_id String Tag id. - tag_key String Tag key. - tag_value String Tag value. - ========= ====== =========== + ========= ====== =============== + tag_key String Rule tag key. + tag_value String Rule tag value. + ========= ====== =============== **Status code: 400** .. table:: **Table 14** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Query the data whose project ID is 9d80d070b6d44942af73c9c3d38e0429, project ID is e12bd2cd-ebfc-4af7-ad6f-ebe6da398029, and size is 10. +Query data on the first page of the protected object e12bd2cd-ebfc-4af7-ad6f-ebe6da398029 whose project ID is 9d80d070b6d44942af73c9c3d38e0429, with **limit** set to **10**. .. code-block:: - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0 + Example URL: https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0 Example Responses ----------------- **Status code: 200** -OK +Return value for querying the rule list. .. code-block:: @@ -409,22 +368,22 @@ Bad Request { "error_code" : "CFW.0020016", - "error_msg" : "instance status error" + "error_msg" : "Incorrect instance status." } Status Codes ------------ -=========== ===================== +=========== ======================================== Status Code Description -=========== ===================== -200 OK +=========== ======================================== +200 Return value for querying the rule list. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ======================================== Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst b/api-ref/source/api/acl_rule_management/querying_rule_tags.rst similarity index 56% rename from api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst rename to api-ref/source/api/acl_rule_management/querying_rule_tags.rst index e4eb8d8..1bf87d5 100644 --- a/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst +++ b/api-ref/source/api/acl_rule_management/querying_rule_tags.rst @@ -2,13 +2,13 @@ .. _ListRuleAclTags: -List Acl Rule Tags +Querying Rule Tags ================== Function -------- -This API is used to list acl rule tags. +This API is used to query rule tags. URI --- @@ -17,36 +17,36 @@ GET /v2/{project_id}/cfw-acl/tags .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID. - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -55,11 +55,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-----------------------------------------------------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================================================+===================================+ - | data | :ref:`HttpGetAclTagResponseData ` object | Result of querying rule acl tags. | - +-----------+-----------------------------------------------------------------------------------------------+-----------------------------------+ + +-----------+-----------------------------------------------------------------------------------------------+-----------------------+ + | Parameter | Type | Description | + +===========+===============================================================================================+=======================+ + | data | :ref:`HttpGetAclTagResponseData ` object | Obtain rule tag data. | + +-----------+-----------------------------------------------------------------------------------------------+-----------------------+ .. _listruleacltags__response_httpgetacltagresponsedata: @@ -70,29 +70,28 @@ Response Parameters +===========+===================================================================+=================================================================================================================================================+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +-----------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024. | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +-----------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of tags. | + | total | Integer | Total number of rule tags. | +-----------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`TagsVO ` objects | Display list of tag. | + | records | Array of :ref:`TagsVO ` objects | Rule tag list. | +-----------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listruleacltags__response_tagsvo: .. table:: **Table 6** TagsVO - ========= ====== =========== + ========= ====== =============== Parameter Type Description - ========= ====== =========== - tag_id String Tag id. - tag_key String Tag key. - tag_value String Tag value. - ========= ====== =========== + ========= ====== =============== + tag_key String Rule tag key. + tag_value String Rule tag value. + ========= ====== =============== Example Requests ---------------- -Query the existing ACL tags of the firewall whose ID is 546af3f8-88e9-47f2-a205-2346d7090925 in the project whose ID is 14181c1245cf4fd786824efe1e2b9388. +Query the existing ACL tags of the firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 14181c1245cf4fd786824efe1e2b9388. .. code-block:: @@ -103,7 +102,7 @@ Example Responses **Status code: 200** -Get successful acl tag response. +Return value for querying rule tags. .. code-block:: @@ -121,8 +120,8 @@ Get successful acl tag response. "tag_value" : "2" }, { "tag_id" : "0bf41046-6587-42f2-8399-a6864022b504", - "tag_key" : "test", - "tag_value" : "test" + "tag_key" : "Test", + "tag_value" : "Test" } ], "total" : 3 } @@ -131,11 +130,11 @@ Get successful acl tag response. Status Codes ------------ -=========== ================================ +=========== ==================================== Status Code Description -=========== ================================ -200 Get successful acl tag response. -=========== ================================ +=========== ==================================== +200 Return value for querying rule tags. +=========== ==================================== Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst b/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst index 0e83b47..39f0b45 100644 --- a/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst +++ b/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst @@ -17,46 +17,46 @@ PUT /v1/{project_id}/acl-rule/order/{acl_rule_id} .. table:: **Table 1** Path Parameters - +-------------+-----------+--------+--------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+==============================================================+ - | project_id | Yes | String | Project ID | - +-------------+-----------+--------+--------------------------------------------------------------+ - | acl_rule_id | Yes | String | Rule ID, it can be obtained by calling the API ListAclRules. | - +-------------+-----------+--------+--------------------------------------------------------------+ + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+=====================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | acl_rule_id | Yes | String | Rule ID, which can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+==========================================================================================================================================================================+ - | dest_rule_id | No | String | ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top. | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | top | No | Integer | Whether to pin on top. The options are as follows: 0 (no), 1 (yes). | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0 (no), 1 (yes). | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================+ + | dest_rule_id | No | String | ID of the target rule. The added rule is placed after this rule. This parameter cannot be left blank when the added rule is not pinned on top, and can be left blank when the added rule is pinned on top. The rule ID can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | top | No | Integer | Whether to pin on top: **0** (no), **1** (yes). | + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bottom | No | Integer | Whether to pin to bottom: **0** (no), **1** (yes). | + +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -65,11 +65,11 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+------------------------------------------------------------+--------------+ - | Parameter | Type | Description | - +===========+============================================================+==============+ - | data | :ref:`RuleId ` object | Rule ID list | - +-----------+------------------------------------------------------------+--------------+ + +-----------+------------------------------------------------------------+-------------+ + | Parameter | Type | Description | + +===========+============================================================+=============+ + | data | :ref:`RuleId ` object | Rule ID. | + +-----------+------------------------------------------------------------+-------------+ .. _updateaclruleorder__response_ruleid: @@ -86,17 +86,17 @@ Response Parameters .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Set the rule with the rule id of ffe9af47-d893-483b-86e3-ee5242e8cb15 in the project id9d80d070b6d44942af73c9c3d38e0429 under the rule with the id of 69c32dc5-f801-4294-98ee-978b51f97d35 +In the project 9d80d070b6d44942af73c9c3d38e0429, move the rule whose ID is ffe9af47-d893-483b-86e3-ee5242e8cb15 behind the rule whose ID is 69c32dc5-f801-4294-98ee-978b51f97d35. .. code-block:: @@ -112,7 +112,7 @@ Example Responses **Status code: 200** -Rule sorting response +Rule sorting response. .. code-block:: @@ -129,23 +129,23 @@ Bad Request .. code-block:: { - "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_code" : "00200005", + "error_msg" : "Object not found." } Status Codes ------------ -=========== ===================== +=========== ====================== Status Code Description -=========== ===================== -200 Rule sorting response +=========== ====================== +200 Rule sorting response. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ====================== Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst b/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst index 87ef176..d05c226 100644 --- a/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst @@ -17,287 +17,238 @@ PUT /v1/{project_id}/acl-rule/{acl_rule_id} .. table:: **Table 1** Path Parameters - +-------------+-----------+--------+--------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+==============================================================+ - | project_id | Yes | String | Project ID | - +-------------+-----------+--------+--------------------------------------------------------------+ - | acl_rule_id | Yes | String | Rule ID, it can be obtained by calling the API ListAclRules. | - +-------------+-----------+--------+--------------------------------------------------------------+ + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+=====================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | acl_rule_id | Yes | String | Rule ID, which can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+========================================================================+====================================================================================================================================================+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Rule name | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | sequence | No | :ref:`OrderRuleAclDto ` object | UpdateRuleAclDto | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | action_type | No | Integer | Action type parameter accept the following values: 0 (allow), 1 (deny). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Rule delivery status: 0 (disabled), 1 (enabled). | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | applications | No | Array of strings | Applications of the Acl rule, the value in the list can be 1.HTTP,2.SMTP,3.HTTPS,4.IMAP4,5.MYSQL,6.POP3,7.POP3S.8.SSH,9.TLS1,10.VNC,11.DNS,12.RDP. | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | applicationsJsonString | No | String | JSON String created by the array list of the applications. | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description of the rule. | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_hour | No | Long | Persistent connection duration (hour) | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_minute | No | Long | Persistent connection duration (hour) | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_second | No | Long | Persistent connection duration (minute) | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time | No | Long | Persistent connection duration | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_enable | No | Integer | Whether to support persistent connections: 0 (not supported), 1 (supported). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | No | :ref:`RuleAddressDto ` object | Source rule address info. | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | destination | No | :ref:`RuleAddressDto ` object | Destination rule address info. | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | service | No | :ref:`RuleServiceDto ` object | Rule Service Info description, includes protocols and port info. | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **2** | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | tag | No | :ref:`TagsVO ` object | tag | - +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateaclrule__request_orderruleacldto: - -.. table:: **Table 5** OrderRuleAclDto - - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+==========================================================================================================================================================================+ - | dest_rule_id | No | String | ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top. | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | top | No | Integer | Whether to pin on top. The options are as follows: 0 (no), 1 (yes). | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0 (no), 1 (yes). | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+===========+======================================================================+=====================================================================================================================================================================================================================+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Rule name. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | No | Integer | Direction: **0** (inbound) or **1** (outbound). This parameter is mandatory when **type** is set to **0** (Internet rule) or **2** (NAT rule). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action_type | No | Integer | Rule action: **0** (permit), **1** (deny). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | Integer | Rule status: **0** (disabled), **1** (enabled). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | applications | No | Array of strings | Rule application list. Rule application type: **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, \*\* IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | applicationsJsonString | No | String | JSON string converted from the **applications** field in the application list. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Rule description. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_hour | No | Long | Persistent connection duration (hour). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_minute | No | Long | Persistent connection duration (minute). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_second | No | Long | Persistent connection duration (second). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time | No | Long | Persistent connection duration. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_enable | No | Integer | Whether to support persistent connections: **0** (no), **1** (yes). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source | No | :ref:`RuleAddressDto ` object | Source address DTO. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | destination | No | :ref:`RuleAddressDto ` object | Destination address DTO. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service | No | :ref:`RuleServiceDto ` object | Service object. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | Integer | Rule type: **0** (Internet rule), **1** (VPC rule), or **2** (NAT rule). | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tag | No | :ref:`TagsVO ` object | Tag object attached to a rule. | + +--------------------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ruleaddressdto: -.. table:: **Table 6** RuleAddressDto +.. table:: **Table 5** RuleAddressDto - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+================================================================================+====================================================================================================================================================================================================================+ - | type | Yes | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Source type. 0: IPv4; 1: IPv6 | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | No | String | IP address group name,it can be obtained by calling the API ListAddressSets. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list_json | No | String | JSON value of the rule region list. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | No | String | Domain set id,it can be obtained by calling the API ListDomainSets. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | No | String | Domain set name,it can be obtained by calling the API ListDomainSets. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | Array of strings | IP address list | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | No | Array of strings | list of address set id, which can be obtained by calling the API ListAddressSets. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group_names | No | Array of :ref:`AddressGroupVO ` objects | List of address group names, which can be obtained by calling the API ListAddressSets, it is only used in the response. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | Predefined group id of the address group.which can be obtained by calling the API ListAddressSets,only applied when the RuleAddressDto is applied for source. | - +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+===========+================================================================================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | type | Yes | Integer | Address type: **0** (manual input), **1** (associated IP address group), **2** (domain name), **3** (geographical location), **4** (domain name group) **5** (multiple objects), **6** (domain name group - network), **7** (domain name group - application). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). If its value is **0**, the input cannot be left blank. | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | IP address information. It cannot be left blank if **type** is set to **0**. | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_id | No | String | ID of an associated IP address group. This parameter cannot be left blank when **type** is set to **1**. You can obtain the value by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_name | No | String | Name of an associated IP address group. This parameter cannot be left blank when **type** is set to **1**. You can obtain the value by calling the :ref:`API for querying the address group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_address_name | No | String | Name of a domain name address. This parameter is valid when **type** is set to **2** (domain name) or **7** (application domain name group). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list_json | No | String | JSON value of the rule region list. | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list | No | Array of :ref:`IpRegionDto ` objects | Rule region list. | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_id | No | String | Domain group ID. The value cannot be left blank when **type** is set to **4** (domain name group) or **7** (domain name group - application). Its value can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_name | No | String | Domain group name. The value cannot be left blank when **type** is set to **4** (domain name group) or **7** (domain name group - application). Its value can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | No | Array of strings | IP address list. This parameter cannot be left blank when **type** is set to **5** (multiple objects). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group | No | Array of strings | Address group ID list. This parameter cannot be left blank when **type** is set to **5** (multiple objects). Its value can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_address_set_type** must be set to **0** (user-defined address group). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group_names | No | Array of :ref:`AddressGroupVO ` objects | Address group name list. | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | No | Integer | Address group type. It cannot be left blank when **type** is set to **1** (associated IP address group). It value can be **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | Pre-defined address group ID list. This parameter cannot be left blank when **type** is set to **5** (multiple objects). Its value can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_address_set_type** must be set to **1** (predefined address group). | + +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ipregiondto: -.. table:: **Table 7** IpRegionDto +.. table:: **Table 6** IpRegionDto - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+=========+=============================================================================+ - | region_id | No | String | Region id,it can be obtained from the Import and export template. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | description_cn | No | String | CN description of the region, it is only applied when the Country is China. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | description_en | No | String | EN description of the region. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ - | region_type | No | Integer | Region type, 0 means country, 1 means province, 2 means continent. | - +----------------+-----------+---------+-----------------------------------------------------------------------------+ + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+=========+=========================================================================================================================================================+ + | region_id | No | String | Region ID. You can obtain the ID by referring to [Obtaining Information About Account, IAM User, Group, Project, Region, and Agency] (cfw_02_0030.xml). | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description_cn | No | String | Region description in Chinese, which is used only for China regions and can be obtained from the :ref:`region information table `. | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description_en | No | String | Region description in English, which is used only for non-China regions and can be obtained from the :ref:`region information table `. | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_type | No | Integer | Region type: **0** (country), **1** (province), and **2** (continent). It can be obtained from the :ref:`region information table `. | + +----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_addressgroupvo: -.. table:: **Table 8** AddressGroupVO +.. table:: **Table 7** AddressGroupVO - +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+=========+====================================================================================================================================================================================================================+ - | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Address set name. | - +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | No | String | Address set id, it can be obtained by calling the ListAddressSets API. | - +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+=========+==========================================================================================================================================================================================================================================================+ + | address_set_type | No | Integer | Address group type: **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Name of an associated IP address group, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | No | String | ID of an associated IP address group, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ruleservicedto: -.. table:: **Table 9** RuleServiceDto +.. table:: **Table 8** RuleServiceDto - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+================================================================================+==================================================================================================================================================================================================================+ - | type | Yes | Integer | Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | Array of protocol types. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | Source port. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | Destination port. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_id | No | String | Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_name | No | String | Service group name. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_service | No | Array of :ref:`ServiceItem ` objects | Custom service. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | Predefined group includes following: Web Service, Remote Login and Ping, Database. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group | No | Array of strings | List of service groups. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | List of service group names. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_type | No | Integer | Predefined service set type: 1 indicates Web Service, 2 indicates Remote login and Ping, 3 indicates Databases. | - +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+===========+================================================================================+=========================================================================================================================================================================================================================================================================================================================================================================+ + | type | Yes | Integer | Service input type: **0** (manual), **1** (automatic). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | Protocol list. Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | No | String | Source port. | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | No | String | Destination port. | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_id | No | String | Service group ID. This parameter cannot be left blank when **type** is set to **1** (associated IP address group). Its value can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_name | No | String | Service group name. This parameter cannot be left blank when **type** is set to **1** (associated IP address group). Its value can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.name** (The period [.] is used to separate different levels of objects). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | custom_service | No | Array of :ref:`ServiceItem ` objects | Custom service. | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | Predefined service group ID list. The service group ID can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_service_set_type** must be set to **1** (predefined service group). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_group | No | Array of strings | Service group ID list. The service group ID can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). In the search criteria, **query_service_set_type** must be set to **0** (user-defined service group). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | Service group name list. | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Service group type: **0** (user-defined service group), **1** (common web service), **2** (common remote login and ping), or **3** (common database). | + +---------------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_serviceitem: -.. table:: **Table 10** ServiceItem +.. table:: **Table 9** ServiceItem - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+=========+==================================================================================================================================================================================================================+ - | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | Source port. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | Destination port. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description of service item. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Name of service item. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+=========+==========================================================================================================================================================================+ + | protocol | No | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **RuleServiceDto.type** is set to **0** (manual). | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | No | String | Source port. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | No | String | Destination port. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Service member description. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Service member name. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_servicegroupvo: -.. table:: **Table 11** ServiceGroupVO +.. table:: **Table 10** ServiceGroupVO - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+===================+===========================================================================================+ - | name | No | String | Service group name. | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | Array of protocol types,the value can be 1(ICMP),6(TCP),17(UDP),58(ICMPV6). | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | set_id | No | String | Service set id. | - +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+===================+======================================================================================================================================================================================================================================+ + | name | No | String | Service group name. | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | Protocol list. Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Service group type: **0** (user-defined service group), **1** (predefined service group). | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | No | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_tagsvo: -.. table:: **Table 12** TagsVO +.. table:: **Table 11** TagsVO - ========= ========= ====== =========== + ========= ========= ====== =============== Parameter Mandatory Type Description - ========= ========= ====== =========== - tag_id No String Tag id. - tag_key No String Tag key. - tag_value No String Tag value. - ========= ========= ====== =========== + ========= ========= ====== =============== + tag_key No String Rule tag key. + tag_value No String Rule tag value. + ========= ========= ====== =============== Response Parameters ------------------- **Status code: 200** -.. table:: **Table 13** Response body parameters +.. table:: **Table 12** Response body parameters +-----------+-------------------------------------------------------+-------------+ | Parameter | Type | Description | +===========+=======================================================+=============+ - | data | :ref:`RuleId ` object | Rule ID | + | data | :ref:`RuleId ` object | Rule data. | +-----------+-------------------------------------------------------+-------------+ .. _updateaclrule__response_ruleid: -.. table:: **Table 14** RuleId +.. table:: **Table 13** RuleId ========= ====== =========== Parameter Type Description @@ -308,26 +259,26 @@ Response Parameters **Status code: 400** -.. table:: **Table 15** Response body parameters +.. table:: **Table 14** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -The following example shows how to update an IPv4 inbound rule. The rule name is TestRule, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled. +The following example shows how to update an IPv4 inbound rule. The rule name is **Test rule**, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled. .. code-block:: https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031 { - "name" : "TestRule", + "name" : "Test rule.", "status" : 1, "action_type" : 0, "description" : "", @@ -378,7 +329,7 @@ Bad Request { "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_msg" : "Object not found." } Status Codes diff --git a/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst b/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst index e7f5226..456a5e4 100644 --- a/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst +++ b/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst @@ -17,44 +17,44 @@ PUT /v1/{project_id}/acl-rule/action .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Action of updating ACL Rules. The value can be enable (enable the rules), or disable (disable the rules). | - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_ids | Yes | Array of strings | Array of rule IDs. | - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action | Yes | String | Rule action: **0** (permit), **1** (deny). | + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_ids | Yes | Array of strings | List of rule IDs. You can obtain the rule IDs by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -63,11 +63,11 @@ Response Parameters .. table:: **Table 5** Response body parameters - ========= ================ ========================= - Parameter Type Description - ========= ================ ========================= - data Array of strings batch update acl rule ids - ========= ================ ========================= + +-----------+------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================+=========================================================================================================+ + | data | Array of strings | IDs of ACL rules to be updated in batches. The value is the rule IDs transferred from the request body. | + +-----------+------------------+---------------------------------------------------------------------------------------------------------+ Example Requests ---------------- @@ -89,7 +89,7 @@ Example Responses **Status code: 200** -Batch Update Acl Rule Response +Returned value for batch ACL rule update. .. code-block:: @@ -100,11 +100,11 @@ Batch Update Acl Rule Response Status Codes ------------ -=========== ============================== +=========== ========================================= Status Code Description -=========== ============================== -200 Batch Update Acl Rule Response -=========== ============================== +=========== ========================================= +200 Returned value for batch ACL rule update. +=========== ========================================= Error Codes ----------- diff --git a/api-ref/source/api/address_set_management/adding_an_address_set.rst b/api-ref/source/api/address_group_management/adding_an_address_group.rst similarity index 64% rename from api-ref/source/api/address_set_management/adding_an_address_set.rst rename to api-ref/source/api/address_group_management/adding_an_address_group.rst index 1a973a7..49a472f 100644 --- a/api-ref/source/api/address_set_management/adding_an_address_set.rst +++ b/api-ref/source/api/address_group_management/adding_an_address_group.rst @@ -2,8 +2,8 @@ .. _AddAddressSet: -Adding an Address Set -===================== +Adding an Address Group +======================= Function -------- @@ -17,52 +17,46 @@ POST /v1/{project_id}/address-set .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | IP address group name | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Address group description | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). The default value is 0 | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | IP address group name. | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Address group description. | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -71,38 +65,38 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+-------------------------------------------------------------------------+-----------------------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================================+===============================================+ - | data | :ref:`AddressIdObject ` object | Data returned after an address group is added | - +-----------+-------------------------------------------------------------------------+-----------------------------------------------+ + +-----------+-------------------------------------------------------------------+------------------------------------------------+ + | Parameter | Type | Description | + +===========+===================================================================+================================================+ + | data | :ref:`AddressSetId ` object | Data returned after an address group is added. | + +-----------+-------------------------------------------------------------------+------------------------------------------------+ -.. _addaddressset__response_addressidobject: +.. _addaddressset__response_addresssetid: -.. table:: **Table 6** AddressIdObject +.. table:: **Table 6** AddressSetId - ========= ====== =================== + ========= ====== ====================== Parameter Type Description - ========= ====== =================== - id String ip address set id - name String ip address set name - ========= ====== =================== + ========= ====== ====================== + id String Address group ID. + name String IP address group name. + ========= ====== ====================== **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Add an IPv4 address group whose project ID is 14181c1245cf4fd786824efe1e2b9388, protected object ID is 1530de8a-522d-4771-9067-9fa4e2f53b48, and name is ceshi. +Add an IPv4 address group whose project ID is 14181c1245cf4fd786824efe1e2b9388, protected object ID is 1530de8a-522d-4771-9067-9fa4e2f53b48, and name is **ceshi**. .. code-block:: @@ -120,7 +114,7 @@ Example Responses **Status code: 200** -OK +Return value for adding an address group. .. code-block:: @@ -138,22 +132,22 @@ Bad Request { "error_code" : "CFW.00900020", - "error_msg" : "Address groups exceed the maximum limit" + "error_msg" : "The number of address groups exceeds the upper limit." } Status Codes ------------ -=========== ===================== +=========== ========================================= Status Code Description -=========== ===================== -200 OK +=========== ========================================= +200 Return value for adding an address group. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ========================================= Error Codes ----------- diff --git a/api-ref/source/api/address_set_management/adding_an_address_set_member.rst b/api-ref/source/api/address_group_management/adding_an_address_group_member.rst similarity index 52% rename from api-ref/source/api/address_set_management/adding_an_address_set_member.rst rename to api-ref/source/api/address_group_management/adding_an_address_group_member.rst index a6a40e9..fb8e136 100644 --- a/api-ref/source/api/address_set_management/adding_an_address_set_member.rst +++ b/api-ref/source/api/address_group_management/adding_an_address_group_member.rst @@ -2,13 +2,13 @@ .. _AddAddressItem: -Adding an Address Set Member -============================ +Adding an Address Group Member +============================== Function -------- -This API is used to add an address group member. +This API is used to add a member to an address group. URI --- @@ -17,56 +17,54 @@ POST /v1/{project_id}/address-items .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +---------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+===============================================================================+================================================================================================+ - | set_id | Yes | String | ID of the IP address group, obtain the ID by calling the API used for querying ip address sets | - +---------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ - | address_items | Yes | Array of :ref:`address_items ` objects | Address group member information | - +---------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + +---------------+-----------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+===============================================================================+======================================================================================================================================================================================================================================+ + | set_id | No | String | Address group ID, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------+-----------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_items | No | Array of :ref:`address_items ` objects | Address group member list. | + +---------------+-----------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaddressitem__request_address_items: .. table:: **Table 5** address_items - +--------------+-----------+---------+------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+======================================================+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | - +--------------+-----------+---------+------------------------------------------------------+ - | address | No | String | IP address information of the address group | - +--------------+-----------+---------+------------------------------------------------------+ - | description | No | String | Address group member description | - +--------------+-----------+---------+------------------------------------------------------+ + ============ ========= ======= ========================================= + Parameter Mandatory Type Description + ============ ========= ======= ========================================= + address_type No Integer Address type: **0** (IPv4), **1** (IPv6). + address Yes String ip + description No String Address group member description. + ============ ========= ======= ========================================= Response Parameters ------------------- @@ -75,60 +73,60 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------+--------------------------------------------------------------------+------------------------------------------------------+ - | Parameter | Type | Description | - +===========+====================================================================+======================================================+ - | data | :ref:`AddressItems ` object | Data returned after an address group member is added | - +-----------+--------------------------------------------------------------------+------------------------------------------------------+ + +-----------+--------------------------------------------------------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +===========+====================================================================+=======================================================+ + | data | :ref:`AddressItems ` object | Data returned after an address group member is added. | + +-----------+--------------------------------------------------------------------+-------------------------------------------------------+ .. _addaddressitem__response_addressitems: .. table:: **Table 7** AddressItems - +------------+--------------------------------------------------------------------------------------------+----------------------------------+ - | Parameter | Type | Description | - +============+============================================================================================+==================================+ - | items | Array of :ref:`AddressItemIdObject ` objects | List of address group member IDs | - +------------+--------------------------------------------------------------------------------------------+----------------------------------+ - | covered_ip | Array of :ref:`CoveredIPVO ` objects | covered ip list | - +------------+--------------------------------------------------------------------------------------------+----------------------------------+ + +------------+------------------------------------------------------------------------------------------------------+-----------------------------------+ + | Parameter | Type | Description | + +============+======================================================================================================+===================================+ + | items | Array of :ref:`AddressItemIdWithoutName ` objects | List of address group member IDs. | + +------------+------------------------------------------------------------------------------------------------------+-----------------------------------+ + | covered_ip | Array of :ref:`CoveredIPVO ` objects | List of covered IP addresses. | + +------------+------------------------------------------------------------------------------------------------------+-----------------------------------+ -.. _addaddressitem__response_addressitemidobject: +.. _addaddressitem__response_addressitemidwithoutname: -.. table:: **Table 8** AddressItemIdObject +.. table:: **Table 8** AddressItemIdWithoutName - ========= ====== =============== + ========= ====== ============================== Parameter Type Description - ========= ====== =============== - id String address item id - ========= ====== =============== + ========= ====== ============================== + id String ID of an address group member. + ========= ====== ============================== .. _addaddressitem__response_coveredipvo: .. table:: **Table 9** CoveredIPVO - ========== ====== =========== + ========== ====== ==================== Parameter Type Description - ========== ====== =========== - ip String ip address - covered_Ip String covered ip - ========== ====== =========== + ========== ====== ==================== + ip String IP address + covered_Ip String Cover an IP address. + ========== ====== ==================== **Status code: 400** .. table:: **Table 10** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Add an address group member whose IP address is 2.2.2.2 and name is ceshi to the group whose set_id is 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429. +Add an address group member whose IP address is 2.2.2.2 and name is **ceshi** to the group whose **set_id** is 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -147,7 +145,7 @@ Example Responses **Status code: 200** -Return value for adding an address group member +Return value for adding an address group member. .. code-block:: @@ -168,22 +166,22 @@ Bad Request { "error_code" : "CFW.00200001", - "error_msg" : "empty param" + "error_msg" : "Empty parameter." } Status Codes ------------ -=========== =============================================== +=========== ================================================ Status Code Description -=========== =============================================== -200 Return value for adding an address group member +=========== ================================================ +200 Return value for adding an address group member. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== =============================================== +=========== ================================================ Error Codes ----------- diff --git a/api-ref/source/api/address_set_management/batch_delete_address_items.rst b/api-ref/source/api/address_group_management/deleting_address_group_members_in_batches.rst similarity index 53% rename from api-ref/source/api/address_set_management/batch_delete_address_items.rst rename to api-ref/source/api/address_group_management/deleting_address_group_members_in_batches.rst index 20af244..6c6c73c 100644 --- a/api-ref/source/api/address_set_management/batch_delete_address_items.rst +++ b/api-ref/source/api/address_group_management/deleting_address_group_members_in_batches.rst @@ -2,13 +2,13 @@ .. _BatchDeleteAddressItems: -Batch Delete Address Items -========================== +Deleting Address Group Members in Batches +========================================= Function -------- -Batch Delete Address Items +This API is used to delete address group members in batches. URI --- @@ -17,42 +17,42 @@ DELETE /v1/{project_id}/address-items .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +------------------+-----------+------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+==================+===========================================================================================+ - | set_id | Yes | String | set id, obtain the ID by calling the API used for querying ip address sets. | - +------------------+-----------+------------------+-------------------------------------------------------------------------------------------+ - | address_item_ids | Yes | Array of strings | address item ids, obtain the ID by calling the API used for querying address set members. | - +------------------+-----------+------------------+-------------------------------------------------------------------------------------------+ + +------------------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+==================+==========================================================================================================================================================================================================================================================================+ + | set_id | Yes | String | Address group ID, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_item_ids | Yes | Array of strings | List of address group member IDs. Address group member IDs can be obtained by calling the :ref:`API for querying address group members `. Find the value in **data.records.item_id** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -61,16 +61,16 @@ Response Parameters .. table:: **Table 5** Response body parameters - ========= ================ ================================== - Parameter Type Description - ========= ================ ================================== - data Array of strings batch delete address item response - ========= ================ ================================== + +-----------+------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================+================================================================+ + | data | Array of strings | ID list of the address group members to be deleted in batches. | + +-----------+------------------+----------------------------------------------------------------+ Example Requests ---------------- -Delete address set member whose ID is d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address set e4884376-7efb-40e7-b98b-13668d6f8b85 for project 9d80d070b6d44942af73c9c3d38e0429. +Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -86,7 +86,7 @@ Example Responses **Status code: 200** -Batch delete address items response +Return value for deleting address group members in batches. .. code-block:: @@ -97,11 +97,11 @@ Batch delete address items response Status Codes ------------ -=========== =================================== +=========== =========================================================== Status Code Description -=========== =================================== -200 Batch delete address items response -=========== =================================== +=========== =========================================================== +200 Return value for deleting address group members in batches. +=========== =========================================================== Error Codes ----------- diff --git a/api-ref/source/api/address_set_management/deleting_an_address_set.rst b/api-ref/source/api/address_group_management/deleting_an_address_group.rst similarity index 50% rename from api-ref/source/api/address_set_management/deleting_an_address_set.rst rename to api-ref/source/api/address_group_management/deleting_an_address_group.rst index 741b3c8..f98d633 100644 --- a/api-ref/source/api/address_set_management/deleting_an_address_set.rst +++ b/api-ref/source/api/address_group_management/deleting_an_address_group.rst @@ -2,8 +2,8 @@ .. _DeleteAddressSet: -Deleting an Address Set -======================= +Deleting an Address Group +========================= Function -------- @@ -17,33 +17,34 @@ DELETE /v1/{project_id}/address-sets/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ========================== - Parameter Mandatory Type Description - ========== ========= ====== ========================== - project_id Yes String Project ID - set_id Yes String ID of the IP address group - ========== ========= ====== ========================== + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+======================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Address group ID, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -52,38 +53,38 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+--------------------------------------------------------------+-------------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================+=================================================+ - | data | :ref:`IdObject ` object | Data returned after an address group is deleted | - +-----------+--------------------------------------------------------------+-------------------------------------------------+ + +-----------+----------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================================================+==================================================+ + | data | :ref:`AddressSetId ` object | Data returned after an address group is deleted. | + +-----------+----------------------------------------------------------------------+--------------------------------------------------+ -.. _deleteaddressset__response_idobject: +.. _deleteaddressset__response_addresssetid: -.. table:: **Table 5** IdObject +.. table:: **Table 5** AddressSetId - ========= ====== =========== + ========= ====== ====================== Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + ========= ====== ====================== + id String Address group ID. + name String IP address group name. + ========= ====== ====================== **Status code: 400** .. table:: **Table 6** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Delete address set cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 from project 9d80d070b6d44942af73c9c3d38e0429. +Delete address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 from project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -94,7 +95,7 @@ Example Responses **Status code: 200** -OK +Return value for deleting an address group. .. code-block:: @@ -113,22 +114,22 @@ Bad Request { "error_code" : "CFW.00200004", - "error_msg" : "can not delete for used" + "error_msg" : "Failed to delete the resource because it is being referenced." } Status Codes ------------ -=========== ===================== +=========== =========================================== Status Code Description -=========== ===================== -200 OK +=========== =========================================== +200 Return value for deleting an address group. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== =========================================== Error Codes ----------- diff --git a/api-ref/source/api/address_group_management/deleting_an_address_group_member.rst b/api-ref/source/api/address_group_management/deleting_an_address_group_member.rst new file mode 100644 index 0000000..c772033 --- /dev/null +++ b/api-ref/source/api/address_group_management/deleting_an_address_group_member.rst @@ -0,0 +1,137 @@ +:original_name: DeleteAddressItem.html + +.. _DeleteAddressItem: + +Deleting an Address Group Member +================================ + +Function +-------- + +This API is used to delete a member from an address group. + +URI +--- + +DELETE /v1/{project_id}/address-items/{item_id} + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+==============================================================================================================================================================================================================================================+ + | item_id | Yes | String | Address group member ID, which can be obtained by calling the :ref:`API for querying address group members `. Find the value in **data.records.item_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+-----------------------------------------------------------------------------------+------------------------------------+ + | Parameter | Type | Description | + +===========+===================================================================================+====================================+ + | data | Array of :ref:`AddressItemId ` objects | Delete an address group member ID. | + +-----------+-----------------------------------------------------------------------------------+------------------------------------+ + +.. _deleteaddressitem__response_addressitemid: + +.. table:: **Table 5** AddressItemId + + ========= ====== ================================ + Parameter Type Description + ========= ====== ================================ + id String ID of an address group member. + name String Name of an address group member. + ========= ====== ================================ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +Delete address group member 65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae from project 9d80d070b6d44942af73c9c3d38e0429. + +.. code-block:: + + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae + +Example Responses +----------------- + +**Status code: 200** + +Return value for deleting an address group member. + +.. code-block:: + + { + "data" : { + "id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae", + "name" : "test" + } + } + +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.0020016", + "error_msg" : "Incorrect instance status." + } + +Status Codes +------------ + +=========== ================================================== +Status Code Description +=========== ================================================== +200 Return value for deleting an address group member. +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/address_group_management/index.rst b/api-ref/source/api/address_group_management/index.rst new file mode 100644 index 0000000..0bbc446 --- /dev/null +++ b/api-ref/source/api/address_group_management/index.rst @@ -0,0 +1,30 @@ +:original_name: topic_300000004.html + +.. _topic_300000004: + +Address Group Management +======================== + +- :ref:`Adding an Address Group ` +- :ref:`Adding an Address Group Member ` +- :ref:`Deleting an Address Group ` +- :ref:`Deleting an Address Group Member ` +- :ref:`Deleting Address Group Members in Batches ` +- :ref:`Updating Address Group Information ` +- :ref:`Querying the Address Group List ` +- :ref:`Querying Address Group Details ` +- :ref:`Querying Address Group Members ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + adding_an_address_group + adding_an_address_group_member + deleting_an_address_group + deleting_an_address_group_member + deleting_address_group_members_in_batches + updating_address_group_information + querying_the_address_group_list + querying_address_group_details + querying_address_group_members diff --git a/api-ref/source/api/ips_management/querying_the_protection_mode.rst b/api-ref/source/api/address_group_management/querying_address_group_details.rst similarity index 54% rename from api-ref/source/api/ips_management/querying_the_protection_mode.rst rename to api-ref/source/api/address_group_management/querying_address_group_details.rst index 128dd41..5bc7956 100644 --- a/api-ref/source/api/ips_management/querying_the_protection_mode.rst +++ b/api-ref/source/api/address_group_management/querying_address_group_details.rst @@ -1,50 +1,52 @@ -:original_name: ListIpsProtectMode.html +:original_name: ListAddressSetDetail.html -.. _ListIpsProtectMode: +.. _ListAddressSetDetail: -Querying the Protection Mode -============================ +Querying Address Group Details +============================== Function -------- -This API is used to query the protection mode. +This API is used to query address group details. URI --- -GET /v1/{project_id}/ips/protect +GET /v1/{project_id}/address-sets/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+======================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Address group ID, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_address_set_type | No | Integer | Type of the address group to be queried: **0** (user-defined address group), **1** (predefined address group). | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -53,47 +55,69 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+----------------------------------------------------------------------------------------+----------------------+ - | Parameter | Type | Description | - +===========+========================================================================================+======================+ - | data | :ref:`IpsProtectModeObject ` object | IpsProtectModeObject | - +-----------+----------------------------------------------------------------------------------------+----------------------+ + +-----------+----------------------------------------------------------+------------------------------+ + | Parameter | Type | Description | + +===========+==========================================================+==============================+ + | data | :ref:`data ` object | Query address group details. | + +-----------+----------------------------------------------------------+------------------------------+ -.. _listipsprotectmode__response_ipsprotectmodeobject: +.. _listaddresssetdetail__response_data: -.. table:: **Table 5** IpsProtectModeObject +.. table:: **Table 5** data - +-----------+---------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+=================================================================================================================+ - | id | String | ips protect mode id | - +-----------+---------+-----------------------------------------------------------------------------------------------------------------+ - | mode | Integer | IPS protection mode. 0: observation mode; 1: strict mode; 2: medium mode; 3: loose mode, The default value is 0 | - +-----------+---------+-----------------------------------------------------------------------------------------------------------------+ + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=========+====================================================================================================================================================================================+ + | id | String | Address group ID. | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | IP address group name. | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Address group description. | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | Integer | Address group type: **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 6** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Query the IPS protection mode of the project whose ID is 9d80d070b6d44942af73c9c3d38e0429. +Query details about the address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2 + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 Example Responses ----------------- +**Status code: 200** + +Response body for querying address group details. + +.. code-block:: + + { + "data" : { + "address_set_type" : 0, + "address_type" : 0, + "description" : "", + "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16", + "name" : "ABC" + } + } + **Status code: 400** Bad Request @@ -101,23 +125,23 @@ Bad Request .. code-block:: { - "error_code" : "CFW.0020016", - "error_msg" : "instance status error" + "error_code" : "CFW.00200005", + "error_msg" : "Object not found." } Status Codes ------------ -=========== ===================== +=========== ================================================= Status Code Description -=========== ===================== -200 OK +=========== ================================================= +200 Response body for querying address group details. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ================================================= Error Codes ----------- diff --git a/api-ref/source/api/address_group_management/querying_address_group_members.rst b/api-ref/source/api/address_group_management/querying_address_group_members.rst new file mode 100644 index 0000000..828cb50 --- /dev/null +++ b/api-ref/source/api/address_group_management/querying_address_group_members.rst @@ -0,0 +1,176 @@ +:original_name: ListAddressItems.html + +.. _ListAddressItems: + +Querying Address Group Members +============================== + +Function +-------- + +This API is used to query members in an address group. + +URI +--- + +GET /v1/{project_id}/address-items + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | set_id | Yes | String | Address group ID, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Keyword, including the name or part of the description of an address group member. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | IP address | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_address_set_type | No | Integer | Type of the address group to be queried: **0** (user-defined address group), **1** (predefined address group). | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+------------------------------------------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================================+===================================================+ + | data | :ref:`data ` object | Returned data for querying address group members. | + +-----------+------------------------------------------------------+---------------------------------------------------+ + +.. _listaddressitems__response_data: + +.. table:: **Table 5** data + + +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================================================+=================================================================================================================================================+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Total number of address group members. | + +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | String | Address group ID. | + +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | List of address group member records. | + +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listaddressitems__response_records: + +.. table:: **Table 6** records + + ============ ======= ========================================= + Parameter Type Description + ============ ======= ========================================= + item_id String ID of an address group member. + name String Name of an address group member. + description String Description. + address_type Integer Address type: **0** (IPv4), **1** (IPv6). + address String Address information. + ============ ======= ========================================= + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +Query members in the address group 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429. + +.. code-block:: + + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0 + +Example Responses +----------------- + +**Status code: 200** + +Return value for querying address group members. + +.. code-block:: + + { + "data" : { + "limit" : 10, + "offset" : 0, + "records" : [ { + "address" : "1.1.1.1", + "address_type" : 0, + "description" : "", + "item_id" : "294fab71-34bf-4858-a380-8f7530e1c816" + } ], + "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c", + "total" : 1 + } + } + +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.00200005", + "error_msg" : "Object not found." + } + +Status Codes +------------ + +=========== ================================================ +Status Code Description +=========== ================================================ +200 Return value for querying address group members. +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ================================================ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst b/api-ref/source/api/address_group_management/querying_the_address_group_list.rst similarity index 63% rename from api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst rename to api-ref/source/api/address_group_management/querying_the_address_group_list.rst index fbc8699..db6a66f 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst +++ b/api-ref/source/api/address_group_management/querying_the_address_group_list.rst @@ -1,74 +1,64 @@ -:original_name: ListBlackWhiteLists.html +:original_name: ListAddressSets.html -.. _ListBlackWhiteLists: +.. _ListAddressSets: -Querying a Blacklist or Whitelist -================================= +Querying the Address Group List +=============================== Function -------- -This API is used to query a blacklist or whitelist. +This API is used to query the address group list. URI --- -GET /v1/{project_id}/black-white-lists +GET /v1/{project_id}/address-sets .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | list_type | Yes | Integer | Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **4** | - | | | | | - | | | | - **5** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Specifies the IP address type. The value can be 0 (IPv4), 1 (IPv6). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | No | String | Port | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Keyword, including the name or part of the description of an address group. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | IP address | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_address_set_type | No | Integer | Type of the address group to be queried: **0** (user-defined address group), **1** (predefined address group). This parameter takes effect only if **address_set_type** is not **0** and **query_address_set_type** is **1**. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | No | Integer | Address group type: **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -77,76 +67,76 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+---------------------------------------------------------+------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================+======================================================+ - | data | :ref:`data ` object | Return value for querying the blacklist or whitelist | - +-----------+---------------------------------------------------------+------------------------------------------------------+ + +-----------+-----------------------------------------------------+----------------------------------------------------+ + | Parameter | Type | Description | + +===========+=====================================================+====================================================+ + | data | :ref:`data ` object | Returned data for querying the address group list. | + +-----------+-----------------------------------------------------+----------------------------------------------------+ -.. _listblackwhitelists__response_data: +.. _listaddresssets__response_data: .. table:: **Table 5** data - +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================================+=================================================================================================================================================+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of queried records | - +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Blacklist and whitelist records | - +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=====================================================================+=================================================================================================================================================+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Total number of address groups. | + +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | IP address group list. | + +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _listblackwhitelists__response_records: +.. _listaddresssets__response_records: .. table:: **Table 6** records - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+=========+==================================================================================================================================================================================================================+ - | list_id | String | Blacklist/Whitelist ID | - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Integer | Direction of a black or white address. 0: source address; 1: destination address. | - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | IP address type. 0: ipv4; 1: ipv6 | - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | String | IP address | - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | String | Port | - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | description | - +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | set_id | String | Address group ID. | + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ref_count | Integer | Number of times an address group is referenced by rules. | + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Description. | + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | IP address group name. | + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | Integer | Address group type: **0** (user-defined address group), **1** (WAF back-to-source IP address group), **2** (DDoS back-to-source IP address group), or **3** (NAT64 address group). | + +------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Query five whitelist records on the first page of object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429. +Query the IP address groups on the first page of the protected object 8a41d6a5-f215-428a-a76c-dc923b5d599a in project 5c69cf330cda42369cbd726ee1bc5e76. .. code-block:: - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5 + https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0 Example Responses ----------------- **Status code: 200** -Return value of a blacklist or whitelist query +Return value for querying the address group list. .. code-block:: @@ -155,12 +145,13 @@ Return value of a blacklist or whitelist query "limit" : 10, "offset" : 0, "records" : [ { - "address" : "1.1.1.1", + "address_set_type" : 0, + "object_id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16", "address_type" : 0, "description" : "", - "direction" : 0, - "list_id" : "1310d401-daf5-44f2-8276-f79e1643984d", - "protocol" : 6 + "name" : "test", + "ref_count" : 0, + "set_id" : "50da1eff-e58d-4380-b899-a78f94137d3b" } ], "total" : 1 } @@ -174,22 +165,22 @@ Bad Request { "error_code" : "CFW.0020016", - "error_msg" : "instance status error" + "error_msg" : "Incorrect instance status." } Status Codes ------------ -=========== ============================================== +=========== ================================================= Status Code Description -=========== ============================================== -200 Return value of a blacklist or whitelist query +=========== ================================================= +200 Return value for querying the address group list. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ============================================== +=========== ================================================= Error Codes ----------- diff --git a/api-ref/source/api/address_set_management/updating_address_set_information.rst b/api-ref/source/api/address_group_management/updating_address_group_information.rst similarity index 53% rename from api-ref/source/api/address_set_management/updating_address_set_information.rst rename to api-ref/source/api/address_group_management/updating_address_group_information.rst index 9940f61..9c214b6 100644 --- a/api-ref/source/api/address_set_management/updating_address_set_information.rst +++ b/api-ref/source/api/address_group_management/updating_address_group_information.rst @@ -2,8 +2,8 @@ .. _UpdateAddressSet: -Updating Address Set Information -================================ +Updating Address Group Information +================================== Function -------- @@ -17,42 +17,43 @@ PUT /v1/{project_id}/address-sets/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ========================== - Parameter Mandatory Type Description - ========== ========= ====== ========================== - project_id Yes String Project ID - set_id Yes String ID of the IP address group - ========== ========= ====== ========================== + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+======================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Address group ID, which can be obtained by calling the :ref:`API for querying the address group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - =========== ========= ====== ========================= + =========== ========= ====== ========================== Parameter Mandatory Type Description - =========== ========= ====== ========================= - name No String IP address group name - description No String Address group description - =========== ========= ====== ========================= + =========== ========= ====== ========================== + name No String IP address group name. + description No String Address group description. + =========== ========= ====== ========================== Response Parameters ------------------- @@ -61,37 +62,38 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+------------------------------------------------------------------------------------------------------+-------------------------------------------------+ - | Parameter | Type | Description | - +===========+======================================================================================================+=================================================+ - | data | :ref:`UpdateAddressSetResponseData ` object | Data returned after an address group is updated | - +-----------+------------------------------------------------------------------------------------------------------+-------------------------------------------------+ + +-----------+------------------------------------------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================================================================================+==================================================+ + | data | :ref:`UpdateAddressSetResponseData ` object | Data returned after an address group is updated. | + +-----------+------------------------------------------------------------------------------------------------------+--------------------------------------------------+ .. _updateaddressset__response_updateaddresssetresponsedata: .. table:: **Table 6** UpdateAddressSetResponseData - ========= ====== =========== + ========= ====== ====================== Parameter Type Description - ========= ====== =========== - id String Id - ========= ====== =========== + ========= ====== ====================== + id String Address group ID. + name String IP address group name. + ========= ====== ====================== **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -In the project 9d80d070b6d44942af73c9c3d38e0429, change the name of the address set whose ID is cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 to ABCD. +Change the name of address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16) in project 9d80d070b6d44942af73c9c3d38e0429 to **ABCD**. .. code-block:: @@ -107,7 +109,7 @@ Example Responses **Status code: 200** -OK +Return value for updating an address group. .. code-block:: @@ -125,22 +127,22 @@ Bad Request { "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_msg" : "Object not found." } Status Codes ------------ -=========== ===================== +=========== =========================================== Status Code Description -=========== ===================== -200 OK +=========== =========================================== +200 Return value for updating an address group. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== =========================================== Error Codes ----------- diff --git a/api-ref/source/api/address_set_management/index.rst b/api-ref/source/api/address_set_management/index.rst deleted file mode 100644 index 33ee267..0000000 --- a/api-ref/source/api/address_set_management/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -:original_name: topic_300000004.html - -.. _topic_300000004: - -Address Set Management -====================== - -- :ref:`Adding an Address Set Member ` -- :ref:`Batch Delete Address Items ` -- :ref:`Deleting an Address Set Member ` -- :ref:`Querying Address Set Members ` -- :ref:`Adding an Address Set ` -- :ref:`Querying IP Address Sets ` -- :ref:`Querying Address Set Details ` -- :ref:`Updating Address Set Information ` -- :ref:`Deleting an Address Set ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - adding_an_address_set_member - batch_delete_address_items - deleting_an_address_set_member - querying_address_set_members - adding_an_address_set - querying_ip_address_sets - querying_address_set_details - updating_address_set_information - deleting_an_address_set diff --git a/api-ref/source/api/address_set_management/querying_address_set_details.rst b/api-ref/source/api/address_set_management/querying_address_set_details.rst deleted file mode 100644 index 857c1ad..0000000 --- a/api-ref/source/api/address_set_management/querying_address_set_details.rst +++ /dev/null @@ -1,156 +0,0 @@ -:original_name: ListAddressSetDetail.html - -.. _ListAddressSetDetail: - -Querying Address Set Details -============================ - -Function --------- - -This API is used to query details about an address group. - -URI ---- - -GET /v1/{project_id}/address-sets/{set_id} - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== ========================== - Parameter Mandatory Type Description - ========== ========= ====== ========================== - project_id Yes String Project ID - set_id Yes String ID of the IP address group - ========== ========= ====== ========================== - -.. table:: **Table 2** Query Parameters - - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query_address_set_type | No | Integer | Query address set type, 0 indicates a custom address set and 1 indicates a predefined address set | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+----------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+==========================================================+==============================+ - | data | :ref:`data ` object | Query address group details. | - +-----------+----------------------------------------------------------+------------------------------+ - -.. _listaddresssetdetail__response_data: - -.. table:: **Table 5** data - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+====================================================================================================================================================================================================================+ - | id | String | ID of the IP address group | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | IP address group name | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Address group description | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 6** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -Query details about address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 in project 9d80d070b6d44942af73c9c3d38e0429. - -.. code-block:: - - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "data" : { - "address_set_type" : 0, - "address_type" : 0, - "description" : "", - "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16", - "name" : "ABC" - } - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" - } - -Status Codes ------------- - -=========== ===================== -Status Code Description -=========== ===================== -200 OK -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ===================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/address_set_management/querying_address_set_members.rst b/api-ref/source/api/address_set_management/querying_address_set_members.rst deleted file mode 100644 index dee0e2c..0000000 --- a/api-ref/source/api/address_set_management/querying_address_set_members.rst +++ /dev/null @@ -1,180 +0,0 @@ -:original_name: ListAddressItems.html - -.. _ListAddressItems: - -Querying Address Set Members -============================ - -Function --------- - -This API is used to query address group members. - -URI ---- - -GET /v1/{project_id}/address-items - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | set_id | Yes | String | ID of the IP address group | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Keyword | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | IP address | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query_address_set_type | No | Integer | Query address set type, 0 means custom define address set, 1 means predefined address set | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+------------------------------------------------------+-----------------------------------------+ - | Parameter | Type | Description | - +===========+======================================================+=========================================+ - | data | :ref:`data ` object | Response for address group member query | - +-----------+------------------------------------------------------+-----------------------------------------+ - -.. _listaddressitems__response_data: - -.. table:: **Table 5** data - - +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+======================================================================+=================================================================================================================================================+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total | - +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | String | ID of the IP address group | - +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Member information | - +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listaddressitems__response_records: - -.. table:: **Table 6** records - - +--------------+---------+------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+=========+============================================================+ - | item_id | String | ID of an address group member | - +--------------+---------+------------------------------------------------------------+ - | name | String | Name of an address group member | - +--------------+---------+------------------------------------------------------------+ - | description | String | Description | - +--------------+---------+------------------------------------------------------------+ - | address_type | Integer | Address group type. The value can be 0 (IPv4) or 1 (IPv6). | - +--------------+---------+------------------------------------------------------------+ - | address | String | Address group | - +--------------+---------+------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 7** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -Query members in address group 8773c082-2a6c-4529-939a-edc28ef1a67c of project 9d80d070b6d44942af73c9c3d38e0429. - -.. code-block:: - - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0 - -Example Responses ------------------ - -**Status code: 200** - -Return value for querying address group members - -.. code-block:: - - { - "data" : { - "limit" : 10, - "offset" : 0, - "records" : [ { - "address" : "1.1.1.1", - "address_type" : 0, - "description" : "", - "item_id" : "294fab71-34bf-4858-a380-8f7530e1c816" - } ], - "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c", - "total" : 1 - } - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" - } - -Status Codes ------------- - -=========== =============================================== -Status Code Description -=========== =============================================== -200 Return value for querying address group members -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== =============================================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/address_set_management/querying_ip_address_sets.rst b/api-ref/source/api/address_set_management/querying_ip_address_sets.rst deleted file mode 100644 index 7823b3d..0000000 --- a/api-ref/source/api/address_set_management/querying_ip_address_sets.rst +++ /dev/null @@ -1,194 +0,0 @@ -:original_name: ListAddressSets.html - -.. _ListAddressSets: - -Querying IP Address Sets -======================== - -Function --------- - -Querying IP Address Sets - -URI ---- - -GET /v1/{project_id}/address-sets - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Keyword | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | IP address | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query_address_set_type | No | Integer | Query address set type, 0 indicates a custom address set and 1 indicates a predefined address set | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+-----------------------------------------------------+------------------------------------------------+ - | Parameter | Type | Description | - +===========+=====================================================+================================================+ - | data | :ref:`data ` object | Data returned for the address group list query | - +-----------+-----------------------------------------------------+------------------------------------------------+ - -.. _listaddresssets__response_data: - -.. table:: **Table 5** data - - +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=====================================================================+=================================================================================================================================================+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total | - +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | IP address set list | - +-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listaddresssets__response_records: - -.. table:: **Table 6** records - - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+=========+=====================================================================================================================================================================================================================================================================================+ - | set_id | String | ID of the IP address group | - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ref_count | Integer | Reference count | - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description | - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | IP address group name | - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | - +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 7** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -This API is used to query the IP address group information on the first page of project 8a41d6a5-f215-428a-a76c-dc923b5d599a. The protected object ID is 5c69cf330cda42369cbd726ee1bc5e76. - -.. code-block:: - - https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "data" : { - "limit" : 10, - "offset" : 0, - "records" : [ { - "address_set_type" : 0, - "object_id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16", - "address_type" : 0, - "description" : "", - "name" : "test", - "ref_count" : 0, - "set_id" : "50da1eff-e58d-4380-b899-a78f94137d3b" - } ], - "total" : 1 - } - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.0020016", - "error_msg" : "instance status error" - } - -Status Codes ------------- - -=========== ===================== -Status Code Description -=========== ===================== -200 OK -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ===================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst b/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst deleted file mode 100644 index 0e1261a..0000000 --- a/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst +++ /dev/null @@ -1,167 +0,0 @@ -:original_name: AddBlackWhiteList.html - -.. _AddBlackWhiteList: - -Creating a Blacklist or Whitelist Rule -====================================== - -Function --------- - -This API is used for creating a blacklist or whitelist rule. - -URI ---- - -POST /v1/{project_id}/black-white-list - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | list_type | Yes | Integer | Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist). | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Yes | Integer | Indicates the address direction. 0: source address 1: destination address | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Yes | Integer | IP address type. 0: ipv4; 1: ipv6 | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | Yes | String | IP Address | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | Yes | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | Yes | String | Destination port | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | description | - +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - +-----------+---------------------------------------------------------------+-------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+=============================================================+ - | data | :ref:`IdObject ` object | Response to the request for adding a blacklist or whitelist | - +-----------+---------------------------------------------------------------+-------------------------------------------------------------+ - -.. _addblackwhitelist__response_idobject: - -.. table:: **Table 6** IdObject - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== - -**Status code: 400** - -.. table:: **Table 7** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -Add an IPv4 TCP whitelist to object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1 - -.. code-block:: - - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list - - { - "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", - "list_type" : 5, - "direction" : 0, - "address" : "1.1.1.1", - "protocol" : 6, - "port" : "1", - "address_type" : 0 - } - -Example Responses ------------------ - -**Status code: 200** - -Response to the request for adding a blacklist or whitelist - -.. code-block:: - - { - "data" : { - "id" : "2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a", - "name" : "test" - } - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.0020016", - "error_msg" : "instance status error" - } - -Status Codes ------------- - -=========== =========================================================== -Status Code Description -=========== =========================================================== -200 Response to the request for adding a blacklist or whitelist -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== =========================================================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/log_management/list_log_config.rst b/api-ref/source/api/blacklist_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst similarity index 60% rename from api-ref/source/api/log_management/list_log_config.rst rename to api-ref/source/api/blacklist_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst index dd09cd5..d3f7ada 100644 --- a/api-ref/source/api/log_management/list_log_config.rst +++ b/api-ref/source/api/blacklist_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst @@ -1,125 +1,170 @@ -:original_name: ListLogConfig.html +:original_name: AddBlackWhiteList.html -.. _ListLogConfig: +.. _AddBlackWhiteList: -List Log Config -=============== +Creating a Blacklist or Whitelist Rule +====================================== Function -------- -This API is used to list log config. +This API is used to create a blacklist or whitelist rule. URI --- -GET /v1/{project_id}/cfw/logs/configuration +POST /v1/{project_id}/black-white-list .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | list_type | Yes | Integer | Blacklist/Whitelist type: **4** (blacklist), **5** (whitelist). | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Yes | Integer | Address direction: **0** (source), **1** (destination). | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Yes | Integer | IP address type: **0** (IPv4), **1** (IPv6). | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | Yes | String | IP address | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | Yes | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | Yes | String | Destination port. | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description. | + +--------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- **Status code: 200** -.. table:: **Table 4** Response body parameters +.. table:: **Table 5** Response body parameters - +-----------+-------------------------------------------------------------------+---------------------+ - | Parameter | Type | Description | - +===========+===================================================================+=====================+ - | data | :ref:`LogConfigDto ` object | Log Config Response | - +-----------+-------------------------------------------------------------------+---------------------+ + +-----------+-------------------------------------------------------------------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================================+================================================================+ + | data | :ref:`BlackWhiteListId ` object | Response to the request for adding a blacklist/whitelist item. | + +-----------+-------------------------------------------------------------------------------+----------------------------------------------------------------+ -.. _listlogconfig__response_logconfigdto: +.. _addblackwhitelist__response_blackwhitelistid: -.. table:: **Table 5** LogConfigDto +.. table:: **Table 6** BlackWhiteListId - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============================+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_enable | Integer | whether to enable LTS | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_log_group_id | String | Lts log group id, which can be obtained by calling the Querying All Log Groups of an Account API | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_attack_log_stream_id | String | Lts attack log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_attack_log_stream_enable | Integer | whether to enable attack log streaming | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_access_log_stream_id | String | Lts access log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_access_log_stream_enable | Integer | whether to enable access log streaming | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_flow_log_stream_id | String | Lts flow log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_flow_log_stream_enable | Integer | whether to enable flow log streaming | - +------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + ========= ====== ========================= + Parameter Type Description + ========= ====== ========================= + id String Blacklist/Whitelist ID. + name String Blacklist/Whitelist name. + ========= ====== ========================= + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Query the log configuration of whose firewall instance id is 4e113415-7811-4bb3-bf5e-eb835953f7d4 and project id is 408972e72dcd4c1a9b033e955802a36b. +Add an IPv4 whitelist to object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1. .. code-block:: - https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list + + { + "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", + "list_type" : 5, + "direction" : 0, + "address" : "1.1.1.1", + "protocol" : 6, + "port" : "1", + "address_type" : 0 + } Example Responses ----------------- **Status code: 200** -List Log Config Response +Response to the request for adding a blacklist or whitelist rule. .. code-block:: { "data" : { - "fw_instance_id" : "4df2bcd1-6299-4fba-8e71-8d50ea807090", - "lts_access_log_stream_enable" : 0, - "lts_attack_log_stream_enable" : 0, - "lts_enable" : 0, - "lts_flow_log_stream_enable" : 0, - "lts_log_group_id" : "d783ce42-7f56-4c2d-9a96-b1043d016f5a" + "id" : "2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a", + "name" : "test" } } +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.0020016", + "error_msg" : "Incorrect instance status." + } + Status Codes ------------ -=========== ======================== -Status Code Description -=========== ======================== -200 List Log Config Response -=========== ======================== ++-------------+-------------------------------------------------------------------+ +| Status Code | Description | ++=============+===================================================================+ +| 200 | Response to the request for adding a blacklist or whitelist rule. | ++-------------+-------------------------------------------------------------------+ +| 400 | Bad Request | ++-------------+-------------------------------------------------------------------+ +| 401 | Unauthorized | ++-------------+-------------------------------------------------------------------+ +| 403 | Forbidden | ++-------------+-------------------------------------------------------------------+ +| 404 | Not Found | ++-------------+-------------------------------------------------------------------+ +| 500 | Internal Server Error | ++-------------+-------------------------------------------------------------------+ Error Codes ----------- diff --git a/api-ref/source/api/blacklist_and_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst b/api-ref/source/api/blacklist_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst similarity index 50% rename from api-ref/source/api/blacklist_and_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst rename to api-ref/source/api/blacklist_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst index e90e982..5fd408a 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst +++ b/api-ref/source/api/blacklist_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst @@ -17,33 +17,34 @@ DELETE /v1/{project_id}/black-white-list/{list_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ====================== - Parameter Mandatory Type Description - ========== ========= ====== ====================== - project_id Yes String Project ID - list_id Yes String Blacklist/Whitelist ID - ========== ========= ====== ====================== + +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+=====================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | list_id | Yes | String | Blacklist or whitelist ID, which can be obtained through the :ref:`API for querying the blacklist or whitelist `. Find the value in **data.records.list_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -52,38 +53,38 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================================================================+===============================================================+ - | data | :ref:`IdObject ` object | Response to the request for deleting a blacklist or whitelist | - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ + +-----------+----------------------------------------------------------------------------------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================================+==================================================================+ + | data | :ref:`BlackWhiteListId ` object | Response to the request for deleting a blacklist/whitelist item. | + +-----------+----------------------------------------------------------------------------------+------------------------------------------------------------------+ -.. _deleteblackwhitelist__response_idobject: +.. _deleteblackwhitelist__response_blackwhitelistid: -.. table:: **Table 5** IdObject +.. table:: **Table 5** BlackWhiteListId - ========= ====== =========== + ========= ====== ========================= Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + ========= ====== ========================= + id String Blacklist/Whitelist ID. + name String Blacklist/Whitelist name. + ========= ====== ========================= **Status code: 400** .. table:: **Table 6** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Delete the black and white list with the project id 9d80d070b6d44942af73c9c3d38e0429 and the black and white list with the id 2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a +Delete the blacklist or whitelist whose ID is 2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a from the project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -94,7 +95,7 @@ Example Responses **Status code: 200** -Blacklist/Whitelist deletion response +Blacklist/Whitelist deletion response. .. code-block:: @@ -112,22 +113,22 @@ Bad Request { "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_msg" : "Object not found." } Status Codes ------------ -=========== ===================================== +=========== ====================================== Status Code Description -=========== ===================================== -200 Blacklist/Whitelist deletion response +=========== ====================================== +200 Blacklist/Whitelist deletion response. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================================== +=========== ====================================== Error Codes ----------- diff --git a/api-ref/source/api/blacklist_and_whitelist_management/index.rst b/api-ref/source/api/blacklist_whitelist_management/index.rst similarity index 70% rename from api-ref/source/api/blacklist_and_whitelist_management/index.rst rename to api-ref/source/api/blacklist_whitelist_management/index.rst index c56f543..c7959f7 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/index.rst +++ b/api-ref/source/api/blacklist_whitelist_management/index.rst @@ -2,11 +2,11 @@ .. _topic_300000003: -Blacklist and Whitelist Management -================================== +Blacklist/Whitelist Management +============================== - :ref:`Creating a Blacklist or Whitelist Rule ` -- :ref:`Updating the Blacklist or Whitelist ` +- :ref:`Updating a Blacklist or Whitelist ` - :ref:`Deleting a Blacklist or Whitelist Rule ` - :ref:`Querying a Blacklist or Whitelist ` @@ -15,6 +15,6 @@ Blacklist and Whitelist Management :hidden: creating_a_blacklist_or_whitelist_rule - updating_the_blacklist_or_whitelist + updating_a_blacklist_or_whitelist deleting_a_blacklist_or_whitelist_rule querying_a_blacklist_or_whitelist diff --git a/api-ref/source/api/blacklist_whitelist_management/querying_a_blacklist_or_whitelist.rst b/api-ref/source/api/blacklist_whitelist_management/querying_a_blacklist_or_whitelist.rst new file mode 100644 index 0000000..c32411f --- /dev/null +++ b/api-ref/source/api/blacklist_whitelist_management/querying_a_blacklist_or_whitelist.rst @@ -0,0 +1,185 @@ +:original_name: ListBlackWhiteLists.html + +.. _ListBlackWhiteLists: + +Querying a Blacklist or Whitelist +================================= + +Function +-------- + +This API is used to query a blacklist or whitelist. + +URI +--- + +GET /v1/{project_id}/black-white-lists + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | list_type | Yes | Integer | Blacklist/Whitelist type: **4** (blacklist), **5** (whitelist). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | IP address type: **0** (IPv4), **1** (IPv6). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | IP address | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | No | String | Port | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+---------------------------------------------------------+----------------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================+====================================================+ + | data | :ref:`data ` object | Return value for querying the blacklist/whitelist. | + +-----------+---------------------------------------------------------+----------------------------------------------------+ + +.. _listblackwhitelists__response_data: + +.. table:: **Table 5** data + + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+=================================================================================================================================================+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Query the total number of blacklist/whitelist records. | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | Blacklist/Whitelist. | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listblackwhitelists__response_records: + +.. table:: **Table 6** records + + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============+=========+============================================================================================================================================================================================================================+ + | list_id | String | Blacklist/Whitelist ID. | + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Integer | Direction of a blacklist/whitelist address: **0** (source address), **1** (destination address). | + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | IP address type: **0** (IPv4), **1** (IPv6). | + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | String | IP address | + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Port | + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Description. | + +--------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +Query five whitelist records on the first page of object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429. + +.. code-block:: + + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5 + +Example Responses +----------------- + +**Status code: 200** + +Return value of a blacklist or whitelist query. + +.. code-block:: + + { + "data" : { + "limit" : 10, + "offset" : 0, + "records" : [ { + "address" : "1.1.1.1", + "address_type" : 0, + "description" : "", + "direction" : 0, + "list_id" : "1310d401-daf5-44f2-8276-f79e1643984d", + "protocol" : 6 + } ], + "total" : 1 + } + } + +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.0020016", + "error_msg" : "Incorrect instance status." + } + +Status Codes +------------ + +=========== =============================================== +Status Code Description +=========== =============================================== +200 Return value of a blacklist or whitelist query. +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== =============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst b/api-ref/source/api/blacklist_whitelist_management/updating_a_blacklist_or_whitelist.rst similarity index 51% rename from api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst rename to api-ref/source/api/blacklist_whitelist_management/updating_a_blacklist_or_whitelist.rst index 7d9a6f0..9e74740 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst +++ b/api-ref/source/api/blacklist_whitelist_management/updating_a_blacklist_or_whitelist.rst @@ -2,13 +2,13 @@ .. _UpdateBlackWhiteList: -Updating the Blacklist or Whitelist -=================================== +Updating a Blacklist or Whitelist +================================= Function -------- -This API is used to update the blacklist or whitelist. +This API is used to update a blacklist or whitelist. URI --- @@ -17,51 +17,52 @@ PUT /v1/{project_id}/black-white-list/{list_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ====================== - Parameter Mandatory Type Description - ========== ========= ====== ====================== - project_id Yes String Project ID - list_id Yes String Blacklist/Whitelist ID - ========== ========= ====== ====================== + +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+=====================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | list_id | Yes | String | Blacklist or whitelist ID, which can be obtained through the :ref:`API for querying the blacklist or whitelist `. Find the value in **data.records.list_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+========================================================================================================+ - | direction | No | Integer | Indicates the address direction. 0: source address 1: destination address | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Address type. 0: ipv4; 1: ipv6 | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ - | address | Yes | String | IP address | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ - | protocol | No | Integer | Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ - | port | No | String | Port | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ - | description | No | String | description | - +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ + +--------------+-----------+---------+-------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+===========================================================================================+ + | direction | No | Integer | Address direction: **0** (source), **1** (destination). | + +--------------+-----------+---------+-------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +--------------+-----------+---------+-------------------------------------------------------------------------------------------+ + | address | Yes | String | IP address | + +--------------+-----------+---------+-------------------------------------------------------------------------------------------+ + | protocol | No | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). | + +--------------+-----------+---------+-------------------------------------------------------------------------------------------+ + | port | No | String | Port | + +--------------+-----------+---------+-------------------------------------------------------------------------------------------+ + | description | No | String | Description. | + +--------------+-----------+---------+-------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -70,46 +71,44 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================================================================+===============================================================+ - | data | :ref:`IdObject ` object | Response to the request for updating a blacklist or whitelist | - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ + +-----------+----------------------------------------------------------------------------------+---------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================================+===============================================================+ + | data | :ref:`BlackWhiteListId ` object | Response to the request for updating the blacklist/whitelist. | + +-----------+----------------------------------------------------------------------------------+---------------------------------------------------------------+ -.. _updateblackwhitelist__response_idobject: +.. _updateblackwhitelist__response_blackwhitelistid: -.. table:: **Table 6** IdObject +.. table:: **Table 6** BlackWhiteListId - ========= ====== =========== + ========= ====== ========================= Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + ========= ====== ========================= + id String Blacklist/Whitelist ID. + name String Blacklist/Whitelist name. + ========= ====== ========================= **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Update the whitelist with the project id 9d80d070b6d44942af73c9c3d38e0429 and the protected object id as cfebd347-b655-4b84-b938-3c54317599b2. The direction is the source address, the address is 1.1.1.1, the protocol type is tcp, and the port is 1 ipv4 tcp +Update the whitelist of object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1. .. code-block:: https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b { - "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", - "list_type" : 5, "direction" : 0, "address" : "1.1.1.1", "protocol" : 6, @@ -122,7 +121,7 @@ Example Responses **Status code: 200** -Blacklist/Whitelist update response +Response to the request for updating a blacklist or whitelist. .. code-block:: @@ -141,22 +140,27 @@ Bad Request { "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_msg" : "Object not found." } Status Codes ------------ -=========== =================================== -Status Code Description -=========== =================================== -200 Blacklist/Whitelist update response -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== =================================== ++-------------+----------------------------------------------------------------+ +| Status Code | Description | ++=============+================================================================+ +| 200 | Response to the request for updating a blacklist or whitelist. | ++-------------+----------------------------------------------------------------+ +| 400 | Bad Request | ++-------------+----------------------------------------------------------------+ +| 401 | Unauthorized | ++-------------+----------------------------------------------------------------+ +| 403 | Forbidden | ++-------------+----------------------------------------------------------------+ +| 404 | Not Found | ++-------------+----------------------------------------------------------------+ +| 500 | Internal Server Error | ++-------------+----------------------------------------------------------------+ Error Codes ----------- diff --git a/api-ref/source/api/capture_management/cancel_capture_task.rst b/api-ref/source/api/capture_management/cancel_capture_task.rst deleted file mode 100644 index b8c909c..0000000 --- a/api-ref/source/api/capture_management/cancel_capture_task.rst +++ /dev/null @@ -1,120 +0,0 @@ -:original_name: CancelCaptureTask.html - -.. _CancelCaptureTask: - -cancel capture task -=================== - -Function --------- - -cancel capture task - -URI ---- - -POST /v1/{project_id}/capture-task/stop - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - ========= ========= ====== ======================= - Parameter Mandatory Type Description - ========= ========= ====== ======================= - task_id No String cancel capture task dto - ========= ========= ====== ======================= - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - +-----------+---------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+==============================+ - | data | :ref:`IdObject ` object | cancel capture task response | - +-----------+---------------------------------------------------------------+------------------------------+ - -.. _cancelcapturetask__response_idobject: - -.. table:: **Table 6** IdObject - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== - -Example Requests ----------------- - -Stop the packet capture task with project ID 09bb24e6fe80d23d2fa2c010b53b418c and firewall ID ebf891cd-2163-48a0-9963-6309f99dd3c4 and task ID 1dcddab3-7d79-4a56-9e67-4aa0962b98ad. - -.. code-block:: - - https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/stop?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default - - { - "task_id" : "1dcddab3-7d79-4a56-9e67-4aa0962b98ad" - } - -Example Responses ------------------ - -**Status code: 200** - -cancle capture task response - -.. code-block:: - - { - "data" : { - "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", - "name" : "test" - } - } - -Status Codes ------------- - -=========== ============================ -Status Code Description -=========== ============================ -200 cancle capture task response -=========== ============================ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/capture_management/create_capture_task.rst b/api-ref/source/api/capture_management/create_capture_task.rst deleted file mode 100644 index d51ad0c..0000000 --- a/api-ref/source/api/capture_management/create_capture_task.rst +++ /dev/null @@ -1,178 +0,0 @@ -:original_name: CreateCaptureTask.html - -.. _CreateCaptureTask: - -Create capture task -=================== - -Function --------- - -Create capture task - -URI ---- - -POST /v1/{project_id}/capture-task - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - +-----------------+-----------------+----------------------------------------------------------------------------------------+--------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+========================================================================================+==========================+ - | destination | Yes | :ref:`CaptureRuleAddressDto ` object | capture rule address dto | - +-----------------+-----------------+----------------------------------------------------------------------------------------+--------------------------+ - | duration | Yes | Integer | capture duration | - +-----------------+-----------------+----------------------------------------------------------------------------------------+--------------------------+ - | max_packets | Yes | Integer | max packets | - | | | | | - | | | | Maximum: **1000000** | - +-----------------+-----------------+----------------------------------------------------------------------------------------+--------------------------+ - | name | Yes | String | capture name | - +-----------------+-----------------+----------------------------------------------------------------------------------------+--------------------------+ - | service | Yes | :ref:`CaptureServiceDto ` object | capture service dto | - +-----------------+-----------------+----------------------------------------------------------------------------------------+--------------------------+ - | source | Yes | :ref:`CaptureRuleAddressDto ` object | capture rule address dto | - +-----------------+-----------------+----------------------------------------------------------------------------------------+--------------------------+ - -.. _createcapturetask__request_captureservicedto: - -.. table:: **Table 5** CaptureServiceDto - - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+=========+==================================================================================================================================================================================================================+ - | dest_port | No | String | destination port | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | Yes | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | source port | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createcapturetask__request_captureruleaddressdto: - -.. table:: **Table 6** CaptureRuleAddressDto - - +--------------+-----------+---------+----------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+==========================================================+ - | address | Yes | String | address | - +--------------+-----------+---------+----------------------------------------------------------+ - | address_type | Yes | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6) | - +--------------+-----------+---------+----------------------------------------------------------+ - | type | Yes | Integer | input address type, manual means 0, only 0 is supported. | - +--------------+-----------+---------+----------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - +-----------+---------------------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+===================================+ - | data | :ref:`IdObject ` object | create capture task response info | - +-----------+---------------------------------------------------------------+-----------------------------------+ - -.. _createcapturetask__response_idobject: - -.. table:: **Table 8** IdObject - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== - -Example Requests ----------------- - -Add a packet capture task to the project ID 09bb24e6fe80d23d2fa2c010b53b418c and the firewall id ebf891cd-2163-48a0-9963-6309f99dd3c4 with the task name zhuabaotest, the maximum number of packet captures is 100,000, the packet capture duration is 3 minutes, the remaining retention days are 7 days, the source address protocol is tcp protocol, and the address type is IPv4. The address is 1.1.1.1, the port number is 1-65535, the destination address protocol is TCP, the address type is IPv4, the address is 2.2.2.2, and the port number is 1-65535. - -.. code-block:: - - https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default - - { - "name" : "zhuabaotest", - "max_packets" : 100000, - "duration" : 3, - "hold_day" : 7, - "source" : { - "type" : 0, - "address_type" : 0, - "address" : "1.1.1.1" - }, - "destination" : { - "type" : 0, - "address_type" : 0, - "address" : "2.2.2.2" - }, - "service" : { - "protocol" : -1, - "source_port" : "", - "dest_port" : "" - } - } - -Example Responses ------------------ - -**Status code: 200** - -Create capture task response - -.. code-block:: - - { - "data" : { - "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", - "name" : "test" - } - } - -Status Codes ------------- - -=========== ============================ -Status Code Description -=========== ============================ -200 Create capture task response -=========== ============================ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/capture_management/delete_capture_task.rst b/api-ref/source/api/capture_management/delete_capture_task.rst deleted file mode 100644 index a64cecb..0000000 --- a/api-ref/source/api/capture_management/delete_capture_task.rst +++ /dev/null @@ -1,120 +0,0 @@ -:original_name: DeleteCaptureTask.html - -.. _DeleteCaptureTask: - -Delete capture task -=================== - -Function --------- - -Delete capture task - -URI ---- - -POST /v1/{project_id}/capture-task/batch-delete - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - ========= ========= ================ ======================= - Parameter Mandatory Type Description - ========= ========= ================ ======================= - task_ids Yes Array of strings delete capture task dto - ========= ========= ================ ======================= - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - +-----------+---------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+==============================+ - | data | :ref:`IdObject ` object | delete capture task response | - +-----------+---------------------------------------------------------------+------------------------------+ - -.. _deletecapturetask__response_idobject: - -.. table:: **Table 6** IdObject - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== - -Example Requests ----------------- - -Delete the packet capture task from project ID 09bb24e6fe80d23d2fa2c010b53b418c and firewall id ebf891cd-2163-48a0-9963-6309f99dd3c4, and the packet capture task ID is 24e6bb6d-d335-48fd-b9c7-bbaaa851d209. - -.. code-block:: - - https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/batch-delete?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default - - { - "task_ids" : [ "24e6bb6d-d335-48fd-b9c7-bbaaa851d209" ] - } - -Example Responses ------------------ - -**Status code: 200** - -delete capture task response - -.. code-block:: - - { - "data" : { - "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", - "name" : "test" - } - } - -Status Codes ------------- - -=========== ============================ -Status Code Description -=========== ============================ -200 delete capture task response -=========== ============================ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/capture_management/index.rst b/api-ref/source/api/capture_management/index.rst deleted file mode 100644 index 6622323..0000000 --- a/api-ref/source/api/capture_management/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: topic_300000009.html - -.. _topic_300000009: - -Capture Management -================== - -- :ref:`list capture task ` -- :ref:`Create capture task ` -- :ref:`Delete capture task ` -- :ref:`list capture task result ` -- :ref:`cancel capture task ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - list_capture_task - create_capture_task - delete_capture_task - list_capture_task_result - cancel_capture_task diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_group.rst similarity index 73% rename from api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_group.rst index fb89cc6..45fce13 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_group.rst @@ -2,13 +2,13 @@ .. _AddDomainSet: -Add Domain Set -============== +Adding a Domain Name Group +========================== Function -------- -This API is used to add domain set. +This API is used to add a domain name group. URI --- @@ -17,61 +17,61 @@ POST /v1/{project_id}/domain-set .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+===================================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | Yes | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | domain set name | - +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | description | - +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_names | Yes | Array of :ref:`DomainSetInfoDto ` objects | domain names | - +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_type | Yes | Integer | Domain name group type. 0 means Application type and 1 means Network type. | - +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+===================================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | Domain name group name. | + +-----------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Domain name group description. | + +-----------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_names | Yes | Array of :ref:`DomainSetInfoDto ` objects | Domain name information list. | + +-----------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_type | No | Integer | Domain name group typ: **0** (application domain name group), **1** (network domain name group). | + +-----------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _adddomainset__request_domainsetinfodto: .. table:: **Table 5** DomainSetInfoDto - =========== ========= ====== ======================================= + =========== ========= ====== =========================================== Parameter Mandatory Type Description - =========== ========= ====== ======================================= - domain_name Yes String domain name, for example, www.test.com. - description No String description - =========== ========= ====== ======================================= + =========== ========= ====== =========================================== + domain_name Yes String Domain name, for example, **www.test.com**. + description No String Domain name description. + =========== ========= ====== =========================================== Response Parameters ------------------- @@ -80,27 +80,27 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------+------------------------------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+====================================================================================+==============================+ - | data | :ref:`DomainSetResponseData ` object | Add Domain Set Response Data | - +-----------+------------------------------------------------------------------------------------+------------------------------+ + +-----------+------------------------------------------------------------------------------------+-----------------------------------------------+ + | Parameter | Type | Description | + +===========+====================================================================================+===============================================+ + | data | :ref:`DomainSetResponseData ` object | Returned data for adding a domain name group. | + +-----------+------------------------------------------------------------------------------------+-----------------------------------------------+ .. _adddomainset__response_domainsetresponsedata: .. table:: **Table 7** DomainSetResponseData - ========= ====== =============== + ========= ====== ======================= Parameter Type Description - ========= ====== =============== - id String domain set id - name String domain set name - ========= ====== =============== + ========= ====== ======================= + id String Domain name group ID. + name String Domain name group name. + ========= ====== ======================= Example Requests ---------------- -Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2 and domain set type is application type. +Add an application domain name group whose name is **test**, domain name is **www.aaa.com**, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2 to the firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -123,7 +123,7 @@ Example Responses **Status code: 200** -Add Domain Set Response +Return value for adding a domain name group. .. code-block:: @@ -137,11 +137,11 @@ Add Domain Set Response Status Codes ------------ -=========== ======================= +=========== ============================================ Status Code Description -=========== ======================= -200 Add Domain Set Response -=========== ======================= +=========== ============================================ +200 Return value for adding a domain name group. +=========== ============================================ Error Codes ----------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_list.rst similarity index 71% rename from api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_list.rst index 0c29cfc..6bbd492 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/adding_a_domain_name_list.rst @@ -2,13 +2,13 @@ .. _AddDomains: -Add Domains -=========== +Adding a Domain Name List +========================= Function -------- -add domains +This API is used to add a domain name list. URI --- @@ -17,56 +17,57 @@ POST /v1/{project_id}/domain-set/domains/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ============= - Parameter Mandatory Type Description - ========== ========= ====== ============= - project_id Yes String Project ID - set_id Yes String Domain Set ID - ========== ========= ====== ============= + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+=============================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Domain name group ID, which can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +----------------+-----------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+=================================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +----------------+-----------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +----------------+-----------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_names | Yes | Array of :ref:`DomainSetInfoDto ` objects | domain names | - +----------------+-----------+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+=================================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the :ref:`API for querying a firewall instance `. | + +----------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +----------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_names | Yes | Array of :ref:`DomainSetInfoDto ` objects | Domain name list. | + +----------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _adddomains__request_domainsetinfodto: .. table:: **Table 5** DomainSetInfoDto - =========== ========= ====== ======================================= + =========== ========= ====== =========================================== Parameter Mandatory Type Description - =========== ========= ====== ======================================= - domain_name Yes String domain name, for example, www.test.com. - description No String description - =========== ========= ====== ======================================= + =========== ========= ====== =========================================== + domain_name Yes String Domain name, for example, **www.test.com**. + description No String Domain name description. + =========== ========= ====== =========================================== Response Parameters ------------------- @@ -75,27 +76,27 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------+----------------------------------------------------------------------------------+---------------------------+ - | Parameter | Type | Description | - +===========+==================================================================================+===========================+ - | data | :ref:`DomainSetResponseData ` object | add domains response data | - +-----------+----------------------------------------------------------------------------------+---------------------------+ + +-----------+----------------------------------------------------------------------------------+-------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================================+=====================================+ + | data | :ref:`DomainSetResponseData ` object | Return data of a domain name group. | + +-----------+----------------------------------------------------------------------------------+-------------------------------------+ .. _adddomains__response_domainsetresponsedata: .. table:: **Table 7** DomainSetResponseData - ========= ====== =============== + ========= ====== ======================= Parameter Type Description - ========= ====== =============== - id String domain set id - name String domain set name - ========= ====== =============== + ========= ====== ======================= + id String Domain name group ID. + name String Domain name group name. + ========= ====== ======================= Example Requests ---------------- -Add domain names to the domain set under the project where project id is 14181c1245cf4fd786824efe1e2b9388, the firewall instance id is 546af3f8-88e9-47f2-a205-2346d7090925, the protected object id is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, The domain set id is 78719348-6d79-477e-acec -676a29842ab2, and the domain names are www.bnm.com and www.vbc.com +Add domain names **www.bnm.com** and **www.vbc.com** to the domain name group of project 14181c1245cf4fd786824efe1e2b9388. The firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, and domain name group ID is 78719348-6d79-477e-acec-676a29842ab2. .. code-block:: @@ -118,7 +119,7 @@ Example Responses **Status code: 200** -add domains response +Return value for adding a domain names. .. code-block:: @@ -132,11 +133,11 @@ add domains response Status Codes ------------ -=========== ==================== +=========== ======================================= Status Code Description -=========== ==================== -200 add domains response -=========== ==================== +=========== ======================================= +200 Return value for adding a domain names. +=========== ======================================= Error Codes ----------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_group.rst similarity index 54% rename from api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_group.rst index b48598d..4c7bb6b 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_group.rst @@ -2,13 +2,13 @@ .. _DeleteDomainSet: -Delete Domain Set -================= +Deleting a Domain Name Group +============================ Function -------- -This API is used to delete domain set. +This API is used to delete a domain name group. URI --- @@ -17,33 +17,34 @@ DELETE /v1/{project_id}/domain-set/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - set_id Yes String set id - ========== ========= ====== =========== + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+=============================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Domain name group ID, which can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -52,27 +53,27 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+---------------------------------------------------------------------------------------+----------------------------+ - | Parameter | Type | Description | - +===========+=======================================================================================+============================+ - | data | :ref:`DomainSetResponseData ` object | delete domain set response | - +-----------+---------------------------------------------------------------------------------------+----------------------------+ + +-----------+---------------------------------------------------------------------------------------+-------------------------------------------------+ + | Parameter | Type | Description | + +===========+=======================================================================================+=================================================+ + | data | :ref:`DomainSetResponseData ` object | Returned data for deleting a domain name group. | + +-----------+---------------------------------------------------------------------------------------+-------------------------------------------------+ .. _deletedomainset__response_domainsetresponsedata: .. table:: **Table 5** DomainSetResponseData - ========= ====== =============== + ========= ====== ======================= Parameter Type Description - ========= ====== =============== - id String domain set id - name String domain set name - ========= ====== =============== + ========= ====== ======================= + id String Domain name group ID. + name String Domain name group name. + ========= ====== ======================= Example Requests ---------------- -Delete domain set 89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a from firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429. +Delete domain name group 89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a from firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -83,7 +84,7 @@ Example Responses **Status code: 200** -Delete Domain Set Response +Return value for deleting a domain name group. .. code-block:: @@ -97,11 +98,11 @@ Delete Domain Set Response Status Codes ------------ -=========== ========================== +=========== ============================================== Status Code Description -=========== ========================== -200 Delete Domain Set Response -=========== ========================== +=========== ============================================== +200 Return value for deleting a domain name group. +=========== ============================================== Error Codes ----------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_list.rst similarity index 53% rename from api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_list.rst index 13082a8..6f472c6 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/deleting_a_domain_name_list.rst @@ -1,135 +1,123 @@ -:original_name: ListDnsServers.html +:original_name: DeleteDomains.html -.. _ListDnsServers: +.. _DeleteDomains: -Querying the DNS Server List -============================ +Deleting a Domain Name List +=========================== Function -------- -This API is used to query the DNS server list. +This API is used to delete a domain name list. URI --- -GET /v1/{project_id}/dns/servers +DELETE /v1/{project_id}/domain-set/domains/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+=============================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Domain name group ID, which can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | limit | No | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +--------------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +====================+===========+==================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +--------------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_address_ids | Yes | Array of strings | Domain name ID list. Domain name IDs can be obtained by calling the :ref:`API for querying the domain name list under a domain name group `. Find the value in **data.records.domain_address_id** (The period [.] is used to separate different levels of objects). | + +--------------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- **Status code: 200** -.. table:: **Table 4** Response body parameters +.. table:: **Table 5** Response body parameters - +-----------+------------------------------------------------------------------------------------------------+------------------+ - | Parameter | Type | Description | - +===========+================================================================================================+==================+ - | data | Array of :ref:`DnsServersResponseDTO ` objects | dns server list | - +-----------+------------------------------------------------------------------------------------------------+------------------+ - | total | Integer | dns server total | - +-----------+------------------------------------------------------------------------------------------------+------------------+ + +-----------+-------------------------------------------------------------------------------------+------------------------------------------------+ + | Parameter | Type | Description | + +===========+=====================================================================================+================================================+ + | data | :ref:`DomainSetResponseData ` object | Returned data for deleting a domain name list. | + +-----------+-------------------------------------------------------------------------------------+------------------------------------------------+ -.. _listdnsservers__response_dnsserversresponsedto: +.. _deletedomains__response_domainsetresponsedata: -.. table:: **Table 5** DnsServersResponseDTO +.. table:: **Table 6** DomainSetResponseData - +--------------------------+---------+-----------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+=================================================================+ - | id | Integer | dns server id | - +--------------------------+---------+-----------------------------------------------------------------+ - | is_applied | Integer | Indicates whether to apply. 0: no; 1: yes | - +--------------------------+---------+-----------------------------------------------------------------+ - | is_customized | Integer | Indicates whether the DNS server is user-defined. 0: no; 1: yes | - +--------------------------+---------+-----------------------------------------------------------------+ - | server_ip | String | DNS server IP address | - +--------------------------+---------+-----------------------------------------------------------------+ - | health_check_domain_name | String | health check domain name | - +--------------------------+---------+-----------------------------------------------------------------+ + ========= ====== ======================= + Parameter Type Description + ========= ====== ======================= + id String Domain name group ID. + name String Domain name group name. + ========= ====== ======================= Example Requests ---------------- -Obtain the DNS server list of the project whose ID is 2349ba469daf4b7daf268bb0261d18b0. +In project 14181c1245cf4fd786824efe1e2b9388, delete domain names from domain name group 78719348-6d79-477e-acec-676a29842ab2. The firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, the protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, the domain name group ID is 78719348-6d79-477e-acec-676a29842ab2, and the domain list is "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95". .. code-block:: - https://console.example.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers + https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default + + { + "domain_address_ids" : [ "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95" ], + "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b" + } Example Responses ----------------- **Status code: 200** -Response to the request for obtaining DNS servers +Return value for deleting a domain name list. .. code-block:: { "data" : { - "data" : [ { - "health_check_domain_name" : "sslstatic.xiaoyusan.com", - "id" : 20165, - "is_applied" : 0, - "is_customized" : 1, - "server_ip" : "0.0.0.0" - }, { - "health_check_domain_name" : "sslstatic.xiaoyusan.com", - "id" : 14190, - "is_applied" : 1, - "is_customized" : 0, - "server_ip" : "100.79.1.240" - } ] - }, - "total" : 2 + "id" : "78719348-6d79-477e-acec-676a29842ab2", + "name" : "test26" + } } Status Codes ------------ -=========== ================================================= +=========== ============================================= Status Code Description -=========== ================================================= -200 Response to the request for obtaining DNS servers -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ================================================= +=========== ============================================= +200 Return value for deleting a domain name list. +=========== ============================================= Error Codes ----------- diff --git a/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/index.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/index.rst new file mode 100644 index 0000000..86f83ed --- /dev/null +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/index.rst @@ -0,0 +1,32 @@ +:original_name: topic_300000006.html + +.. _topic_300000006: + +Domain Name Resolution and Domain Name Group Management +======================================================= + +- :ref:`Adding a Domain Name Group ` +- :ref:`Deleting a Domain Name Group ` +- :ref:`Updating a Domain Name Group ` +- :ref:`Updating the DNS Server List ` +- :ref:`Querying the Domain Name Group List ` +- :ref:`Querying the DNS Server List ` +- :ref:`Querying an IP Address for Domain Name Resolution ` +- :ref:`Obtaining the Domain Name List in a Domain Name Group ` +- :ref:`Adding a Domain Name List ` +- :ref:`Deleting a Domain Name List ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + adding_a_domain_name_group + deleting_a_domain_name_group + updating_a_domain_name_group + updating_the_dns_server_list + querying_the_domain_name_group_list + querying_the_dns_server_list + querying_an_ip_address_for_domain_name_resolution + obtaining_the_domain_name_list_in_a_domain_name_group + adding_a_domain_name_list + deleting_a_domain_name_list diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/obtaining_the_domain_name_list_in_a_domain_name_group.rst similarity index 70% rename from api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/obtaining_the_domain_name_list_in_a_domain_name_group.rst index 8317178..12bded9 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/obtaining_the_domain_name_list_in_a_domain_name_group.rst @@ -2,56 +2,57 @@ .. _ListDomains: -List Domains -============ +Obtaining the Domain Name List in a Domain Name Group +===================================================== Function -------- -list domains +This API is used to obtain the list of domain names in a domain name group. URI --- -GET /v1/{project_id}/domain-set/domains/{set_id} +GET /v1/{project_id}/domain-set/domains/{domain_set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ============= - Parameter Mandatory Type Description - ========== ========= ====== ============= - project_id Yes String Project ID - set_id Yes String domain set id - ========== ========= ====== ============= + +---------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+========+=============================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +---------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_id | Yes | String | Domain name group ID, which can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_name | No | String | domain name | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_Id | No | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_name | No | String | Domain name, for example, **www.test.com**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_Id | No | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -60,11 +61,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-------------------------------------------------------------------------------------+---------------------------+ - | Parameter | Type | Description | - +===========+=====================================================================================+===========================+ - | data | :ref:`ListDomainResponseData ` object | list domain response data | - +-----------+-------------------------------------------------------------------------------------+---------------------------+ + +-----------+-------------------------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +===========+=====================================================================================+==================================================+ + | data | :ref:`ListDomainResponseData ` object | Returned data for querying the domain name list. | + +-----------+-------------------------------------------------------------------------------------+--------------------------------------------------+ .. _listdomains__response_listdomainresponsedata: @@ -73,36 +74,35 @@ Response Parameters +------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +============+=======================================================================+=================================================================================================================================================+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | + | project_id | String | Project ID. | +------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`DomainInfo ` objects | domain info list | + | records | Array of :ref:`DomainInfo ` objects | Domain name information list. | +------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | String | domain set id | + | set_id | String | Domain name group ID. | +------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | total | + | total | Integer | Total number of domain names. | +------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listdomains__response_domaininfo: .. table:: **Table 6** DomainInfo - ================= ================ ================= - Parameter Type Description - ================= ================ ================= - domain_address_id String domain address id - domain_name String domain name - description String description - dns_ips Array of strings dns ips - ================= ================ ================= + ================= ====== =========================================== + Parameter Type Description + ================= ====== =========================================== + domain_address_id String Domain name ID. + domain_name String Domain name, for example, **www.test.com**. + description String Domain name description. + ================= ====== =========================================== Example Requests ---------------- -Query the list of domain names under project id 14181c1245cf4fd786824efe1e2b9388, domain set id 78719348-6d79-477e-acec-676a29842ab2, and the firewall instance id 546af3f8-88e9-47f2-a205-2346d7090925. +Query the domain name list of project 14181c1245cf4fd786824efe1e2b9388. The domain name group ID is 78719348-6d79-477e-acec-676a29842ab2, and the firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925. .. code-block:: @@ -113,7 +113,7 @@ Example Responses **Status code: 200** -list domain response +Return value for querying the domain name list. .. code-block:: @@ -135,11 +135,11 @@ list domain response Status Codes ------------ -=========== ==================== +=========== =============================================== Status Code Description -=========== ==================== -200 list domain response -=========== ==================== +=========== =============================================== +200 Return value for querying the domain name list. +=========== =============================================== Error Codes ----------- diff --git a/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_an_ip_address_for_domain_name_resolution.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_an_ip_address_for_domain_name_resolution.rst new file mode 100644 index 0000000..49285ab --- /dev/null +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_an_ip_address_for_domain_name_resolution.rst @@ -0,0 +1,125 @@ +:original_name: ListDomainParseDetail.html + +.. _ListDomainParseDetail: + +Querying an IP Address for Domain Name Resolution +================================================= + +Function +-------- + +This API is used to check the validity of a domain name. + +URI +--- + +GET /v1/{project_id}/domain/parse/{domain_name} + +.. table:: **Table 1** Path Parameters + + +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | domain_name | Yes | String | Domain name, for example, **www.test.com**. | + +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + ========= ================ =========================================== + Parameter Type Description + ========= ================ =========================================== + data Array of strings IP address list for domain name resolution. + ========= ================ =========================================== + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +Check whether the domain name **ceshi.com** of project 5c69cf330cda42369cbd726ee1bc5e76 is valid. + +.. code-block:: + + https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/domain/parse/ceshi.com + +Example Responses +----------------- + +**Status code: 200** + +Return value for querying domain name validity. + +.. code-block:: + + { + "data" : [ "192.168.88.85", "192.168.88.50", "192.168.88.22", "192.168.88.87", "192.168.88.86", "192.168.5.1", "192.168.88.88", "192.168.88.90", "192.168.88.83", "192.168.88.84" ] + } + +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.00109004", + "error_msg" : "HTTP request error." + } + +Status Codes +------------ + +=========== =============================================== +Status Code Description +=========== =============================================== +200 Return value for querying domain name validity. +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== =============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_the_dns_server_list.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_the_dns_server_list.rst new file mode 100644 index 0000000..73249e0 --- /dev/null +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_the_dns_server_list.rst @@ -0,0 +1,135 @@ +:original_name: ListDnsServers.html + +.. _ListDnsServers: + +Querying the DNS Server List +============================ + +Function +-------- + +This API is used to query the DNS server list. + +URI +--- + +GET /v1/{project_id}/dns/servers + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | limit | No | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+------------------------------------------------------------------------------------------------+------------------------------+ + | Parameter | Type | Description | + +===========+================================================================================================+==============================+ + | data | Array of :ref:`DnsServersResponseDTO ` objects | DNS server list. | + +-----------+------------------------------------------------------------------------------------------------+------------------------------+ + | total | Integer | Total number of DNS servers. | + +-----------+------------------------------------------------------------------------------------------------+------------------------------+ + +.. _listdnsservers__response_dnsserversresponsedto: + +.. table:: **Table 5** DnsServersResponseDTO + + +--------------------------+---------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+==================================================================+ + | id | Integer | Domain name server ID. | + +--------------------------+---------+------------------------------------------------------------------+ + | is_applied | Integer | Whether the DNS server is applied: **0** (no), **1** (yes). | + +--------------------------+---------+------------------------------------------------------------------+ + | is_customized | Integer | Whether the DNS server is user-defined: **0** (no), **1** (yes). | + +--------------------------+---------+------------------------------------------------------------------+ + | server_ip | String | DNS server IP address. | + +--------------------------+---------+------------------------------------------------------------------+ + | health_check_domain_name | String | Health check domain name. | + +--------------------------+---------+------------------------------------------------------------------+ + +Example Requests +---------------- + +Obtain the DNS server list of project 2349ba469daf4b7daf268bb0261d18b0. + +.. code-block:: + + https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers?fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e + +Example Responses +----------------- + +**Status code: 200** + +Response to the request for obtaining DNS servers. + +.. code-block:: + + { + "data" : [ { + "health_check_domain_name" : "sslstatic.xiaoyusan.com", + "id" : 20165, + "is_applied" : 0, + "is_customized" : 1, + "server_ip" : "0.0.0.0" + }, { + "health_check_domain_name" : "sslstatic.xiaoyusan.com", + "id" : 14190, + "is_applied" : 1, + "is_customized" : 0, + "server_ip" : "100.79.1.240" + } ], + "total" : 2 + } + +Status Codes +------------ + +=========== ================================================== +Status Code Description +=========== ================================================== +200 Response to the request for obtaining DNS servers. +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_the_domain_name_group_list.rst similarity index 71% rename from api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_the_domain_name_group_list.rst index 76675ef..5997463 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/querying_the_domain_name_group_list.rst @@ -2,13 +2,13 @@ .. _ListDomainSets: -List Domain Sets -================ +Querying the Domain Name Group List +=================================== Function -------- -list domain sets +This API is used to query the domain name group list. URI --- @@ -17,44 +17,44 @@ GET /v1/{project_id}/domain-sets .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | Yes | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | key | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_type | No | Integer | Domain name group type. 0 means Application type and 1 means Network type. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_status | No | Integer | config status | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Keyword, which can be the domain name group name or description. | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_type | No | Integer | Domain name group typ: **0** (application domain name group), **1** (network domain name group). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config_status | No | Integer | Configuration status: **-1** (unconfigured), **0** (configuration failed), **1** (configuration succeeded), **2** (configuring), **3** (normal), or **4** (abnormal). | + +-----------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -63,11 +63,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+------------------------------------------------------------------------------------------------+--------------------------+ - | Parameter | Type | Description | - +===========+================================================================================================+==========================+ - | data | :ref:`ListDomainsetsResponseData ` object | list domain set response | - +-----------+------------------------------------------------------------------------------------------------+--------------------------+ + +-----------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+ + | Parameter | Type | Description | + +===========+================================================================================================+========================================================+ + | data | :ref:`ListDomainsetsResponseData ` object | Returned data for querying the domain name group list. | + +-----------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+ .. _listdomainsets__response_listdomainsetsresponsedata: @@ -76,36 +76,36 @@ Response Parameters +-----------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +===========+============================================================================+=================================================================================================================================================+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +-----------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +-----------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | total | + | total | Integer | Total number of domain name groups. | +-----------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`DomainSetVo ` objects | domain set list | + | records | Array of :ref:`DomainSetVo ` objects | Domain name group list. | +-----------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listdomainsets__response_domainsetvo: .. table:: **Table 6** DomainSetVo - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========================================================================+===============================================================================+ - | set_id | String | set id | - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | name | String | domain set name | - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | description | String | description | - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | ref_count | Integer | Number of times referenced by protection rules | - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | domain_set_type | Integer | Domain name group type. 0 means Application type and 1 means Network type. | - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | config_status | Integer | config status, 0(config failed), 1(config success), 2(configuring), 3(normal) | - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | rules | Array of :ref:`UseRuleVO ` objects | used rule list | - +-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========================================================================+=======================================================================================================================================================================+ + | set_id | String | Domain name group ID. | + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Domain name group name. | + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Domain name group description. | + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ref_count | Integer | Number of times a domain name group is referenced by rules. | + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_type | Integer | Domain name group typ: **0** (application domain name group), **1** (network domain name group). | + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config_status | Integer | Configuration status: **-1** (unconfigured), **0** (configuration failed), **1** (configuration succeeded), **2** (configuring), **3** (normal), or **4** (abnormal). | + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rules | Array of :ref:`UseRuleVO ` objects | Used rule ID list. | + +-----------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listdomainsets__response_userulevo: @@ -114,14 +114,14 @@ Response Parameters ========= ====== =========== Parameter Type Description ========= ====== =========== - id String rule id - name String rule name + id String Rule ID. + name String Rule name. ========= ====== =========== Example Requests ---------------- -Query the domain set list of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429. The protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b. +Query the domain name group list of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429. The protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b. .. code-block:: @@ -132,7 +132,7 @@ Example Responses **Status code: 200** -List Domain Set Response +Return value for querying the domain name group list. .. code-block:: @@ -155,11 +155,11 @@ List Domain Set Response Status Codes ------------ -=========== ======================== +=========== ===================================================== Status Code Description -=========== ======================== -200 List Domain Set Response -=========== ======================== +=========== ===================================================== +200 Return value for querying the domain name group list. +=========== ===================================================== Error Codes ----------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/updating_a_domain_name_group.rst similarity index 53% rename from api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/updating_a_domain_name_group.rst index 1ab4f1b..2a295ab 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/updating_a_domain_name_group.rst @@ -2,13 +2,13 @@ .. _UpdateDomainSet: -Update Domain Set -================= +Updating a Domain Name Group +============================ Function -------- -This API is used to update domain set. +This API is used to update a domain name group. URI --- @@ -17,42 +17,43 @@ PUT /v1/{project_id}/domain-set/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ============= - Parameter Mandatory Type Description - ========== ========= ====== ============= - project_id Yes String project ID - set_id Yes String domain set id - ========== ========= ====== ============= + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+=============================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Domain name group ID, which can be obtained by calling the :ref:`API for querying the domain name group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the :ref:`API for querying a firewall instance `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - =========== ========= ====== =========== + =========== ========= ====== ============================== Parameter Mandatory Type Description - =========== ========= ====== =========== - name Yes String name - description No String description - =========== ========= ====== =========== + =========== ========= ====== ============================== + name Yes String Domain name group name. + description No String Domain name group description. + =========== ========= ====== ============================== Response Parameters ------------------- @@ -61,27 +62,27 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+---------------------------------------------------------------------------------------+----------------------------+ - | Parameter | Type | Description | - +===========+=======================================================================================+============================+ - | data | :ref:`DomainSetResponseData ` object | update domain set response | - +-----------+---------------------------------------------------------------------------------------+----------------------------+ + +-----------+---------------------------------------------------------------------------------------+----------------------------------------------------+ + | Parameter | Type | Description | + +===========+=======================================================================================+====================================================+ + | data | :ref:`DomainSetResponseData ` object | Returned data of for updating a domain name group. | + +-----------+---------------------------------------------------------------------------------------+----------------------------------------------------+ .. _updatedomainset__response_domainsetresponsedata: .. table:: **Table 6** DomainSetResponseData - ========= ====== =============== + ========= ====== ======================= Parameter Type Description - ========= ====== =============== - id String domain set id - name String domain set name - ========= ====== =============== + ========= ====== ======================= + id String Domain name group ID. + name String Domain name group name. + ========= ====== ======================= Example Requests ---------------- -For the firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in the project 9d80d070b6d44942af73c9c3d38e0429, change the domain set ID to 94da194d-24b2-4f60-919e-cf0bc76c75b3, the domain name to www.aaa.com, and name to test. +Change the name of the domain name group 94da194d-24b2-4f60-919e-cf0bc76c75b3 of firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429 to **test**. .. code-block:: @@ -97,7 +98,7 @@ Example Responses **Status code: 200** -Update Domain Set Response +Return value for updating a domain name group. .. code-block:: @@ -111,11 +112,11 @@ Update Domain Set Response Status Codes ------------ -=========== ========================== +=========== ============================================== Status Code Description -=========== ========================== -200 Update Domain Set Response -=========== ========================== +=========== ============================================== +200 Return value for updating a domain name group. +=========== ============================================== Error Codes ----------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/updating_the_dns_server_list.rst similarity index 70% rename from api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst rename to api-ref/source/api/domain_name_resolution_and_domain_name_group_management/updating_the_dns_server_list.rst index f592f99..c75e250 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst +++ b/api-ref/source/api/domain_name_resolution_and_domain_name_group_management/updating_the_dns_server_list.rst @@ -17,56 +17,56 @@ PUT /v1/{project_id}/dns/servers .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +--------------------------+-----------+---------------------------------------------------------------------------+--------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+===========+===========================================================================+==========================+ - | dns_server | Yes | Array of :ref:`dns_server ` objects | DNS server | - +--------------------------+-----------+---------------------------------------------------------------------------+--------------------------+ - | health_check_domain_name | No | String | Health check domain name | - +--------------------------+-----------+---------------------------------------------------------------------------+--------------------------+ + +--------------------------+-----------+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+===========+===========================================================================+====================================================================================================================================================================================================================================================+ + | dns_server | Yes | Array of :ref:`dns_server ` objects | DNS server list. | + +--------------------------+-----------+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | health_check_domain_name | No | String | Health check domain name, which can be obtained by calling the :ref:`API for querying the DNS server list `. Find the value in **data.health_check_domain_name** (The period [.] is used to separate different levels of objects). | + +--------------------------+-----------+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updatednsservers__request_dns_server: .. table:: **Table 5** dns_server - +---------------+-----------+---------+-----------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+=========+=================================================================+ - | server_ip | No | String | DNS server IP address | - +---------------+-----------+---------+-----------------------------------------------------------------+ - | is_customized | No | Integer | Indicates whether the DNS server is user-defined. 0: no; 1: yes | - +---------------+-----------+---------+-----------------------------------------------------------------+ - | is_applied | No | Integer | Indicates whether to apply. 0: no; 1: yes | - +---------------+-----------+---------+-----------------------------------------------------------------+ + +---------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+=========+==================================================================================================================================================================================================================================+ + | server_ip | Yes | String | DNS server IP address, which can be obtained by calling the :ref:`API for querying the DNS server list `. Find the value in **data.server_ip** (The period [.] is used to separate different levels of objects). | + +---------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_customized | Yes | Integer | Whether the DNS server is user-defined: **0** (no), **1** (yes). | + +---------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_applied | Yes | Integer | Whether to apply: **0** (no), **1** (yes). | + +---------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -75,31 +75,31 @@ Response Parameters .. table:: **Table 6** Response body parameters - ========= ================ ======================= + ========= ================ ================ Parameter Type Description - ========= ================ ======================= - data Array of strings Domain name server list - ========= ================ ======================= + ========= ================ ================ + data Array of strings DNS server list. + ========= ================ ================ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Set server 8.8.8.8 to the default server and put it in use. Set server IP address 192.168.0.2 to a user-defined server and do not put it in use. +Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Put the default server 8.8.8.8 in use. Stop using the non-default server 192.168.0.2. .. code-block:: - https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers + https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers?fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e { "dns_server" : [ { @@ -118,7 +118,7 @@ Example Responses **Status code: 200** -Response to the request for updating the DNS server list +Response to the request for updating the DNS server list. .. code-block:: @@ -134,22 +134,22 @@ Bad Request { "error_code" : "CFW.01000001", - "error_msg" : "Duplicate DNS server IP address" + "error_msg" : "Duplicate DNS server IP addresses." } Status Codes ------------ -=========== ======================================================== +=========== ========================================================= Status Code Description -=========== ======================================================== -200 Response to the request for updating the DNS server list +=========== ========================================================= +200 Response to the request for updating the DNS server list. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ======================================================== +=========== ========================================================= Error Codes ----------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst b/api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst deleted file mode 100644 index d67992f..0000000 --- a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst +++ /dev/null @@ -1,122 +0,0 @@ -:original_name: DeleteDomains.html - -.. _DeleteDomains: - -Delete Domains -============== - -Function --------- - -delete domains - -URI ---- - -DELETE /v1/{project_id}/domain-set/domains/{set_id} - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== ============= - Parameter Mandatory Type Description - ========== ========= ====== ============= - project_id Yes String Project ID - set_id Yes String Domain Set ID - ========== ========= ====== ============= - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+==========================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - +--------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+===========+==================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +--------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_address_ids | Yes | Array of strings | domain address ids | - +--------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - +-----------+-------------------------------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+=====================================================================================+==============================+ - | data | :ref:`DomainSetResponseData ` object | delete domains response data | - +-----------+-------------------------------------------------------------------------------------+------------------------------+ - -.. _deletedomains__response_domainsetresponsedata: - -.. table:: **Table 6** DomainSetResponseData - - ========= ====== =============== - Parameter Type Description - ========= ====== =============== - id String domain set id - name String domain set name - ========= ====== =============== - -Example Requests ----------------- - -For the project whose project id is 14181c1245cf4fd786824efe1e2b9388, delete the domain names under the firewall whose firewall id is 546af3f8-88e9-47f2-a205-2346d7090925, the protected object id is ae42418e-f077-41a0-9d3b-5b2f5ad910 2b, the domain set id is 78719348-6d79- 477e-acec-676a29842ab2, and the domain names are "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95". - -.. code-block:: - - https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default - - { - "domain_address_ids" : [ "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95" ], - "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b" - } - -Example Responses ------------------ - -**Status code: 200** - -delete domains response - -.. code-block:: - - { - "data" : { - "id" : "78719348-6d79-477e-acec-676a29842ab2", - "name" : "test26" - } - } - -Status Codes ------------- - -=========== ======================= -Status Code Description -=========== ======================= -200 delete domains response -=========== ======================= - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/index.rst b/api-ref/source/api/domain_parse_and_domain_set_management/index.rst deleted file mode 100644 index e3580a6..0000000 --- a/api-ref/source/api/domain_parse_and_domain_set_management/index.rst +++ /dev/null @@ -1,32 +0,0 @@ -:original_name: topic_300000006.html - -.. _topic_300000006: - -Domain Parse and Domain Set Management -====================================== - -- :ref:`Add Domain Set ` -- :ref:`Delete Domain Set ` -- :ref:`Update Domain Set ` -- :ref:`List Domain Sets ` -- :ref:`List Domains ` -- :ref:`Add Domains ` -- :ref:`Delete Domains ` -- :ref:`Querying the DNS Server List ` -- :ref:`Updating the DNS Server List ` -- :ref:`Querying the IP Address for Domain Name Resolution ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - add_domain_set - delete_domain_set - update_domain_set - list_domain_sets - list_domains - add_domains - delete_domains - querying_the_dns_server_list - updating_the_dns_server_list - querying_the_ip_address_for_domain_name_resolution diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst deleted file mode 100644 index 4ecf3b0..0000000 --- a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst +++ /dev/null @@ -1,124 +0,0 @@ -:original_name: ListDomainParseDetail.html - -.. _ListDomainParseDetail: - -Querying the IP Address for Domain Name Resolution -================================================== - -Function --------- - -This API is used to test the validity of a domain name. - -URI ---- - -GET /v1/{project_id}/domain/parse/{domain_name} - -.. table:: **Table 1** Path Parameters - - =========== ========= ====== =========== - Parameter Mandatory Type Description - =========== ========= ====== =========== - project_id Yes String Project ID - domain_name Yes String Domain name - =========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+------------------+------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+==============================================================================================================================+ - | data | Array of strings | Domain name ID list, The resolution result of the domain is returned. If the result is empty, the domain cannot be resolved. | - +-----------+------------------+------------------------------------------------------------------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 5** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -Check whether the ceshi.com domain name in the project whose ID is 5c69cf330cda42369cbd726ee1bc5e76 is valid. - -.. code-block:: - - https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/domain/parse/ceshi.com - -Example Responses ------------------ - -**Status code: 200** - -Return value of a domain name validity query - -.. code-block:: - - { - "data" : [ "192.168.88.85", "192.168.88.50", "192.168.88.22", "192.168.88.87", "192.168.88.86", "192.168.5.1", "192.168.88.88", "192.168.88.90", "192.168.88.83", "192.168.88.84" ] - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.00109004", - "error_msg" : "http to external service error" - } - -Status Codes ------------- - -=========== ============================================ -Status Code Description -=========== ============================================ -200 Return value of a domain name validity query -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ============================================ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst b/api-ref/source/api/eip_management/enabling_or_disabling_eip_protection.rst similarity index 59% rename from api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst rename to api-ref/source/api/eip_management/enabling_or_disabling_eip_protection.rst index 96c180b..bf9c9e7 100644 --- a/api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst +++ b/api-ref/source/api/eip_management/enabling_or_disabling_eip_protection.rst @@ -2,13 +2,13 @@ .. _ChangeEipStatus: -Enabling or Disabling an EIP -============================ +Enabling or Disabling EIP Protection +==================================== Function -------- -Enable and disable EIPs, you need to use ListEips to synchronize EIP assets and set the sync field to 1 before enabling EIP protection for the first time after purchasing an EIP. +This API is used to enable or disable EIP protection. After a customer purchases an EIP, the customer needs to call ListEips to synchronize EIPs asset before enabling EIP protection for the first time. The **sync** field should be set to **1**. URI --- @@ -17,80 +17,58 @@ POST /v1/{project_id}/eip/protect .. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+-----------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=================+ - | project_id | Yes | String | Project ID | - | | | | | - | | | | Minimum: **32** | - | | | | | - | | | | Maximum: **32** | - +-----------------+-----------------+-----------------+-----------------+ + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------+-----------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+======================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - | | | | | - | | | | Minimum: **36** | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Yes | Integer | EIP Status,0:protected,1:unprotected | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **1** | - +-----------------+-----------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_infos | Yes | Array of :ref:`ip_infos ` objects | EIP information list | - | | | | | - | | | | Array Length: **0 - 50** | - +-----------------+-----------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+======================================================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Yes | Integer | Status that an EIP will be changed to: **0** (protected), **1** (unprotected). | + +-----------+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_infos | Yes | Array of :ref:`ip_infos ` objects | List of EIPs whose protection status is changed. | + +-----------+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _changeeipstatus__request_ip_infos: .. table:: **Table 5** ip_infos - +-----------------+-----------------+-----------------+------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================+ - | id | No | String | EIP data ID | - | | | | | - | | | | Minimum: **36** | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+-----------------+------------------+ - | public_ip | No | String | EIP | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **255** | - +-----------------+-----------------+-----------------+------------------+ - | public_ipv6 | No | String | EIP IPv6 | - +-----------------+-----------------+-----------------+------------------+ + +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+========================================================================================================================================================================================================+ + | id | No | String | EIP ID, which can be obtained by calling the API for querying the EIP list. Find the value in **data.records.id** (The period [.] is used to separate different levels of objects). | + +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip | No | String | EIP IPv4 address, which can be obtained by calling the API for querying the EIP list. Find the value in **data.records.public_ip** (The period [.] is used to separate different levels of objects). | + +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ipv6 | No | String | EIP IPv6 address, which can be obtained by calling the API for querying the EIP list. Find the value in **data.records.public_ipv6** (The period [.] is used to separate different levels of objects). | + +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -99,41 +77,54 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------+-------------------------------------------------------------------------------+----------------------+ - | Parameter | Type | Description | - +===========+===============================================================================+======================+ - | data | :ref:`EIPSwitchStatusVO ` object | Eip Switch Status Vo | - +-----------+-------------------------------------------------------------------------------+----------------------+ + +-----------+-------------------------------------------------------------------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================================+=======================================================+ + | data | :ref:`EIPSwitchStatusVO ` object | Data returned for changing the EIP protection status. | + +-----------+-------------------------------------------------------------------------------+-------------------------------------------------------+ .. _changeeipstatus__response_eipswitchstatusvo: .. table:: **Table 7** EIPSwitchStatusVO - +------------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+==================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +------------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fail_eip_id_list | Array of strings | failed eip id list | - +------------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | firewall instance id | - +------------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=================================================================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fail_eip_id_list | Array of strings | List of EIP protection statuses that fail to be modified. The status can be **successful** or **fail**. | + +------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fail_eip_list | Array of :ref:`FailedEipInfo ` objects | List of failures to modify the EIP protection status. | + +------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _changeeipstatus__response_failedeipinfo: + +.. table:: **Table 8** FailedEipInfo + + ============= ====== ============================================== + Parameter Type Description + ============= ====== ============================================== + id String ID of an EIP whose status fails to be changed. + error_message String Error code of a status change failure. + ============= ====== ============================================== **Status code: 400** -.. table:: **Table 8** Response body parameters +.. table:: **Table 9** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -- Enable EIP (100.85.121.62) traffic protection. +- Enable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62. .. code-block:: @@ -148,7 +139,7 @@ Example Requests } ] } -- Disable EIP (100.85.121.62) traffic protection. +- Disable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62. .. code-block:: @@ -168,31 +159,31 @@ Example Responses **Status code: 200** -Return value for enabling or disabling EIP protection +Return value for enabling or disabling EIP protection. .. code-block:: { - "data" : { - "fail_eip_id_list" : [ ], - "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", - "id" : "b0a2dacc-3886-4805-838e-281653d3cd1f" + "data": { + "fail_eip_id_list": [], + "fail_eip_list": [], + "object_id": "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", + "id": "b0a2dacc-3886-4805-838e-281653d3cd1f" } - } Status Codes ------------ -=========== ===================================================== +=========== ====================================================== Status Code Description -=========== ===================================================== -200 Return value for enabling or disabling EIP protection +=========== ====================================================== +200 Return value for enabling or disabling EIP protection. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================================================== +=========== ====================================================== Error Codes ----------- diff --git a/api-ref/source/api/eip_management/index.rst b/api-ref/source/api/eip_management/index.rst index f9b6d0f..3813e9c 100644 --- a/api-ref/source/api/eip_management/index.rst +++ b/api-ref/source/api/eip_management/index.rst @@ -5,14 +5,14 @@ EIP Management ============== +- :ref:`Enabling or Disabling EIP Protection ` - :ref:`Querying the Number of EIPs ` -- :ref:`Enabling or Disabling an EIP ` - :ref:`Querying the EIP List ` .. toctree:: :maxdepth: 1 :hidden: + enabling_or_disabling_eip_protection querying_the_number_of_eips - enabling_or_disabling_an_eip querying_the_eip_list diff --git a/api-ref/source/api/eip_management/querying_the_eip_list.rst b/api-ref/source/api/eip_management/querying_the_eip_list.rst index c848516..20af70d 100644 --- a/api-ref/source/api/eip_management/querying_the_eip_list.rst +++ b/api-ref/source/api/eip_management/querying_the_eip_list.rst @@ -17,79 +17,54 @@ GET /v1/{project_id}/eips/protect .. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+-----------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=================+ - | project_id | Yes | String | Project ID | - | | | | | - | | | | Minimum: **32** | - | | | | | - | | | | Maximum: **32** | - +-----------------+-----------------+-----------------+-----------------+ + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - | | | | | - | | | | Minimum: **36** | - | | | | | - | | | | Maximum: **36** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Public network ID or EIP | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **255** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies the protection status. The value can be null, 0 (enabled), or 1 (disabled). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **null** | - | | | | - **0** | - | | | | - **1** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sync | No | Integer | Specifies whether to synchronize tenant EIP data. The options are as follows: 0: no; 1: yes | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | - **1** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - | | | | | - | | | | Minimum: **0** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_key | No | String | Device key,It can be obtained by calling the EIP service API ListPublicips. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_key_word | No | String | The bound firewall name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | eps_id | No | String | The enterprise project id of the eip | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | String | Tag list | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Keyword for querying the protected EIP list. You can set an EIP ID or an EIP. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | String | Protection status: null (all), **0** (enabled), or **1** (disabled). | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sync | No | Integer | Whether to synchronize tenant EIP data: **0** (no), **1** (yes) | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_key | No | String | Device keyword, which is the name or ID of the asset bound to an EIP. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type: **0** (IPv4), **1** (IPv6). | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_key_word | No | String | Firewall keyword, which can be queried based on the firewall ID or name. For details, see :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eps_id | No | String | Enterprise project ID of the EIP, which can be obtained by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | String | You can obtain the tag list by querying it on the EIP console. | + +-----------------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -98,11 +73,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+--------------------------------------------------------------------+--------------------+ - | Parameter | Type | Description | - +===========+====================================================================+====================+ - | data | :ref:`EipResponseData ` object | eip query response | - +-----------+--------------------------------------------------------------------+--------------------+ + +-----------+--------------------------------------------------------------------+------------------------------------+ + | Parameter | Type | Description | + +===========+====================================================================+====================================+ + | data | :ref:`EipResponseData ` object | Returned data for querying an EIP. | + +-----------+--------------------------------------------------------------------+------------------------------------+ .. _listeips__response_eipresponsedata: @@ -111,77 +86,72 @@ Response Parameters +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +===========+======================================================================+=================================================================================================================================================+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | total | + | total | Integer | Query the total number of EIPs. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`EipResource ` objects | eip records | + | records | Array of :ref:`EipResource ` objects | EIP resource record. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listeips__response_eipresource: .. table:: **Table 6** EipResource - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | EIP ID | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | public_ip | String | EIP | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | EIP protection status,0:protected,1:unprotected | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | - **1** | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | public_ipv6 | String | EIP IPv6 | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Device ID | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_name | String | Device name | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Device owner | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | associate_instance_type | String | Type of the associated instance | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_name | String | firewall name | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_enterprise_project_id | String | Firewall enterprise project id bound to Eip | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | String | tags | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_id | String | domain id | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | The username of the project, which is the owner of the EIPs | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_domain_id | String | firewall domain id | - +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | EIP ID. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip | String | EIP. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Integer | EIP protection status: **0** (protected), **1** (unprotected). | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ipv6 | String | EIP (IPv6). | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID of the account that the EIP belongs to. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | ID of the device (such as ECS and NAT) bound to the EIP. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_name | String | Name of the device (such as ECS and NAT) bound to the EIP | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Owner of the device (such as ECS and NAT) bound to the EIP. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associate_instance_type | String | Type of the associated instance: **NATGW**, **ELB**, or **PORT**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_name | String | Firewall name. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the :ref:`API for querying a firewall instance `. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_enterprise_project_id | String | Enterprise project ID of the firewall bound to the EIP. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | String | Tag list. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_id | String | ID of the user that an EIP belongs to. You can obtain the ID by referring to [Obtaining Information About Account, IAM User, Group, Project, Region, and Agency] (cfw_02_0030.xml). | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | owner | String | Name of the user that an EIP belongs to. You can obtain it by referring to [Obtaining Information About Account, IAM User, Group, Project, Region, and Agency] (cfw_02_0030.xml). | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_domain_id | String | User that a firewall belongs to. You can obtain it by referring to [Obtaining Information About Account, IAM User, Group, Project, Region, and Agency] (cfw_02_0030.xml). | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Query the data on the non-synchronized first page whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and protected object ID is cfebd347-b655-4b84-b938-3c54317599b2. +Query the existing data, without updating it through synchronization, on the first page of protected object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -192,13 +162,13 @@ Example Responses **Status code: 200** -Return value of EIP data query +Return value for querying EIP data. .. code-block:: { "data" : { - "limit" : 10, + "limit" : 200, "offset" : 0, "records" : [ { "associate_instance_type" : "PORT", @@ -229,22 +199,22 @@ Bad Request { "error_code" : "CFW.00109004", - "error_msg" : "http to external service error" + "error_msg" : "HTTP request error." } Status Codes ------------ -=========== ============================== +=========== =================================== Status Code Description -=========== ============================== -200 Return value of EIP data query +=========== =================================== +200 Return value for querying EIP data. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ============================== +=========== =================================== Error Codes ----------- diff --git a/api-ref/source/api/eip_management/querying_the_number_of_eips.rst b/api-ref/source/api/eip_management/querying_the_number_of_eips.rst index 6bb02f9..ebe73ab 100644 --- a/api-ref/source/api/eip_management/querying_the_number_of_eips.rst +++ b/api-ref/source/api/eip_management/querying_the_number_of_eips.rst @@ -17,42 +17,34 @@ GET /v1/{project_id}/eip-count/{object_id} .. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | project_id | Yes | String | Project ID | - | | | | | - | | | | Minimum: **32** | - | | | | | - | | | | Maximum: **32** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - | | | | | - | | | | Minimum: **36** | - | | | | | - | | | | Maximum: **36** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -61,46 +53,38 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+--------------------------------------------------------------------------+-------------------------+ - | Parameter | Type | Description | - +===========+==========================================================================+=========================+ - | data | :ref:`EipCountRespData ` object | eip count response data | - +-----------+--------------------------------------------------------------------------+-------------------------+ + +-----------+--------------------------------------------------------------------------+-------------+ + | Parameter | Type | Description | + +===========+==========================================================================+=============+ + | data | :ref:`EipCountRespData ` object | EIP count. | + +-----------+--------------------------------------------------------------------------+-------------+ .. _listeipcount__response_eipcountrespdata: .. table:: **Table 5** EipCountRespData - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - | | | | - | | | Minimum: **36** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | eip_total | Integer | Total EIPs | - | | | | - | | | Default: **0** | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | eip_protected | Integer | protected eip count | - | | | | - | | | Default: **0** | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | eip_protected_self | Integer | self protected eip count | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================+=========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +--------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eip_total | Integer | Total number of EIPs. | + +--------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eip_protected | Integer | Total number of EIPs protected by all firewalls under the account. | + +--------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eip_protected_self | Integer | Number of EIPs protected by the current firewall. | + +--------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 6** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- @@ -137,7 +121,7 @@ Bad Request { "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_msg" : "Object not found." } Status Codes diff --git a/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst b/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst index 5377011..4644bd1 100644 --- a/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst +++ b/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst @@ -17,48 +17,42 @@ POST /v1/{project_id}/firewall/east-west/protect .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Yes | Integer | Protection status. The value can be 0 (enabled) or 1 (disabled). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **1** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Yes | Integer | Protection status: **0** (enabled), **1** (disabled). | + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -67,32 +61,32 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+------------------------------------------------------------------+---------------+ - | Parameter | Type | Description | - +===========+==================================================================+===============+ - | data | :ref:`data ` object | Response body | - +-----------+------------------------------------------------------------------+---------------+ + +-----------+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +===========+==========================================================================================================================================+===================================================+ + | data | :ref:`ChangeEastWestFirewallStatusResponseData ` object | Data returned for modifying east-west protection. | + +-----------+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ -.. _changeeastwestfirewallstatus__response_data: +.. _changeeastwestfirewallstatus__response_changeeastwestfirewallstatusresponsedata: -.. table:: **Table 6** data +.. table:: **Table 6** ChangeEastWestFirewallStatusResponseData - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==========================================================================================================================================+ - | id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | East-west protected object ID, which can be obtained by calling the :ref:`API for querying a firewall instance `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). Note that **type** indicates the protected object type. **0** indicates the ID of a protected object at the Internet border, **1** indicates the ID of a protected object at the VPC border. Here, a protected object ID whose **type** is **1** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- @@ -113,7 +107,7 @@ Example Responses **Status code: 200** -Response body for updating the east-west protection status +Response body for updating the east-west protection status. .. code-block:: @@ -131,22 +125,22 @@ Bad Request { "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_msg" : "Object not found." } Status Codes ------------ -=========== ========================================================== +=========== =========================================================== Status Code Description -=========== ========================================================== -200 Response body for updating the east-west protection status +=========== =========================================================== +200 Response body for updating the east-west protection status. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ========================================================== +=========== =========================================================== Error Codes ----------- diff --git a/api-ref/source/api/firewall_management/create_firewall.rst b/api-ref/source/api/firewall_management/create_firewall.rst deleted file mode 100644 index 3fdc2b4..0000000 --- a/api-ref/source/api/firewall_management/create_firewall.rst +++ /dev/null @@ -1,254 +0,0 @@ -:original_name: CreateFirewall.html - -.. _CreateFirewall: - -Create Firewall -=============== - -Function --------- - -This API is used to create firewall. - -URI ---- - -POST /v2/{project_id}/firewall - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+========================================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | X-Client-Token | No | String | An identity that guarantees the idempotency of client requests. The identifier is in 32-bit UUID format, generated by the client, and must be unique between requests. | - +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** Request body parameters - - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================================================================+==========================================================================================================================================================================+ - | name | Yes | String | Firewall Name | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - | | | | | - | | | | Default: **0** | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of :ref:`tags ` objects | Resource Tag | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | Yes | :ref:`flavor ` object | flavor | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_info | Yes | :ref:`charge_info ` object | Billing type information, postpaid. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createfirewall__request_tags: - -.. table:: **Table 4** tags - - ========= ========= ====== =========== - Parameter Mandatory Type Description - ========= ========= ====== =========== - key No String Tag Key - value No String Tag Value - ========= ========= ====== =========== - -.. _createfirewall__request_flavor: - -.. table:: **Table 5** flavor - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================+ - | version | Yes | String | Firewall version: charge_mode is postPaid, only the Professional Edition is supported | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **Professional** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------+ - -.. _createfirewall__request_charge_info: - -.. table:: **Table 6** charge_info - - +-------------+-----------+--------+----------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+================================================================+ - | charge_mode | Yes | String | The billing mode can be postPaid: postpaid, i.e., pay-per-use. | - +-------------+-----------+--------+----------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================================+======================================================================================================================+ - | job_id | String | The job id, created when the firewall instance is created, which is returned only when the billing mode is postpaid. | - +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | order_id | String | Order id,which is returned when the firewall instance is created. | - +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | data | :ref:`CreateFirewallReq ` object | Create Firewall Request | - +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - -.. _createfirewall__response_createfirewallreq: - -.. table:: **Table 8** CreateFirewallReq - - +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==================================================================+==========================================================================================================================================================================+ - | name | String | Firewall Name | - +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - | | | | - | | | Default: **0** | - +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`tags ` objects | Resource Tag | - +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | :ref:`flavor ` object | flavor | - +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_info | :ref:`charge_info ` object | Billing type information, postpaid. | - +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createfirewall__response_tags: - -.. table:: **Table 9** tags - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - key String Tag Key - value String Tag Value - ========= ====== =========== - -.. _createfirewall__response_flavor: - -.. table:: **Table 10** flavor - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================================================================================+ - | version | String | Firewall version: charge_mode is postPaid, only the Professional Edition is supported | - | | | | - | | | Enumeration values: | - | | | | - | | | - **Professional** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - -.. _createfirewall__response_charge_info: - -.. table:: **Table 11** charge_info - - +-------------+--------+----------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+========+================================================================+ - | charge_mode | String | The billing mode can be postPaid: postpaid, i.e., pay-per-use. | - +-------------+--------+----------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 12** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -Enable a standard firewall with 2000 extended EIP, 5,000 Mbps extended protection bandwidth, 100 extended protection VCPs under a monthly billing auto-renewal model. - -.. code-block:: - - https://{Endpoint}/v2/124147da-5b08-471a-93d2-bc82acc290c6/firewall - - { - "name" : "CFW-TEST", - "enterprise_project_id" : "0", - "tags" : [ { - "key" : "TagKey", - "value" : "TagVal" - } ], - "flavor" : { - "version" : "Professional" - }, - "charge_info" : { - "charge_mode" : "postPaid", - "period_type" : "month", - "period_num" : 1, - "is_auto_renew" : true, - "is_auto_pay" : true - } - } - -Example Responses ------------------ - -**Status code: 200** - -Create Firewall Response - -.. code-block:: - - { - "data" : { - "charge_info" : { - "charge_mode" : "postPaid" - }, - "enterprise_project_id" : "0", - "flavor" : { - "version" : "Professional" - }, - "name" : "CFW-TEST", - "tags" : [ { - "key" : "TagKey", - "value" : "TagVal" - } ] - }, - "job_id" : "jobId" - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.00100001", - "error_msg" : "The system is busy. Please try again later." - } - -Status Codes ------------- - -=========== ======================== -Status Code Description -=========== ======================== -200 Create Firewall Response -400 Bad Request -=========== ======================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/create_tags.rst b/api-ref/source/api/firewall_management/create_tags.rst deleted file mode 100644 index 26db79a..0000000 --- a/api-ref/source/api/firewall_management/create_tags.rst +++ /dev/null @@ -1,96 +0,0 @@ -:original_name: CreateTag.html - -.. _CreateTag: - -Create tags -=========== - -Function --------- - -Creating tags for firewalls. - -URI ---- - -POST /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/create - -.. table:: **Table 1** Path Parameters - - +----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | project_id | Yes | String | project ID | - +----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** Request body parameters - - +-----------+-----------+------------------------------------------------------------------+-------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================================================================+=============+ - | tags | No | Array of :ref:`CreateTag ` objects | tag list | - +-----------+-----------+------------------------------------------------------------------+-------------+ - -.. _createtag__request_createtag: - -.. table:: **Table 4** CreateTag - - ========= ========= ====== =========== - Parameter Mandatory Type Description - ========= ========= ====== =========== - key No String key - value No String value - ========= ========= ====== =========== - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Add a tag to the project ID 0b2179bbe180d3762fb0c01a2d5725c7 and the firewall ID 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 with the keytest key and valuetest valuetest. - -.. code-block:: - - https://{Endpoint}/v2/0b2179bbe180d3762fb0c01a2d5725c7/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/create - - { - "tags" : [ { - "key" : "keytest", - "value" : "valuetest" - } ] - } - -Example Responses ------------------ - -None - -Status Codes ------------- - -=========== =========== -Status Code Description -=========== =========== -200 OK -=========== =========== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/creating_a_firewall.rst b/api-ref/source/api/firewall_management/creating_a_firewall.rst new file mode 100644 index 0000000..5fafd14 --- /dev/null +++ b/api-ref/source/api/firewall_management/creating_a_firewall.rst @@ -0,0 +1,329 @@ +:original_name: CreateFirewall.html + +.. _CreateFirewall: + +Creating a Firewall +=================== + +Function +-------- + +This API is used to create a firewall. + +URI +--- + +POST /v2/{project_id}/firewall + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------+ + | X-Client-Token | No | String | Identifier that ensures idempotency of client requests. | + | | | | | + | | | | It is a 32-bit UUID and is generated by the client. The value must be unique. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +-----------------------+-----------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=================================================================+==============================================================================================================================================================================================================================================================================+ + | name | Yes | String | Firewall name. | + +-----------------------+-----------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`tags ` objects | List of service resource tags. After tags are added to firewall resources, you can query resources and combine CDRs by key and value. | + +-----------------------+-----------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor | Yes | :ref:`flavor ` object | Firewall specifications. | + +-----------------------+-----------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | Yes | :ref:`charge_info ` object | Billing type, which can be yearly/monthly or pay-per-use (default setting). | + +-----------------------+-----------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createfirewall__request_tags: + +.. table:: **Table 4** tags + + ========= ========= ====== =================== + Parameter Mandatory Type Description + ========= ========= ====== =================== + key No String Resource tag key. + value No String Resource tag value. + ========= ========= ====== =================== + +.. _createfirewall__request_flavor: + +.. table:: **Table 5** flavor + + +------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+=========+==============================================================================================================================================================================+ + | version | Yes | String | Firewall edition. Only the professional edition is supported. | + +------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_eip_count | No | Integer | Number of EIPs to be added. This parameter takes effect only in the yearly/monthly billing mode. Set this parameter when you need to increase protected EIPs. | + +------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_bandwidth | No | Integer | Added bandwidth. The increment step is 5. This parameter takes effect only in yearly/monthly billing mode. Set this parameter when you need to increase protected bandwidth. | + +------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_vpc_count | No | Integer | Number of VPCs to be added. This parameter takes effect only in the yearly/monthly billing mode. Set this parameter when you need to increase protected VPCs. | + +------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createfirewall__request_charge_info: + +.. table:: **Table 6** charge_info + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+====================================================================================================================================================================================================================================================================================================================================================================================================+ + | charge_mode | Yes | String | Billing mode. The value can only be **postPaid**, indicating pay-per-use billing. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period_type | No | String | Subscription period. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **month** | + | | | | | + | | | | - **year** | + | | | | | + | | | | Note: This parameter is valid and mandatory when **charge_mode** is set to **prePaid**. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period_num | No | Integer | Subscription time. This parameter is valid and mandatory only when **charge_mode** is set to **prePaid**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - If **period_type** is set to **month**, the parameter value ranges from integer **1** to **9**. | + | | | | - If **period_type** is set to **year**, the parameter value ranges from integer **1** to **3**. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_auto_renew | Yes | Boolean | Whether automatic renewal is enabled for yearly/monthly instances. The renewal period is the same as the original period and the order will be automatically paid during the subscription renewal. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **true** (Automatic renewal enabled.) | + | | | | - **false** (Default. Automatic renewal disabled.) | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_auto_pay | Yes | Boolean | Whether an order will be automatically paid after yearly/monthly CFW instances are created. This parameter does not affect the payment mode of automatic renewal. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **true**: The order will be automatically paid. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.) | + | | | | - **false**: The order will be manually paid. This is the default value. (You need to manually pay for the bill. Discounts and coupons can be used.) | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 7** Response body parameters + + +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==============================================================================+====================================================================================================+ + | job_id | String | Instance creation task ID. This parameter is returned only when pay-per-use instances are created. | + +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | order_id | String | Order ID. This parameter is returned only when yearly/monthly instances are created. | + +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | data | :ref:`CreateFirewallReq ` object | Request body for creating a firewall. | + +-----------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + +.. _createfirewall__response_createfirewallreq: + +.. table:: **Table 8** CreateFirewallReq + + +-----------------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==================================================================+==============================================================================================================================================================================================================================================================================+ + | name | String | Firewall name. | + +-----------------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`tags ` objects | List of service resource tags. After tags are added to firewall resources, you can query resources and combine CDRs by key and value. | + +-----------------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor | :ref:`flavor ` object | Firewall specifications. | + +-----------------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`charge_info ` object | Billing type, which can be yearly/monthly or pay-per-use (default setting). | + +-----------------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createfirewall__response_tags: + +.. table:: **Table 9** tags + + ========= ====== =================== + Parameter Type Description + ========= ====== =================== + key String Resource tag key. + value String Resource tag value. + ========= ====== =================== + +.. _createfirewall__response_flavor: + +.. table:: **Table 10** flavor + + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=========+==============================================================================================================================================================================+ + | version | String | Firewall edition. Only the professional edition is supported. | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_eip_count | Integer | Number of EIPs to be added. This parameter takes effect only in the yearly/monthly billing mode. Set this parameter when you need to increase protected EIPs. | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_bandwidth | Integer | Added bandwidth. The increment step is 5. This parameter takes effect only in yearly/monthly billing mode. Set this parameter when you need to increase protected bandwidth. | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_vpc_count | Integer | Number of VPCs to be added. This parameter takes effect only in the yearly/monthly billing mode. Set this parameter when you need to increase protected VPCs. | + +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createfirewall__response_charge_info: + +.. table:: **Table 11** charge_info + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================+ + | charge_mode | String | Billing mode. The value can only be **postPaid**, indicating pay-per-use billing. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period_type | String | Subscription period. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **month** | + | | | | + | | | - **year** | + | | | | + | | | Note: This parameter is valid and mandatory when **charge_mode** is set to **prePaid**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period_num | Integer | Subscription time. This parameter is valid and mandatory only when **charge_mode** is set to **prePaid**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - If **period_type** is set to **month**, the parameter value ranges from integer **1** to **9**. | + | | | - If **period_type** is set to **year**, the parameter value ranges from integer **1** to **3**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_auto_renew | Boolean | Whether automatic renewal is enabled for yearly/monthly instances. The renewal period is the same as the original period and the order will be automatically paid during the subscription renewal. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **true** (Automatic renewal enabled.) | + | | | - **false** (Default. Automatic renewal disabled.) | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_auto_pay | Boolean | Whether an order will be automatically paid after yearly/monthly CFW instances are created. This parameter does not affect the payment mode of automatic renewal. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **true**: The order will be automatically paid. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.) | + | | | - **false**: The order will be manually paid. This is the default value. (You need to manually pay for the bill. Discounts and coupons can be used.) | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 12** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +The customer whose project ID is 124147da-5b08-471a-93d2-bc82acc290c6 subscribes to the standard firewall. The firewall name is **CFW-Test**, the enterprise project ID is **0**, the resource tag is a key-value pair, the key is **TagKey**, the value is **TagValue**, the added number of protected EIPs is 2000, the added protection bandwidth is 5000 Mbit/s, and the added number of protected VCPs is 100. The yearly/monthly billing mode is used. Auto-renewal and auto-payment are enabled. The usage duration is one month. + +.. code-block:: + + https://{Endpoint}/v2/124147da-5b08-471a-93d2-bc82acc290c6/firewall + + { + "name" : "CFW-TEST", + "enterprise_project_id" : "0", + "tags" : [ { + "key" : "TagKey", + "value" : "TagVal" + } ], + "flavor" : { + "version" : "standard", + "extend_eip_count" : 2000, + "extend_bandwidth" : 5000, + "extend_vpc_count" : 100 + }, + "charge_info" : { + "charge_mode" : "prePaid", + "period_type" : "month", + "period_num" : 1, + "is_auto_renew" : true, + "is_auto_pay" : true + } + } + +Example Responses +----------------- + +**Status code: 200** + +Information returned when the firewall is purchased successfully. + +.. code-block:: + + { + "data" : { + "charge_info" : { + "charge_mode" : "prePaid", + "is_auto_pay" : true, + "is_auto_renew" : true, + "period_num" : 1, + "period_type" : "month" + }, + "enterprise_project_id" : "0", + "flavor" : { + "extend_bandwidth" : 5000, + "extend_eip_count" : 2000, + "extend_vpc_count" : 100, + "version" : "Standard" + }, + "name" : "CFW-TEST", + "tags" : [ { + "key" : "TagKey", + "value" : "TagVal" + } ] + }, + "job_id" : "CS2403271050ZEM0L" + } + +**Status code: 400** + +Returned error information. + +.. code-block:: + + { + "error_code" : "CFW.00100001", + "error_msg" : "System busy. Try again later." + } + +Status Codes +------------ + ++-------------+-------------------------------------------------------------------+ +| Status Code | Description | ++=============+===================================================================+ +| 200 | Information returned when the firewall is purchased successfully. | ++-------------+-------------------------------------------------------------------+ +| 400 | Returned error information. | ++-------------+-------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/creating_a_tag.rst b/api-ref/source/api/firewall_management/creating_a_tag.rst new file mode 100644 index 0000000..049f58e --- /dev/null +++ b/api-ref/source/api/firewall_management/creating_a_tag.rst @@ -0,0 +1,104 @@ +:original_name: CreateTag.html + +.. _CreateTag: + +Creating a Tag +============== + +Function +-------- + +This API is used to create a tag. + +URI +--- + +POST /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/create + +.. table:: **Table 1** Path Parameters + + +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +-----------+-----------+------------------------------------------------------------------+-----------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==================================================================+=============================+ + | tags | No | Array of :ref:`CreateTag ` objects | Create a firewall tag list. | + +-----------+-----------+------------------------------------------------------------------+-----------------------------+ + +.. _createtag__request_createtag: + +.. table:: **Table 4** CreateTag + + ========= ========= ====== =========== + Parameter Mandatory Type Description + ========= ========= ====== =========== + key No String Tag key. + value No String Tag value. + ========= ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + ``-`` String + ========= ====== =========== + +Example Requests +---------------- + +Add a tag whose key is **keytest** and value is **valuetest** to firewall 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 in project 0b2179bbe180d3762fb0c01a2d5725c7. + +.. code-block:: + + https://{Endpoint}/v2/0b2179bbe180d3762fb0c01a2d5725c7/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/create + + { + "tags" : [ { + "key" : "keytest", + "value" : "valuetest" + } ] + } + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== =========== +Status Code Description +=========== =========== +200 OK +=========== =========== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/create_east_west_firewall.rst b/api-ref/source/api/firewall_management/creating_an_east-west_firewall.rst similarity index 62% rename from api-ref/source/api/firewall_management/create_east_west_firewall.rst rename to api-ref/source/api/firewall_management/creating_an_east-west_firewall.rst index 8b8060b..2c34b3d 100644 --- a/api-ref/source/api/firewall_management/create_east_west_firewall.rst +++ b/api-ref/source/api/firewall_management/creating_an_east-west_firewall.rst @@ -2,13 +2,13 @@ .. _CreateEastWestFirewall: -Create East West Firewall -========================= +Creating an East-West Firewall +============================== Function -------- -This API is used to create east west firewall. +This API is used to create an east-west firewall. URI --- @@ -17,44 +17,44 @@ POST /v1/{project_id}/firewall/east-west .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+========+=================================================================================================================+ - | er_id | No | String | Instance ID of the associated outbound ER, which can be obtained by calling the Querying Enterprise Routers API | - +-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+ - | inspection_cidr | Yes | String | inspection cidr | - +-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+ - | mode | Yes | String | east-west protection mode,only er mode is supported | - +-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+========+==========================================================================================================================================================================================================================================================================================================+ + | er_id | No | String | ID of the associated enterprise router in the outbound direction, which can be obtained by calling the API for querying the enterprise router list of the Enterprise Router service. Find the enterprise router ID in **instances.id** (The period [.] is used to separate different levels of objects). | + +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | inspection_cidr | Yes | String | CIDR block used for creating a traffic diversion VPC. | + +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | Yes | String | East-west firewall mode. Enter **er**. | + +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -63,52 +63,54 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+--------------------------------------------------------------------------------------------+------------------------------------+ - | Parameter | Type | Description | - +===========+============================================================================================+====================================+ - | data | :ref:`CreateEWFirewallResp ` object | create east west firewall response | - +-----------+--------------------------------------------------------------------------------------------+------------------------------------+ + +-----------+--------------------------------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +===========+============================================================================================+==================================================+ + | data | :ref:`CreateEWFirewallResp ` object | Return value for creating an east-west firewall. | + +-----------+--------------------------------------------------------------------------------------------+--------------------------------------------------+ .. _createeastwestfirewall__response_createewfirewallresp: .. table:: **Table 6** CreateEWFirewallResp - +----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+================================================================================================================+==========================================================================================================================================+ - | id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. | - +----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | er | :ref:`ER ` object | ER data | - +----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | inspertion_vpc | :ref:`CreateEWFirewallInspectVpcResp ` object | inspection vpc | - +----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------+----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+================================================================================================================+====================================================================+ + | id | String | East-west protection ID, corresponding to the **object_id** field. | + +----------------+----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ + | er | :ref:`ER ` object | Enterprise router information. | + +----------------+----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ + | inspertion_vpc | :ref:`CreateEWFirewallInspectVpcResp ` object | Information about the traffic diversion VPC. | + +----------------+----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ .. _createeastwestfirewall__response_er: .. table:: **Table 7** ER - ============ ====== ================================================== - Parameter Type Description - ============ ====== ================================================== - er_id String ER ID - er_attach_id String ER attachment ID, connection id between CFW and ER - ============ ====== ================================================== + +--------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============+========+===================================================================================================================================================================================================================================================================================================+ + | er_id | String | Enterprise router ID, which is referenced when east-west protection is created. | + +--------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | er_attach_id | String | Connection ID of an enterprise router. This connection is used to connect the firewall and the enterprise router. This field can be used to obtain the connection details on the connection management page after querying a specified enterprise router by its ID on the Enterprise Router page. | + +--------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _createeastwestfirewall__response_createewfirewallinspectvpcresp: .. table:: **Table 8** CreateEWFirewallInspectVpcResp - ========== ================ =========== - Parameter Type Description - ========== ================ =========== - vpc_id String vpc id - subnet_ids Array of strings subnet ids - ========== ================ =========== + +------------+------------------+------------------------------------------------------+ + | Parameter | Type | Description | + +============+==================+======================================================+ + | vpc_id | String | ID of a traffic diversion VPC. | + +------------+------------------+------------------------------------------------------+ + | subnet_ids | Array of strings | Subnet ID list of the created traffic diversion VPC. | + +------------+------------------+------------------------------------------------------+ Example Requests ---------------- -Create an east-west protection in ER mode under firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500, the project ID is 09bb24e6f280d23d0f9fc0104b901480, the inspection_cidr is 10.1.0.0/24, and the er_id is e0b22a23-02cf-4092-ace9-34b39e10dc77. +Under firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in project 09bb24e6f280d23d0f9fc0104b901480, create a firewall in enterprise router mode. The enterprise router ID is 0eb296a4-aa9b-493e-b58a-ce993a16edfc, the traffic diversion VPC is 0eb296a4-aa9b-493e-b58a-ce993a16edfd, the subnets associated with the firewall are fw-subnet and cfw-subnet, and the subnet associated with the enterprise router is er-subnet. .. code-block:: @@ -125,7 +127,7 @@ Example Responses **Status code: 200** -Create East West Firewall Response Body +Return value for creating an east-west firewall. .. code-block:: @@ -146,11 +148,11 @@ Create East West Firewall Response Body Status Codes ------------ -=========== ======================================= +=========== ================================================ Status Code Description -=========== ======================================= -200 Create East West Firewall Response Body -=========== ======================================= +=========== ================================================ +200 Return value for creating an east-west firewall. +=========== ================================================ Error Codes ----------- diff --git a/api-ref/source/api/firewall_management/delete_tags.rst b/api-ref/source/api/firewall_management/delete_tags.rst deleted file mode 100644 index 05a9aa8..0000000 --- a/api-ref/source/api/firewall_management/delete_tags.rst +++ /dev/null @@ -1,97 +0,0 @@ -:original_name: DeleteTag.html - -.. _DeleteTag: - -Delete Tags -=========== - -Function --------- - -Deleting firewall tag - -URI ---- - -DELETE /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/delete - -.. table:: **Table 1** Path Parameters - - +----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | project_id | Yes | String | project ID | - +----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** Request body parameters - - +-----------+-----------+----------------------------------------------------------------------+-------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+======================================================================+=============+ - | tags | No | Array of :ref:`ResourceTag ` objects | tag list | - +-----------+-----------+----------------------------------------------------------------------+-------------+ - -.. _deletetag__request_resourcetag: - -.. table:: **Table 4** ResourceTag - - =========== ========= ====== =========== - Parameter Mandatory Type Description - =========== ========= ====== =========== - key No String - value No String - update_time No String update time - =========== ========= ====== =========== - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Delete the firewall tag in the firewall where the project ID is 0b2179bbe180d3762fb0c01a2d5725c7 and the firewall ID is 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 - -.. code-block:: - - https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/delete - - { - "tags" : [ { - "key" : "keytest", - "value" : "valuetest" - } ] - } - -Example Responses ------------------ - -None - -Status Codes ------------- - -=========== =========== -Status Code Description -=========== =========== -200 -=========== =========== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/delete_firewall_instance.rst b/api-ref/source/api/firewall_management/deleting_a_firewall.rst similarity index 51% rename from api-ref/source/api/firewall_management/delete_firewall_instance.rst rename to api-ref/source/api/firewall_management/deleting_a_firewall.rst index eb324b5..8049e66 100644 --- a/api-ref/source/api/firewall_management/delete_firewall_instance.rst +++ b/api-ref/source/api/firewall_management/deleting_a_firewall.rst @@ -2,13 +2,13 @@ .. _DeleteFirewall: -Delete firewall instance -======================== +Deleting a Firewall +=================== Function -------- -Delete firewall instance,only postpaid mode is supported. +This API is used to delete a firewall. It takes effect only for pay-per-use firewalls. URI --- @@ -17,24 +17,24 @@ DELETE /v2/{project_id}/firewall/{resource_id} .. table:: **Table 1** Path Parameters - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=========================================================================================================================================================================+ - | project_id | Yes | String | Project ID | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 2** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -43,16 +43,16 @@ Response Parameters .. table:: **Table 3** Response body parameters - ========= ====== ======================== + ========= ====== =============================== Parameter Type Description - ========= ====== ======================== - data String Delete Firewall Response - ========= ====== ======================== + ========= ====== =============================== + data String ID of a firewall deletion task. + ========= ====== =============================== Example Requests ---------------- -Delete firewall whose firewall instance id is 08065281-860a-4c98-aeb5-82cf65c44c46c46 and project id is 06217ebc876e427a80a2c05d51264ab1. +Delete the pay-per-use firewall 08065281-860a-4c98-aeb5-82cf65c44c46 from project 06217ebc876e427a80a2c05d51264ab1. .. code-block:: @@ -63,7 +63,7 @@ Example Responses **Status code: 200** -Delete Firewall Response +Return value for deleting a firewall. .. code-block:: @@ -74,11 +74,11 @@ Delete Firewall Response Status Codes ------------ -=========== ======================== +=========== ===================================== Status Code Description -=========== ======================== -200 Delete Firewall Response -=========== ======================== +=========== ===================================== +200 Return value for deleting a firewall. +=========== ===================================== Error Codes ----------- diff --git a/api-ref/source/api/firewall_management/deleting_a_tag.rst b/api-ref/source/api/firewall_management/deleting_a_tag.rst new file mode 100644 index 0000000..619a51b --- /dev/null +++ b/api-ref/source/api/firewall_management/deleting_a_tag.rst @@ -0,0 +1,105 @@ +:original_name: DeleteTag.html + +.. _DeleteTag: + +Deleting a Tag +============== + +Function +-------- + +This API is used to delete a tag. + +URI +--- + +DELETE /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/delete + +.. table:: **Table 1** Path Parameters + + +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 3** Request body parameters + + +-----------+-----------+----------------------------------------------------------------------+--------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+======================================================================+====================+ + | tags | No | Array of :ref:`ResourceTag ` objects | Firewall tag list. | + +-----------+-----------+----------------------------------------------------------------------+--------------------+ + +.. _deletetag__request_resourcetag: + +.. table:: **Table 4** ResourceTag + + =========== ========= ====== ================ + Parameter Mandatory Type Description + =========== ========= ====== ================ + key No String Tag key. + value No String Tag value. + update_time No String Tag update time. + =========== ========= ====== ================ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + ``-`` String + ========= ====== =========== + +Example Requests +---------------- + +Delete a tag from firewall 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 in project 0b2179bbe180d3762fb0c01a2d5725c7. The tag key is **keytest** and the tag value is **valuetest**. + +.. code-block:: + + https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/delete + + { + "tags" : [ { + "key" : "keytest", + "value" : "valuetest" + } ] + } + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== =========== +Status Code Description +=========== =========== +200 OK +=========== =========== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/index.rst b/api-ref/source/api/firewall_management/index.rst index 0c27541..3b21726 100644 --- a/api-ref/source/api/firewall_management/index.rst +++ b/api-ref/source/api/firewall_management/index.rst @@ -5,30 +5,30 @@ Firewall Management =================== -- :ref:`Create Firewall ` -- :ref:`List Job Status ` -- :ref:`Delete firewall instance ` -- :ref:`List Firewalls ` -- :ref:`Obtaining East-West Firewall Information ` -- :ref:`Create East West Firewall ` -- :ref:`Querying the Number of Protected VPCs ` +- :ref:`Creating a Firewall ` +- :ref:`Obtaining the Status of a CFW Task ` +- :ref:`Deleting a Firewall ` +- :ref:`Querying the Firewall List ` - :ref:`Changing the East-West Firewall Protection Status ` -- :ref:`List Firewall Detail ` -- :ref:`Create tags ` -- :ref:`Delete Tags ` +- :ref:`Querying Firewall Details ` +- :ref:`Obtaining East-West Firewall Information ` +- :ref:`Creating an East-West Firewall ` +- :ref:`Querying the Number of Protected VPCs ` +- :ref:`Creating a Tag ` +- :ref:`Deleting a Tag ` .. toctree:: :maxdepth: 1 :hidden: - create_firewall - list_job_status - delete_firewall_instance - list_firewalls - obtaining_east-west_firewall_information - create_east_west_firewall - querying_the_number_of_protected_vpcs + creating_a_firewall + obtaining_the_status_of_a_cfw_task + deleting_a_firewall + querying_the_firewall_list changing_the_east-west_firewall_protection_status - list_firewall_detail - create_tags - delete_tags + querying_firewall_details + obtaining_east-west_firewall_information + creating_an_east-west_firewall + querying_the_number_of_protected_vpcs + creating_a_tag + deleting_a_tag diff --git a/api-ref/source/api/firewall_management/list_firewall_detail.rst b/api-ref/source/api/firewall_management/list_firewall_detail.rst deleted file mode 100644 index 7a1299a..0000000 --- a/api-ref/source/api/firewall_management/list_firewall_detail.rst +++ /dev/null @@ -1,414 +0,0 @@ -:original_name: ListFirewallDetail.html - -.. _ListFirewallDetail: - -List Firewall Detail -==================== - -Function --------- - -This API is used to query a firewall instance. - -URI ---- - -GET /v1/{project_id}/firewall/exist - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_type | Yes | Integer | Service type | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **1** | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0 North-south firewall** | - | | | | | - | | | | - **1 East-west firewall** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | firewall instance name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+----------------------------------------------------------------------------------------------+-------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================================================+=====================================+ - | data | :ref:`GetFirewallInstanceData ` object | get firewall instance response data | - +-----------+----------------------------------------------------------------------------------------------+-------------------------------------+ - -.. _listfirewalldetail__response_getfirewallinstancedata: - -.. table:: **Table 5** GetFirewallInstanceData - - +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+============================================================================================================================+=================================================================================================================================================+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | total | - +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`GetFirewallInstanceResponseRecord ` objects | Get firewall instance records | - +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listfirewalldetail__response_getfirewallinstanceresponserecord: - -.. table:: **Table 6** GetFirewallInstanceResponseRecord - - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+==========================================================================================================+===============================================================================================================================================================================================================================================================================================+ - | fw_instance_id | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Firewall name | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ha_type | Integer | Cluster type | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | Integer | Billing mode. The value can be 0 (yearly/monthly) or 1 (pay-per-use). | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_type | Integer | Service type | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_type | Integer | firewall instance types | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | :ref:`Flavor ` object | Firewall specifications | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protect_objects | Array of :ref:`ProtectObjectVO ` objects | Project list | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Firewall status list. The options are as follows: -1: waiting for payment; 0: creating; 1: deleting; 2: running; 3: upgrading; 4: deletion completed; 5: freezing; 6: creation failed; 7: deletion failed; 8: freezing failed; 9: storage in progress; 10: storage failed; 11: upgrade failed | - | | | | - | | | Enumeration values: | - | | | | - | | | - **-1** | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - | | | | - | | | - **2** | - | | | | - | | | - **3** | - | | | | - | | | - **4** | - | | | | - | | | - **5** | - | | | | - | | | - **6** | - | | | | - | | | - **7** | - | | | | - | | | - **8** | - | | | | - | | | - **9** | - | | | | - | | | - **10** | - | | | | - | | | - **11** | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_old_firewall_instance | Boolean | Whether the engine is an old engine. The options are true (yes) and false (no). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **true** | - | | | | - | | | - **false** | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_available_obs | Boolean | Whether obs is available | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_support_threat_tags | Boolean | Whether threat tags is supported | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | support_ipv6 | Boolean | Whether IPv6 is supported. The options are true (yes) and false (no). | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | feature_toggle | Map | Whether to enable the feature. The options are true (yes) and false (no). | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resources | Array of :ref:`FirewallInstanceResource ` objects | Firewall instance resources | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_name | String | firewall name | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | resource id | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | support_url_filtering | Boolean | whether to enable url filtering. The options are true (yes) and false (no). | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | String | tags | - +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listfirewalldetail__response_flavor: - -.. table:: **Table 7** Flavor - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+================================================================================================================================+ - | version | Integer | Firewall version. The value can be 0 (standard edition), 1 (professional edition), 2 (platinum edition), or 3 (basic edition). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - | | | | - | | | - **2** | - | | | | - | | | - **3** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | eip_count | Integer | Number of EIPs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | vpc_count | Integer | Number of VPCs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | bandwidth | Integer | Bandwidth | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_storage | Integer | Log storage | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_bandwidth | Integer | default bandwidth | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_eip_count | Integer | default eip count | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_log_storage | Integer | default log storage | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_vpc_count | Integer | default vpc count | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. _listfirewalldetail__response_protectobjectvo: - -.. table:: **Table 8** ProtectObjectVO - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_name | String | Protected object name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Project type. The options are as follows: 0: north-south; 1: east-west. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listfirewalldetail__response_firewallinstanceresource: - -.. table:: **Table 9** FirewallInstanceResource - - +--------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+===========================================================================================================================================================================================================================================================================================================+ - | resource_id | String | Firewall instance ID, which is automatically generated after a CFW instance is created. | - +--------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cloud_service_type | String | Service type, which is used by CBC. | - +--------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Resource type. The options are as follows:1. CFW: cloudPlatform.resource.type.cfw 2. EIP:cloudPlatform.resource.type.cfw.exp.eip 3. Bandwidth: cloudPlatform.resource.type.cfw.exp.bandwidth 4. VPC: cloudPlatform.resource.type.cfw.exp.vpc 5. Log storage: cloudPlatform.resource.type.cfw.exp.logaudit | - +--------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_spec_code | String | Inventory unit code | - +--------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_size | Integer | Resource quantity | - +--------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_size_measure_id | Integer | Resource unit name | - +--------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Query the firewall list of the project whose ID is 9d80d070b6d44942af73c9c3d38e0429. - -.. code-block:: - - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/firewall/exist?service_type=0&offset=0&limit=10 - -Example Responses ------------------ - -**Status code: 200** - -Response to the request for obtaining a firewall instance - -.. code-block:: - - { - "data" : { - "limit" : 10, - "offset" : 0, - "records" : [ { - "charge_mode" : 0, - "engine_type" : 1, - "enterprise_project_id" : "default", - "feature_toggle" : { - "is_support_anti_virus" : true, - "is_support_application" : true, - "is_support_tcp_proxy" : false, - "is_support_url_profile" : true, - "is_support_threat_tags" : true, - "is_support_flow_associated_host" : false, - "is_support_predefined" : true, - "isSupportSession" : false, - "is_support_acl_region_config" : true, - "is_support_ips" : true, - "is_support_ew_create_er_tenant_inspection_mode" : false, - "ips_rule_list" : true, - "long_connect" : true, - "is_support_ew_create_vpc_peering_inspection_mode" : true, - "alarm_config" : true, - "is_not_support_resource_reduction" : false, - "acl_multi_object" : true, - "is_support_advanced_ips_rule" : true, - "is_support_multi_account" : false, - "is_support_capture" : true, - "is_support_ew_create_er_bearer_inspection_mode" : true - }, - "flavor" : { - "bandwidth" : 60, - "eip_count" : 51, - "log_storage" : 0, - "session_concurrent" : 200, - "session_create" : 200, - "total_rule_count" : 200, - "used_rule_count" : 2136, - "version" : 1, - "vpc_bandwith" : 1400, - "vpc_count" : 8, - "default_eip_count" : 20, - "default_vpc_count" : 0, - "default_bandwidth" : 10, - "default_log_storage" : 0 - }, - "tags" : "{\"key1234\":\"1234\",\"key122\":\"2222\"}", - "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", - "fw_instance_name" : "test", - "ha_type" : 1, - "is_available_obs" : false, - "is_old_firewall_instance" : false, - "is_support_threat_tags" : false, - "name" : "1680054140516", - "protect_objects" : [ { - "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", - "object_name" : "1680054141674", - "type" : 0 - }, { - "object_id" : "be83d202-df0b-498d-a96e-41589dc85c86", - "object_name" : "ew-1680070626042", - "type" : 1 - } ], - "resource_id" : "546af3f8-88e9-47f2-a205-2346d7090925", - "resources" : [ { - "cloud_service_type" : "cloudPlatform.service.type.cfw", - "resource_id" : "546af3f8-88e9-47f2-a205-2346d7090925", - "resource_spec_code" : "cfw.professional", - "resource_type" : "cloudPlatform.resource.type.cfw" - }, { - "cloud_service_type" : "cloudPlatform.service.type.cfw", - "resource_id" : "0acdd5c7-1178-4bea-b5b6-bd55dc5e2669", - "resource_size" : 5, - "resource_size_measure_id" : 14, - "resource_spec_code" : "cfw.expack.vpc.professional", - "resource_type" : "cloudPlatform.resource.type.cfw.exp.vpc" - }, { - "cloud_service_type" : "cloudPlatform.service.type.cfw", - "resource_id" : "4002620c-916a-49c7-8042-cbe02fc17e61", - "resource_size" : 5, - "resource_size_measure_id" : 36, - "resource_spec_code" : "cfw.expack.bandwidth.professional", - "resource_type" : "cloudPlatform.resource.type.cfw.exp.bandwidth" - }, { - "cloud_service_type" : "cloudPlatform.service.type.cfw", - "resource_id" : "0235c7db-0baa-4c82-8db2-7b8d5108bd86", - "resource_size" : 2, - "resource_size_measure_id" : 14, - "resource_spec_code" : "cfw.expack.eip.professional", - "resource_type" : "cloudPlatform.resource.type.cfw.exp.eip" - }, { - "cloud_service_type" : "cloudPlatform.service.type.cfw", - "resource_id" : "079ade46-18cd-4917-b7bb-00d402931097", - "resource_size" : 6, - "resource_size_measure_id" : 14, - "resource_spec_code" : "cfw.expack.vpc.professional", - "resource_type" : "cloudPlatform.resource.type.cfw.exp.vpc" - }, { - "cloud_service_type" : "cloudPlatform.service.type.cfw", - "resource_id" : "dd078faa-abfd-4e63-b681-1a93489955b9", - "resource_size" : 1, - "resource_size_measure_id" : 14, - "resource_spec_code" : "cfw.expack.eip.professional", - "resource_type" : "cloudPlatform.resource.type.cfw.exp.eip" - }, { - "cloud_service_type" : "cloudPlatform.service.type.cfw", - "resource_id" : "4d78d523-745d-4d54-a9ca-e6d25e555bde", - "resource_size" : 10, - "resource_size_measure_id" : 36, - "resource_spec_code" : "cfw.expack.bandwidth.professional", - "resource_type" : "cloudPlatform.resource.type.cfw.exp.bandwidth" - } ], - "service_type" : 0, - "status" : 2, - "support_ipv6" : true, - "support_url_filtering" : true - } ], - "total" : 1 - } - } - -Status Codes ------------- - -=========== ========================================================= -Status Code Description -=========== ========================================================= -200 Response to the request for obtaining a firewall instance -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ========================================================= - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/list_job_status.rst b/api-ref/source/api/firewall_management/list_job_status.rst deleted file mode 100644 index bdd40b3..0000000 --- a/api-ref/source/api/firewall_management/list_job_status.rst +++ /dev/null @@ -1,117 +0,0 @@ -:original_name: ListJob.html - -.. _ListJob: - -List Job Status -=============== - -Function --------- - -This API is used to obtain job status. - -URI ---- - -GET /v3/{project_id}/jobs/{job_id} - -.. table:: **Table 1** Path Parameters - - +------------+-----------+--------+------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+==================================================================+ - | project_id | Yes | String | Project ID | - +------------+-----------+--------+------------------------------------------------------------------+ - | job_id | Yes | String | job id,which can be obtained by calling the Create Firewall API. | - +------------+-----------+--------+------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - ========== =========================================== =========== - Parameter Type Description - ========== =========================================== =========== - error_code String Error code - error_msg String Description - data :ref:`data ` object Job Result - ========== =========================================== =========== - -.. _listjob__response_data: - -.. table:: **Table 4** data - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================================================================================================================================================+ - | id | String | Job Id | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Job execution status. Running means the job is being executed, Success means the job is successful, Failed means the job is failed. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **Running** | - | | | | - | | | - **Success** | - | | | | - | | | - **Failed** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_time | String | Creation time, in the format yyyy-mm-ddThh:mm:ssZ. where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | String | End time, in the format "yyyy-mm-ddThh:mm:ssZ". where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Get job status of the job which job id is f588ce71-e26c-400d-8981-f854355f6849 and project id is 09bb24e6fe80d23d2fa2c010b53b418c. - -.. code-block:: - - /v3/09bb24e6fe80d23d2fa2c010b53b418c/jobs/f588ce71-e26c-400d-8981-f854355f6849 - -Example Responses ------------------ - -**Status code: 200** - -Get Job Response - -.. code-block:: - - { - "data" : { - "begin_time" : 1641370501000, - "end_time" : 1641370515000, - "id" : "f588ce71-e26c-400d-8981-f854355f6849", - "status" : "Success" - } - } - -Status Codes ------------- - -=========== ================ -Status Code Description -=========== ================ -200 Get Job Response -=========== ================ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst b/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst index 809f081..71a89c3 100644 --- a/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst +++ b/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst @@ -17,36 +17,36 @@ GET /v1/{project_id}/firewall/east-west .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -55,154 +55,164 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+----------------------------------------------------------------------------------------------------------------+--------------------------------------+ - | Parameter | Type | Description | - +===========+================================================================================================================+======================================+ - | data | :ref:`GetEastWestFirewallResponseBody ` object | Get east west firewall data response | - +-----------+----------------------------------------------------------------------------------------------------------------+--------------------------------------+ + +-----------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ + | Parameter | Type | Description | + +===========+================================================================================================================+==========================================================+ + | data | :ref:`GetEastWestFirewallResponseBody ` object | Returned data for obtaining the east-west firewall list. | + +-----------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------+ .. _listeastwestfirewall__response_geteastwestfirewallresponsebody: .. table:: **Table 5** GetEastWestFirewallResponseBody - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+======================================================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Protection status. The value can be 0 (protection enabled) or 1 (protection disabled). | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | er_associated_subnet | :ref:`SubnetInfo ` object | Information about the subnet associated with ER | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | firewall_associated_subnets | Array of :ref:`SubnetInfo ` objects | Subnet associated with CFW | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | er | :ref:`ErInstance ` object | Information about the associated outbound enterprise router | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inspection_vpc | :ref:`VpcDetail ` object | Monitoring VPC information | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protect_infos | Array of :ref:`EwProtectResourceInfo ` objects | East-west protection resource information | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of protected VPCs | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | String | mode | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ew_vpc_route_limit | Integer | east west vpc route limit | - +-----------------------------+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+======================================================================================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **1** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Integer | Protection status: **0** (enabled), **1** (disabled). | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | er_associated_subnet | :ref:`SubnetInfo ` object | Information about the subnet associated with an enterprise router. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | firewall_associated_subnets | Array of :ref:`SubnetInfo ` objects | Information about the subnet associated with a cloud firewall. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | er | :ref:`ErInstance ` object | Information about the associated enterprise router in the outbound direction. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | inspection_vpc | :ref:`VpcDetail ` object | Information about the traffic diversion VPC. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protect_infos | Array of :ref:`EwProtectResourceInfo ` objects | East-west protected resource information. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Total number of protected VPCs. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | String | Protection mode. Its value is **er**. | + +-----------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listeastwestfirewall__response_subnetinfo: .. table:: **Table 6** SubnetInfo - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================+=========+===========================================================================================+ - | availability_zone | String | availability zone | - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | cidr | String | vpc cidr | - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | name | String | Subnet name | - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | id | String | Subnet ID | - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | gateway_ip | String | Subnet gateway IP address | - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | vpc_id | String | vpc id | - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | status | String | Subnet status | - +-------------------+---------+-------------------------------------------------------------------------------------------+ - | ipv6_enable | Boolean | Whether IPv6 is supported. The value true indicates yes and the value false indicates no. | - +-------------------+---------+-------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================================+ + | availability_zone | String | ID of the AZ where a subnet is located, which is obtained from an endpoint. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ + | cidr | String | Available IP address ranges for subnets in a VPC. | + | | | | + | | | Value ranges: | + | | | | + | | | 10.0.0.0/8-24 | + | | | | + | | | 172.16.0.0/12-24 | + | | | | + | | | 192.168.0.0/16-24 | + | | | | + | | | If **cidr** is not specified, it is left blank by default. | + | | | | + | | | The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ + | name | String | Subnet name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ + | id | String | Subnet ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ + | gateway_ip | String | Subnet gateway. The value is the IP address in the subnet CIDR block **cidr**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ + | vpc_id | String | UUID generated when a VPC is created. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ + | ipv6_enable | Boolean | Whether IPv6 is supported: **true** (yes), **false** (no). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------+ .. _listeastwestfirewall__response_erinstance: .. table:: **Table 7** ErInstance - +-----------------------+--------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========+========================================================================+ - | id | String | ER ID | - +-----------------------+--------+------------------------------------------------------------------------+ - | name | String | ER name | - +-----------------------+--------+------------------------------------------------------------------------+ - | state | String | Er Running status: pending|available|modifying|deleting|deleted|failed | - +-----------------------+--------+------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +-----------------------+--------+------------------------------------------------------------------------+ - | project_id | String | Project ID | - +-----------------------+--------+------------------------------------------------------------------------+ - | enable_ipv6 | String | Whether to enable IPv6 | - +-----------------------+--------+------------------------------------------------------------------------+ - | attachment_id | String | ER attachment ID, connection id between CFW and ER | - +-----------------------+--------+------------------------------------------------------------------------+ + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+===================================================================================================================================================================================================================================================================================================+ + | id | String | Enterprise router ID, which is generated when an enterprise router is created. | + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Enterprise router name. | + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Enterprise router status: **pending**, **available**, **modifying**, **deleting**, or **failed**. | + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_ipv6 | String | Whether to enable IPv6: **true** (yes), **false** (no). | + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attachment_id | String | Connection ID of an enterprise router. This connection is used to connect the firewall and the enterprise router. This field can be used to obtain the connection details on the connection management page after querying a specified enterprise router by its ID on the Enterprise Router page. | + +-----------------------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listeastwestfirewall__response_vpcdetail: .. table:: **Table 8** VpcDetail - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String id - name String Name - cidr String vpc cidr - ========= ====== =========== + +-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+===================================================================================================================================================================================================================================================+ + | id | String | Random UUID generated when a traffic diversion VPC is created. | + +-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Traffic diversion VPC name. | + +-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Available subnet ranges in a VPC. Value ranges: 10.0.0.0/8-24; 172.16.0.0/12-24; and 192.168.0.0/16-24. If **cidr** is not specified, it is left blank by default. Constraint: The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listeastwestfirewall__response_ewprotectresourceinfo: .. table:: **Table 9** EwProtectResourceInfo - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============================+=========+===========================================================================================================================+ - | protected_resource_type | Integer | Protection resource type. The value can be 0 (VPC) or 1 (VGW). | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | protected_resource_name | String | Protected resource name | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | protected_resource_id | String | Protected resource ID | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | protected_resource_nat_name | String | Name of the NAT gateway of the protected resource | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | protected_resource_nat_id | String | ID of the NAT gateway of the protected resource | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | protected_resource_project_id | String | Tenant ID of the protected resource | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | protected_resource_mode | String | protected resource mode | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | The protection status of the protected VPC, 0 indicates that it is associated, and 1 indicates that it is not associated. | - +-------------------------------+---------+---------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============================+=========+========================================================================================+ + | protected_resource_type | Integer | Protected resource type: **0** (VPC), **1** (VGW), **2** (VPN), or **3** (peering). | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | protected_resource_name | String | Protected resource name. | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | protected_resource_id | String | Protected resource ID. | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | protected_resource_nat_name | String | Name of the NAT gateway to be protected. The professional edition supports NAT rules. | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | protected_resource_nat_id | String | ID of the NAT gateway to be protected. The professional edition supports NAT rules. | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | protected_resource_project_id | String | Tenant ID of a protected resource. The firewall supports cross-account protection. | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | protected_resource_mode | String | Protected resource mode. Its value is **er**. | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ + | status | Integer | Protection status of a protected resource: **0** (associated), **1** (not associated). | + +-------------------------------+---------+----------------------------------------------------------------------------------------+ **Status code: 500** .. table:: **Table 10** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Get EastWest Firewall Response +Obtain information about the east-west firewall 80e0f2df-24fd-49c2-8398-11f9a0299b3e whose project ID is 09bb24e6f280d23d0f9fc0104b901480. .. code-block:: - https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0 + https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0&fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e Example Responses ----------------- **Status code: 200** -Get EastWest Firewall Response +Response to the request for querying east-west firewall information. .. code-block:: @@ -275,16 +285,21 @@ Get EastWest Firewall Response Status Codes ------------ -=========== ============================== -Status Code Description -=========== ============================== -200 Get EastWest Firewall Response -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ============================== ++-------------+----------------------------------------------------------------------+ +| Status Code | Description | ++=============+======================================================================+ +| 200 | Response to the request for querying east-west firewall information. | ++-------------+----------------------------------------------------------------------+ +| 400 | Bad Request | ++-------------+----------------------------------------------------------------------+ +| 401 | Unauthorized | ++-------------+----------------------------------------------------------------------+ +| 403 | Forbidden | ++-------------+----------------------------------------------------------------------+ +| 404 | Not Found | ++-------------+----------------------------------------------------------------------+ +| 500 | Internal Server Error | ++-------------+----------------------------------------------------------------------+ Error Codes ----------- diff --git a/api-ref/source/api/firewall_management/obtaining_the_status_of_a_cfw_task.rst b/api-ref/source/api/firewall_management/obtaining_the_status_of_a_cfw_task.rst new file mode 100644 index 0000000..b56d0c9 --- /dev/null +++ b/api-ref/source/api/firewall_management/obtaining_the_status_of_a_cfw_task.rst @@ -0,0 +1,119 @@ +:original_name: ListJob.html + +.. _ListJob: + +Obtaining the Status of a CFW Task +================================== + +Function +-------- + +This API is used to obtain the status of a CFW task. + +URI +--- + +GET /v3/{project_id}/jobs/{job_id} + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+====================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_id | Yes | String | Task ID returned when a pay-per-use firewall is created. You can obtain the task ID by calling the :ref:`API for creating a firewall `. Its value is obtained from **job_id** in the return value. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | Parameter | Type | Description | + +===========+=====================================================================================================+====================================================+ + | data | :ref:`GetCreateFirewallJobResponseData ` object | Data returned for creating a pay-per-use firewall. | + +-----------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+ + +.. _listjob__response_getcreatefirewalljobresponsedata: + +.. table:: **Table 4** GetCreateFirewallJobResponseData + + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================================+ + | id | String | ID of the task for creating a pay-per-use firewall. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Task execution status, which indicates whether a firewall is successfully created. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **Running** | + | | | | + | | | - **Success** | + | | | | + | | | - **Failed** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as **+0800**. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | String | End time in the "yyyy-mm-ddThh:mm:ssZ" format. | + | | | | + | | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as **+0800**. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Obtain information about the f588ce71-e26c-400d-8981-f854355f6849 task for creating a pay-per-use firewall in project 09bb24e6fe80d23d2fa2c010b53b418c. + +.. code-block:: + + https://{Endpoint}/v3/09bb24e6fe80d23d2fa2c010b53b418c/jobs/f588ce71-e26c-400d-8981-f854355f6849 + +Example Responses +----------------- + +**Status code: 200** + +Return value of the API for obtaining the information about a pay-per-use firewall creation task. + +.. code-block:: + + { + "data" : { + "begin_time" : 1641370501000, + "end_time" : 1641370515000, + "id" : "f588ce71-e26c-400d-8981-f854355f6849", + "status" : "Success" + } + } + +Status Codes +------------ + ++-------------+---------------------------------------------------------------------------------------------------+ +| Status Code | Description | ++=============+===================================================================================================+ +| 200 | Return value of the API for obtaining the information about a pay-per-use firewall creation task. | ++-------------+---------------------------------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/querying_firewall_details.rst b/api-ref/source/api/firewall_management/querying_firewall_details.rst new file mode 100644 index 0000000..0fed367 --- /dev/null +++ b/api-ref/source/api/firewall_management/querying_firewall_details.rst @@ -0,0 +1,360 @@ +:original_name: ListFirewallDetail.html + +.. _ListFirewallDetail: + +Querying Firewall Details +========================= + +Function +-------- + +This API is used to query firewall instance details. + +URI +--- + +GET /v1/{project_id}/firewall/exist + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+===========================================================================================================================================================================================================================================================================================================================================================================================+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_type | Yes | Integer | Service type. Currently, only **0** (Internet protection) is supported. | + +-----------------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall instance ID, which is automatically generated by the system after a CFW is created. You can call the :ref:`API for querying firewall instances `. By default, if this parameter is left blank, information about the first firewall under the account is returned. If this parameter is specified, information about the corresponding firewall is returned. | + +-----------------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Firewall name. | + +-----------------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+----------------------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +===========+==============================================================================================+===============================+ + | data | :ref:`GetFirewallInstanceData ` object | Query firewall instance data. | + +-----------+----------------------------------------------------------------------------------------------+-------------------------------+ + +.. _listfirewalldetail__response_getfirewallinstancedata: + +.. table:: **Table 5** GetFirewallInstanceData + + +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+============================================================================================================================+=================================================================================================================================================+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Total number of firewalls. | + +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | records | Array of :ref:`GetFirewallInstanceResponseRecord ` objects | Query the firewall instance list. | + +-----------+----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listfirewalldetail__response_getfirewallinstanceresponserecord: + +.. table:: **Table 6** GetFirewallInstanceResponseRecord + + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+==========================================================================================================+==================================================================================================================================================================================================================================================================================================================+ + | fw_instance_id | String | Firewall instance ID, which is automatically generated by the system after a CFW instance is created. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Firewall name. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ha_type | Integer | Cluster type: **0** (active/standby), **1** (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | Integer | Billing mode: **0** (yearly/monthly), **1** (pay-per-use). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_type | Integer | Firewall protection type. Currently, its value can only be **0** (Internet protection). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_type | Integer | Engine type. Its value can only be **1** (Hillstone engine). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor | :ref:`Flavor ` object | Firewall specifications. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protect_objects | Array of :ref:`ProtectObjectVO ` objects | Protected object list. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Integer | Firewall status: **-1** (waiting for payment), **0** (creating), **1** (deleting), **2** (running), **3** (upgrading), **4** (deleted), **5** (frozen), **6** (creation failed), **7** (deletion failed), **8** (freezing failed), or **9** (being stored), **10** (storage failed), or **11** (upgrade failed). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_old_firewall_instance | Boolean | Whether an engine old: **true** (yes), **false** (no). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_available_obs | Boolean | Whether OBS is supported: **true** (yes), **false** (no). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_support_threat_tags | Boolean | Whether threat intelligence tags are supported: **true** (yes), **false** (no). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | support_ipv6 | Boolean | Whether IPv6 is supported: **true** (yes), **false** (no). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | feature_toggle | Map | Whether a feature is enabled: **true** (yes), **false** (no). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resources | Array of :ref:`FirewallInstanceResource ` objects | Firewall resource list. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_name | String | Firewall name. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Firewall resource ID, which is the same as **fw_instance_id**. | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | support_url_filtering | Boolean | Whether website filtering is supported: **true** (yes), **false** (no). | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | String | Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}". | + +--------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listfirewalldetail__response_flavor: + +.. table:: **Table 7** Flavor + + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+=========+=====================================================================================================================================================================+ + | version | Integer | Firewall version. Its value can only be **1** (professional edition). | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eip_count | Integer | Number of EIPs. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_count | Integer | Number of VPCs. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Bandwidth, in Mbit/s. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_storage | Integer | Log storage, in bytes. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_bandwidth | Integer | Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_eip_count | Integer | Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_log_storage | Integer | Default log storage, in bytes. The default value is **0**. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_vpc_count | Integer | Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listfirewalldetail__response_protectobjectvo: + +.. table:: **Table 8** ProtectObjectVO + + +-------------+---------+---------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+=========+=======================================================================================================================================+ + | object_id | String | Protected object ID. It is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. | + +-------------+---------+---------------------------------------------------------------------------------------------------------------------------------------+ + | object_name | String | Protected object name. | + +-------------+---------+---------------------------------------------------------------------------------------------------------------------------------------+ + | type | Integer | Project type: **0** (north-south), **1** (east-west). | + +-------------+---------+---------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listfirewalldetail__response_firewallinstanceresource: + +.. table:: **Table 9** FirewallInstanceResource + + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+==============================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | resource_id | String | Resource ID. It can be the firewall ID, bandwidth ID, EIP ID, VPC ID, or the ID returned after CBC callback. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cloud_service_type | String | Service type, which is used by CBC. The value is **otc.service.type.cfw**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Resource type.Enumeration values:- **otc.resource.type.cfw** (cloud firewall)- **otc.resource.type.cfw.exp.eip** (EIP)- **otc.resource.type.cfw.exp.bandwidth** (bandwidth)- **otc.resource.type.cfw.exp** (VPC) | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_spec_code | String | Inventory unit code: **cfw.standard** (firewall standard edition), **cfw.professional** (firewall professional edition), **cfw.expack.eip.standard** (EIP standard edition), **cfw.expack.eip.professional** (EIP professional edition), **cfw.expack.bandwidth.standard** (bandwidth basic edition), **cfw.expack.bandwidth.professional** (bandwidth professional edition), or **cfw.expack.vpc.professional** (VPC professional edition). | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_size | Integer | Resource quantity. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_size_measure_id | Integer | Resource unit. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Query the firewall list of project 9d80d070b6d44942af73c9c3d38e0429. + +.. code-block:: + + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/firewall/exist?service_type=0&offset=0&limit=10 + +Example Responses +----------------- + +**Status code: 200** + +Response to the request for obtaining an existing firewall instance. + +.. code-block:: + + { + "data": { + "limit": 10, + "offset": 0, + "records": [ + { + "charge_mode": 0, + "engine_type": 1, + "enterprise_project_id": "default", + "feature_toggle": { + "is_support_anti_virus": true, + "is_support_application": true, + "is_support_tcp_proxy": false, + "is_support_url_profile": true, + "is_support_threat_tags": true, + "is_support_flow_associated_host": false, + "is_support_predefined": true, + "isSupportSession": false, + "is_support_acl_region_config": true, + "is_support_ips": true, + "is_support_ew_create_er_tenant_inspection_mode": false, + "ips_rule_list": true, + "long_connect": true, + "is_support_ew_create_vpc_peering_inspection_mode": true, + "alarm_config": true, + "is_not_support_resource_reduction": false, + "acl_multi_object": true, + "is_support_advanced_ips_rule": true, + "is_support_multi_account": false, + "is_support_capture": true, + "is_support_ew_create_er_bearer_inspection_mode": true + }, + "flavor": { + "bandwidth": 60, + "eip_count": 51, + "log_storage": 0, + "version": 1, + "vpc_count": 8, + "default_eip_count": 20, + "default_vpc_count": 0, + "default_bandwidth": 10, + "default_log_storage": 0 + }, + "tags": "{\"key1234\":\"1234\",\"key122\":\"2222\"}", + "fw_instance_id": "546af3f8-88e9-47f2-a205-2346d7090925", + "fw_instance_name": "test", + "ha_type": 1, + "is_available_obs": false, + "is_old_firewall_instance": false, + "is_support_threat_tags": false, + "name": "1680054140516", + "protect_objects": [ + { + "object_id": "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", + "object_name": "1680054141674", + "type": 0 + }, + { + "object_id": "be83d202-df0b-498d-a96e-41589dc85c86", + "object_name": "ew-1680070626042", + "type": 1 + } + ], + "resource_id": "546af3f8-88e9-47f2-a205-2346d7090925", + "resources": [ + { + "cloud_service_type": "hws.service.type.cfw", + "resource_id": "546af3f8-88e9-47f2-a205-2346d7090925", + "resource_spec_code": "cfw.professional", + "resource_type": "hws.resource.type.cfw" + }, + { + "cloud_service_type": "hws.service.type.cfw", + "resource_id": "0acdd5c7-1178-4bea-b5b6-bd55dc5e2669", + "resource_size": 5, + "resource_size_measure_id": 14, + "resource_spec_code": "cfw.expack.vpc.professional", + "resource_type": "hws.resource.type.cfw.exp.vpc" + }, + { + "cloud_service_type": "hws.service.type.cfw", + "resource_id": "4002620c-916a-49c7-8042-cbe02fc17e61", + "resource_size": 5, + "resource_size_measure_id": 36, + "resource_spec_code": "cfw.expack.bandwidth.professional", + "resource_type": "hws.resource.type.cfw.exp.bandwidth" + }, + { + "cloud_service_type": "hws.service.type.cfw", + "resource_id": "0235c7db-0baa-4c82-8db2-7b8d5108bd86", + "resource_size": 2, + "resource_size_measure_id": 14, + "resource_spec_code": "cfw.expack.eip.professional", + "resource_type": "hws.resource.type.cfw.exp.eip" + }, + { + "cloud_service_type": "hws.service.type.cfw", + "resource_id": "079ade46-18cd-4917-b7bb-00d402931097", + "resource_size": 6, + "resource_size_measure_id": 14, + "resource_spec_code": "cfw.expack.vpc.professional", + "resource_type": "hws.resource.type.cfw.exp.vpc" + }, + { + "cloud_service_type": "hws.service.type.cfw", + "resource_id": "dd078faa-abfd-4e63-b681-1a93489955b9", + "resource_size": 1, + "resource_size_measure_id": 14, + "resource_spec_code": "cfw.expack.eip.professional", + "resource_type": "hws.resource.type.cfw.exp.eip" + }, + { + "cloud_service_type": "hws.service.type.cfw", + "resource_id": "4d78d523-745d-4d54-a9ca-e6d25e555bde", + "resource_size": 10, + "resource_size_measure_id": 36, + "resource_spec_code": "cfw.expack.bandwidth.professional", + "resource_type": "hws.resource.type.cfw.exp.bandwidth" + } + ], + "service_type": 0, + "status": 2, + "support_ipv6": true, + "support_url_filtering": true + } + ], + "total": 1 + } + } + +Status Codes +------------ + ++-------------+----------------------------------------------------------------------+ +| Status Code | Description | ++=============+======================================================================+ +| 200 | Response to the request for obtaining an existing firewall instance. | ++-------------+----------------------------------------------------------------------+ +| 401 | Unauthorized | ++-------------+----------------------------------------------------------------------+ +| 403 | Forbidden | ++-------------+----------------------------------------------------------------------+ +| 404 | Not Found | ++-------------+----------------------------------------------------------------------+ +| 500 | Internal Server Error | ++-------------+----------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/firewall_management/list_firewalls.rst b/api-ref/source/api/firewall_management/querying_the_firewall_list.rst similarity index 58% rename from api-ref/source/api/firewall_management/list_firewalls.rst rename to api-ref/source/api/firewall_management/querying_the_firewall_list.rst index b053a03..4cbe676 100644 --- a/api-ref/source/api/firewall_management/list_firewalls.rst +++ b/api-ref/source/api/firewall_management/querying_the_firewall_list.rst @@ -2,13 +2,13 @@ .. _ListFirewallList: -List Firewalls -============== +Querying the Firewall List +========================== Function -------- -List firewall +This API is used to query a firewall list. URI --- @@ -17,57 +17,57 @@ POST /v1/{project_id}/firewalls/list .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+==========================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=====================================================================+==========================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | key | - +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of :ref:`TagInfo ` objects | tags | - +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=====================================================================+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Query keyword, which can be a firewall ID or part of a firewall name. You can obtain the firewall ID by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`TagInfo ` objects | Tag list, which can be obtained by calling the API for querying tags. The return value is the tag list. | + +-----------------------+-----------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listfirewalllist__request_taginfo: .. table:: **Table 5** TagInfo - ========= ========= ================ =========== + ========= ========= ================ =============== Parameter Mandatory Type Description - ========= ========= ================ =========== - key No String key - values No Array of strings tag values - ========= ========= ================ =========== + ========= ========= ================ =============== + key No String Tag key. + values No Array of strings Tag value list. + ========= ========= ================ =============== Response Parameters ------------------- @@ -76,21 +76,21 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+======================================================================================================================+===================================================================+ - | user_support_eps | Boolean | Whether to enable eps. The options are true (yes) and false (no). | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | has_ndr | Boolean | Whether NDR exists | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | is_support_postpaid | Boolean | Whether postpaid is supported | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | is_support_basic_version | Boolean | Whether basic version is supported | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | is_support_buy_professional | Boolean | Whether professional version firewall is supported to buy | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | data | :ref:`HttpFirewallInstanceListResponseData ` object | query firewall instance list response | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============================+======================================================================================================================+=====================================================================================================================+ + | user_support_eps | Boolean | Whether enterprise projects are supported: **true** (yes), **false** (no). | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | has_ndr | Boolean | Whether NDR exists: **true** (yes), **false** (no). NDR is the original out-of-path firewall and is no longer sold. | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | is_support_postpaid | Boolean | Whether pay-per-use purchase is supported: **true** (yes), **false** (no). | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | is_support_basic_version | Boolean | Whether the basic edition is supported: **true** (yes), **false** (no). | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | is_support_buy_professional | Boolean | Whether the professional edition can be purchased: **true** (yes), **false** (no). | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | data | :ref:`HttpFirewallInstanceListResponseData ` object | Data returned for querying the firewall list. | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ .. _listfirewalllist__response_httpfirewallinstancelistresponsedata: @@ -99,90 +99,74 @@ Response Parameters +------------+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +============+============================================================================================+=================================================================================================================================================+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +------------+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +------------+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | project ID | + | project_id | String | Tenant project ID | +------------+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | total | + | total | Integer | Total number of firewalls. | +------------+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`FirewallInstanceVO ` objects | query firewall isntance list | + | records | Array of :ref:`FirewallInstanceVO ` objects | Query the firewall list. | +------------+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listfirewalllist__response_firewallinstancevo: .. table:: **Table 8** FirewallInstanceVO - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | resource id | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | name | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_name | String | firewall instance name | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ha_type | Integer | ha type | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | Integer | Billing mode 0: Yearly/monthly subscription 1: On-demand | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_type | Integer | service type | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_type | Integer | | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | :ref:`Flavor ` object | flavor | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Firewall status list. The options are as follows: -1: waiting for payment; 0: creating; 1: deleting; 2: running; 3: upgrading; 4: deletion completed; 5: freezing; 6: creation failed; 7: deletion failed; 8: freezing failed; 9: storage in progress; 10: storage failed; 11: upgrade failed | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | String | tags | - +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==========================================================+==================================================================================================================================================================================================================================================================================================================+ + | fw_instance_id | String | Firewall instance ID, which is automatically generated by the system after a CFW instance is created. | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Resource ID, which is the same as the firewall instance ID **fw_instance_id**. | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Firewall creation timestamp. | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_name | String | Firewall name. | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID, which is generated after the enterprise project is supported for a user. | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ha_type | Integer | Cluster type: **0** (active/standby), **1** (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster. | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | Integer | Billing mode: **0** (yearly/monthly), **1** (pay-per-use). | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_type | Integer | Firewall protection type. Currently, its value can only be **0** (Internet protection). | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_type | Integer | Engine type: **0** (self-developed engine), **1** (Hillstone engine), or **3** (TOPSEC engine). | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor | :ref:`Flavor ` object | Firewall specifications. | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Integer | Firewall status: **-1** (waiting for payment), **0** (creating), **1** (deleting), **2** (running), **3** (upgrading), **4** (deleted), **5** (frozen), **6** (creation failed), **7** (deletion failed), **8** (freezing failed), or **9** (being stored), **10** (storage failed), or **11** (upgrade failed). | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | String | Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}". | + +-----------------------+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listfirewalllist__response_flavor: .. table:: **Table 9** Flavor - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+================================================================================================================================+ - | version | Integer | Firewall version. The value can be 0 (standard edition), 1 (professional edition), 2 (platinum edition), or 3 (basic edition). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - | | | | - | | | - **2** | - | | | | - | | | - **3** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | eip_count | Integer | Number of EIPs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | vpc_count | Integer | Number of VPCs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | bandwidth | Integer | Bandwidth | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_storage | Integer | Log storage | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_bandwidth | Integer | default bandwidth | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_eip_count | Integer | default eip count | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_log_storage | Integer | default log storage | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | default_vpc_count | Integer | default vpc count | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+=========+=====================================================================================================================================================================+ + | version | Integer | Firewall version. Its value can only be **1** (professional edition). | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | eip_count | Integer | Number of EIPs. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_count | Integer | Number of VPCs. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Bandwidth, in Mbit/s. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_storage | Integer | Log storage, in bytes. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_bandwidth | Integer | Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_eip_count | Integer | Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_log_storage | Integer | Default log storage, in bytes. The default value is **0**. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_vpc_count | Integer | Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition. | + +---------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- @@ -203,7 +187,7 @@ Example Responses **Status code: 200** -Get Firewall Instance Response +Return value for querying the firewall list. .. code-block:: @@ -248,11 +232,11 @@ Get Firewall Instance Response Status Codes ------------ -=========== ============================== +=========== ============================================ Status Code Description -=========== ============================== -200 Get Firewall Instance Response -=========== ============================== +=========== ============================================ +200 Return value for querying the firewall list. +=========== ============================================ Error Codes ----------- diff --git a/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst b/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst index 67e5d4d..fda9ef1 100644 --- a/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst +++ b/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst @@ -8,7 +8,7 @@ Querying the Number of Protected VPCs Function -------- -This API is used to query protected VPCs. +This API is used to query information about protected VPCs. URI --- @@ -17,34 +17,34 @@ GET /v1/{project_id}/vpcs/protection .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **1** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -53,54 +53,54 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-------------------------------------------------------------------------+--------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================================+================================+ - | data | :ref:`VPCProtectsVo ` object | Return value of VPC protection | - +-----------+-------------------------------------------------------------------------+--------------------------------+ + +-----------+-------------------------------------------------------------------------+-------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+===========================================+ + | data | :ref:`VPCProtectsVo ` object | Return value for querying protected VPCs. | + +-----------+-------------------------------------------------------------------------+-------------------------------------------+ .. _listprotectedvpcs__response_vpcprotectsvo: .. table:: **Table 5** VPCProtectsVo - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ - | Parameter | Type | Description | - +====================+===============================================================================================+============================+ - | total | Integer | Total number of VPCs | - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ - | self_total | Integer | Total number of self VPCs | - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ - | other_total | Integer | Total number of other VPCs | - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ - | protect_vpcs | Array of :ref:`VpcAttachmentDetail ` objects | Protect VPC | - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ - | self_protect_vpcs | Array of :ref:`VpcAttachmentDetail ` objects | Self Protect VPC | - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ - | other_protect_vpcs | Array of :ref:`VpcAttachmentDetail ` objects | Other Protect VPC | - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ - | total_assets | Integer | Total Assets | - +--------------------+-----------------------------------------------------------------------------------------------+----------------------------+ + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================+===============================================================================================+========================================================================================================================================================+ + | total | Integer | Total number of protected VPCs. | + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | self_total | Integer | The firewall can protect VPCs across accounts. **self_total** indicates the total number of protected VPCs in the current project. | + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | other_total | Integer | The east-west firewall protection can protect VPCs across accounts. **other_total** indicates the number of protected VPCs in other projects. | + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protect_vpcs | Array of :ref:`VpcAttachmentDetail ` objects | The east-west firewall protection can protect VPCs across accounts. **protect_vpcs** indicates the list of all protected VPCs. | + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | self_protect_vpcs | Array of :ref:`VpcAttachmentDetail ` objects | The east-west firewall protection can protect VPCs across accounts. **self_protect_vpcs** indicates the list of protected VPCs in the current project. | + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | other_protect_vpcs | Array of :ref:`VpcAttachmentDetail ` objects | The east-west firewall protection can protect VPCs across accounts. **other_protect_vpcs** indicates the list of protected VPCs of other projects. | + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | total_assets | Integer | Total number of VPC assets of a tenant. | + +--------------------+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listprotectedvpcs__response_vpcattachmentdetail: .. table:: **Table 6** VpcAttachmentDetail - ========= ====== =========== + ========= ====== ===================================================== Parameter Type Description - ========= ====== =========== - vpc_id String vpc id - ========= ====== =========== + ========= ====== ===================================================== + vpc_id String ID of a protected VPC added for east-west protection. + ========= ====== ===================================================== **Status code: 500** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- @@ -109,14 +109,14 @@ Query the east-west firewall protection information about the projected object w .. code-block:: - https://{ENDPOINT}/v1/0b2179bbe180d3762fb0c01a2d5725c7/vpcs/protection?object_id=8839526e-b804-4a15-a082-a2c797dce633 + https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/vpcs/protection?object_id=8839526e-b804-4a15-a082-a2c797dce633 Example Responses ----------------- **Status code: 200** -Return value of east-west protection query +Return value of east-west protection query. .. code-block:: @@ -140,22 +140,22 @@ Bad Request { "error_code" : "CFW.00109004", - "error_msg" : "http to external service error" + "error_msg" : "HTTP request error." } Status Codes ------------ -=========== ========================================== +=========== =========================================== Status Code Description -=========== ========================================== -200 Return value of east-west protection query +=========== =========================================== +200 Return value of east-west protection query. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ========================================== +=========== =========================================== Error Codes ----------- diff --git a/api-ref/source/api/index.rst b/api-ref/source/api/index.rst index e58ca88..e5e8cac 100644 --- a/api-ref/source/api/index.rst +++ b/api-ref/source/api/index.rst @@ -8,13 +8,13 @@ API - :ref:`Firewall Management ` - :ref:`EIP Management ` - :ref:`ACL Rule Management ` -- :ref:`Blacklist and Whitelist Management ` -- :ref:`Address Set Management ` -- :ref:`Service Set Management ` -- :ref:`Domain Parse and Domain Set Management ` -- :ref:`IPS Management ` +- :ref:`Blacklist/Whitelist Management ` +- :ref:`Address Group Management ` +- :ref:`Service Group Management ` +- :ref:`Domain Name Resolution and Domain Name Group Management ` +- :ref:`IPS management ` - :ref:`Log Management ` -- :ref:`Capture Management ` +- :ref:`Packet Capture Management ` .. toctree:: :maxdepth: 1 @@ -23,10 +23,10 @@ API firewall_management/index eip_management/index acl_rule_management/index - blacklist_and_whitelist_management/index - address_set_management/index - service_set_management/index - domain_parse_and_domain_set_management/index + blacklist_whitelist_management/index + address_group_management/index + service_group_management/index + domain_name_resolution_and_domain_name_group_management/index ips_management/index log_management/index - capture_management/index + packet_capture_management/index diff --git a/api-ref/source/api/ips_management/switching_the_protection_mode.rst b/api-ref/source/api/ips_management/changing_the_ips_feature_status.rst similarity index 58% rename from api-ref/source/api/ips_management/switching_the_protection_mode.rst rename to api-ref/source/api/ips_management/changing_the_ips_feature_status.rst index fa1ce9c..c22cda6 100644 --- a/api-ref/source/api/ips_management/switching_the_protection_mode.rst +++ b/api-ref/source/api/ips_management/changing_the_ips_feature_status.rst @@ -1,58 +1,62 @@ -:original_name: ChangeIpsProtectMode.html +:original_name: ChangeIpsSwitchStatus.html -.. _ChangeIpsProtectMode: +.. _ChangeIpsSwitchStatus: -Switching the Protection Mode -============================= +Changing the IPS Feature Status +=============================== Function -------- -This API is used to switch the protection mode. +This API is used to enable or disable the feature. URI --- -POST /v1/{project_id}/ips/protect +POST /v1/{project_id}/ips/switch .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | X-Language | No | String | Language header. The default value is **zh-cn**. To use English, set it to **en-us**. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | Yes | Integer | IPS protection mode. 0: observation mode; 1: strict mode; 2: medium mode; 3: loose mode | - +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ips_type | Yes | Integer | Patch type. Its value can only be **2** (virtual patch). | + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Yes | Integer | IPS feature status: **0** (disabled), **1** (enabled). | + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -61,45 +65,35 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+----------------------------------------------------------+-------------+ - | Parameter | Type | Description | - +===========+==========================================================+=============+ - | data | :ref:`data ` object | object | - +-----------+----------------------------------------------------------+-------------+ + +-----------+-----------------------------------------------------------+----------------+ + | Parameter | Type | Description | + +===========+===========================================================+================+ + | data | :ref:`data ` object | Response body. | + +-----------+-----------------------------------------------------------+----------------+ -.. _changeipsprotectmode__response_data: +.. _changeipsswitchstatus__response_data: .. table:: **Table 6** data - ========= ====== =================== + ========= ====== =============== Parameter Type Description - ========= ====== =================== - id String Protected object ID - ========= ====== =================== - -**Status code: 400** - -.. table:: **Table 7** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========= ====== =============== + id String ID information. + ========= ====== =============== Example Requests ---------------- -Deliver the strict protection mode to object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429. +Enable or disable the basic patch and virtual patch of the engine on the user side. The following example shows how to enable the basic patch function for protected object 1530de8a-522d-4771-9067-9fa4e2f53b48 whose project ID is 14181c1245cf4fd786824efe1e2b9388. .. code-block:: - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect + https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { - "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", - "mode" : 1 + "ips_type" : 1, + "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48", + "status" : 1 } Example Responses @@ -107,40 +101,28 @@ Example Responses **Status code: 200** -OK +Return value for changing the IPS feature status. .. code-block:: { "data" : { - "id" : "cfebd347-b655-4b84-b938-3c54317599b2" + "id" : "1530de8a-522d-4771-9067-9fa4e2f53b48" } } -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.0020016", - "error_msg" : "instance status error" - } - Status Codes ------------ -=========== ===================== +=========== ================================================= Status Code Description -=========== ===================== -200 OK -400 Bad Request +=========== ================================================= +200 Return value for changing the IPS feature status. 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ================================================= Error Codes ----------- diff --git a/api-ref/source/api/address_set_management/deleting_an_address_set_member.rst b/api-ref/source/api/ips_management/changing_the_protection_mode.rst similarity index 52% rename from api-ref/source/api/address_set_management/deleting_an_address_set_member.rst rename to api-ref/source/api/ips_management/changing_the_protection_mode.rst index cd17ff4..3e9be1f 100644 --- a/api-ref/source/api/address_set_management/deleting_an_address_set_member.rst +++ b/api-ref/source/api/ips_management/changing_the_protection_mode.rst @@ -1,107 +1,119 @@ -:original_name: DeleteAddressItem.html +:original_name: ChangeIpsProtectMode.html -.. _DeleteAddressItem: +.. _ChangeIpsProtectMode: -Deleting an Address Set Member -============================== +Changing the Protection Mode +============================ Function -------- -This API is used to delete a member from an address group. +This API is used to change the protection mode. URI --- -DELETE /v1/{project_id}/address-items/{item_id} +POST /v1/{project_id}/ips/protect .. table:: **Table 1** Path Parameters - ========== ========= ====== ============================= - Parameter Mandatory Type Description - ========== ========= ====== ============================= - item_id Yes String ID of an address group member - project_id Yes String Project ID - ========== ========= ====== ============================= + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+========================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the :ref:`API for querying a firewall instance `. Note that the value **0** indicates the ID of a protected object on the Internet border, and the value **1** indicates the ID of a protected object on the VPC border. | + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | Yes | Integer | IPS protection mode: **0** (observation mode), **1** (strict mode), 2 (medium mode), or 3 (loose mode). | + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- **Status code: 200** -.. table:: **Table 4** Response body parameters +.. table:: **Table 5** Response body parameters - +-----------+---------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+==============================+ - | data | :ref:`IdObject ` object | delete address item response | - +-----------+---------------------------------------------------------------+------------------------------+ + +-----------+----------------------------------------------------------+----------------+ + | Parameter | Type | Description | + +===========+==========================================================+================+ + | data | :ref:`data ` object | Response body. | + +-----------+----------------------------------------------------------+----------------+ -.. _deleteaddressitem__response_idobject: +.. _changeipsprotectmode__response_data: -.. table:: **Table 5** IdObject +.. table:: **Table 6** data - ========= ====== =========== + ========= ====== =============== Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + ========= ====== =============== + id String ID information. + ========= ====== =============== **Status code: 400** -.. table:: **Table 6** Response body parameters +.. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Delete the address group member whose ID is 65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae from the project whose ID is 9d80d070b6d44942af73c9c3d38e0429. +Set the protection mode to **Interception mode - strict** for the protected object whose ID is cfebd347-b655-4b84-b938-3c54317599b2 in the project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect + + { + "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", + "mode" : 1 + } Example Responses ----------------- **Status code: 200** -Return value for deleting an address group member +Request body for modifying the IPS protection mode. .. code-block:: { "data" : { - "id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae", - "name" : "test" + "id" : "cfebd347-b655-4b84-b938-3c54317599b2" } } @@ -119,16 +131,16 @@ Bad Request Status Codes ------------ -=========== ================================================= +=========== =================================================== Status Code Description -=========== ================================================= -200 Return value for deleting an address group member +=========== =================================================== +200 Request body for modifying the IPS protection mode. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ================================================= +=========== =================================================== Error Codes ----------- diff --git a/api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst b/api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst deleted file mode 100644 index d433e18..0000000 --- a/api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst +++ /dev/null @@ -1,138 +0,0 @@ -:original_name: ChangeIpsSwitchStatus.html - -.. _ChangeIpsSwitchStatus: - -Enabling or Disabling Virtual Patching -====================================== - -Function --------- - -This API is used to enable or disable the feature. - -URI ---- - -POST /v1/{project_id}/ips/switch - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project_id - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ips_type | Yes | Integer | Patch type. Only virtual patch is supported. The value is 2. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **2** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Yes | Integer | IPS switch status, 0: virtual patch is disabled; 1: the virtual patch is enabled; | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - +-----------+-----------------------------------------------------------+-------------+ - | Parameter | Type | Description | - +===========+===========================================================+=============+ - | data | :ref:`data ` object | object | - +-----------+-----------------------------------------------------------+-------------+ - -.. _changeipsswitchstatus__response_data: - -.. table:: **Table 6** data - - ========= ====== =================== - Parameter Type Description - ========= ====== =================== - id String Protected object ID - ========= ====== =================== - -Example Requests ----------------- - -Enable or disable the basic patch and virtual patch of the engine on the user portal. The following example shows how to enable the virtual patch function for project 14181c1245cf4fd786824efe1e2b9388 whose protected object ID is 1530de8a-522d-4771-9067-9fa4e2f53b48. - -.. code-block:: - - https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default - - { - "ips_type" : 2, - "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48", - "status" : 1 - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "data" : { - "id" : "1530de8a-522d-4771-9067-9fa4e2f53b48" - } - } - -Status Codes ------------- - -=========== ===================== -Status Code Description -=========== ===================== -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ===================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/ips_management/index.rst b/api-ref/source/api/ips_management/index.rst index bcda0a7..e9f1bd4 100644 --- a/api-ref/source/api/ips_management/index.rst +++ b/api-ref/source/api/ips_management/index.rst @@ -2,19 +2,19 @@ .. _topic_300000007: -IPS Management +IPS management ============== -- :ref:`Querying the IPS Switch Status ` -- :ref:`Enabling or Disabling Virtual Patching ` -- :ref:`Querying the Protection Mode ` -- :ref:`Switching the Protection Mode ` +- :ref:`Querying the Status of the IPS Feature ` +- :ref:`Changing the IPS Feature Status ` +- :ref:`Querying a Protection Mode ` +- :ref:`Changing the Protection Mode ` .. toctree:: :maxdepth: 1 :hidden: - querying_the_ips_switch_status - enabling_or_disabling_virtual_patching - querying_the_protection_mode - switching_the_protection_mode + querying_the_status_of_the_ips_feature + changing_the_ips_feature_status + querying_a_protection_mode + changing_the_protection_mode diff --git a/api-ref/source/api/ips_management/querying_a_protection_mode.rst b/api-ref/source/api/ips_management/querying_a_protection_mode.rst new file mode 100644 index 0000000..e4e0543 --- /dev/null +++ b/api-ref/source/api/ips_management/querying_a_protection_mode.rst @@ -0,0 +1,125 @@ +:original_name: ListIpsProtectMode.html + +.. _ListIpsProtectMode: + +Querying a Protection Mode +========================== + +Function +-------- + +This API is used to query a protection mode. + +URI +--- + +GET /v1/{project_id}/ips/protect + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+----------------------------------------------------------------------------------------+------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========================================================================================+======================================================+ + | data | :ref:`IpsProtectModeObject ` object | Returned value for querying the IPS protection mode. | + +-----------+----------------------------------------------------------------------------------------+------------------------------------------------------+ + +.. _listipsprotectmode__response_ipsprotectmodeobject: + +.. table:: **Table 5** IpsProtectModeObject + + +-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=========+==============================================================================================================================================================================================================================================================================================================================+ + | id | String | IPS protection mode ID. The value is the ID of the protected object, which can be obtained by calling the :ref:`API for querying a firewall instance `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). | + +-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | Integer | IPS protection mode: **0** (observation mode), **1** (strict mode), 2 (medium mode), or 3 (loose mode). | + +-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +Query the IPS protection mode of project 9d80d070b6d44942af73c9c3d38e0429. + +.. code-block:: + + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2 + +Example Responses +----------------- + +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.0020016", + "error_msg" : "Incorrect instance status." + } + +Status Codes +------------ + +=========== ======================================== +Status Code Description +=========== ======================================== +200 Return value for a protection mode query +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ======================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/ips_management/querying_the_ips_switch_status.rst b/api-ref/source/api/ips_management/querying_the_ips_switch_status.rst deleted file mode 100644 index 97b7e24..0000000 --- a/api-ref/source/api/ips_management/querying_the_ips_switch_status.rst +++ /dev/null @@ -1,116 +0,0 @@ -:original_name: ListIpsSwitchStatus.html - -.. _ListIpsSwitchStatus: - -Querying the IPS Switch Status -============================== - -Function --------- - -This API is used to query the IPS switch status. - -URI ---- - -GET /v1/{project_id}/ips/switch - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project_id - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+-----------------------------------------------------------------------------------------+---------------------+ - | Parameter | Type | Description | - +===========+=========================================================================================+=====================+ - | data | :ref:`IpsSwitchResponseDTO ` object | ips switch response | - +-----------+-----------------------------------------------------------------------------------------+---------------------+ - -.. _listipsswitchstatus__response_ipsswitchresponsedto: - -.. table:: **Table 5** IpsSwitchResponseDTO - - ====================== ======= ==================== - Parameter Type Description - ====================== ======= ==================== - id String Ips switch id - basic_defense_status Integer Basic defense status - virtual_patches_status Integer Virtual patch status - ====================== ======= ==================== - -Example Requests ----------------- - -Query the patch status of the current user based on the received user ID 14181c1245cf4fd786824efe1e2b9388 and load the virtual patch on the intrusion prevention page. - -.. code-block:: - - https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "data" : { - "basic_defense_status" : 1, - "id" : "cefe80aa-83e4-4308-99aa-f9b6c816de00", - "virtual_patches_status" : 0 - } - } - -Status Codes ------------- - -=========== ===================== -Status Code Description -=========== ===================== -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ===================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/capture_management/list_capture_task_result.rst b/api-ref/source/api/ips_management/querying_the_status_of_the_ips_feature.rst similarity index 57% rename from api-ref/source/api/capture_management/list_capture_task_result.rst rename to api-ref/source/api/ips_management/querying_the_status_of_the_ips_feature.rst index 64ef828..a75345f 100644 --- a/api-ref/source/api/capture_management/list_capture_task_result.rst +++ b/api-ref/source/api/ips_management/querying_the_status_of_the_ips_feature.rst @@ -1,54 +1,50 @@ -:original_name: ListCaptureResult.html +:original_name: ListIpsSwitchStatus.html -.. _ListCaptureResult: +.. _ListIpsSwitchStatus: -list capture task result -======================== +Querying the Status of the IPS Feature +====================================== Function -------- -list capture result +This API is used to query the status of the IPS feature. URI --- -GET /v1/{project_id}/capture-task/capture-result +GET /v1/{project_id}/ips/switch .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | capture task id | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Whether to specify a public IP address for downloading, 0: unlimited, 1: specify a public IP address for downloading | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip | No | Array | specified public ip address | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. Here, a protected object ID whose **type** is **0** is used. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -57,86 +53,64 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-----------------------------------------------------------------------------------+-----------------------+ - | Parameter | Type | Description | - +===========+===================================================================================+=======================+ - | data | :ref:`CaptureResultUrlVO ` object | capture result url vo | - +-----------+-----------------------------------------------------------------------------------+-----------------------+ + +-----------+-----------------------------------------------------------------------------------------+---------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================================+=============================================+ + | data | :ref:`IpsSwitchResponseDTO ` object | Returned value for querying the IPS switch. | + +-----------+-----------------------------------------------------------------------------------------+---------------------------------------------+ -.. _listcaptureresult__response_captureresulturlvo: +.. _listipsswitchstatus__response_ipsswitchresponsedto: -.. table:: **Table 5** CaptureResultUrlVO +.. table:: **Table 5** IpsSwitchResponseDTO - +----------------+-------------------------------------------------------------------------------+--------------------------+ - | Parameter | Type | Description | - +================+===============================================================================+==========================+ - | captcha | String | captcha | - +----------------+-------------------------------------------------------------------------------+--------------------------+ - | expires | Long | download url expire time | - +----------------+-------------------------------------------------------------------------------+--------------------------+ - | file_list | Array of :ref:`CaptureFile ` objects | capture file list | - +----------------+-------------------------------------------------------------------------------+--------------------------+ - | request_header | :ref:`HostHeaderInfo ` object | request header | - +----------------+-------------------------------------------------------------------------------+--------------------------+ - | url | String | download url | - +----------------+-------------------------------------------------------------------------------+--------------------------+ - -.. _listcaptureresult__response_capturefile: - -.. table:: **Table 6** CaptureFile - - ========= ====== ============ - Parameter Type Description - ========= ====== ============ - file_name String file name - url String download url - file_path String file path - ========= ====== ============ - -.. _listcaptureresult__response_hostheaderinfo: - -.. table:: **Table 7** HostHeaderInfo - - ========= ====== ================ - Parameter Type Description - ========= ====== ================ - Host String host header info - ========= ====== ================ + +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=========+============================================================================================================================================================================================================================================================================================================================================+ + | id | String | IPS switch ID. The value is the ID of the protected object at the Internet border, which can be obtained by calling the :ref:`API for querying a firewall instance `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). | + +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | basic_defense_status | Integer | Basic defense status: **0** (disabled), **1** (enabled). | + +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | virtual_patches_status | Integer | Virtual patch status: **0** (disabled), **1** (enabled). | + +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- -Query the packet capture task with project ID 09bb24e6fe80d23d2fa2c010b53b418c and firewall ID ebf891cd-2163-48a0-9963-6309f99dd3c4. +Query the patch status of the current user based on the user ID 14181c1245cf4fd786824efe1e2b9388 and load the virtual patch status on the intrusion prevention page. .. code-block:: - https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/capture-result?fw_instance_id=14f99b45-47df-4e40-aa5d-cf3700ce9c8b&enterprise_project_id=default&task_id=ea47d7f9-8b93-45de-978d-b4bf0613cfed&type=0 + https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2 Example Responses ----------------- **Status code: 200** -get capture result +Return value for querying the IPS switch. .. code-block:: { "data" : { - "captcha" : "696821", - "expires" : 30, - "url" : "testurl" + "basic_defense_status" : 1, + "id" : "cefe80aa-83e4-4308-99aa-f9b6c816de00", + "virtual_patches_status" : 0 } } Status Codes ------------ -=========== ================== +=========== ========================================= Status Code Description -=========== ================== -200 get capture result -=========== ================== +=========== ========================================= +200 Return value for querying the IPS switch. +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ========================================= Error Codes ----------- diff --git a/api-ref/source/api/log_management/add_log_config.rst b/api-ref/source/api/log_management/add_log_config.rst deleted file mode 100644 index 45ca4aa..0000000 --- a/api-ref/source/api/log_management/add_log_config.rst +++ /dev/null @@ -1,127 +0,0 @@ -:original_name: AddLogConfig.html - -.. _AddLogConfig: - -Add Log Config -============== - -Function --------- - -This API is used to add log config. - -URI ---- - -POST /v1/{project_id}/cfw/logs/configuration - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_enable | Yes | Integer | whether to enable LTS | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_log_group_id | Yes | String | Lts log group id, which can be obtained by calling the Querying All Log Groups of an Account API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_attack_log_stream_id | No | String | Lts attack log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_attack_log_stream_enable | Yes | Integer | whether to enable attack log streaming | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_access_log_stream_id | No | String | Lts access log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_access_log_stream_enable | Yes | Integer | whether to enable access log streaming | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_flow_log_stream_id | No | String | Lts flow log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_flow_log_stream_enable | Yes | Integer | whether to enable flow log streaming | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - ========= ====== ==================== - Parameter Type Description - ========= ====== ==================== - data String Firewall instance Id - ========= ====== ==================== - -Example Requests ----------------- - -Add a log flow configuration to the firewall whose firewall instance id is 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 and project id is 408972e72dcd4c1a9b033e955802a36b with LTS group ID 20282428-a8f9-4e75-8246-165e64cf8ba8, and the access control log flow is disabled, the traffic log flow is disabled, the attack log flow is disabled, and the LTS is disabled. - -.. code-block:: - - https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4d6c860a-0338-49e8-ac64-fcaeb4182ba5&enterprise_project_id=default - - { - "fw_instance_id" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5", - "lts_enable" : 0, - "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8", - "lts_attack_log_stream_enable" : 0, - "lts_access_log_stream_enable" : 0, - "lts_flow_log_stream_enable" : 0 - } - -Example Responses ------------------ - -**Status code: 200** - -Add Log Config Response - -.. code-block:: - - { - "data" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5" - } - -Status Codes ------------- - -=========== ======================= -Status Code Description -=========== ======================= -200 Add Log Config Response -=========== ======================= - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/log_management/adding_log_configurations.rst b/api-ref/source/api/log_management/adding_log_configurations.rst new file mode 100644 index 0000000..75b0ccb --- /dev/null +++ b/api-ref/source/api/log_management/adding_log_configurations.rst @@ -0,0 +1,127 @@ +:original_name: AddLogConfig.html + +.. _AddLogConfig: + +Adding Log Configurations +========================= + +Function +-------- + +This API is used to add log configurations. + +URI +--- + +POST /v1/{project_id}/cfw/logs/configuration + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============================+===========+=========+============================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_enable | Yes | Integer | Whether to enable LTS: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_log_group_id | Yes | String | Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in **log_groups.log_group_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_attack_log_stream_id | No | String | Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_attack_log_stream_enable | Yes | Integer | Whether to enable the attack log stream: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_access_log_stream_id | No | String | Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_access_log_stream_enable | Yes | Integer | Whether to enable the access control stream: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_flow_log_stream_id | No | String | Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_flow_log_stream_enable | Yes | Integer | Whether to enable the traffic log function: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+===============================================================================================================================================================+ + | data | String | Return value for adding log configurations. The value is the firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Add log stream configurations for firewall 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 in project 408972e72dcd4c1a9b033e955802a36b. The LTS group ID is 20282428-a8f9-4e75-8246-165e64cf8ba8. The access control log stream, traffic log stream, attack log stream, and LTS are disabled. + +.. code-block:: + + https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4d6c860a-0338-49e8-ac64-fcaeb4182ba5&enterprise_project_id=default + + { + "fw_instance_id" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5", + "lts_enable" : 0, + "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8", + "lts_attack_log_stream_enable" : 0, + "lts_access_log_stream_enable" : 0, + "lts_flow_log_stream_enable" : 0 + } + +Example Responses +----------------- + +**Status code: 200** + +Return value for adding log configurations. + +.. code-block:: + + { + "data" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5" + } + +Status Codes +------------ + +=========== =========================================== +Status Code Description +=========== =========================================== +200 Return value for adding log configurations. +=========== =========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/log_management/index.rst b/api-ref/source/api/log_management/index.rst index 6ffee16..e523afa 100644 --- a/api-ref/source/api/log_management/index.rst +++ b/api-ref/source/api/log_management/index.rst @@ -5,9 +5,9 @@ Log Management ============== -- :ref:`List Log Config ` -- :ref:`Add Log Config ` -- :ref:`Update Log Config ` +- :ref:`Obtaining Log Configurations ` +- :ref:`Adding Log Configurations ` +- :ref:`Updating Log Configurations ` - :ref:`Querying Flow Logs ` - :ref:`Querying Access Control Logs ` - :ref:`Querying Attack Logs ` @@ -16,9 +16,9 @@ Log Management :maxdepth: 1 :hidden: - list_log_config - add_log_config - update_log_config + obtaining_log_configurations + adding_log_configurations + updating_log_configurations querying_flow_logs querying_access_control_logs querying_attack_logs diff --git a/api-ref/source/api/log_management/obtaining_log_configurations.rst b/api-ref/source/api/log_management/obtaining_log_configurations.rst new file mode 100644 index 0000000..7727385 --- /dev/null +++ b/api-ref/source/api/log_management/obtaining_log_configurations.rst @@ -0,0 +1,127 @@ +:original_name: ListLogConfig.html + +.. _ListLogConfig: + +Obtaining Log Configurations +============================ + +Function +-------- + +This API is used to obtain log configurations. + +URI +--- + +GET /v1/{project_id}/cfw/logs/configuration + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+-------------------------------------------------------------------+---------------------+ + | Parameter | Type | Description | + +===========+===================================================================+=====================+ + | data | :ref:`LogConfigDto ` object | Log configurations. | + +-----------+-------------------------------------------------------------------+---------------------+ + +.. _listlogconfig__response_logconfigdto: + +.. table:: **Table 5** LogConfigDto + + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============================+=========+============================================================================================================================================================================================================================================================+ + | fw_instance_id | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_enable | Integer | Whether to enable LTS: **true** (yes), **false** (no). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_log_group_id | String | Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in **log_groups.log_group_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_attack_log_stream_id | String | Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_attack_log_stream_enable | Integer | Whether to enable the attack log stream: **true** (yes), **false** (no). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_access_log_stream_id | String | Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_access_log_stream_enable | Integer | Whether to enable the access control stream: **true** (yes), **false** (no). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_flow_log_stream_id | String | Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_flow_log_stream_enable | Integer | Whether to enable the traffic log function: **true** (yes), **false** (no). | + +------------------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Query the log configuration of the firewall 4e113415-7811-4bb3-bf5e-eb835953f7d4 in project 408972e72dcd4c1a9b033e955802a36b. + +.. code-block:: + + https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default + +Example Responses +----------------- + +**Status code: 200** + +Return value for querying log configurations. + +.. code-block:: + + { + "data" : { + "fw_instance_id" : "4df2bcd1-6299-4fba-8e71-8d50ea807090", + "lts_access_log_stream_enable" : 0, + "lts_attack_log_stream_enable" : 0, + "lts_enable" : 0, + "lts_flow_log_stream_enable" : 0, + "lts_log_group_id" : "d783ce42-7f56-4c2d-9a96-b1043d016f5a" + } + } + +Status Codes +------------ + +=========== ============================================= +Status Code Description +=========== ============================================= +200 Return value for querying log configurations. +=========== ============================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/log_management/querying_access_control_logs.rst b/api-ref/source/api/log_management/querying_access_control_logs.rst index fcfd659..9c03300 100644 --- a/api-ref/source/api/log_management/querying_access_control_logs.rst +++ b/api-ref/source/api/log_management/querying_access_control_logs.rst @@ -17,86 +17,78 @@ GET /v1/{project_id}/cfw/logs/access-control .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_id | No | String | Rule ID | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Yes | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Yes | Long | End time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_ip | No | String | Source IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_port | No | Integer | Source port | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_ip | No | String | Destination IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_port | No | Integer | Destination port | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Protocol types, including TCP, UDP, ICMP, ICMPV6, etc. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app | No | String | Application protocol | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | No | String | Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_date | No | Integer | The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_type | No | String | Log type | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **internet** | - | | | | | - | | | | - **nat** | - | | | | | - | | | | - **vpc** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_host | No | String | destination host | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_name | No | String | rule name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action | No | String | Action. including allow and deny | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_name | No | String | source region name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_name | No | String | destination region name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_province_name | No | String | source province name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_province_name | No | String | destination province name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_city_name | No | String | source city name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_city_name | No | String | destination city name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_id | No | String | Rule ID, which can be obtained by calling the :ref:`API for querying protection rules `. Find the value in **data.records.rule_id** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | start_time | Yes | Long | Start time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | Yes | Long | End time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_ip | No | String | Source IP address. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_port | No | Integer | Source port. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_ip | No | String | Destination IP address. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_port | No | Integer | Destination port. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | Protocol type. Its value can be **TCP**, **UDP**, **ICMP**, or **ICMPv6**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app | No | String | Rule application type. Its value can be **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, **IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_id | No | String | Document ID. For the first page, its value is null. For other pages, its value can be the **log_id** of the last record in the last query. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | next_date | No | Integer | Next date. For the first page, its value is null. For other pages, its value can be the **start_time** of the last record in the last query. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_type | No | String | Log type. Its value can be **internet**, **vpc**, or **nat**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_host | No | String | Destination host. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_name | No | String | Rule name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action | No | String | Action. Its value can be **permit** or **deny**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | No | String | Source region name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | No | String | Destination region name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | No | String | Source province name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | No | String | Destination province name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | No | String | Source city name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | No | String | Destination city name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -105,92 +97,92 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-----------------------------------------------------------+------------------------------------------------+ - | Parameter | Type | Description | - +===========+===========================================================+================================================+ - | data | :ref:`data ` object | Data returned for querying access control logs | - +-----------+-----------------------------------------------------------+------------------------------------------------+ + +-----------+-----------------------------------------------------------+-------------------------------------------------+ + | Parameter | Type | Description | + +===========+===========================================================+=================================================+ + | data | :ref:`data ` object | Returned data for querying access control logs. | + +-----------+-----------------------------------------------------------+-------------------------------------------------+ .. _listaccesscontrollogs__response_data: .. table:: **Table 5** data - +-----------+---------------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+===========================================================================+===============================================================+ - | total | Integer | Returned quantity | - +-----------+---------------------------------------------------------------------------+---------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+---------------------------------------------------------------------------+---------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Record | - +-----------+---------------------------------------------------------------------------+---------------------------------------------------------------+ + +-----------+---------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===========================================================================+============================================================================+ + | total | Integer | Query the total number of access control logs. | + +-----------+---------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+---------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | Query access control logs. | + +-----------+---------------------------------------------------------------------------+----------------------------------------------------------------------------+ .. _listaccesscontrollogs__response_records: .. table:: **Table 6** records - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================+=========+==================================================================================================================================================================================================================+ - | action | String | Action. 0: allow; 1: deny | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_name | String | Rule name | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_id | String | Rule ID | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hit_time | Long | Hit time, a timestamp in milliseconds, such as 1718936272648 | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_id | String | source region id | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_name | String | source region name | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_id | String | destination region id | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_name | String | destination region name | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | String | Document ID | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_ip | String | Source IP address | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_port | Integer | Source port | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_ip | String | Destination IP address | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_port | Integer | Destination port | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app | String | Application protocol | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_host | String | destination host | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_province_id | String | source province id | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_province_name | String | source province name | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_city_id | String | source city id | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_city_name | String | source city name | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_province_id | String | destination province id | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_province_name | String | destination province name | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_city_id | String | destination city id | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_city_name | String | destination city name | - +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+=========+============================================================================================================================================================================================================================+ + | action | String | Action: **0** (allow), **1** (deny). | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_name | String | Rule name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_id | String | Rule ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | hit_time | Long | Hit time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_id | String | Source region ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | String | Source region name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_id | String | Destination region ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | String | Destination region name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_id | String | Document ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_ip | String | Source IP address. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_port | Integer | Source port. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_ip | String | Destination IP address. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_port | Integer | Destination port. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app | String | Rule application type. Its value can be **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, **IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_host | String | Destination host. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_id | String | Source province ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | String | Source province name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_id | String | Source city ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | String | Source city name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_id | String | Destination province ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | String | Destination province name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_id | String | Destination city ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | String | Destination city name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- @@ -206,7 +198,7 @@ Example Responses **Status code: 200** -OK +Return value for querying access control logs. .. code-block:: @@ -229,10 +221,10 @@ OK "src_province_name" : "source province name", "src_city_id" : "source city id", "src_city_name" : "source city name", - "dst_province_id" : "destination province id", - "dst_province_name" : "destination province name", - "dst_city_id" : "destination city id", - "dst_city_name" : "destination city name" + "dst_province_id" : "dst province id", + "dst_province_name" : "dst province name", + "dst_city_id" : "dst city id", + "dst_city_name" : "dst city name" } ], "total" : 1 } @@ -246,22 +238,22 @@ Bad Request { "error_code" : "CFW.00500002", - "error_msg" : "time range error" + "error_msg" : "Invalid interval." } Status Codes ------------ -=========== ===================== +=========== ============================================== Status Code Description -=========== ===================== -200 OK +=========== ============================================== +200 Return value for querying access control logs. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ============================================== Error Codes ----------- diff --git a/api-ref/source/api/log_management/querying_attack_logs.rst b/api-ref/source/api/log_management/querying_attack_logs.rst index ca07157..38d932d 100644 --- a/api-ref/source/api/log_management/querying_attack_logs.rst +++ b/api-ref/source/api/log_management/querying_attack_logs.rst @@ -17,102 +17,84 @@ GET /v1/{project_id}/cfw/logs/attack .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================+ - | start_time | Yes | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Yes | Long | End time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_ip | No | String | Source IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_port | No | Integer | Source port number | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **65535** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_ip | No | String | Destination IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_port | No | Integer | Destination port number | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **65535** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Protocol types, including TCP, UDP, ICMP, ICMPV6, etc. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app | No | String | Application protocol | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | No | String | Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_date | No | Long | The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action | No | String | Action. including allow and deny | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | String | Direction. including in2out and out2in | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | attack_type | No | String | Intrusion event type | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | attack_rule | No | String | Intrusion event rule, Including CRITICAL,HIGH,MEDIUM,LOW. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | level | No | String | Threat level | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | No | String | Source | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_host | No | String | destination host | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_type | No | String | log_type | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **internet** | - | | | | | - | | | | - **nat** | - | | | | | - | | | | - **vpc** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | attack_rule_id | No | String | attack rule id | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_name | No | String | source region name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_name | No | String | destination region name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_province_name | No | String | source province name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_province_name | No | String | destination province name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_city_name | No | String | source city name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_city_name | No | String | destination city name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | start_time | Yes | Long | Start time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | Yes | Long | End time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_ip | No | String | Source IP address. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_port | No | Integer | Source port. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_ip | No | String | Destination IP address. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_port | No | Integer | Destination port. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | Protocol type. Its value can be **TCP**, **UDP**, **ICMP**, or **ICMPv6**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app | No | String | Rule application type. Its value can be **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, **IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_id | No | String | Document ID. For the first page, its value is null. For other pages, its value can be the **log_id** of the last record in the last query. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | next_date | No | Long | Next date. For the first page, its value is null. For other pages, its value can be the **event_time** of the last record in the last query. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action | No | String | Action. Its value can be **permit** or **deny**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | No | String | Direction. Its value can be **in2out** or **out2in**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attack_type | No | String | Intrusion event type. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attack_rule | No | String | Intrusion event rule. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | level | No | String | Threat level. Its value can be **CRITICAL**, **HIGH**, **MEDIUM**, or **LOW**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_host | No | String | Destination host. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_type | No | String | Log type. Its value can be **internet**, **vpc**, or **nat**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attack_rule_id | No | String | Intrusion event ID. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | No | String | Source region name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | No | String | Destination region name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | No | String | Source province name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | No | String | Destination province name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | No | String | Source city name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | No | String | Destination city name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -121,132 +103,118 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+----------------------------------------------------+----------------------------------+ - | Parameter | Type | Description | - +===========+====================================================+==================================+ - | data | :ref:`data ` object | Return value of attack log query | - +-----------+----------------------------------------------------+----------------------------------+ + +-----------+----------------------------------------------------+----------------------------------------+ + | Parameter | Type | Description | + +===========+====================================================+========================================+ + | data | :ref:`data ` object | Return value for querying attack logs. | + +-----------+----------------------------------------------------+----------------------------------------+ .. _listattacklogs__response_data: .. table:: **Table 5** data - +-----------+--------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+====================================================================+===============================================================+ - | total | Integer | Returned quantity | - +-----------+--------------------------------------------------------------------+---------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+--------------------------------------------------------------------+---------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Record | - +-----------+--------------------------------------------------------------------+---------------------------------------------------------------+ + +-----------+--------------------------------------------------------------------+----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+====================================================================+============================================================================+ + | total | Integer | Total number of returned attack data records. | + +-----------+--------------------------------------------------------------------+----------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+--------------------------------------------------------------------+----------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | Attack log list. | + +-----------+--------------------------------------------------------------------+----------------------------------------------------------------------------+ .. _listattacklogs__response_records: .. table:: **Table 6** records - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+================================================================+ - | direction | String | Direction, which can be inbound or outbound | - | | | | - | | | Enumeration values: | - | | | | - | | | - **out2in** | - | | | | - | | | - **in2out** | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | action | String | Action | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | event_time | Long | Event time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | attack_type | String | Attack type | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | attack_rule | String | Attack rule | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | level | String | Threat level | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | source | String | Source | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | packet_length | Long | Packet length | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | attack_rule_id | String | Attack rule ID | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | hit_time | Integer | Hit time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | log_id | String | Log ID | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_ip | String | Source IP address | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_port | Integer | Source port | - | | | | - | | | Minimum: **0** | - | | | | - | | | Maximum: **65535** | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_ip | String | Destination IP address | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_port | Integer | Destination port | - | | | | - | | | Minimum: **0** | - | | | | - | | | Maximum: **65535** | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | protocol | String | Protocol | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | packet | String | Attack log packet | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | app | String | Application protocol | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | packetMessages | Array of :ref:`PacketMessage ` objects | packet message | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_region_id | String | source region id | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_region_name | String | source region name | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_region_id | String | destination region id | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_region_name | String | destination region name | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_province_id | String | source province id | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_province_name | String | source province name | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_city_id | String | source city id | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | src_city_name | String | source city name | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_province_id | String | destination province id | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_province_name | String | destination province name | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_city_id | String | destination city id | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ - | dst_city_name | String | destination city name | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+================================================================================+============================================================================================================================================================================================================+ + | direction | String | Direction. Its value can be **in2out** or **out2in**. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action | String | Action. Its value can be **permit** or **deny**. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | event_time | Long | Event time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attack_type | String | Attack type. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attack_rule | String | Attack rule. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | level | String | Threat level. Its value can be **CRITICAL**, **HIGH**, **MEDIUM**, or **LOW**. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source | String | Source. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | packet_length | Long | Packet length. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attack_rule_id | String | Attack rule ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | hit_time | Long | Hit time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_id | String | Log ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_ip | String | Source IP address. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_port | Integer | Source port. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_ip | String | Destination IP address. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_port | Integer | Destination port. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Protocol type. Its value can be **TCP**, **UDP**, **ICMP**, or **ICMPv6**. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | packet | String | Attack log packet. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app | String | Rule application type. Its value can be **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, **IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | packetMessages | Array of :ref:`PacketMessage ` objects | Attack packet information. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_id | String | Source region ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | String | Source region name. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_id | String | Destination region ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | String | Destination region name. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_id | String | Source province ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | String | Source province name. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_id | String | Source city ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | String | Source city name. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_id | String | Destination province ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | String | Destination province name. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_id | String | Destination city ID. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | String | Destination city name. | + +-------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listattacklogs__response_packetmessage: .. table:: **Table 7** PacketMessage - =========== ================ =========== + =========== ================ ============================ Parameter Type Description - =========== ================ =========== - hex_index String hex index - hexs Array of strings hexs - utf8_String String utf8 string - =========== ================ =========== + =========== ================ ============================ + hex_index String Hexadecimal index. + hexs Array of strings Hexadecimal number sequence. + utf8_String String UTF-8 string. + =========== ================ ============================ **Status code: 400** .. table:: **Table 8** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- @@ -262,7 +230,7 @@ Example Responses **Status code: 200** -OK +Return value for querying attack logs. .. code-block:: @@ -293,7 +261,7 @@ OK }, { "hex_index" : "00000020", "hexs" : [ "94", "31", "c4", "d0", "1f", "90", "74", "c1", "d6", "b3", "f3", "cf", "3e", "ba", "80", "18" ], - "utf8_String" : ".1..\u001F.t.ֳ..>..." + "utf8_String" : ".1..?.t.ֳ..>..." }, { "hex_index" : "00000030", "hexs" : [ "00", "e5", "72", "35", "00", "00", "01", "01", "08", "0a", "3a", "e6", "8a", "45", "5b", "f4" ], @@ -324,10 +292,10 @@ OK "src_province_name" : "source province name", "src_city_id" : "source city id", "src_city_name" : "source city name", - "dst_province_id" : "destination province id", - "dst_province_name" : "destination province name", - "dst_city_id" : "destination city id", - "dst_city_name" : "destination city name" + "dst_province_id" : "dst province id", + "dst_province_name" : "dst province name", + "dst_city_id" : "dst city id", + "dst_city_name" : "dst city name" } ], "total" : 1 } @@ -341,22 +309,22 @@ Bad Request { "error_code" : "00500002", - "error_msg" : "time range error" + "error_msg" : "Invalid interval." } Status Codes ------------ -=========== ===================== +=========== ====================================== Status Code Description -=========== ===================== -200 OK +=========== ====================================== +200 Return value for querying attack logs. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ====================================== Error Codes ----------- diff --git a/api-ref/source/api/log_management/querying_flow_logs.rst b/api-ref/source/api/log_management/querying_flow_logs.rst index 92ed470..900609d 100644 --- a/api-ref/source/api/log_management/querying_flow_logs.rst +++ b/api-ref/source/api/log_management/querying_flow_logs.rst @@ -17,94 +17,74 @@ GET /v1/{project_id}/cfw/logs/flow .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | String | direction, including in2out and out2in | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_type | No | String | Log type | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **internet** | - | | | | | - | | | | - **vpc** | - | | | | | - | | | | - **nat** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Yes | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Yes | Long | End time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_ip | No | String | Source IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_port | No | Integer | Source port | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **65535** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_ip | No | String | Destination IP address | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_port | No | Integer | Destination port | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **65535** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Protocol types, including TCP, UDP, ICMP, ICMPV6, etc. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app | No | String | Application protocol | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | No | String | Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_date | No | Long | The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **1024** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_host | No | String | destination host | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_name | No | String | source region name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_name | No | String | destination region name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_province_name | No | String | source province name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_province_name | No | String | destination province name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_city_name | No | String | source city name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_city_name | No | String | destination city name | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | No | String | Direction. Its value can be **in2out** or **out2in**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_type | No | String | Log type. Its value can be **internet**, **vpc**, or **nat**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | start_time | Yes | Long | Start time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | Yes | Long | End time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_ip | No | String | Source IP address. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_port | No | Integer | Source port. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_ip | No | String | Destination IP address. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_port | No | Integer | Destination port. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | Protocol type. Its value can be **TCP**, **UDP**, **ICMP**, or **ICMPv6**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app | No | String | Rule application type. Its value can be **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, **IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_id | No | String | Document ID. For the first page, its value is null. For other pages, its value can be the **log_id** of the last record in the last query. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | next_date | No | Long | Next date. For the first page, its value is null. For other pages, its value can be the **start_time** of the last record in the last query. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_host | No | String | Destination host. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | No | String | Source region name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | No | String | Destination region name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | No | String | Source province name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | No | String | Destination province name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | No | String | Source city name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | No | String | Destination city name. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -113,100 +93,94 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+--------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +===========+==================================================+===================================+ - | data | :ref:`data ` object | Value returned for flow log query | - +-----------+--------------------------------------------------+-----------------------------------+ + +-----------+--------------------------------------------------+--------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================+======================================+ + | data | :ref:`data ` object | Return value for querying flow logs. | + +-----------+--------------------------------------------------+--------------------------------------+ .. _listflowlogs__response_data: .. table:: **Table 5** data - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================================================================+===============================================================+ - | total | Integer | Returned quantity | - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Record | - +-----------+------------------------------------------------------------------+---------------------------------------------------------------+ + +-----------+------------------------------------------------------------------+----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================================================================+============================================================================+ + | total | Integer | Total number of returned records for querying flow logs. | + +-----------+------------------------------------------------------------------+----------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------+------------------------------------------------------------------+----------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | Record. | + +-----------+------------------------------------------------------------------+----------------------------------------------------------------------------+ .. _listflowlogs__response_records: .. table:: **Table 6** records - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==================================================================================================================================================================================================================+ - | bytes | Double | Byte | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Direction, which can be inbound or outbound | - | | | | - | | | Enumeration values: | - | | | | - | | | - **out2in** | - | | | | - | | | - **in2out** | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | packets | Integer | Packet | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Long | End time, a timestamp in milliseconds, such as 1718936272648 | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | String | Document ID | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_ip | String | Source IP address | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_port | Integer | Source port | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_ip | String | Destination IP address | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app | String | Application protocol | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_port | Integer | Destination port | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_host | String | destination host | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_id | String | destination region id | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_name | String | destination region name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_id | String | source region id | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_name | String | source region name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_province_id | String | source province id | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_province_name | String | source province name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_city_id | String | source city id | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_city_name | String | source city name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_province_id | String | destination province id | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_province_name | String | destination province name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_city_id | String | destination city id | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_city_name | String | destination city name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+=========+============================================================================================================================================================================================================================+ + | bytes | Double | Byte. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Direction: **in2out** (outbound) or **out2in** (inbound). | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | packets | Integer | Number of packets. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | start_time | Long | Start time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | Long | End time, in milliseconds. The value is a timestamp, for example, 1718936272648. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_id | String | Document ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_ip | String | Source IP address. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_port | Integer | Source port. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_ip | String | Destination IP address. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app | String | Rule application type. Its value can be **HTTP**, **HTTPS**, **TLS1**, **DNS**, **SSH**, **MYSQL**, **SMTP**, **RDP**, **RDPS**, **VNC**, **POP3**, **IMAP4**, **SMTPS**, **POP3S**, **FTPS**, or **ANY**. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_port | Integer | Destination port. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_host | String | Destination host. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_id | String | Destination region ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | String | Destination region name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_id | String | Source region ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | String | Source region name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_id | String | Destination province ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | String | Destination province name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_id | String | Destination city ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | String | Destination city name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_id | String | Source province ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | String | Source province name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_id | String | Source city ID. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | String | Source city name. | + +-------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- @@ -222,7 +196,7 @@ Example Responses **Status code: 200** -OK +Value returned for flow log query. .. code-block:: @@ -246,10 +220,10 @@ OK "src_province_name" : "source province name", "src_city_id" : "source city id", "src_city_name" : "source city name", - "dst_province_id" : "destination province id", - "dst_province_name" : "destination province name", - "dst_city_id" : "destination city id", - "dst_city_name" : "destination city name" + "dst_province_id" : "dst province id", + "dst_province_name" : "dst province name", + "dst_city_id" : "dst city id", + "dst_city_name" : "dst city name" } ], "total" : 1 } @@ -263,22 +237,22 @@ Bad Request { "error_code" : "CFW.00500002", - "error_msg" : "time range error" + "error_msg" : "Invalid interval." } Status Codes ------------ -=========== ===================== +=========== ================================== Status Code Description -=========== ===================== -200 OK +=========== ================================== +200 Value returned for flow log query. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ================================== Error Codes ----------- diff --git a/api-ref/source/api/log_management/update_log_config.rst b/api-ref/source/api/log_management/update_log_config.rst deleted file mode 100644 index 3cff8dc..0000000 --- a/api-ref/source/api/log_management/update_log_config.rst +++ /dev/null @@ -1,127 +0,0 @@ -:original_name: UpdateLogConfig.html - -.. _UpdateLogConfig: - -Update Log Config -================= - -Function --------- - -This API is used to update log config. - -URI ---- - -PUT /v1/{project_id}/cfw/logs/configuration - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_enable | Yes | Integer | whether to enable LTS | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_log_group_id | Yes | String | Lts log group id, which can be obtained by calling the Querying All Log Groups of an Account API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_attack_log_stream_id | No | String | Lts attack log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_attack_log_stream_enable | Yes | Integer | whether to enable attack log streaming | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_access_log_stream_id | No | String | Lts access log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_access_log_stream_enable | Yes | Integer | whether to enable access log streaming | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_flow_log_stream_id | No | String | Lts flow log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lts_flow_log_stream_enable | Yes | Integer | whether to enable flow log streaming | - +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - ========= ====== ============= - Parameter Type Description - ========= ====== ============= - data String Log Config Id - ========= ====== ============= - -Example Requests ----------------- - -Update the log configuration of the firewall whose firewall instance id is 22c4a5db-504c-471f-8187-5192bc11de0b and project id is 408972e72dcd4c1a9b033e955802a36b, set LTS logs to disabled, and set flow logs, access control logs, and attack logs to disabled. - -.. code-block:: - - https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=22c4a5db-504c-471f-8187-5192bc11de0b&enterprise_project_id=default - - { - "fw_instance_id" : "22c4a5db-504c-471f-8187-5192bc11de0b", - "lts_enable" : 0, - "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8", - "lts_attack_log_stream_enable" : 0, - "lts_access_log_stream_enable" : 0, - "lts_flow_log_stream_enable" : 0 - } - -Example Responses ------------------ - -**Status code: 200** - -Update Log Config Response - -.. code-block:: - - { - "data" : "4e113415-7811-4bb3-bf5e-eb835953f7d4" - } - -Status Codes ------------- - -=========== ========================== -Status Code Description -=========== ========================== -200 Update Log Config Response -=========== ========================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/log_management/updating_log_configurations.rst b/api-ref/source/api/log_management/updating_log_configurations.rst new file mode 100644 index 0000000..8b1091a --- /dev/null +++ b/api-ref/source/api/log_management/updating_log_configurations.rst @@ -0,0 +1,127 @@ +:original_name: UpdateLogConfig.html + +.. _UpdateLogConfig: + +Updating Log Configurations +=========================== + +Function +-------- + +This API is used to update log configurations. + +URI +--- + +PUT /v1/{project_id}/cfw/logs/configuration + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained via :ref:`API ` by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============================+===========+=========+============================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_enable | Yes | Integer | Whether to enable LTS: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_log_group_id | Yes | String | Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in **log_groups.log_group_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_attack_log_stream_id | No | String | Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_attack_log_stream_enable | Yes | Integer | Whether to enable the attack log stream: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_access_log_stream_id | No | String | Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_access_log_stream_enable | Yes | Integer | Whether to enable the access control stream: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_flow_log_stream_id | No | String | Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in **log_streams.log_stream_id** (The period [.] is used to separate different levels of objects). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | lts_flow_log_stream_enable | Yes | Integer | Whether to enable the traffic log function: **true** (yes), **false** (no). | + +------------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=================================================================================================================================================================+ + | data | String | Return value for updating log configurations. The value is the firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +Update the log configurations of firewall 22c4a5db-504c-471f-8187-5192bc11de0b in project 408972e72dcd4c1a9b033e955802a36b. The LTS log, flow log, access control log, and attack log functions are disabled. + +.. code-block:: + + https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=22c4a5db-504c-471f-8187-5192bc11de0b&enterprise_project_id=default + + { + "fw_instance_id" : "22c4a5db-504c-471f-8187-5192bc11de0b", + "lts_enable" : 0, + "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8", + "lts_attack_log_stream_enable" : 0, + "lts_access_log_stream_enable" : 0, + "lts_flow_log_stream_enable" : 0 + } + +Example Responses +----------------- + +**Status code: 200** + +Return value for updating log configurations. + +.. code-block:: + + { + "data" : "4e113415-7811-4bb3-bf5e-eb835953f7d4" + } + +Status Codes +------------ + +=========== ============================================= +Status Code Description +=========== ============================================= +200 Return value for updating log configurations. +=========== ============================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/packet_capture_management/canceling_a_packet_capture_task.rst b/api-ref/source/api/packet_capture_management/canceling_a_packet_capture_task.rst new file mode 100644 index 0000000..07e5629 --- /dev/null +++ b/api-ref/source/api/packet_capture_management/canceling_a_packet_capture_task.rst @@ -0,0 +1,120 @@ +:original_name: CancelCaptureTask.html + +.. _CancelCaptureTask: + +Canceling a Packet Capture Task +=============================== + +Function +-------- + +This API is used to cancel a packet capture task. + +URI +--- + +POST /v1/{project_id}/capture-task/stop + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+===========================================================================================================================================================================================================================================+ + | task_id | Yes | String | Packet capture task ID, which can be obtained by calling the :ref:`API for querying packet capture tasks `. Find the value in **data.records.task_id** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------+-------------------------------------------------------------------------+--------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+============================================+ + | data | :ref:`CaptureTaskId ` object | ID of a packet capture task to be stopped. | + +-----------+-------------------------------------------------------------------------+--------------------------------------------+ + +.. _cancelcapturetask__response_capturetaskid: + +.. table:: **Table 6** CaptureTaskId + + ========= ====== ============== + Parameter Type Description + ========= ====== ============== + id String Firewall ID. + name String Firewall name. + ========= ====== ============== + +Example Requests +---------------- + +Stop the packet capture task 1dcddab3-7d79-4a56-9e67-4aa0962b98ad of firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. + +.. code-block:: + + https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/stop?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default + + { + "task_id" : "1dcddab3-7d79-4a56-9e67-4aa0962b98ad" + } + +Example Responses +----------------- + +**Status code: 200** + +Return value for stopping a packet capture task. + +.. code-block:: + + { + "data" : { + "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", + "name" : "test" + } + } + +Status Codes +------------ + +=========== ================================================ +Status Code Description +=========== ================================================ +200 Return value for stopping a packet capture task. +=========== ================================================ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/packet_capture_management/creating_a_packet_capture_task.rst b/api-ref/source/api/packet_capture_management/creating_a_packet_capture_task.rst new file mode 100644 index 0000000..4fa5d82 --- /dev/null +++ b/api-ref/source/api/packet_capture_management/creating_a_packet_capture_task.rst @@ -0,0 +1,175 @@ +:original_name: CreateCaptureTask.html + +.. _CreateCaptureTask: + +Creating a Packet Capture Task +============================== + +Function +-------- + +This API is used to create a packet capture task. + +URI +--- + +POST /v1/{project_id}/capture-task + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +-------------+-----------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========================================================================================+===================================================================+ + | destination | Yes | :ref:`CaptureRuleAddressDto ` object | Request body of the destination address in a packet capture rule. | + +-------------+-----------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + | duration | Yes | Integer | Packet capture duration, in minutes. | + +-------------+-----------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + | max_packets | Yes | Integer | Maximum number of captured packets. | + +-------------+-----------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + | name | Yes | String | Packet capture task name. | + +-------------+-----------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + | service | Yes | :ref:`CaptureServiceDto ` object | Request body of a packet capture task. | + +-------------+-----------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + | source | Yes | :ref:`CaptureRuleAddressDto ` object | Request body of the source address in a packet capture rule. | + +-------------+-----------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------+ + +.. _createcapturetask__request_captureservicedto: + +.. table:: **Table 5** CaptureServiceDto + + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+=========+============================================================================================================================================================================================================================+ + | dest_port | No | String | Destination port. | + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | Yes | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | No | String | Source port. | + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createcapturetask__request_captureruleaddressdto: + +.. table:: **Table 6** CaptureRuleAddressDto + + +--------------+-----------+---------+----------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+======================================================================+ + | address | Yes | String | Address. | + +--------------+-----------+---------+----------------------------------------------------------------------+ + | address_type | Yes | Integer | Destination address type: **0** (IPv4), **1** (IPv6). | + +--------------+-----------+---------+----------------------------------------------------------------------+ + | type | Yes | Integer | Input address type. Currently, its value can only be **0** (manual). | + +--------------+-----------+---------+----------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 7** Response body parameters + + +-----------+-------------------------------------------------------------------------+--------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+======================================+ + | data | :ref:`CaptureTaskId ` object | ID of a created packet capture task. | + +-----------+-------------------------------------------------------------------------+--------------------------------------+ + +.. _createcapturetask__response_capturetaskid: + +.. table:: **Table 8** CaptureTaskId + + ========= ====== ============== + Parameter Type Description + ========= ====== ============== + id String Firewall ID. + name String Firewall name. + ========= ====== ============== + +Example Requests +---------------- + +Add a packet capture task to firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. Set the task name to **zhuabaotest**, maximum number of captured packets to 100000, packet capture duration to 3 minutes, and remaining retention days to 7 days. Source address protocol: TCP; address type: IPv4; address: 1.1.1.1; port number: 1-65535; destination address protocol: TCP; address type: IPv4; address: 2.2.2.2; port number: 1-65535. + +.. code-block:: + + https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default + + { + "name" : "zhuabaotest", + "max_packets" : 100000, + "duration" : 3, + "source" : { + "type" : 0, + "address_type" : 0, + "address" : "1.1.1.1" + }, + "destination" : { + "type" : 0, + "address_type" : 0, + "address" : "2.2.2.2" + }, + "service" : { + "protocol" : -1, + "source_port" : "", + "dest_port" : "" + } + } + +Example Responses +----------------- + +**Status code: 200** + +Return value for creating a packet capture task. + +.. code-block:: + + { + "data" : { + "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", + "name" : "test" + } + } + +Status Codes +------------ + +=========== ================================================ +Status Code Description +=========== ================================================ +200 Return value for creating a packet capture task. +=========== ================================================ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/packet_capture_management/deleting_packet_capture_tasks_in_batches.rst b/api-ref/source/api/packet_capture_management/deleting_packet_capture_tasks_in_batches.rst new file mode 100644 index 0000000..6a1bc07 --- /dev/null +++ b/api-ref/source/api/packet_capture_management/deleting_packet_capture_tasks_in_batches.rst @@ -0,0 +1,120 @@ +:original_name: DeleteCaptureTask.html + +.. _DeleteCaptureTask: + +Deleting Packet Capture Tasks in Batches +======================================== + +Function +-------- + +This API is used to delete packet capture tasks in batches. + +URI +--- + +POST /v1/{project_id}/capture-task/batch-delete + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + +-----------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==================+==========================================================================================================================================================================================================================================================================+ + | task_ids | Yes | Array of strings | List of packet capture task IDs. The packet capture task IDs can be obtained by calling the :ref:`API for querying packet capture tasks `. Find the value in **data.records.task_id** (The period [.] is used to separate different levels of objects). | + +-----------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------+-------------------------------------------------------------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+===================================================+ + | data | :ref:`CaptureTaskId ` object | Returned data for deleting a packet capture task. | + +-----------+-------------------------------------------------------------------------+---------------------------------------------------+ + +.. _deletecapturetask__response_capturetaskid: + +.. table:: **Table 6** CaptureTaskId + + ========= ====== ============== + Parameter Type Description + ========= ====== ============== + id String Firewall ID. + name String Firewall name. + ========= ====== ============== + +Example Requests +---------------- + +Delete the packet capture task 24e6bb6d-d335-48fd-b9c7-bbaaa851d209 from firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. + +.. code-block:: + + https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/batch-delete?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default + + { + "task_ids" : [ "24e6bb6d-d335-48fd-b9c7-bbaaa851d209" ] + } + +Example Responses +----------------- + +**Status code: 200** + +Return value for deleting packet capture tasks. + +.. code-block:: + + { + "data" : { + "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", + "name" : "test" + } + } + +Status Codes +------------ + +=========== =============================================== +Status Code Description +=========== =============================================== +200 Return value for deleting packet capture tasks. +=========== =============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/packet_capture_management/index.rst b/api-ref/source/api/packet_capture_management/index.rst new file mode 100644 index 0000000..1dffaa7 --- /dev/null +++ b/api-ref/source/api/packet_capture_management/index.rst @@ -0,0 +1,22 @@ +:original_name: topic_300000009.html + +.. _topic_300000009: + +Packet Capture Management +========================= + +- :ref:`Querying a Packet Capture Task ` +- :ref:`Creating a Packet Capture Task ` +- :ref:`Deleting Packet Capture Tasks in Batches ` +- :ref:`Obtaining Packet Capture Task Results ` +- :ref:`Canceling a Packet Capture Task ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_a_packet_capture_task + creating_a_packet_capture_task + deleting_packet_capture_tasks_in_batches + obtaining_packet_capture_task_results + canceling_a_packet_capture_task diff --git a/api-ref/source/api/packet_capture_management/obtaining_packet_capture_task_results.rst b/api-ref/source/api/packet_capture_management/obtaining_packet_capture_task_results.rst new file mode 100644 index 0000000..82919df --- /dev/null +++ b/api-ref/source/api/packet_capture_management/obtaining_packet_capture_task_results.rst @@ -0,0 +1,144 @@ +:original_name: ListCaptureResult.html + +.. _ListCaptureResult: + +Obtaining Packet Capture Task Results +===================================== + +Function +-------- + +This API is used to obtain packet capture task results. + +URI +--- + +GET /v1/{project_id}/capture-task/capture-result + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+==================+==============================================================================================================================================================================================================================================================================+ + | fw_instance_id | Yes | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | task_id | Yes | String | Packet capture task ID, which can be obtained by calling the :ref:`API for querying packet capture tasks `. Find the value in **data.records.task_id** (The period [.] is used to separate different levels of objects). | + +-----------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | Integer | Whether to download from a specified EIP: **0** (no), **1** (yes). | + +-----------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip | No | Array of strings | Specified EIP. | + +-----------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+-----------------------------------------------------------------------------------+----------------------------+ + | Parameter | Type | Description | + +===========+===================================================================================+============================+ + | data | :ref:`CaptureResultUrlVO ` object | Packet capture result URL. | + +-----------+-----------------------------------------------------------------------------------+----------------------------+ + +.. _listcaptureresult__response_captureresulturlvo: + +.. table:: **Table 5** CaptureResultUrlVO + + +----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+===============================================================================+=============================================================================================================================================================================+ + | captcha | String | Access code used to open the download link. | + +----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | expires | Long | Download link expiration time. | + +----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | file_list | Array of :ref:`CaptureFile ` objects | List of packet capture files, which is used when OBS folder sharing is not supported. If this field is specified, no **captch**, **expires**, or **url** value is returned. | + +----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | request_header | :ref:`HostHeaderInfo ` object | Server request header, which is used when OBS folder sharing is not supported. | + +----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | url | String | Download link. | + +----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listcaptureresult__response_capturefile: + +.. table:: **Table 6** CaptureFile + + ========= ====== ============== + Parameter Type Description + ========= ====== ============== + file_name String File name. + url String Download link. + file_path String File path. + ========= ====== ============== + +.. _listcaptureresult__response_hostheaderinfo: + +.. table:: **Table 7** HostHeaderInfo + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + Host String Server. + ========= ====== =========== + +Example Requests +---------------- + +Query the packet capture results firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. + +.. code-block:: + + https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/capture-result?fw_instance_id=14f99b45-47df-4e40-aa5d-cf3700ce9c8b&enterprise_project_id=default&task_id=ea47d7f9-8b93-45de-978d-b4bf0613cfed&type=0 + +Example Responses +----------------- + +**Status code: 200** + +Obtain packet capture results. + +.. code-block:: + + { + "data" : { + "captcha" : "696821", + "expires" : 30, + "url" : "testurl" + } + } + +Status Codes +------------ + +=========== ============================== +Status Code Description +=========== ============================== +200 Obtain packet capture results. +=========== ============================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/capture_management/list_capture_task.rst b/api-ref/source/api/packet_capture_management/querying_a_packet_capture_task.rst similarity index 73% rename from api-ref/source/api/capture_management/list_capture_task.rst rename to api-ref/source/api/packet_capture_management/querying_a_packet_capture_task.rst index a585a30..526ad68 100644 --- a/api-ref/source/api/capture_management/list_capture_task.rst +++ b/api-ref/source/api/packet_capture_management/querying_a_packet_capture_task.rst @@ -2,13 +2,13 @@ .. _ListCaptureTask: -list capture task -================= +Querying a Packet Capture Task +============================== Function -------- -list capture task +This API is used to query a packet capture task. URI --- @@ -17,36 +17,36 @@ GET /v1/{project_id}/capture-task .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -55,78 +55,78 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+=======================================================================================================================+==============================+ - | data | Array of :ref:`HttpQueryCaptureTaskResponseData ` objects | query capture task response. | - +-----------+-----------------------------------------------------------------------------------------------------------------------+------------------------------+ + +-----------+-------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +===========+=============================================================================================================+===================================================+ + | data | :ref:`HttpQueryCaptureTaskResponseData ` object | Returned data for querying a packet capture task. | + +-----------+-------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ .. _listcapturetask__response_httpquerycapturetaskresponsedata: .. table:: **Table 5** HttpQueryCaptureTaskResponseData - +------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+=================================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | project id | - +------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Long | total capture tasks | - +------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`CaptureTaskVO ` objects | capture task vo | - +------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+=================================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Long | Total number of packet capture tasks. | + +------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | records | Array of :ref:`CaptureTaskVO ` objects | Packet capture task list. | + +------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listcapturetask__response_capturetaskvo: .. table:: **Table 6** CaptureTaskVO - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+=========+==================================================================================================================================================================================================================+ - | capture_size | String | capture size | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_date | String | capture task created date | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_address | String | destination address | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_address_type | Integer | destination address type. The value can be 0 (IPv4), 1 (IPv6). | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | String | destination port | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | Integer | capture duration | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_deleted | Integer | whether is deleted,0 means no,1 means yes. | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | max_packets | Integer | max packets | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | modified_date | String | modified date | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | capture task name | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remaining_days | Integer | remaining days | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_address | String | source address | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_address_type | Integer | source address type. The value can be 0 (IPv4), 1 (IPv6) | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | String | source port | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | capture task status | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | String | capture task id | - +---------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+=========+============================================================================================================================================================================================================================+ + | capture_size | String | Packet size, for example, **500kb** or **500mb**. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_date | String | Packet capture task creation time, for example, 2024/08/31 10:17:30. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_address | String | Destination IP address. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_address_type | Integer | Destination address type: **0** (IPv4), **1** (IPv6). | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | String | Destination port. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | duration | Integer | Packet capture duration, in minutes. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_deleted | Integer | Deleted or not: **0** (no), **1** (yes). | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_packets | Integer | Maximum number of captured packets. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | modified_date | String | Modification time, for example, 2024/08/31 10:17:30. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Packet capture task name. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remaining_days | Integer | Remaining retention period (days). | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_address | String | Source IP address. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_address_type | Integer | Source address type: **0** (IPv4), **1** (IPv6). | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | String | Source port. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | Integer | Packet capture task status: **1** (successful), **2** (running), **4** (stopped), or **5** (ending). | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | task_id | String | Packet capture task ID. | + +---------------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- -Query 50 packet capture tasks from project ID 09bb24e6fe80d23d2fa2c010b53b418c and firewall ID ebf891cd-2163-48a0-9963-6309f99dd3c4. +Query 50 packet capture tasks of firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. .. code-block:: @@ -137,7 +137,7 @@ Example Responses **Status code: 200** -query capture task response +Return value for querying the packet capture task list. .. code-block:: @@ -171,11 +171,11 @@ query capture task response Status Codes ------------ -=========== =========================== +=========== ======================================================= Status Code Description -=========== =========================== -200 query capture task response -=========== =========================== +=========== ======================================================= +200 Return value for querying the packet capture task list. +=========== ======================================================= Error Codes ----------- diff --git a/api-ref/source/api/service_set_management/creating_a_service_member.rst b/api-ref/source/api/service_group_management/adding_service_group_members.rst similarity index 64% rename from api-ref/source/api/service_set_management/creating_a_service_member.rst rename to api-ref/source/api/service_group_management/adding_service_group_members.rst index 0ce09e7..5138b16 100644 --- a/api-ref/source/api/service_set_management/creating_a_service_member.rst +++ b/api-ref/source/api/service_group_management/adding_service_group_members.rst @@ -2,13 +2,13 @@ .. _AddServiceItems: -Creating a Service Member -========================= +Adding Service Group Members +============================ Function -------- -This API is used to add group members in batches. +This API is used to add service group members in batches. URI --- @@ -17,58 +17,58 @@ POST /v1/{project_id}/service-items .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +---------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+================================================================================+============================================================================================+ - | set_id | Yes | String | Service group ID, obtain the ID by calling the API used for Obtaining the Service Set List | - +---------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | service_items | Yes | Array of :ref:`service_items ` objects | Add a member to a service group. | - +---------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + +---------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+================================================================================+======================================================================================================================================================================================================================================+ + | set_id | Yes | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +---------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_items | Yes | Array of :ref:`service_items ` objects | Service group member list. | + +---------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addserviceitems__request_service_items: .. table:: **Table 5** service_items - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+=========+==================================================================================================================================================================================================================+ - | protocol | Yes | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | Yes | String | Source port | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | Yes | String | Destination port | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Service member description | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+=========+============================================================================================================================================================================================================================+ + | protocol | Yes | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | Yes | String | Source port. | + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | Yes | String | Destination port. | + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Service member description. | + +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -77,47 +77,47 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------+-------------------------------------------------------------------------+------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================================+======================================================+ - | data | :ref:`ServiceItemIds ` object | Data returned when a service group member is created | - +-----------+-------------------------------------------------------------------------+------------------------------------------------------+ + +-----------+-------------------------------------------------------------------------+----------------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+====================================================+ + | data | :ref:`ServiceItemIds ` object | Data returned for creating a service group member. | + +-----------+-------------------------------------------------------------------------+----------------------------------------------------+ .. _addserviceitems__response_serviceitemids: .. table:: **Table 7** ServiceItemIds - +-----------+-----------------------------------------------------------------+----------------------+ - | Parameter | Type | Description | - +===========+=================================================================+======================+ - | items | Array of :ref:`items ` objects | service item id list | - +-----------+-----------------------------------------------------------------+----------------------+ + +-----------+-----------------------------------------------------------------+-----------------------------------+ + | Parameter | Type | Description | + +===========+=================================================================+===================================+ + | items | Array of :ref:`items ` objects | List of service group member IDs. | + +-----------+-----------------------------------------------------------------+-----------------------------------+ .. _addserviceitems__response_items: .. table:: **Table 8** items - ========= ====== =============== + ========= ====== ======================== Parameter Type Description - ========= ====== =============== - id String service item id - ========= ====== =============== + ========= ====== ======================== + id String Service group member ID. + ========= ====== ======================== **Status code: 400** .. table:: **Table 9** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Add a service group member named ceshi to the project whose ID is 9d80d070b6d44942af73c9c3d38e0429. +Add a service group member named **ceshi** to project 9d80d070b6d44942af73c9c3d38e0429. The description is **Add a service group member**. .. code-block:: @@ -126,8 +126,7 @@ Add a service group member named ceshi to the project whose ID is 9d80d070b6d449 { "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57", "service_items" : [ { - "description" : "Add a member to a service group", - "name" : "ceshi", + "description" : "Add members to a service group.", "dest_port" : "1", "source_port" : "1", "protocol" : 6 @@ -139,7 +138,7 @@ Example Responses **Status code: 200** -Return value for adding a service group member +Return value for adding service group members. .. code-block:: @@ -159,7 +158,7 @@ Bad Request { "error_code" : "CFW.00200001", - "error_msg" : "empty param" + "error_msg" : "Empty parameter." } Status Codes @@ -168,7 +167,7 @@ Status Codes =========== ============================================== Status Code Description =========== ============================================== -200 Return value for adding a service group member +200 Return value for adding service group members. 400 Bad Request 401 Unauthorized 403 Forbidden diff --git a/api-ref/source/api/service_set_management/creating_a_service_set.rst b/api-ref/source/api/service_group_management/creating_a_service_group.rst similarity index 61% rename from api-ref/source/api/service_set_management/creating_a_service_set.rst rename to api-ref/source/api/service_group_management/creating_a_service_group.rst index 3c30a53..49b3f1c 100644 --- a/api-ref/source/api/service_set_management/creating_a_service_set.rst +++ b/api-ref/source/api/service_group_management/creating_a_service_group.rst @@ -2,8 +2,8 @@ .. _AddServiceSet: -Creating a Service Set -====================== +Creating a Service Group +======================== Function -------- @@ -17,52 +17,44 @@ POST /v1/{project_id}/service-set .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Service group name | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **255** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Service group description | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **255** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | Service group name. | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Service group description. | + +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -71,37 +63,37 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+---------------------------------------------------+----------------------+ - | Parameter | Type | Description | - +===========+===================================================+======================+ - | data | :ref:`data ` object | service set response | - +-----------+---------------------------------------------------+----------------------+ + +-----------+-------------------------------------------------------------------+---------------------------------------------+ + | Parameter | Type | Description | + +===========+===================================================================+=============================================+ + | data | :ref:`ServiceSetId ` object | Data returned for creating a service group. | + +-----------+-------------------------------------------------------------------+---------------------------------------------+ -.. _addserviceset__response_data: +.. _addserviceset__response_servicesetid: -.. table:: **Table 6** data +.. table:: **Table 6** ServiceSetId - ========= ====== ============== + ========= ====== ================= Parameter Type Description - ========= ====== ============== - id String service set ID - ========= ====== ============== + ========= ====== ================= + id String Service group ID. + ========= ====== ================= **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Add a service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429, protected object is cfebd347-b655-4b84-b938-3c54317599b2, and name is ceshi. +Add a service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429, protected object is cfebd347-b655-4b84-b938-3c54317599b2, and name is **ceshi**. .. code-block:: @@ -118,7 +110,7 @@ Example Responses **Status code: 200** -Return value of creating a service group +Return value for creating a service group. .. code-block:: @@ -136,22 +128,22 @@ Bad Request { "error_code" : "CFW.00200024", - "error_msg" : "Exceeded maximum quantity limit" + "error_msg" : "Exceeded the upper limit." } Status Codes ------------ -=========== ======================================== +=========== ========================================== Status Code Description -=========== ======================================== -200 Return value of creating a service group +=========== ========================================== +200 Return value for creating a service group. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ======================================== +=========== ========================================== Error Codes ----------- diff --git a/api-ref/source/api/service_group_management/deleting_a_service_group.rst b/api-ref/source/api/service_group_management/deleting_a_service_group.rst new file mode 100644 index 0000000..c11bf59 --- /dev/null +++ b/api-ref/source/api/service_group_management/deleting_a_service_group.rst @@ -0,0 +1,136 @@ +:original_name: DeleteServiceSet.html + +.. _DeleteServiceSet: + +Deleting a Service Group +======================== + +Function +-------- + +This API is used to delete a service group. + +URI +--- + +DELETE /v1/{project_id}/service-sets/{set_id} + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+======================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+----------------------------------------------------------------------+---------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================================================+=============================================+ + | data | :ref:`ServiceSetId ` object | Data returned for deleting a service group. | + +-----------+----------------------------------------------------------------------+---------------------------------------------+ + +.. _deleteserviceset__response_servicesetid: + +.. table:: **Table 5** ServiceSetId + + ========= ====== ================= + Parameter Type Description + ========= ====== ================= + id String Service group ID. + ========= ====== ================= + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +Delete service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429. + +.. code-block:: + + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866 + +Example Responses +----------------- + +**Status code: 200** + +Return value for deleting a service group. + +.. code-block:: + + { + "data" : { + "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866", + "name" : "test" + } + } + +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.00200004", + "error_msg" : "Failed to delete the resource because it is being referenced." + } + +Status Codes +------------ + +=========== ========================================== +Status Code Description +=========== ========================================== +200 Return value for deleting a service group. +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/service_set_management/deleting_a_service_member.rst b/api-ref/source/api/service_group_management/deleting_a_service_group_member.rst similarity index 54% rename from api-ref/source/api/service_set_management/deleting_a_service_member.rst rename to api-ref/source/api/service_group_management/deleting_a_service_group_member.rst index cbd2d4a..59be968 100644 --- a/api-ref/source/api/service_set_management/deleting_a_service_member.rst +++ b/api-ref/source/api/service_group_management/deleting_a_service_group_member.rst @@ -2,8 +2,8 @@ .. _DeleteServiceItem: -Deleting a Service Member -========================= +Deleting a Service Group Member +=============================== Function -------- @@ -17,33 +17,34 @@ DELETE /v1/{project_id}/service-items/{item_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ============================ - Parameter Mandatory Type Description - ========== ========= ====== ============================ - project_id Yes String Project ID - item_id Yes String ID of a service group member - ========== ========= ====== ============================ + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+======================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | item_id | Yes | String | Service group member ID, which can be obtained by calling the :ref:`API for querying the service group member list `. Find the value in **data.records.item_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -52,37 +53,37 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-------------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +===========+=======================================================+===================================+ - | data | :ref:`data ` object | Delete service group member data. | - +-----------+-------------------------------------------------------+-----------------------------------+ + +-----------+-----------------------------------------------------------------------------------------------------------------+-----------------------------------+ + | Parameter | Type | Description | + +===========+=================================================================================================================+===================================+ + | data | :ref:`DeleteServiceItemResponseBodyData ` object | Delete service group member data. | + +-----------+-----------------------------------------------------------------------------------------------------------------+-----------------------------------+ -.. _deleteserviceitem__response_data: +.. _deleteserviceitem__response_deleteserviceitemresponsebodydata: -.. table:: **Table 5** data +.. table:: **Table 5** DeleteServiceItemResponseBodyData - ========= ====== =============== + ========= ====== ======================== Parameter Type Description - ========= ====== =============== - id String service item id - ========= ====== =============== + ========= ====== ======================== + id String Service group member ID. + ========= ====== ======================== **Status code: 400** .. table:: **Table 6** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -This API is used to Delete the service group member whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group member ID is 6b37ed55-1e21-46a5-a7dc-a59ef418d359. +Delete the service group member whose ID is 6b37ed55-1e21-46a5-a7dc-a59ef418d359 from project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -93,7 +94,7 @@ Example Responses **Status code: 200** -Response to the request for deleting a service group member. +Information returned for service group member deletion. .. code-block:: @@ -111,22 +112,22 @@ Bad Request { "error_code" : "CFW.0020016", - "error_msg" : "instance status error" + "error_msg" : "Incorrect instance status." } Status Codes ------------ -=========== ============================================================ +=========== ======================================================= Status Code Description -=========== ============================================================ -200 Response to the request for deleting a service group member. +=========== ======================================================= +200 Information returned for service group member deletion. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ============================================================ +=========== ======================================================= Error Codes ----------- diff --git a/api-ref/source/api/service_set_management/batch_delete_service_items.rst b/api-ref/source/api/service_group_management/deleting_service_group_members_in_batches.rst similarity index 50% rename from api-ref/source/api/service_set_management/batch_delete_service_items.rst rename to api-ref/source/api/service_group_management/deleting_service_group_members_in_batches.rst index 432a7b0..2b80b3a 100644 --- a/api-ref/source/api/service_set_management/batch_delete_service_items.rst +++ b/api-ref/source/api/service_group_management/deleting_service_group_members_in_batches.rst @@ -2,13 +2,13 @@ .. _BatchDeleteServiceItems: -Batch Delete Service Items -========================== +Deleting Service Group Members in Batches +========================================= Function -------- -This API is used to batch delete service items. +This API is used to delete service group members in batches. URI --- @@ -17,41 +17,42 @@ DELETE /v1/{project_id}/service-items .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters - ================ ========= ================ ================ - Parameter Mandatory Type Description - ================ ========= ================ ================ - set_id Yes String set id - service_item_ids Yes Array of strings service item ids - ================ ========= ================ ================ + +------------------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+==================+==================================================================================================================================================================================================================================================================================+ + | set_id | Yes | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_item_ids | Yes | Array of strings | List of service group member IDs. Service group member IDs can be obtained by calling the :ref:`API for querying the service group member list `. Find the value in **data.records.item_id** (The period [.] is used to separate different levels of objects). | + +------------------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -60,16 +61,27 @@ Response Parameters .. table:: **Table 5** Response body parameters - ========= ================ ========================== - Parameter Type Description - ========= ================ ========================== - data Array of strings batch delete service items - ========= ================ ========================== + +-----------+------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================+================================================================+ + | data | Array of strings | ID list of the service group members to be deleted in batches. | + +-----------+------------------+----------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Delete the service item f837f7ae-22c9-449d-a99c-4be24533e243 under the service set 688faf62-20fc-4ca6-b9f9-6fbc518df5ae with project id 9d80d070b6d44942af73c9c3d38e0429 +Delete service group member f837f7ae-22c9-449d-a99c-4be24533e243 from service group 688faf62-20fc-4ca6-b9f9-6fbc518df5ae in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -85,7 +97,7 @@ Example Responses **Status code: 200** -Batch Delete Service Item Response +Return value for deleting service group members in batches. .. code-block:: @@ -93,14 +105,26 @@ Batch Delete Service Item Response "data" : [ "f837f7ae-22c9-449d-a99c-4be24533e243" ] } +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.00200005", + "error_msg" : "Object not found." + } + Status Codes ------------ -=========== ================================== +=========== =========================================================== Status Code Description -=========== ================================== -200 Batch Delete Service Item Response -=========== ================================== +=========== =========================================================== +200 Return value for deleting service group members in batches. +400 Bad Request +=========== =========================================================== Error Codes ----------- diff --git a/api-ref/source/api/service_group_management/index.rst b/api-ref/source/api/service_group_management/index.rst new file mode 100644 index 0000000..d37d8d4 --- /dev/null +++ b/api-ref/source/api/service_group_management/index.rst @@ -0,0 +1,30 @@ +:original_name: topic_300000005.html + +.. _topic_300000005: + +Service Group Management +======================== + +- :ref:`Creating a Service Group ` +- :ref:`Adding Service Group Members ` +- :ref:`Deleting a Service Group ` +- :ref:`Deleting a Service Group Member ` +- :ref:`Deleting Service Group Members in Batches ` +- :ref:`Modifying a Service Group ` +- :ref:`Obtaining the Service Group List ` +- :ref:`Querying Service Group Details ` +- :ref:`Querying the Service Group Member List ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_service_group + adding_service_group_members + deleting_a_service_group + deleting_a_service_group_member + deleting_service_group_members_in_batches + modifying_a_service_group + obtaining_the_service_group_list + querying_service_group_details + querying_the_service_group_member_list diff --git a/api-ref/source/api/service_group_management/modifying_a_service_group.rst b/api-ref/source/api/service_group_management/modifying_a_service_group.rst new file mode 100644 index 0000000..9531411 --- /dev/null +++ b/api-ref/source/api/service_group_management/modifying_a_service_group.rst @@ -0,0 +1,149 @@ +:original_name: UpdateServiceSet.html + +.. _UpdateServiceSet: + +Modifying a Service Group +========================= + +Function +-------- + +This API is used to update a service group. + +URI +--- + +PUT /v1/{project_id}/service-sets/{set_id} + +.. table:: **Table 1** Path Parameters + + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+======================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request header parameters + + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + +.. table:: **Table 4** Request body parameters + + =========== ========= ====== ========================== + Parameter Mandatory Type Description + =========== ========= ====== ========================== + name No String Service group name. + description No String Service group description. + =========== ========= ====== ========================== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 5** Response body parameters + + +-----------+----------------------------------------------------------------------+----------------------------+ + | Parameter | Type | Description | + +===========+======================================================================+============================+ + | data | :ref:`ServiceSetId ` object | Update service group data. | + +-----------+----------------------------------------------------------------------+----------------------------+ + +.. _updateserviceset__response_servicesetid: + +.. table:: **Table 6** ServiceSetId + + ========= ====== ================= + Parameter Type Description + ========= ====== ================= + id String Service group ID. + ========= ====== ================= + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +Example Requests +---------------- + +Change the name of the service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429 to **ceshi2** and change its description to **Description**. + +.. code-block:: + + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866 + + { + "name" : "ceshi2", + "description" : "Description." + } + +Example Responses +----------------- + +**Status code: 200** + +Return value for updating a service group. + +.. code-block:: + + { + "data" : { + "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866" + } + } + +**Status code: 400** + +Bad Request + +.. code-block:: + + { + "error_code" : "CFW.00200005", + "error_msg" : "Object not found." + } + +Status Codes +------------ + +=========== ========================================== +Status Code Description +=========== ========================================== +200 Return value for updating a service group. +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst b/api-ref/source/api/service_group_management/obtaining_the_service_group_list.rst similarity index 66% rename from api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst rename to api-ref/source/api/service_group_management/obtaining_the_service_group_list.rst index 0f7c5da..0f495ca 100644 --- a/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst +++ b/api-ref/source/api/service_group_management/obtaining_the_service_group_list.rst @@ -2,8 +2,8 @@ .. _ListServiceSets: -Obtaining the Service Set List -============================== +Obtaining the Service Group List +================================ Function -------- @@ -17,48 +17,42 @@ GET /v1/{project_id}/service-sets .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Keyword | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of queries on each page, in the range 1-1024 | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **1024** | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - | | | | | - | | | | Minimum: **0** | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | - +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the :ref:`API for querying firewall instances `. In the return value, find the ID in **data.records.protect_objects.object_id** (The period [.] is used to separate different levels of objects). If the value of **type** is **0**, the protected object ID belongs to the Internet border. If the value of **type** is **1**, the protected object ID belongs to the VPC border. You can obtain the value of **type** from **data.records.protect_objects.type** (The period [.] is used to separate different levels of objects). | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Keyword, which can be the service group name or part of the service group description. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of query records on each page. The value ranges from 1 to 1024. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_service_set_type | No | Integer | Type of the service group to be queried: **0** (user-defined service group), **1** (predefined service group). | + +------------------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -67,11 +61,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-------------------------------------------------------------------------------+-------------------------+ - | Parameter | Type | Description | - +===========+===============================================================================+=========================+ - | data | :ref:`ServiceSetRecords ` object | QueryServiceSetResponse | - +-----------+-------------------------------------------------------------------------------+-------------------------+ + +-----------+-------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================================+===============================+ + | data | :ref:`ServiceSetRecords ` object | Query the service group list. | + +-----------+-------------------------------------------------------------------------------+-------------------------------+ .. _listservicesets__response_servicesetrecords: @@ -82,45 +76,45 @@ Response Parameters +===========+===========================================================================+=================================================================================================================================================+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +-----------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +-----------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of records queried | + | total | Integer | Query the total number of service groups. | +-----------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`ServiceSet ` objects | Service group list | + | records | Array of :ref:`ServiceSet ` objects | Service group list. | +-----------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listservicesets__response_serviceset: .. table:: **Table 6** ServiceSet - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+===================+================================================================================================================+ - | set_id | String | Service group ID | - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ - | name | String | Name | - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ - | description | String | Description | - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ - | service_set_type | Integer | predefined service set type, 1 indicates Web Service, 2 indicates Remote login and PING, 3 indicates Databases | - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ - | ref_count | Integer | Reference count | - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ - | protocols | Array of integers | Protocols | - +------------------+-------------------+----------------------------------------------------------------------------------------------------------------+ + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================+==========================================================================================================================================================================+ + | set_id | String | Service group ID. | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Service group name. | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Service group description. | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Service group type: **0** (user-defined service group), **1** (common web service), **2** (common remote login and ping), or **3** (common database). | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ref_count | Integer | Number of times a service group is referenced by rules. | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID. | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | Array of integers | Protocol list. Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual). | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- @@ -136,7 +130,7 @@ Example Responses **Status code: 200** -Response to the request for querying service group information +Return value for the service group list query. .. code-block:: @@ -164,27 +158,22 @@ Bad Request { "error_code" : "CFW.0020016", - "error_msg" : "instance status error" + "error_msg" : "Incorrect instance status." } Status Codes ------------ -+-------------+----------------------------------------------------------------+ -| Status Code | Description | -+=============+================================================================+ -| 200 | Response to the request for querying service group information | -+-------------+----------------------------------------------------------------+ -| 400 | Bad Request | -+-------------+----------------------------------------------------------------+ -| 401 | Unauthorized | -+-------------+----------------------------------------------------------------+ -| 403 | Forbidden | -+-------------+----------------------------------------------------------------+ -| 404 | Not Found | -+-------------+----------------------------------------------------------------+ -| 500 | Internal Server Error | -+-------------+----------------------------------------------------------------+ +=========== ============================================== +Status Code Description +=========== ============================================== +200 Return value for the service group list query. +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ============================================== Error Codes ----------- diff --git a/api-ref/source/api/service_set_management/deleting_a_service_set.rst b/api-ref/source/api/service_group_management/querying_service_group_details.rst similarity index 50% rename from api-ref/source/api/service_set_management/deleting_a_service_set.rst rename to api-ref/source/api/service_group_management/querying_service_group_details.rst index cfcf171..cb08a50 100644 --- a/api-ref/source/api/service_set_management/deleting_a_service_set.rst +++ b/api-ref/source/api/service_group_management/querying_service_group_details.rst @@ -1,49 +1,52 @@ -:original_name: DeleteServiceSet.html +:original_name: ListServiceSetDetail.html -.. _DeleteServiceSet: +.. _ListServiceSetDetail: -Deleting a Service Set -====================== +Querying Service Group Details +============================== Function -------- -This API is used to delete a service group. +This API is used to query details about a service group. URI --- -DELETE /v1/{project_id}/service-sets/{set_id} +GET /v1/{project_id}/service-sets/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== ============================= - Parameter Mandatory Type Description - ========== ========= ====== ============================= - project_id Yes String Project ID - set_id Yes String Indicates the service set ID. - ========== ========= ====== ============================= + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+======================================================================================================================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | Yes | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_service_set_type | No | Integer | Type of the service group to be queried: **0** (user-defined service group), **1** (predefined service group). | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -52,38 +55,43 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+--------------------------------------------------------------+------------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================+================================================+ - | data | :ref:`IdObject ` object | Data returned after a service group is deleted | - +-----------+--------------------------------------------------------------+------------------------------------------------+ + +-----------+--------------------------------------------------------------------------------------------------------+------------------------+ + | Parameter | Type | Description | + +===========+========================================================================================================+========================+ + | data | :ref:`ServiceSetDetailResponseDto ` object | Service group details. | + +-----------+--------------------------------------------------------------------------------------------------------+------------------------+ -.. _deleteserviceset__response_idobject: +.. _listservicesetdetail__response_servicesetdetailresponsedto: -.. table:: **Table 5** IdObject +.. table:: **Table 5** ServiceSetDetailResponseDto - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=========+=======================================================================================================================================================+ + | id | String | Service group ID. | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Service group name. | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Service group description. | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Service group type: **0** (user-defined service group), **1** (common web service), **2** (common remote login and ping), or **3** (common database). | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 6** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== Example Requests ---------------- -Delete the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 221cfdca-3abf-4c30-ab0d-516a03c70866. +Query details about service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -94,14 +102,15 @@ Example Responses **Status code: 200** -OK +Return value for querying service group details. .. code-block:: { "data" : { + "service_set_type" : 0, "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866", - "name" : "test" + "name" : "ceshi2" } } @@ -112,23 +121,23 @@ Bad Request .. code-block:: { - "error_code" : "CFW.00200004", - "error_msg" : "can not delete for used" + "error_code" : "CFW.00200005", + "error_msg" : "Object not found." } Status Codes ------------ -=========== ===================== +=========== ================================================ Status Code Description -=========== ===================== -200 OK +=========== ================================================ +200 Return value for querying service group details. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ===================== +=========== ================================================ Error Codes ----------- diff --git a/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst b/api-ref/source/api/service_group_management/querying_the_service_group_member_list.rst similarity index 53% rename from api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst rename to api-ref/source/api/service_group_management/querying_the_service_group_member_list.rst index 36646a4..b5a1ddd 100644 --- a/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst +++ b/api-ref/source/api/service_group_management/querying_the_service_group_member_list.rst @@ -2,13 +2,13 @@ .. _ListServiceItems: -Querying the Service Set Member List -==================================== +Querying the Service Group Member List +====================================== Function -------- -This API is used to query service group members. +This API is used to query the service group member list. URI --- @@ -17,42 +17,42 @@ GET /v1/{project_id}/service-items .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+========================================================================================================================================+ + | project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Query Parameters - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | set_id | Yes | String | Service group ID | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Query field | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set, Takes effect only if the set_id is a predefined service set ID | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+==============================================================================================================================================================================================================================================================================+ + | set_id | Yes | String | Service group ID, which can be obtained by calling the :ref:`API for querying the service group list `. Find the value in **data.records.set_id** (The period [.] is used to separate different levels of objects). | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Query field, which can be a service group member name or a part of the service group member description. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to :ref:`Obtaining an Enterprise Project ID `. If the enterprise project function is not enabled, the value is **0**. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall ID, which can be obtained by referring to :ref:`Obtaining a Firewall ID `. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_service_set_type | No | Integer | Type of the service group to be queried: **0** (user-defined service group), **1** (predefined service group). This parameter is valid only if **set_id** is the ID of a predefined service group. | + +------------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ .. table:: **Table 3** Request header parameters - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+===================================================================================================+ + | X-Auth-Token | Yes | String | User token. You can obtain the token by referring to :ref:`Obtaining a User Token `. | + +--------------+-----------+--------+---------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -61,11 +61,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+------------------------------------------------------+---------------------------+ - | Parameter | Type | Description | - +===========+======================================================+===========================+ - | data | :ref:`data ` object | Service group member list | - +-----------+------------------------------------------------------+---------------------------+ + +-----------+------------------------------------------------------+----------------------------+ + | Parameter | Type | Description | + +===========+======================================================+============================+ + | data | :ref:`data ` object | Service group member list. | + +-----------+------------------------------------------------------+----------------------------+ .. _listserviceitems__response_data: @@ -76,48 +76,88 @@ Response Parameters +===========+======================================================================+=================================================================================================================================================+ | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Integer | Number of records displayed on each page. The value ranges from 1 to 1024. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of records | + | total | Integer | Total number of service group members. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | String | service set id | + | set_id | String | Service group ID. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Record | + | records | Array of :ref:`records ` objects | Record. | +-----------+----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listserviceitems__response_records: .. table:: **Table 6** records - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+==================================================================================================================================================================================================================+ - | item_id | String | Service member ID | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | String | Source port | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | String | Destination port | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Service member description | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+=========+============================================================================================================================================================================================================================+ + | item_id | String | Service member ID. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | Integer | Protocol type: **6** (TCP), **17** (UDP), **1** (ICMP), **58** (ICMPv6), or **-1** (any). It cannot be left blank when **type** is set to **0** (manual), and can be left blank when **type** is set to **1** (automatic). | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_port | String | Source port. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dest_port | String | Destination port. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Service member description. | + +-------------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** .. table:: **Table 7** Response body parameters - ========== ====== =========== + ========== ====== ================== Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== + ========== ====== ================== + error_code String Error code. + error_msg String Error description. + ========== ====== ================== + +**Status code: 401** + +.. table:: **Table 8** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + ``-`` String + ========= ====== =========== + +**Status code: 403** + +.. table:: **Table 9** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + ``-`` String + ========= ====== =========== + +**Status code: 404** + +.. table:: **Table 10** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + ``-`` String + ========= ====== =========== + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + ``-`` String + ========= ====== =========== Example Requests ---------------- -Query the member list of the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 7cdebed3-af07-494e-a3c2-b88bb8d58b57. +Query the members of service group 7cdebed3-af07-494e-a3c2-b88bb8d58b57 in project 9d80d070b6d44942af73c9c3d38e0429. .. code-block:: @@ -128,7 +168,7 @@ Example Responses **Status code: 200** -Return value of the service group member list +Return value of the service group member list. .. code-block:: @@ -156,22 +196,22 @@ Bad Request { "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" + "error_msg" : "Object not found." } Status Codes ------------ -=========== ============================================= +=========== ============================================== Status Code Description -=========== ============================================= -200 Return value of the service group member list +=========== ============================================== +200 Return value of the service group member list. 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 500 Internal Server Error -=========== ============================================= +=========== ============================================== Error Codes ----------- diff --git a/api-ref/source/api/service_set_management/index.rst b/api-ref/source/api/service_set_management/index.rst deleted file mode 100644 index c72ea83..0000000 --- a/api-ref/source/api/service_set_management/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -:original_name: topic_300000005.html - -.. _topic_300000005: - -Service Set Management -====================== - -- :ref:`Creating a Service Member ` -- :ref:`Batch Delete Service Items ` -- :ref:`Obtaining the Service Set List ` -- :ref:`Creating a Service Set ` -- :ref:`Querying Service Set Details ` -- :ref:`Modifying a Service Set ` -- :ref:`Deleting a Service Set ` -- :ref:`Querying the Service Set Member List ` -- :ref:`Deleting a Service Member ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - creating_a_service_member - batch_delete_service_items - obtaining_the_service_set_list - creating_a_service_set - querying_service_set_details - modifying_a_service_set - deleting_a_service_set - querying_the_service_set_member_list - deleting_a_service_member diff --git a/api-ref/source/api/service_set_management/modifying_a_service_set.rst b/api-ref/source/api/service_set_management/modifying_a_service_set.rst deleted file mode 100644 index bf393a1..0000000 --- a/api-ref/source/api/service_set_management/modifying_a_service_set.rst +++ /dev/null @@ -1,157 +0,0 @@ -:original_name: UpdateServiceSet.html - -.. _UpdateServiceSet: - -Modifying a Service Set -======================= - -Function --------- - -This API is used to update a service group. - -URI ---- - -PUT /v1/{project_id}/service-sets/{set_id} - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== ================ - Parameter Mandatory Type Description - ========== ========= ====== ================ - project_id Yes String Project ID - set_id Yes String Service group ID - ========== ========= ====== ================ - -.. table:: **Table 2** Query Parameters - - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Request body parameters - - +-----------------+-----------------+-----------------+---------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================+ - | name | No | String | Service group name | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **255** | - +-----------------+-----------------+-----------------+---------------------------+ - | description | No | String | Service group description | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **255** | - +-----------------+-----------------+-----------------+---------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 5** Response body parameters - - +-----------+------------------------------------------------------+----------------------+ - | Parameter | Type | Description | - +===========+======================================================+======================+ - | data | :ref:`data ` object | service set response | - +-----------+------------------------------------------------------+----------------------+ - -.. _updateserviceset__response_data: - -.. table:: **Table 6** data - - ========= ====== ============== - Parameter Type Description - ========= ====== ============== - id String service set ID - ========= ====== ============== - -**Status code: 400** - -.. table:: **Table 7** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -Change the name and description of service group 221cfdca-3abf-4c30-ab0d-516a03c70866 of project 9d80d070b6d44942af73c9c3d38e0429 to ceshi2. - -.. code-block:: - - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866 - - { - "name" : "ceshi2", - "description" : "Description" - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "data" : { - "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866" - } - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" - } - -Status Codes ------------- - -=========== ===================== -Status Code Description -=========== ===================== -200 OK -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -500 Internal Server Error -=========== ===================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/api/service_set_management/querying_service_set_details.rst b/api-ref/source/api/service_set_management/querying_service_set_details.rst deleted file mode 100644 index 382f368..0000000 --- a/api-ref/source/api/service_set_management/querying_service_set_details.rst +++ /dev/null @@ -1,157 +0,0 @@ -:original_name: ListServiceSetDetail.html - -.. _ListServiceSetDetail: - -Querying Service Set Details -============================ - -Function --------- - -This API is used to query the details about a service group. - -URI ---- - -GET /v1/{project_id}/service-sets/{set_id} - -.. table:: **Table 1** Path Parameters - - ========== ========= ====== ================ - Parameter Mandatory Type Description - ========== ========= ====== ================ - project_id Yes String Project ID - set_id Yes String Service group ID - ========== ========= ====== ================ - -.. table:: **Table 2** Query Parameters - - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+--------------------------------------------------------------------------------------------------------+-----------------------------+ - | Parameter | Type | Description | - +===========+========================================================================================================+=============================+ - | data | :ref:`ServiceSetDetailResponseDto ` object | service set detail response | - +-----------+--------------------------------------------------------------------------------------------------------+-----------------------------+ - -.. _listservicesetdetail__response_servicesetdetailresponsedto: - -.. table:: **Table 5** ServiceSetDetailResponseDto - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+================================================================================================================+ - | id | String | Service group ID | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------+ - | name | String | Service group name | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **255** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------+ - | description | String | Service group description | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **255** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------+ - | service_set_type | Integer | predefined service set type, 1 indicates Web Service, 2 indicates Remote login and PING, 3 indicates Databases | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 6** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - error_code String Error code - error_msg String Description - ========== ====== =========== - -Example Requests ----------------- - -Query details about the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 221cfdca-3abf-4c30-ab0d-516a03c70866. - -.. code-block:: - - https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866 - -Example Responses ------------------ - -**Status code: 200** - -Response to the request for querying details about a service group member - -.. code-block:: - - { - "data" : { - "service_set_type" : 0, - "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866", - "name" : "ceshi2" - } - } - -**Status code: 400** - -Bad Request - -.. code-block:: - - { - "error_code" : "CFW.00200005", - "error_msg" : "operation content does not exist" - } - -Status Codes ------------- - -+-------------+---------------------------------------------------------------------------+ -| Status Code | Description | -+=============+===========================================================================+ -| 200 | Response to the request for querying details about a service group member | -+-------------+---------------------------------------------------------------------------+ -| 400 | Bad Request | -+-------------+---------------------------------------------------------------------------+ -| 401 | Unauthorized | -+-------------+---------------------------------------------------------------------------+ -| 403 | Forbidden | -+-------------+---------------------------------------------------------------------------+ -| 404 | Not Found | -+-------------+---------------------------------------------------------------------------+ -| 500 | Internal Server Error | -+-------------+---------------------------------------------------------------------------+ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/api-ref/source/appendix/index.rst b/api-ref/source/appendix/index.rst index b2dd1a1..ffa93f2 100644 --- a/api-ref/source/appendix/index.rst +++ b/api-ref/source/appendix/index.rst @@ -7,6 +7,12 @@ Appendix - :ref:`Status Code ` - :ref:`Error Codes ` +- :ref:`Obtaining a Project ID ` +- :ref:`Obtaining an Enterprise Project ID ` +- :ref:`Obtaining a Firewall ID ` +- :ref:`Obtaining a User Token ` +- :ref:`Obtaining Account, IAM User, Group, Project, Region, and Agency Information ` +- :ref:`Region Information ` .. toctree:: :maxdepth: 1 @@ -14,3 +20,9 @@ Appendix status_code error_codes + obtaining_a_project_id + obtaining_an_enterprise_project_id + obtaining_a_firewall_id + obtaining_a_user_token + obtaining_account_iam_user_group_project_region_and_agency_information + region_information diff --git a/api-ref/source/appendix/obtaining_a_firewall_id.rst b/api-ref/source/appendix/obtaining_a_firewall_id.rst new file mode 100644 index 0000000..09f85e4 --- /dev/null +++ b/api-ref/source/appendix/obtaining_a_firewall_id.rst @@ -0,0 +1,13 @@ +:original_name: cfw_02_0028.html + +.. _cfw_02_0028: + +Obtaining a Firewall ID +======================= + +A firewall ID (**fw_instance_Id**) is a CFW instance ID. It is automatically generated by the system after CFW is created. + +You can obtain the value by calling the API for querying a firewall list. + +- By default, if **fw_instance_Id** is not specified, information about the first firewall under the account is returned. If **fw_instance_Id** is specified, information about the firewall with this **fw_instance_Id** is returned. +- If **object_Id** is specified, information about the firewall with this **object_Id** is returned by default. If both **fw_instance_Id** and **object_Id** are specified, the specified **object_Id** must belong to the specified firewall. diff --git a/api-ref/source/appendix/obtaining_a_project_id.rst b/api-ref/source/appendix/obtaining_a_project_id.rst new file mode 100644 index 0000000..ae91b13 --- /dev/null +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -0,0 +1,23 @@ +:original_name: cfw_02_0015.html + +.. _cfw_02_0015: + +Obtaining a Project ID +====================== + +Obtaining a Project ID from the Console +--------------------------------------- + +A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations: + +#. Log in to the management console. + +#. Click the username and choose **My Credential** from the drop-down list. + + On the **My Credential** page, view project IDs in the project list. + + +.. figure:: /_static/images/en-us_image_0218728478.jpg + :alt: **Figure 1** Viewing project IDs + + **Figure 1** Viewing project IDs diff --git a/api-ref/source/appendix/obtaining_a_user_token.rst b/api-ref/source/appendix/obtaining_a_user_token.rst new file mode 100644 index 0000000..f78ddde --- /dev/null +++ b/api-ref/source/appendix/obtaining_a_user_token.rst @@ -0,0 +1,11 @@ +:original_name: cfw_02_0029.html + +.. _cfw_02_0029: + +Obtaining a User Token +====================== + +Obtaining a User Token by Using Postman +--------------------------------------- + +Before calling an API, you need to obtain a user token for authentication. For details about how to use Postman to obtain a user token, see `Token Authentication `__. diff --git a/api-ref/source/appendix/obtaining_account_iam_user_group_project_region_and_agency_information.rst b/api-ref/source/appendix/obtaining_account_iam_user_group_project_region_and_agency_information.rst new file mode 100644 index 0000000..4b90828 --- /dev/null +++ b/api-ref/source/appendix/obtaining_account_iam_user_group_project_region_and_agency_information.rst @@ -0,0 +1,27 @@ +:original_name: cfw_02_0030.html + +.. _cfw_02_0030: + +Obtaining Account, IAM User, Group, Project, Region, and Agency Information +=========================================================================== + +Obtaining User, Account, and Project Information +------------------------------------------------ + +Your username, user ID, account name, account ID, project name, and project ID need to be specified in the URI and request body for calling certain APIs. Obtain these parameters on the **My Credentials** page. + +#. Log in to management console. +#. Click the username in the upper right corner, and choose **My Credentials**. +#. On the **My Credentials** page, view the username, user ID, account name, account ID, project name, and project ID. + +Obtaining User Group Information +-------------------------------- + +#. Log in to the IAM console, and choose **User Groups** in the navigation pane. +#. Expand the details page of a user group and view the group name and ID. + +Obtaining Agency Information +---------------------------- + +#. Log in to the IAM console, and choose **Agencies** in the navigation pane. +#. Hover the mouse pointer over the agency you want to view. The name and ID of this agency are displayed. diff --git a/api-ref/source/appendix/obtaining_an_enterprise_project_id.rst b/api-ref/source/appendix/obtaining_an_enterprise_project_id.rst new file mode 100644 index 0000000..c3a248f --- /dev/null +++ b/api-ref/source/appendix/obtaining_an_enterprise_project_id.rst @@ -0,0 +1,15 @@ +:original_name: cfw_02_0027.html + +.. _cfw_02_0027: + +Obtaining an Enterprise Project ID +================================== + +This section describes how to obtain an enterprise project ID on the management console. + +Procedure +--------- + +#. Log in to the management console. +#. Choose **Enterprise** > **Project Management** in the upper right corner of the page. +#. Copy the enterprise project ID in the **Name/ID** column. diff --git a/api-ref/source/appendix/region_information.rst b/api-ref/source/appendix/region_information.rst new file mode 100644 index 0000000..57da3ff --- /dev/null +++ b/api-ref/source/appendix/region_information.rst @@ -0,0 +1,225 @@ +:original_name: cfw_02_0031.html + +.. _cfw_02_0031: + +Region Information +================== + +Continent Information +--------------------- + +============= ==== +Continent Code +============= ==== +North America NA +Oceania OA +Africa AF +Antarctica AN +South America SA +Europe EU +Asia AS +============= ==== + +Country/Province Information +---------------------------- + +======================================== ==== +Country Code +======================================== ==== +Albania AL +Algeria DZ +Afghanistan AF +Libya LY +United Arab Emirates AE +Aruba AW +Oman OM +Azerbaijan AZ +Egypt EG +Ethiopia ET +Ireland IE +Estonia EE +Andorra AD +Angola AO +Anguilla AI +Antigua and Barbuda AG +Austria AT +Åland Islands AX +Australia AU +Barbados BB +Papua New Guinea PG +Bahamas BS +Pakistan PK +Paraguay PY +Bahrain BH +Brazil BR +Belarus BY +Bermuda BM +Bulgaria BG +Benin BJ +Belgium BE +Iceland IS +Poland PL +Bosnia and Herzegovina BA +Botswana BW +Bhutan BT +Burkina Faso BF +Burundi BI +North Korea KP +Equatorial Guinea GQ +Denmark DK +Germany DE +East Timor TL +Togo TG +Dominica DM +Dominican Republic DO +Russia RU +Eritrea ER +France FR +Faroe Islands FO +French Guiana GF +French Southern Territories TF +Philippines PH +Fiji FJ +Finland FI +Cape Verde CV +Falkland Islands FK +Gambia GM +Republic of the Congo CG +Guernsey GG +Greenland GL +Georgia GE +Guyana GY +Kazakhstan KZ +South Korea KR +Netherlands NL +Montenegro ME +Djibouti DJ +Kyrgyzstan KG +Guinea GN +Guinea-Bissau GW +Ghana GH +Gabon GA +Cambodia KH +Czech Republic CZ +Zimbabwe ZW +Cameroon CM +Qatar QA +Cocos (Keeling) Islands CC +Comoros KM +Kuwait KW +Croatia HR +Kenya KE +Cook Islands CK +Latvia LV +Lesotho LS +Laos LA +Lebanon LB +Republic of Lithuania LT +Liberia LR +Liechtenstein LI +Reunion RE +Luxembourg LU +Rwanda RW +Romania RO +Madagascar MG +Maldives MV +Malta MT +Malawi MW +Malaysia MY +Mali ML +Marshall Islands MH +Martinique MQ +Mayotte YT +Isle of Man IM +Mauritius MU +Mauritania MR +Mongolia MN +Bangladesh BD +Federated States of Micronesia FM +Myanmar MM +Republic of Moldova MD +Morocco MA +Monaco MC +Mozambique MZ +Namibia NA +South Africa ZA +South Georgia and South Sandwich Islands GS +Nauru NR +Nepal NP +Niger NE +Nigeria NG +Norway NO +Norfolk Island NF +Palau PW +Portugal PT +North Macedonia MK +Japan JP +Sweden SE +Switzerland CH +Sierra Leone SL +Senegal SN +Cyprus CY +Seychelles SC +Saudi Arabia SA +Christmas Island CX +Sao Tome and Principe ST +Saint Helena SH +Saint Kitts and Nevis KN +Sant Lucia LC +San Marino SM +Saint Pierre and Miquelon PM +Vatican City VA +Sri Lanka LK +Slovak Republic SK +Slovenia SI +Svalbard and Jan Mayen SJ +Eswatini SZ +Suriname SR +Solomon Islands SB +Somalia SO +Tajikistan TJ +Thailand TH +Tanzania TZ +Turks and Caicos Islands TC +Trinidad and Tobago TT +Tunisia TN +Tuvalu TV +Türkiye TR +Turkmenistan TM +Vanuatu VU +Brunei BN +Uganda UG +Ukraine UA +Uruguay UY +Uzbekistan UZ +Spain ES +Greece GR +Ivory Coast CI +Singapore SG +New Caledonia NC +New Zealand NZ +Hungary HU +Jamaica JM +Armenia AM +Yemen YE +Iraq IQ +Israel IL +Italy IT +India IN +Indonesia ID +United Kingdom GB +Virgin Islands, British VG +British Indian Ocean Territory IO +Jordan JO +Vietnam VN +Zambia ZM +Jersey JE +Republic of Zaire CD +Chad TD +Gibraltar GI +Central African Republic CF +Macao (China) MO +Chinese mainland CN +Taiwan (China) TW +Hong Kong (China) HK +======================================== ==== diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index c68f970..16c0b26 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,18 @@ Change History +-----------------------------------+----------------------------------------------------------------------------------+ | Release Date | Description | +===================================+==================================================================================+ +| 2024-09-18 | This issue is the sixth official release. | +| | | +| | Updated the API parameter description. | +| | | +| | Added the following sections to the appendix: | +| | | +| | - Obtaining an Enterprise Project ID | +| | - Obtaining a Firewall ID | +| | - Obtaining a User Token | +| | - Obtaining Account, IAM User, Group, Project, Region, and Agency Information | +| | - Region Information | ++-----------------------------------+----------------------------------------------------------------------------------+ | 2024-08-14 | This issue is the fifth official release. | | | | | | Optimized "ACL Rule Management". | diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 6f8663f..ec72534 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -131,4 +131,4 @@ latex_elements = { 'figure_align': 'H', 'preamble': r'\newcommand{\githash}{' + current_commit_hash + '}', 'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm' -} \ No newline at end of file +}