AOM API 0929

.gitea/workflows/class-txt-check.yml

@@ -1,81 +0,0 @@
-# .gitea/workflows/class-txt-check.yml
-name: Docs Precheck - CLASS.TXT.json Check
-
-on:
-  pull_request:
-    types: [opened, reopened, synchronize, edited]
-
-permissions:
-  contents: read
-  pull-requests: write
-
-jobs:
-  class-txt-check:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Get changed CLASS.TXT.json files
-        id: changed-files
-        run: |
-          BASE_SHA="${{ gitea.event.pull_request.base.sha }}"
-          changed=$(git diff --name-only ${BASE_SHA}...HEAD | grep -E 'CLASS\.TXT\.json$' | tr '\n' ' ' || true)
-          echo "files=$changed" >> $GITHUB_OUTPUT
-          echo "CHANGED_FILES=$changed" >> $GITHUB_ENV
-          echo "Changed CLASS.TXT.json files: $changed"
-
-      - name: Run duplicate title check
-        id: class-check
-        run: |
-          python3 .gitea/workflows/helpers/class-txt-check.py
-
-      - name: Comment on PR with violations
-        if: failure() && steps.class-check.outcome == 'failure'
-        env:
-          GITEA_SERVER_URL: ${{ gitea.server_url }}
-          REPO: ${{ gitea.repository }}
-          PR_NUMBER: ${{ gitea.event.pull_request.number }}
-          TOKEN: ${{ gitea.token }}
-        run: |
-          set -euo pipefail
-
-          # Ensure URL starts with http
-          if [[ ! "${GITEA_SERVER_URL}" =~ ^https?:// ]]; then
-            GITEA_SERVER_URL="http://${GITEA_SERVER_URL}"
-            echo "Added http:// prefix to URL"
-          fi
-
-          # Generate comment message
-          MSG=$(python3 .gitea/workflows/helpers/class-comment.py)
-          echo "$MSG"
-
-          # Extract body from JSON
-          BODY=$(echo "$MSG" | python3 -c "import sys, json; print(json.load(sys.stdin)['body'])")
-
-          # Build the full URL
-          FULL_URL="${GITEA_SERVER_URL}/api/v1/repos/${REPO}/issues/${PR_NUMBER}/comments"
-          echo "Posting comment to: ${FULL_URL}"
-
-          # Comment on PR
-          curl -sS -X POST \
-            -H "Authorization: token ${TOKEN}" \
-            -H "Content-Type: application/json" \
-            "${FULL_URL}" \
-            -d "$(echo "$BODY" | python3 -c "import sys, json; print(json.dumps({'body': sys.stdin.read()}))")"
-
-      - name: Final status
-        if: always()
-        run: |
-          if [ -f violations.json ]; then
-            echo "::error::CLASS.TXT.json check failed. See previous step for details."
-            exit 1
-          fi

.gitea/workflows/docs-precheck.yml

@@ -1,84 +0,0 @@
-# .gitea/workflows/docs-precheck.yml
-name: Docs Precheck - Underscore Check
-
-on:
-  pull_request:
-    types: [opened, reopened, synchronize, edited]
-
-permissions:
-  contents: read
-  pull-requests: write
-
-jobs:
-  docs-precheck:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Install dependencies
-        run: pip install beautifulsoup4 lxml
-
-      - name: Get changed HTML files
-        id: changed-files
-        run: |
-          BASE_SHA="${{ gitea.event.pull_request.base.sha }}"
-          changed=$(git diff --name-only ${BASE_SHA}...HEAD | grep -E '\.(html|htm)$' | tr '\n' ' ' || true)
-          echo "files=$changed" >> $GITHUB_OUTPUT
-          echo "CHANGED_FILES=$changed" >> $GITHUB_ENV
-          echo "Changed HTML files: $changed"
-
-      - name: Run underscore check
-        id: underscore-check
-        run: |
-          python3 .gitea/workflows/helpers/underscore-check.py
-
-      - name: Comment on PR with violations
-        if: failure() && steps.underscore-check.outcome == 'failure'
-        env:
-          GITEA_SERVER_URL: ${{ gitea.server_url }}
-          REPO: ${{ gitea.repository }}
-          PR_NUMBER: ${{ gitea.event.pull_request.number }}
-          TOKEN: ${{ gitea.token }}
-        run: |
-          set -euo pipefail
-
-          # Ensure URL starts with http
-          if [[ ! "${GITEA_SERVER_URL}" =~ ^https?:// ]]; then
-            GITEA_SERVER_URL="http://${GITEA_SERVER_URL}"
-            echo "Added http:// prefix to URL"
-          fi
-
-          # Generate comment message
-          MSG=$(python3 .gitea/workflows/helpers/underscore-comment.py)
-          echo "$MSG"
-
-          # Extract body from JSON
-          BODY=$(echo "$MSG" | python3 -c "import sys, json; print(json.load(sys.stdin)['body'])")
-
-          # Build the full URL
-          FULL_URL="${GITEA_SERVER_URL}/api/v1/repos/${REPO}/issues/${PR_NUMBER}/comments"
-          echo "Posting comment to: ${FULL_URL}"
-
-          # Comment on PR
-          curl -sS -X POST \
-            -H "Authorization: token ${TOKEN}" \
-            -H "Content-Type: application/json" \
-            "${FULL_URL}" \
-            -d "$(echo "$BODY" | python3 -c "import sys, json; print(json.dumps({'body': sys.stdin.read()}))")"
-
-      - name: Final status
-        if: always()
-        run: |
-          if [ -f violations.json ]; then
-            echo "::error::Underscore check failed. See previous step for details."
-            exit 1
-          fi

.gitea/workflows/helpers/class-comment.py

@@ -1,71 +0,0 @@
-#!/usr/bin/env python3
-"""
-Generate PR comment for CLASS.TXT.json duplicate title violations.
-
-This script reads violations.json (created by class-txt-check.py) and generates
-a formatted markdown comment to be posted on the PR. The comment includes:
-  - File path where violations were found
-  - Parent document title and code
-  - The duplicate title
-  - Document codes that share the duplicate title
-
-Usage:
-  Run after class-txt-check.py fails. Reads violations.json and outputs JSON
-  with 'body' field containing the markdown comment text.
-"""
-
-import json
-import sys
-
-
-def main():
-    try:
-        with open("violations.json", "r") as f:
-            violations = json.load(f)
-    except Exception:
-        violations = []
-
-    if not violations:
-        print(json.dumps({"body": "No violations to report"}))
-        sys.exit(0)
-
-    # Group violations by file
-    by_file = {}
-    for v in violations:
-        key = v["file"]
-        if key not in by_file:
-            by_file[key] = []
-        by_file[key].append(v)
-
-    # Build message
-    lines = [
-        "❌ **Duplicate title detected in CLASS.TXT.json**",
-        "",
-        "Found child documents with duplicate titles under the same parent:",
-        "",
-    ]
-
-    for filepath, file_violations in by_file.items():
-        lines.append(f"**{filepath}:**")
-        for v in file_violations:
-            parent_code = v["parent_code"]
-            parent_title = v["parent_title"]
-            duplicate_title = v["duplicate_title"]
-            codes = v["codes"]
-
-            lines.append(f"   - Parent: `{parent_title}` (code: `{parent_code}`)")
-            lines.append(f"     Duplicate title: `{duplicate_title}`")
-            for code in codes:
-                lines.append(f"       - Document code: `{code}`")
-        lines.append("")
-
-    lines.append(
-        "**Please ensure all child documents under the same parent have unique titles.**"
-    )
-
-    message = "\n".join(lines)
-    print(json.dumps({"body": message}))
-
-
-if __name__ == "__main__":
-    main()

.gitea/workflows/helpers/metadata-comment.py

@@ -1,63 +0,0 @@
-#!/usr/bin/env python3
-"""
-Generate PR comment for metadata registration check violations.
-
-This script reads violations.json (created by metadata-check.py) and generates
-a formatted markdown comment to be posted on the PR. The comment includes:
-  - HTML file path that was added but not registered
-  - Which metadata files it's missing from (CLASS.TXT.json, ALL_META.TXT.json)
-  - Whether the metadata files don't exist or the file is simply missing from them
-
-Usage:
-  Run after metadata-check.py fails. Reads violations.json and outputs JSON
-  with 'body' field containing the markdown comment text.
-"""
-
-import json
-import sys
-
-
-def main():
-    try:
-        with open("violations.json", "r") as f:
-            violations = json.load(f)
-    except Exception:
-        violations = []
-
-    if not violations:
-        print(json.dumps({"body": "No violations to report"}))
-        sys.exit(0)
-
-    # Build message
-    lines = [
-        "❌ **HTML file not registered in metadata**",
-        "",
-        "The following HTML files were added but are not properly registered in the metadata files:",
-        "",
-    ]
-
-    for v in violations:
-        html_file = v["file"]
-        missing_from = v["missing_from"]
-
-        lines.append(f"**{html_file}**")
-        for missing in missing_from:
-            # Check if it's a "file not found" case
-            if "(file not found)" in missing:
-                lines.append(
-                    f"  ❌ Missing from: `{missing.split(' (')[0]}` (metadata file does not exist)"
-                )
-            else:
-                lines.append(f"  ❌ Missing from: `{missing}`")
-        lines.append("")
-
-    lines.append(
-        "**Please add the new HTML files to both `CLASS.TXT.json` and `ALL_META.TXT.json` in the same directory.**"
-    )
-
-    message = "\n".join(lines)
-    print(json.dumps({"body": message}))
-
-
-if __name__ == "__main__":
-    main()

.gitea/workflows/helpers/underscore-comment.py

@@ -1,68 +0,0 @@
-#!/usr/bin/env python3
-"""
-Generate PR comment for underscore check violations.
-
-This script reads violations.json (created by underscore-check.py) and generates
-a formatted markdown comment to be posted on the PR. The comment includes:
-  - File path where violations were found
-  - Line number of each violation
-  - The offending word (ending with underscore)
-  - Context showing where the violation appears in the HTML
-
-Usage:
-  Run after underscore-check.py fails. Reads violations.json and outputs JSON
-  with 'body' field containing the markdown comment text.
-"""
-
-import json
-import sys
-
-
-def main():
-    try:
-        with open("violations.json", "r") as f:
-            violations = json.load(f)
-    except Exception:
-        violations = []
-
-    if not violations:
-        print(json.dumps({"body": "No violations to report"}))
-        sys.exit(0)
-
-    # Group violations by file
-    by_file = {}
-    for v in violations:
-        key = v["file"]
-        if key not in by_file:
-            by_file[key] = []
-        by_file[key].append(v)
-
-    # Build message
-    lines = [
-        "❌ **Underscore check failed**",
-        "",
-        "Found words ending with underscore (not followed by alphanumeric characters):",
-        "",
-    ]
-
-    for filepath, file_violations in by_file.items():
-        lines.append(f"**{filepath}:**")
-        for v in file_violations:
-            word = v["word"]
-            line_num = v["line"]
-            context = v["context"]
-            # Escape markdown special chars in context
-            context = context.replace("`", "\\`")
-            lines.append(f"   - Line {line_num}: `{word}` in context: `{context}`")
-        lines.append("")
-
-    lines.append(
-        "**Please fix these issues as soon as possible.** Words should not end with an underscore unless followed by alphanumeric characters (A-Za-z0-9)."
-    )
-
-    message = "\n".join(lines)
-    print(json.dumps({"body": message}))
-
-
-if __name__ == "__main__":
-    main()

.gitea/workflows/metadata-check.yml

@@ -1,81 +0,0 @@
-# .gitea/workflows/metadata-check.yml
-name: Docs Precheck - Metadata Registration Check
-
-on:
-  pull_request:
-    types: [opened, reopened, synchronize, edited]
-
-permissions:
-  contents: read
-  pull-requests: write
-
-jobs:
-  metadata-check:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Get added HTML files
-        id: added-files
-        run: |
-          BASE_SHA="${{ gitea.event.pull_request.base.sha }}"
-          added=$(git diff --name-status ${BASE_SHA}...HEAD | grep "^A" | awk '{print $2}' | grep -E '\.html$' | tr '\n' ' ' || true)
-          echo "files=$added" >> $GITHUB_OUTPUT
-          echo "ADDED_FILES=$added" >> $GITHUB_ENV
-          echo "Added HTML files: $added"
-
-      - name: Run metadata registration check
-        id: metadata-check
-        run: |
-          python3 .gitea/workflows/helpers/metadata-check.py
-
-      - name: Comment on PR with violations
-        if: failure() && steps.metadata-check.outcome == 'failure'
-        env:
-          GITEA_SERVER_URL: ${{ gitea.server_url }}
-          REPO: ${{ gitea.repository }}
-          PR_NUMBER: ${{ gitea.event.pull_request.number }}
-          TOKEN: ${{ gitea.token }}
-        run: |
-          set -euo pipefail
-
-          # Ensure URL starts with http
-          if [[ ! "${GITEA_SERVER_URL}" =~ ^https?:// ]]; then
-            GITEA_SERVER_URL="http://${GITEA_SERVER_URL}"
-            echo "Added http:// prefix to URL"
-          fi
-
-          # Generate comment message
-          MSG=$(python3 .gitea/workflows/helpers/metadata-comment.py)
-          echo "$MSG"
-
-          # Extract body from JSON
-          BODY=$(echo "$MSG" | python3 -c "import sys, json; print(json.load(sys.stdin)['body'])")
-
-          # Build the full URL
-          FULL_URL="${GITEA_SERVER_URL}/api/v1/repos/${REPO}/issues/${PR_NUMBER}/comments"
-          echo "Posting comment to: ${FULL_URL}"
-
-          # Comment on PR
-          curl -sS -X POST \
-            -H "Authorization: token ${TOKEN}" \
-            -H "Content-Type: application/json" \
-            "${FULL_URL}" \
-            -d "$(echo "$BODY" | python3 -c "import sys, json; print(json.dumps({'body': sys.stdin.read()}))")"
-
-      - name: Final status
-        if: always()
-        run: |
-          if [ -f violations.json ]; then
-            echo "::error::Metadata registration check failed. See previous step for details."
-            exit 1
-          fi

.gitignore

@@ -133,12 +133,3 @@ dmypy.json
 
 **/temp/
 **/tmp_result/
-
-.stestr/
-
-# Some people build submodule because of not understanding git basics
-doc-exports
-
-# Drop userless content of the docs
-docs/**/*.js
-docs/**/*.css

.spectral.yaml

@@ -1,11 +0,0 @@
-rules:
-  path-starts-with-slash-no-spaces:
-    description: Path must start with / and contain no spaces
-    message: "Path '{{property}}' must start with '/' and must not contain spaces"
-    severity: error
-    given: $.paths
-    then:
-      field: "@key"
-      function: pattern
-      functionOptions:
-        match: "^\\/[^\\s]*$"

.stestr.conf

@@ -1,3 +0,0 @@
-[DEFAULT]
-test_path=./otc_doc_convertor/tests/unit
-top_dir=./

.yamllint

@@ -1,17 +0,0 @@
-# .yamllint
-extends: default
-
-yaml-files:
-  - '*.yaml'
-  - '*.yml'
-
-rules:
-  line-length:
-    max: 120
-    level: warning
-  indentation:
-    spaces: 2        # number of spaces per indent level
-    indent-sequences: consistent  # or true/false/whatever
-    level: error
-  document-start:
-    level: warning

docs/antiddos/api-ref/PARAMETERS.txt

@@ -1,3 +0,0 @@
-version=""
-language="en-us"
-type=""

docs/antiddos/api-ref/antiddos_02_0016.html

@@ -1,39 +0,0 @@
-<a name="antiddos_02_0016"></a><a name="antiddos_02_0016"></a>
-
-<h1 class="topictitle1">Anti-DDoS APIs</h1>
-<div id="body25138252"></div>
-<div>
-<ul class="ullinks">
-<li class="ulchildlink"><strong><a href="antiddos_02_0017.html">Querying Optional Anti-DDoS Defense Policies</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0020.html">Querying Configured Anti-DDoS Defense Policies</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0021.html">Updating Anti-DDoS Defense Policies</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0022.html">Querying Anti-DDoS Tasks</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0024.html">Querying the Defense Status of a Specified EIP</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0025.html">Querying the Traffic of a Specified EIP</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0026.html">Querying Events of a Specified EIP</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0027.html">Querying Weekly Defense Statistics</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0002.html">Querying All API Versions</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0007.html">Querying a Specified API Version</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0037.html">Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0038.html">Configuring the Default Protection Policy for Newly Purchased Public IP Addresses</a></strong><br>
-</li>
-</ul>
-
-<div class="familylinks">
-<div class="parentlink"><strong>Parent topic:</strong> <a href="antiddos_02_0040.html">API</a></div>
-</div>
-</div>
-

docs/antiddos/api-ref/antiddos_02_0024.html

@@ -1,79 +0,0 @@
-<a name="antiddos_02_0024"></a><a name="antiddos_02_0024"></a>
-
-<h1 class="topictitle1">Querying the Defense Status of a Specified EIP</h1>
-<div id="body39349682"><div class="section" id="antiddos_02_0024__section35493489"><h4 class="sectiontitle">Functions</h4><p id="antiddos_02_0024__p33207705">This API allows you to query the defense status of a specified EIP.</p>
-</div>
-<div class="section" id="antiddos_02_0024__section51005947"><h4 class="sectiontitle">URI</h4><ul id="antiddos_02_0024__ul5469547"><li id="antiddos_02_0024__li49225929">URI format<p id="antiddos_02_0024__p3997403151136"><a name="antiddos_02_0024__li49225929"></a><a name="li49225929"></a>GET /v1/{project_id}/antiddos/{floating_ip_id}/status</p>
-</li><li id="antiddos_02_0024__li49569014">Parameter description
-<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0024__table43467946" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0024__row29878402"><th align="left" class="cellrowborder" valign="top" width="30.92690730926907%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="antiddos_02_0024__p4231468">Parameter</p>
-</th>
-<th align="left" class="cellrowborder" valign="top" width="17.52824717528247%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="antiddos_02_0024__p7204610">Mandatory</p>
-</th>
-<th align="left" class="cellrowborder" valign="top" width="20.617938206179375%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="antiddos_02_0024__p46702574">Type</p>
-</th>
-<th align="left" class="cellrowborder" valign="top" width="30.92690730926907%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="antiddos_02_0024__p24812117">Description</p>
-</th>
-</tr>
-</thead>
-<tbody><tr id="antiddos_02_0024__row63624481"><td class="cellrowborder" valign="top" width="30.92690730926907%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="antiddos_02_0024__p53309370">project_id</p>
-</td>
-<td class="cellrowborder" valign="top" width="17.52824717528247%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="antiddos_02_0024__p23091719">Yes</p>
-</td>
-<td class="cellrowborder" valign="top" width="20.617938206179375%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="antiddos_02_0024__p58489969">String</p>
-</td>
-<td class="cellrowborder" valign="top" width="30.92690730926907%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="antiddos_02_0024__p40067039">User ID</p>
-</td>
-</tr>
-<tr id="antiddos_02_0024__row25059035"><td class="cellrowborder" valign="top" width="30.92690730926907%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="antiddos_02_0024__p16515979">floating_ip_id</p>
-</td>
-<td class="cellrowborder" valign="top" width="17.52824717528247%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="antiddos_02_0024__p62725940">Yes</p>
-</td>
-<td class="cellrowborder" valign="top" width="20.617938206179375%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="antiddos_02_0024__p47636349">String</p>
-</td>
-<td class="cellrowborder" valign="top" width="30.92690730926907%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="antiddos_02_0024__p33339022">ID corresponding to the EIP of a user</p>
-</td>
-</tr>
-</tbody>
-</table>
-</div>
-</li></ul>
-</div>
-<div class="section" id="antiddos_02_0024__section56400342"><h4 class="sectiontitle">Request</h4><p id="antiddos_02_0024__p72063462079"><strong id="antiddos_02_0024__b133853916584">Request parameters</strong></p>
-<p id="antiddos_02_0024__p14332041145213">None</p>
-</div>
-<div class="section" id="antiddos_02_0024__section37841036"><h4 class="sectiontitle">Response</h4><ul id="antiddos_02_0024__ul58618290"><li id="antiddos_02_0024__li57802569">Parameter description
-<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0024__table50461073" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0024__row8925963"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="antiddos_02_0024__p51914417">Parameter</p>
-</th>
-<th align="left" class="cellrowborder" valign="top" width="19.84%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="antiddos_02_0024__p33008942">Type</p>
-</th>
-<th align="left" class="cellrowborder" valign="top" width="56.93%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="antiddos_02_0024__p56478678">Description</p>
-</th>
-</tr>
-</thead>
-<tbody><tr id="antiddos_02_0024__row11370190"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0024__p48570174">status</p>
-</td>
-<td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0024__p36029352">String</p>
-</td>
-<td class="cellrowborder" valign="top" width="56.93%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><div class="p" id="antiddos_02_0024__p32696434">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0024__ul25832457"><li id="antiddos_02_0024__li31165525"><span class="parmvalue" id="antiddos_02_0024__parmvalue555125744114325"><b>normal</b></span>: indicates that the defense status is normal.</li><li id="antiddos_02_0024__li12054271"><span class="parmvalue" id="antiddos_02_0024__parmvalue404664094114337"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0024__li41379576"><span class="parmvalue" id="antiddos_02_0024__parmvalue600552156114412"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0024__li36871865"><span class="parmvalue" id="antiddos_02_0024__parmvalue1506354986114925"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0024__li63411331"><span class="parmvalue" id="antiddos_02_0024__parmvalue1400332350143613"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul>
-</div>
-</td>
-</tr>
-</tbody>
-</table>
-</div>
-</li></ul>
-</div>
-<div class="section" id="antiddos_02_0024__section17226558185213"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0024__ul178811332182913"><li id="antiddos_02_0024__li966416362293">Example request<pre class="codeblock" id="antiddos_02_0024__codeblock1591508415125">GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/1df977c2-fdc6-4483-bc1c-ba46829f57b8/status</pre>
-</li></ul>
-</div>
-<ul id="antiddos_02_0024__ul623214583522"><li id="antiddos_02_0024__li10232105835220">Example response<pre class="screen" id="antiddos_02_0024__screen223245835219">{"status": "normal"}</pre>
-</li></ul>
-<div class="section" id="antiddos_02_0024__section5025004"><h4 class="sectiontitle">Status Code</h4><p id="antiddos_02_0024__p15839470">See <a href="antiddos_02_0031.html">Status Code</a>.</p>
-</div>
-</div>
-<div>
-<div class="familylinks">
-<div class="parentlink"><strong>Parent topic:</strong> <a href="antiddos_02_0016.html">Anti-DDoS APIs</a></div>
-</div>
-</div>
-

docs/antiddos/api-ref/antiddos_02_0028.html

@@ -1,17 +0,0 @@
-<a name="antiddos_02_0028"></a><a name="antiddos_02_0028"></a>
-
-<h1 class="topictitle1">Alarm Reminding APIs</h1>
-<div id="body38386134"></div>
-<div>
-<ul class="ullinks">
-<li class="ulchildlink"><strong><a href="antiddos_02_0029.html">Querying Alarm Configuration</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0041.html">Updating Alarm Configuration</a></strong><br>
-</li>
-</ul>
-
-<div class="familylinks">
-<div class="parentlink"><strong>Parent topic:</strong> <a href="antiddos_02_0040.html">API</a></div>
-</div>
-</div>
-

docs/antiddos/api-ref/antiddos_02_0030.html

@@ -1,11 +0,0 @@
-<a name="antiddos_02_0030"></a><a name="antiddos_02_0030"></a>
-
-<h1 class="topictitle1">Appendix</h1>
-<div id="body1473320842492"></div>
-<div>
-<ul class="ullinks">
-<li class="ulchildlink"><strong><a href="antiddos_02_0031.html">Status Code</a></strong><br>
-</li>
-</ul>
-</div>
-

docs/antiddos/api-ref/antiddos_02_0034.html

@@ -1,76 +0,0 @@
-<a name="antiddos_02_0034"></a><a name="antiddos_02_0034"></a>
-
-<h1 class="topictitle1">Change History</h1>
-<div id="body1477278042389">
-<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0034__table63136454111444" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0034__en-us_topic_0040422987_row2942532716410"><th align="left" class="cellrowborder" valign="top" width="27.33%" id="mcps1.3.1.1.3.1.1"><p id="antiddos_02_0034__en-us_topic_0040422987_p5627845516410"><strong id="antiddos_02_0034__b620013998">Release Date</strong></p>
-</th>
-<th align="left" class="cellrowborder" valign="top" width="72.67%" id="mcps1.3.1.1.3.1.2"><p id="antiddos_02_0034__en-us_topic_0040422987_p2382284816410"><strong id="antiddos_02_0034__en-us_topic_0040422987_b3316380216410">Description</strong></p>
-</th>
-</tr>
-</thead>
-<tbody><tr id="antiddos_02_0034__row19105101411014"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p21055144012">2025-01-21</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul1157249104117"><li id="antiddos_02_0034__li15198215114211">Updated response parameters in <a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a>.</li><li id="antiddos_02_0034__li125725918414">Optimized the title of section <a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a>.</li><li id="antiddos_02_0034__li146331312416">Optimized the example request in <a href="antiddos_02_0037.html">Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses</a>.</li><li id="antiddos_02_0034__li1931015515512">Optimized the example request in <a href="antiddos_02_0038.html">Configuring the Default Protection Policy for Newly Purchased Public IP Addresses</a>.</li></ul>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row533003615444"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p133314362446">2024-10-25</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p2033143615443">Deleted section "Enabling Anti-DDoS".</p>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row1842237134719"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p4422279474">2024-09-13</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p1742247154713">Updated the response parameters in section "Querying the List of EIP Defense Statuses".</p>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row181611243749"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p121611143845">2024-03-29</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul184731533860"><li id="antiddos_02_0034__li5473103315618">Optimized the response parameters in section "Querying Alarm Configuration Information".</li><li id="antiddos_02_0034__li455816351565">Added an example response in section "Updating Alarm Configuration Information".</li></ul>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row884562561617"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p9846102501613">2022-09-30</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p7846325151619">Updated examples in section "Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses".</p>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row6581822134515"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p059162254519">2020-07-08</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p15597222459">Added section "Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses".</p>
-<p id="antiddos_02_0034__p5174185911454">Added section "Configuring the Default Protection Policy for Newly Purchased Public IP Addresses".</p>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row14362125124"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p9363051214">2020-03-10</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul1077692710211"><li id="antiddos_02_0034__li1777152714210">Added section "Querying All API Versions".</li><li id="antiddos_02_0034__li157772278218">Added section "Querying a Specified API Version".</li></ul>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row11697153312367"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p15697123310362">2019-12-09</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul198011271371"><li id="antiddos_02_0034__li18811327153715">Deleted section "Querying All API Versions".</li><li id="antiddos_02_0034__li15811227123713">Deleted section "Querying a Specified API Version".</li></ul>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row1175522819385"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p6988417195812">2018-09-30</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p14566849123511">Added sections "Querying All API Versions" and "Querying a Specified API Version".</p>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row32105225152214"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p13357488152214">2017-04-28</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p49257083152447">Updated examples in section "Querying Optional Anti-DDoS Defense Policies".</p>
-</td>
-</tr>
-<tr id="antiddos_02_0034__row18307222155211"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p6490036155211">2016-11-24</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul1825788915596"><li id="antiddos_02_0034__li99482177368">Changed the parameter type of <span class="parmname" id="antiddos_02_0034__parmname9136676021527"><b>task_id</b></span> to <span class="uicontrol" id="antiddos_02_0034__uicontrol198576041715214"><b>string</b></span>.</li><li id="antiddos_02_0034__li2072773816215">Added parameters <span class="parmname" id="antiddos_02_0034__parmname210131544915234"><b>ip</b></span> and <span class="parmname" id="antiddos_02_0034__parmname164606454415234"><b>network_type</b></span> in section "Querying the List of Defense Statuses of EIPs."</li><li id="antiddos_02_0034__li495557001686">Added error codes 10005004 and 10005005 in section "Error Codes".</li><li id="antiddos_02_0034__li25158493153037">Modified section "AK and SK Generation."</li></ul>
-</td>
-</tr>
-<tr id="antiddos_02_0034__en-us_topic_0040422987_row5947359616410"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__en-us_topic_0040422987_p648803616410">2016-10-29</p>
-</td>
-<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__en-us_topic_0040422987_p1946537916410">This is the first official release.</p>
-</td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
-

docs/antiddos/api-ref/antiddos_02_0040.html

@@ -1,17 +0,0 @@
-<a name="antiddos_02_0040"></a><a name="antiddos_02_0040"></a>
-
-
-  <h1 class="topictitle1">API</h1>
-
-  <div id="body1597044742079"><p id="antiddos_02_0040__p8060118"></p>
-</div>
-
-<div>
-<ul class="ullinks">
-<li class="ulchildlink"><strong><a href="antiddos_02_0016.html">Anti-DDoS APIs</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="antiddos_02_0028.html">Alarm Reminding APIs</a></strong><br>
-</li>
-</ul>
-</div>
-

docs/antiddos/api-ref/en-us_topic_0037386201.html

@@ -1,8 +0,0 @@
-<a name="en-us_topic_0037386201"></a><a name="en-us_topic_0037386201"></a>
-
-<h1 class="topictitle1">API Usage Guidelines</h1>
-<div id="body1583744621332"><p id="en-us_topic_0037386201__en-us_topic_0020507759_p1645204610259">Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="en-us_topic_0037386201__en-us_topic_0020507759_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="en-us_topic_0037386201__en-us_topic_0020507759_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
-<p id="en-us_topic_0037386201__en-us_topic_0020507759_p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="en-us_topic_0037386201__en-us_topic_0020507759_b3082532510259">Application/json</strong>.</p>
-<p id="en-us_topic_0037386201__en-us_topic_0020507759_p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
-</div>
-