CFW API 20250428 version

Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qinweiwei <qinweiwei@huawei.com>
Co-committed-by: qinweiwei <qinweiwei@huawei.com>

docs/cfw/api-ref/ALL_META.TXT.json

@@ -221,7 +221,7 @@
 		"node_id":"createeastwestfirewall.xml",
 		"product_code":"cfw",
 		"code":"12",
-		"des":"This API is used to create an east-west firewall.POST /v1/{project_id}/firewall/east-westStatus code: 200Under firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in project 09",
+		"des":"This API is used to create an east-west firewall.POST /v1/{project_id}/firewall/east-westStatus code: 200In project 09bb24e6f280d23d0f9fc0104b901480, create a firewall 55",
 		"doc_type":"api",
 		"kw":"Creating an East-West Firewall,Firewall Management,API Reference",
 		"search_title":"",
@@ -1563,13 +1563,15 @@
 		"node_id":"cfw_02_0013.xml",
 		"product_code":"cfw",
 		"code":"80",
-		"des":"NormalStatus CodeDescriptionDescription200OKThe request is successfully processed.AbnormalStatus CodeDescriptionDescription400Bad RequestIt is a bad request.401Unauthoriz",
+		"des":"NormalStatus CodeDescriptionDescription200OKThe request is successfully processed.201CreatedThe request for creating resources has been fulfilled.202AcceptedThe request h",
 		"doc_type":"api",
 		"kw":"Status Code,Appendix,API Reference",
 		"search_title":"",
 		"metedata":[
 			{
 				"documenttype":"api",
+				"IsBot":"No;Yes",
+				"opensource":"true",
 				"prodname":"cfw"
 			}
 		],
@@ -1587,9 +1589,8 @@
 		"search_title":"",
 		"metedata":[
 			{
-				"documenttype":"api",
 				"prodname":"cfw",
-				"opensource":"true"
+				"documenttype":"api"
 			}
 		],
 		"title":"Error Codes",
@@ -1607,6 +1608,8 @@
 		"metedata":[
 			{
 				"documenttype":"api",
+				"opensource":"true",
+				"IsBot":"Yes",
 				"prodname":"cfw"
 			}
 		],

docs/cfw/api-ref/CLASS.TXT.json

@@ -99,7 +99,7 @@
 		"code":"11"
 	},
 	{
-		"desc":"This API is used to create an east-west firewall.POST /v1/{project_id}/firewall/east-westStatus code: 200Under firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in project 09",
+		"desc":"This API is used to create an east-west firewall.POST /v1/{project_id}/firewall/east-westStatus code: 200In project 09bb24e6f280d23d0f9fc0104b901480, create a firewall 55",
 		"product_code":"cfw",
 		"title":"Creating an East-West Firewall",
 		"uri":"CreateEastWestFirewall.html",
@@ -711,7 +711,7 @@
 		"code":"79"
 	},
 	{
-		"desc":"NormalStatus CodeDescriptionDescription200OKThe request is successfully processed.AbnormalStatus CodeDescriptionDescription400Bad RequestIt is a bad request.401Unauthoriz",
+		"desc":"NormalStatus CodeDescriptionDescription200OKThe request is successfully processed.201CreatedThe request for creating resources has been fulfilled.202AcceptedThe request h",
 		"product_code":"cfw",
 		"title":"Status Code",
 		"uri":"cfw_02_0013.html",

docs/cfw/api-ref/ListJob.html

@@ -145,9 +145,9 @@
 <p>Return value of the API for obtaining the information about a pay-per-use firewall creation task.</p>
 <pre class="screen">{
   "data" : {
-    "begin_time" : 1641370501000,
+    "begin_time" : "2023-11-14 10:10:27 +0800",
-    "end_time" : 1641370515000,
+    "end_time" : "2023-11-14 10:15:46 +0800",
-    "id" : "f588ce71-e26c-400d-8981-f854355f6849",
+    "id" : "7517d932-8e79-4273-a001-ceff74e121f7",
     "status" : "Success"
   }
 }</pre>

docs/cfw/api-ref/cfw_02_0013.html

@@ -17,6 +17,28 @@
 <td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.1.1.1.1.4.1.3 "><p id="cfw_02_0013__p9398018">The request is successfully processed.</p>
 </td>
 </tr>
+<tr id="cfw_02_0013__row8394114083318"><td class="cellrowborder" valign="top" width="14.16%" headers="mcps1.3.1.1.1.1.4.1.1 "><p id="cfw_02_0013__p109721541173416">201</p>
+</td>
+<td class="cellrowborder" valign="top" width="32.42%" headers="mcps1.3.1.1.1.1.4.1.2 "><p id="cfw_02_0013__p997210419342">Created</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.1.1.1.1.4.1.3 "><p id="cfw_02_0013__p79721241133412">The request for creating resources has been fulfilled.</p>
+</td>
+</tr>
+<tr id="cfw_02_0013__row1085774173311"><td class="cellrowborder" valign="top" width="14.16%" headers="mcps1.3.1.1.1.1.4.1.1 "><p id="cfw_02_0013__p9972441153419">202</p>
+</td>
+<td class="cellrowborder" valign="top" width="32.42%" headers="mcps1.3.1.1.1.1.4.1.2 "><p id="cfw_02_0013__p16972941123410">Accepted</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.1.1.1.1.4.1.3 "><p id="cfw_02_0013__p797217414344">The request has been accepted, but the processing has not been completed.</p>
+</td>
+</tr>
+<tr id="cfw_02_0013__row1155364483316"><td class="cellrowborder" valign="top" width="14.16%" headers="mcps1.3.1.1.1.1.4.1.1 "><p id="cfw_02_0013__p13723351113316">204</p>
+</td>
+<td class="cellrowborder" valign="top" width="32.42%" headers="mcps1.3.1.1.1.1.4.1.2 "><p id="cfw_02_0013__p672325119333">No Content</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.1.1.1.1.4.1.3 "><p id="cfw_02_0013__p179744743419">The request has been fulfilled, but the HTTP response does not contain a response body.</p>
+<p id="cfw_02_0013__p497154723415">The status code is returned in response to an HTTP OPTIONS request.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -57,6 +79,43 @@
 <td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p986356152818">The page is not found.</p>
 </td>
 </tr>
+<tr id="cfw_02_0013__row74891804343"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p103312915343">405</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p143311092348">Method Not Allowed</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p93741157103413">The request contains one or more methods not supported for the resource.</p>
+<p id="cfw_02_0013__p17374195793416">Modify the request and then try again.</p>
+</td>
+</tr>
+<tr id="cfw_02_0013__row468017093411"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p1233179193418">409</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p933189113419">Conflict</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p465812124357">The request could not be processed due to a conflict with the current state of the resource.</p>
+<p id="cfw_02_0013__p14658912153517">This status code indicates that the resource that the client is attempting to create already exists, or that the requested update cannot be fulfilled due to the conflict.</p>
+</td>
+</tr>
+<tr id="cfw_02_0013__row987613073419"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p17331159173416">413</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p1733114983411">Request Entity Too Large</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p118761203345">The request is larger than what the server is able to process. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a <strong id="cfw_02_0013__b89457361092723">Retry-After</strong> header field.</p>
+</td>
+</tr>
+<tr id="cfw_02_0013__row1649151193418"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p733139103410">415</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p13318983411">Unsupported Media Type</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p144914113347">The server is unable to process the media format in the request.</p>
+</td>
+</tr>
+<tr id="cfw_02_0013__row1623361163419"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p033129133414">429</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p333115915344">Too Many Requests</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p62331418343">The client has sent excessive number of requests to the server within a given time (exceeding the limit on the access frequency of the client), or the server has received an excessive number of requests within a given time (beyond its processing capability). In this case, the client should resend the request after the time specified in the <strong id="cfw_02_0013__b37360754192723">Retry-After</strong> header of the response has elapsed.</p>
+</td>
+</tr>
 <tr id="cfw_02_0013__row86529268286"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p1765372612814">500</p>
 </td>
 <td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p46539263281">Internal Server Error</p>
@@ -64,6 +123,21 @@
 <td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p106531264280">There is an internal server error.</p>
 </td>
 </tr>
+<tr id="cfw_02_0013__row53611615123416"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p18400191943415">501</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p104001194341">Not Implemented</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p1336131513346">The server does not support the function required to fulfill the request.</p>
+</td>
+</tr>
+<tr id="cfw_02_0013__row1353710152345"><td class="cellrowborder" valign="top" width="13.87%" headers="mcps1.3.1.2.1.1.4.1.1 "><p id="cfw_02_0013__p6400111915347">503</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.1.2.1.1.4.1.2 "><p id="cfw_02_0013__p84001719153410">Service Unavailable</p>
+</td>
+<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.1.2.1.1.4.1.3 "><p id="cfw_02_0013__p1374264083512">The requested service is invalid.</p>
+<p id="cfw_02_0013__p1174264017351">Modify the request and then try again.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>

docs/cfw/api-ref/cfw_02_0015.html

@@ -1,10 +1,10 @@
 <a name="cfw_02_0015"></a><a name="cfw_02_0015"></a>
 
 <h1 class="topictitle1">Obtaining a Project ID</h1>
-<div id="body8662426"><div class="section" id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_section59621329127"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_p8112855194115">A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
+<div id="body8662426"><div class="section" id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_section59621329127"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_p8112855194115">A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
-<ol id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_ol8715914194127"><li id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_li50056756194127">Log in to the management console.</li><li id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_li2804809915217">Click the username and choose <strong id="cfw_02_0015__en-us_topic_0171850914_b8169259132211">My Credential</strong> from the drop-down list.<p id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_p136772519449">On the <strong id="cfw_02_0015__en-us_topic_0171850914_b57411048112216">My Credential</strong> page, view project IDs in the project list.</p>
+<ol id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_ol8715914194127"><li id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_li50056756194127">Log in to the management console.</li><li id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_li2804809915217">Click the username and choose <strong id="cfw_02_0015__en-us_topic_0277985054_b123731795154">My Credential</strong> from the drop-down list.<p id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_p136772519449">On the displayed page, view project IDs in the project list.</p>
 </li></ol>
-<div class="fignone" id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="cfw_02_0015__en-us_topic_0171850914_en-us_topic_0101662393_image538470016132" src="en-us_image_0218728478.jpg"></span></div>
+<div class="fignone" id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="cfw_02_0015__en-us_topic_0277985054_en-us_topic_0101662393_image538470016132" src="en-us_image_0277985093.jpg"></span></div>
 </div>
 </div>
 <div>

docs/cfw/api-ref/cfw_02_0017.html

@@ -8,7 +8,38 @@
 </th>
 </tr>
 </thead>
-<tbody><tr id="cfw_02_0017__row611346192716"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p119463276">2025-02-18</p>
+<tbody><tr id="cfw_02_0017__row2692131412476"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p46922014154715">2025-08-01</p>
+</td>
+<td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="cfw_02_0017__p196921914174710">This issue is the fifteenth official release.</p>
+<p id="cfw_02_0017__p5168183334715">Changed the<strong id="cfw_02_0017__b513717920132"> Type</strong> of <strong id="cfw_02_0017__b1874907135">begin_time</strong> and<strong id="cfw_02_0017__b11702391310"> end_time</strong> in "Obtaining the Status of a CFW Task" to <strong id="cfw_02_0017__b959981171314">String</strong>.</p>
+</td>
+</tr>
+<tr id="cfw_02_0017__row7372193410548"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p15372163465410">2025-07-09</p>
+</td>
+<td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="cfw_02_0017__p14372534165414">This is the fourteenth official release.</p>
+<p id="cfw_02_0017__p1356135113548">Optimized the "Example Responses" section in "Obtaining the Status of a CFW Task".</p>
+</td>
+</tr>
+<tr id="cfw_02_0017__row16897133912488"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p13897123910485">2025-06-27</p>
+</td>
+<td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><div class="p" id="cfw_02_0017__p689710398481">This is the thirteenth official release.<ul id="cfw_02_0017__ul7966122145316"><li id="cfw_02_0017__li2966112117537">Optimized the "Example Requests" section in "Creating an East-West Firewall."</li><li id="cfw_02_0017__li19979182415538">Changed <strong id="cfw_02_0017__b4403212114">connection ID</strong> to <strong id="cfw_02_0017__b10392531211">attachment ID</strong>.</li></ul>
+</div>
+</td>
+</tr>
+<tr id="cfw_02_0017__row1227073715715"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p8270737975">2025-05-23</p>
+</td>
+<td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><div class="p" id="cfw_02_0017__p72709371373">This is the twelfth official release.<ul id="cfw_02_0017__ul9449185616813"><li id="cfw_02_0017__li104495561189">Optimized the description of lts_enable.</li><li id="cfw_02_0017__li45804591684">Updated the "Example Request" section in "Creating a Firewall."</li><li id="cfw_02_0017__li51091065157">Updated the <strong id="cfw_02_0017__b148829112278">inspection_vpc_id</strong> parameter in "Creating an East-West Firewall".</li></ul>
+</div>
+</td>
+</tr>
+<tr id="cfw_02_0017__row1864639183010"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p36471912304">2025-03-31</p>
+</td>
+<td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="cfw_02_0017__p16475943014">This issue is the eleventh official release.</p>
+<p id="cfw_02_0017__p11279181853015">Deleted:</p>
+<p id="cfw_02_0017__p1730574213220"><strong id="cfw_02_0017__b142930576383">period_type</strong>, <strong id="cfw_02_0017__b193211581385">period_num</strong>, and other parameters.</p>
+</td>
+</tr>
+<tr id="cfw_02_0017__row611346192716"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p119463276">2025-02-18</p>
 </td>
 <td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="cfw_02_0017__p311446152716">This issue is the tenth official release. </p>
 <p id="cfw_02_0017__p9716313162815">Optimized:</p>
@@ -19,7 +50,7 @@
 </tr>
 <tr id="cfw_02_0017__row18832350536"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.1.1.3.1.1 "><p id="cfw_02_0017__p1583314509317">2025-01-22</p>
 </td>
-<td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="cfw_02_0017__p4833125011313">This is the ninth official release.</p>
+<td class="cellrowborder" valign="top" width="72.72999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="cfw_02_0017__p4833125011313">This issue is the ninth official release.</p>
 <p id="cfw_02_0017__p18475583310">Added the header parameter <strong id="cfw_02_0017__b12942151816275">Content-Type</strong>.</p>
 <div class="p" id="cfw_02_0017__p729884821811">Optimized:<ul id="cfw_02_0017__ul1860155315186"><li id="cfw_02_0017__li16600530183">Link name in the <a href="cfw_02_0028.html">Obtaining a Firewall ID</a> section.</li><li id="cfw_02_0017__li4927205319183">Description of parameters such as <strong id="cfw_02_0017__b461744910272">tags_id</strong>.</li></ul>
 </div>