forked from docs/doc-exports
Compare commits
193 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 71ea4df1c7 | |||
| 4e4d472221 | |||
| 8ea25ba1a2 | |||
| c59638f8c2 | |||
| ca8a03a437 | |||
| cf38dbaabb | |||
| d42223ce64 | |||
| 40454bfc1d | |||
| 25107e5284 | |||
| 6283700aec | |||
| dbb848c448 | |||
| 93a47eef6a | |||
| 96eb58b771 | |||
| 88b6007443 | |||
| 8343d6fd15 | |||
| 3051ee4914 | |||
| e21aa18fe1 | |||
| c4291b1dd5 | |||
| 8f53a840be | |||
| d66f088990 | |||
| 27236a2de8 | |||
| e93b6e9947 | |||
| 5bfde208c6 | |||
| 842e8f4dce | |||
| 3d21c1b3f6 | |||
| 719d8b18de | |||
| 6c66276520 | |||
| 8af0f653c6 | |||
| a2e28c7623 | |||
| 59805c5073 | |||
| 218900ecfc | |||
| 78f14b668b | |||
| 07ee744364 | |||
| 480aac78f1 | |||
| 6d6608a45d | |||
| 007dffd756 | |||
| 6ed7ea9dbd | |||
| 823df869a9 | |||
| a436b26338 | |||
| e1bbc4dd5e | |||
| d7b37f7ef0 | |||
| 535e30e292 | |||
| af86f4a33b | |||
| 27aafc1878 | |||
| a41a4e0331 | |||
| affc0093ff | |||
| b8457f8476 | |||
| 2edd9cc641 | |||
| 00b6f42eca | |||
| 6d73dcaf41 | |||
| 4d1fac645a | |||
| c750d15f42 | |||
| ac787f42f1 | |||
| 03e77f3e5b | |||
| b662a89e70 | |||
| 1ddaec1a62 | |||
| 584d272a0b | |||
| 09469dcb98 | |||
| 856eead9f0 | |||
| cfeabe6434 | |||
| b2353339c3 | |||
| 43ff755460 | |||
| eff4373f7f | |||
| 3e4721c813 | |||
| 04ae6632a7 | |||
| ab1e53a279 | |||
| 46d24ba358 | |||
| 0a674cd795 | |||
| 6a7143f96d | |||
| b47ac2cabb | |||
| 221780bfeb | |||
| 8f024b87ae | |||
| ba239fc43e | |||
| 583968ed3a | |||
| 3cbb6e4ac4 | |||
| a3775fc78e | |||
| d5e281fd38 | |||
| 8341d19ec6 | |||
| 53f94d774d | |||
| 8c3286488e | |||
| b59645e299 | |||
| cd7925dbd2 | |||
| 9431327613 | |||
| 18397ded73 | |||
| e9265fb6b0 | |||
| 79a6901263 | |||
| 3bac3b88e8 | |||
| c7ca14ad93 | |||
| 2a915e26a2 | |||
| fa1c18873d | |||
| 07a013e6d2 | |||
| b8dbeabef4 | |||
| 93d856d5c5 | |||
| 8f6b8d3664 | |||
| 70f009fb3e | |||
| dc34fae01a | |||
| 6de26be70e | |||
| 22397bca9e | |||
| e18658dde8 | |||
| 18ff2c859e | |||
| 2d02dc5d79 | |||
| bd13b1d3a9 | |||
| c1d4f578e7 | |||
| 8b155f2928 | |||
| c9c395e9b3 | |||
| effc5e0a2f | |||
| 89457a7fa8 | |||
| 128b7e694f | |||
| 275abe4f14 | |||
| bbe5c00f67 | |||
| aec20f17ba | |||
| d60ee93f9e | |||
| 11026d61f2 | |||
| e3dc236e76 | |||
| ee9f8aa0b6 | |||
| 1287ab0cee | |||
| 6d480dcc20 | |||
| 73ffc816f4 | |||
| 7f49a3566f | |||
| c38525b39b | |||
| f8f4226a40 | |||
| 285f8e4a64 | |||
| 4d53c82e02 | |||
| 793d68b1b5 | |||
| 4f9585c038 | |||
| 0f8501c63c | |||
| c62d651866 | |||
| 91cea8efb1 | |||
| 441a86b39d | |||
| 9a6a028567 | |||
| 6f818add66 | |||
| 53bc92e1f5 | |||
| 48a9cbde3c | |||
| 904c1aad8b | |||
| 190f09501c | |||
| 06c8ac5e62 | |||
| 60127db659 | |||
| 66d959f7d2 | |||
| 043e229a46 | |||
| 0bfc29fc2c | |||
| 6f5e895214 | |||
| 605b8bd9b2 | |||
| aa6c3af702 | |||
| 68ad3e5adf | |||
| ec95a67a29 | |||
| f65b8dc631 | |||
| 4d9b299c10 | |||
| 1605c388fb | |||
| d78ff45820 | |||
| 64672e58fb | |||
| b3f7e0e837 | |||
| 7d7b02e5ca | |||
| bc0c808038 | |||
| 05458809ab | |||
| d2f00b744a | |||
| 6f60ff9f8d | |||
| 070036121f | |||
| cd96953687 | |||
| 8d0926f0e5 | |||
| f9e2808b7c | |||
| 26dfc1fff2 | |||
| c285e88a17 | |||
| 1f1f0cdb4f | |||
| 88d94aea83 | |||
| 71aa7049a2 | |||
| 5b25ae292f | |||
| 88e10a37f3 | |||
| a15d5e5f49 | |||
| a510c1f9fd | |||
| b9f4932025 | |||
| f63df09d85 | |||
| e733dda338 | |||
| 0381bf72d9 | |||
| 708fdb2d21 | |||
| 0110b557aa | |||
| 663e5d14cb | |||
| 289bb754d4 | |||
| 87153b4b9b | |||
| a0d8676db4 | |||
| 913a19b5f6 | |||
| c0bc4c43cf | |||
| a21b995e0a | |||
| 3a18074b37 | |||
| ca5c9a3342 | |||
| 30a6059c65 | |||
| c336743d9b | |||
| 4cb36481e8 | |||
| fd5ee5dcd8 | |||
| 119e8283a9 | |||
| bbebe3bbdb | |||
| 78d5ebfce8 | |||
| 115b91a147 | |||
| 6ef094d874 |
81
.gitea/workflows/class-txt-check.yml
Normal file
81
.gitea/workflows/class-txt-check.yml
Normal file
@ -0,0 +1,81 @@
|
||||
# .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
|
||||
84
.gitea/workflows/docs-precheck.yml
Normal file
84
.gitea/workflows/docs-precheck.yml
Normal file
@ -0,0 +1,84 @@
|
||||
# .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
|
||||
71
.gitea/workflows/helpers/class-comment.py
Executable file
71
.gitea/workflows/helpers/class-comment.py
Executable file
@ -0,0 +1,71 @@
|
||||
#!/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()
|
||||
161
.gitea/workflows/helpers/class-txt-check.py
Executable file
161
.gitea/workflows/helpers/class-txt-check.py
Executable file
File diff suppressed because it is too large
Load Diff
149
.gitea/workflows/helpers/metadata-check.py
Executable file
149
.gitea/workflows/helpers/metadata-check.py
Executable file
File diff suppressed because it is too large
Load Diff
63
.gitea/workflows/helpers/metadata-comment.py
Executable file
63
.gitea/workflows/helpers/metadata-comment.py
Executable file
@ -0,0 +1,63 @@
|
||||
#!/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()
|
||||
214
.gitea/workflows/helpers/underscore-check.py
Executable file
214
.gitea/workflows/helpers/underscore-check.py
Executable file
File diff suppressed because it is too large
Load Diff
68
.gitea/workflows/helpers/underscore-comment.py
Executable file
68
.gitea/workflows/helpers/underscore-comment.py
Executable file
@ -0,0 +1,68 @@
|
||||
#!/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()
|
||||
81
.gitea/workflows/metadata-check.yml
Normal file
81
.gitea/workflows/metadata-check.yml
Normal file
@ -0,0 +1,81 @@
|
||||
# .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
|
||||
198
.gitea/workflows/openapi.yml
Normal file
198
.gitea/workflows/openapi.yml
Normal file
File diff suppressed because it is too large
Load Diff
115
.gitea/workflows/run-hcdc.yaml
Normal file
115
.gitea/workflows/run-hcdc.yaml
Normal file
File diff suppressed because it is too large
Load Diff
123
.gitea/workflows/yaml-lint.yml
Normal file
123
.gitea/workflows/yaml-lint.yml
Normal file
File diff suppressed because it is too large
Load Diff
11
.spectral.yaml
Normal file
11
.spectral.yaml
Normal file
@ -0,0 +1,11 @@
|
||||
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]*$"
|
||||
17
.yamllint
Normal file
17
.yamllint
Normal file
@ -0,0 +1,17 @@
|
||||
# .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
|
||||
@ -515,7 +515,7 @@
|
||||
{
|
||||
"desc":"Meaning: Request throttling policy.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
||||
"product_code":"apig",
|
||||
"title":"x-apigateway-ratelimit",
|
||||
"title":"x-apigateway-ratelimits",
|
||||
"uri":"apig_03_0098.html",
|
||||
"doc_type":"usermanual",
|
||||
"p_code":"43",
|
||||
|
||||
20
docs/apig/umn/apig_02_0001_1.html
Normal file
20
docs/apig/umn/apig_02_0001_1.html
Normal file
@ -0,0 +1,20 @@
|
||||
<a name="apig_02_0001"></a><a name="apig_02_0001"></a>
|
||||
|
||||
<h1 class="topictitle1">Process Flow</h1>
|
||||
<div id="body8662426"><p id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_p8060118">The following figure shows the process of exposing an API.</p>
|
||||
<p id="apig_02_0001__en-us_topic_0000001128377382_p18543548134311"><span><img id="apig_02_0001__en-us_topic_0000001128377382_image14730133294617" src="en-us_image_0000001829896089.png"></span></p>
|
||||
<ol id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_ol134712352910"><li id="apig_02_0001__en-us_topic_0000001128377382_li035223651911">Creating a Gateway<p id="apig_02_0001__en-us_topic_0000001128377382_p08351451237"><a name="apig_02_0001__en-us_topic_0000001128377382_li035223651911"></a><a name="en-us_topic_0000001128377382_li035223651911"></a><a href="apig_03_0037.html">Create a dedicated gateway.</a></p>
|
||||
</li><li id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_li1934718315294"><a href="apig-ug-180307003.html">Creating an API Group</a><p id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_p52731551293">An API group facilitates management of APIs used for the same service. Create an API group and then create APIs.</p>
|
||||
</li><li id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_li1239042116208"><a href="apig-ug-190419107.html">Binding a Domain Name</a><p id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_p1939022115203">Before making the API available for users to access, bind an independent domain name (custom domain name) to the group to which the API belongs. Then API callers can use these domain names to call the API.</p>
|
||||
</li><li id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_li034715392911"><a href="apig_0080101678.html">Creating an API</a><p id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_p1396201052917">When creating an API, configure the frontend and backend request paths, parameters, and protocols.</p>
|
||||
</li><li id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_li1447643191811"><a href="apig-ug-190419108.html">Debugging an API</a><p id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_p18728145518188">Debug the API to check whether it works normally.</p>
|
||||
</li><li id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_li23471332910"><a href="apig-ug-180307004.html">(Optional) Creating an Environment</a><p id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_p10254142615218">An API can be called in different scenarios, such as the production environment (RELEASE) or other custom environments. RELEASE is the default environment defined in APIG.</p>
|
||||
</li><li id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_li134733102913"><a href="apig-ug-180307005.html">Publishing an API</a><p id="apig_02_0001__en-us_topic_0000001128377382_en-us_topic_0080101676_p780511012155">Publish the API so that it can be called.</p>
|
||||
</li></ol>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-180307001.html">Opening APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -41,7 +41,7 @@
|
||||
</table>
|
||||
</div>
|
||||
</p></li><li id="apig_03_0006__en-us_topic_0000001221574215_en-us_topic_0103545823_li369614061512"><span>Click <strong id="apig_03_0006__en-us_topic_0000001221574215_en-us_topic_0103545823_b1151018810305">OK</strong>.</span><p><p id="apig_03_0006__en-us_topic_0000001221574215_en-us_topic_0103545823_p643617378212">If the domain name is no longer needed, click <strong id="apig_03_0006__en-us_topic_0000001221574215_en-us_topic_0103545823_b791211518302">Unbind Domain Name</strong> to unbind it from the API group.</p>
|
||||
</p></li><li id="apig_03_0006__en-us_topic_0000001221574215_en-us_topic_0103545823_li93451675213"><span>(Optional) If the API group contains HTTPS APIs, bind an SSL certificate to the independent domain name.</span><p><ol type="a" id="apig_03_0006__en-us_topic_0000001221574215_ol1799111542324"><li id="apig_03_0006__en-us_topic_0000001221574215_li13991165415321">In the row that contains the domain name, click <strong id="apig_03_0006__en-us_topic_0000001221574215_b854515393379">Select SSL Certificate</strong>.</li></ol><ol type="a" start="2" id="apig_03_0006__en-us_topic_0000001221574215_ol2992145419328"><li id="apig_03_0006__en-us_topic_0000001221574215_li2992135493218">Select an SSL certificate and click <strong id="apig_03_0006__en-us_topic_0000001221574215_b13711142203720">OK</strong>.<ul id="apig_03_0006__en-us_topic_0000001221574215_ul867615616168"><li id="apig_03_0006__en-us_topic_0000001221574215_li20676175641611">If a CA certificate has been uploaded for the SSL certificate, you can enable client authentication (HTTPS two-way authentication). <strong id="apig_03_0006__en-us_topic_0000001221574215_b28742914013">Enabling or disabling client authentication will affect the existing services. Exercise caution when performing this operation.</strong></li><li id="apig_03_0006__en-us_topic_0000001221574215_li14676105617167">If no SSL certificate is available, click <strong id="apig_03_0006__en-us_topic_0000001221574215_b11101651114714">Create SSL Certificate</strong> to create one. For details, see <a href="apig_03_0055.html#apig_03_0055">SSL Certificates</a>.</li></ul>
|
||||
</p></li><li id="apig_03_0006__en-us_topic_0000001221574215_en-us_topic_0103545823_li93451675213"><span>(Optional) If the API group contains HTTPS APIs, bind an SSL certificate to the independent domain name test_.</span><p><ol type="a" id="apig_03_0006__en-us_topic_0000001221574215_ol1799111542324"><li id="apig_03_0006__en-us_topic_0000001221574215_li13991165415321">In the row that contains the domain name, click <strong id="apig_03_0006__en-us_topic_0000001221574215_b854515393379">Select SSL Certificate</strong>.</li></ol><ol type="a" start="2" id="apig_03_0006__en-us_topic_0000001221574215_ol2992145419328"><li id="apig_03_0006__en-us_topic_0000001221574215_li2992135493218">Select an SSL certificate and click <strong id="apig_03_0006__en-us_topic_0000001221574215_b13711142203720">OK</strong>.<ul id="apig_03_0006__en-us_topic_0000001221574215_ul867615616168"><li id="apig_03_0006__en-us_topic_0000001221574215_li20676175641611">If a CA certificate has been uploaded for the SSL certificate, you can enable client authentication (HTTPS two-way authentication). <strong id="apig_03_0006__en-us_topic_0000001221574215_b28742914013">Enabling or disabling client authentication will affect the existing services. Exercise caution when performing this operation.</strong></li><li id="apig_03_0006__en-us_topic_0000001221574215_li14676105617167">If no SSL certificate is available, click <strong id="apig_03_0006__en-us_topic_0000001221574215_b11101651114714">Create SSL Certificate</strong> to create one. For details, see <a href="apig_03_0055.html#apig_03_0055">SSL Certificates</a>.</li></ul>
|
||||
</li></ol>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
|
||||
@ -28,7 +28,7 @@
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="apig_03_0055.html">SSL Certificates</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="apig_03_0040.html">Load Balance Channels</a></strong><br>
|
||||
<li class="ulchildlink test_policy test_"><strong><a href="apig_03_0040.html">Load Balance Channels</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="apig_03_0041.html">Managing Environments</a></strong><br>
|
||||
</li>
|
||||
|
||||
@ -47,7 +47,7 @@
|
||||
</li></ul>
|
||||
</p></li><li id="apig_03_0019__en-us_topic_0000001221774151_en-us_topic_0000001151883501_li19109142924410"><span>Click <strong id="apig_03_0019__en-us_topic_0000001221774151_b1275410503448">OK</strong>.</span><p><ul id="apig_03_0019__en-us_topic_0000001221774151_ul18334414115613"><li id="apig_03_0019__en-us_topic_0000001221774151_li133351014125618">To clone this policy, click <strong id="apig_03_0019__en-us_topic_0000001221774151_b995111582546">Clone</strong> in the <strong id="apig_03_0019__en-us_topic_0000001221774151_b204471192551">Operation</strong> column.<div class="note" id="apig_03_0019__en-us_topic_0000001221774151_note165441445125319"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig_03_0019__en-us_topic_0000001221774151_ul133541495612"><li id="apig_03_0019__en-us_topic_0000001221774151_li2335181412567">The name of a cloned policy cannot be the same as that of any existing policy.</li><li id="apig_03_0019__en-us_topic_0000001221774151_li1533581455617"><strong id="apig_03_0019__en-us_topic_0000001221774151_b033415153572">Request throttling</strong> and <strong id="apig_03_0019__en-us_topic_0000001221774151_b391031715576">signature key</strong> policies cannot be cloned.</li></ul>
|
||||
</div></div>
|
||||
</li><li id="apig_03_0019__en-us_topic_0000001221774151_li933561485617">After the policy is created, perform the operations described in <a href="#apig_03_0019__en-us_topic_0000001221774151_en-us_topic_0000001151883501_section020918935713">Binding the Policy to APIs</a> for the policy to take effect for the API.</li></ul>
|
||||
</li><li id="apig_03_0019__en-us_topic_0000001221774151_li933561485617">After the policy is created, perform the operations described in test_policy <a href="#apig_03_0019__en-us_topic_0000001221774151_en-us_topic_0000001151883501_section020918935713">Binding the Policy to APIs</a> for the policy to take effect for the API.</li></ul>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
<div class="section" id="apig_03_0019__en-us_topic_0000001221774151_en-us_topic_0000001151883501_section020918935713"><a name="apig_03_0019__en-us_topic_0000001221774151_en-us_topic_0000001151883501_section020918935713"></a><a name="en-us_topic_0000001221774151_en-us_topic_0000001151883501_section020918935713"></a><h4 class="sectiontitle">Binding the Policy to APIs</h4><ol id="apig_03_0019__en-us_topic_0000001221774151_en-us_topic_0000001151883501_ol1356962619589"><li id="apig_03_0019__en-us_topic_0000001221774151_li53566433142"><span>Click a policy name to go to the policy details page.</span></li><li id="apig_03_0019__en-us_topic_0000001221774151_li1350414233155"><span>In the <strong id="apig_03_0019__en-us_topic_0000001221774151_b253612484616">APIs</strong> area, select an environment and click <strong id="apig_03_0019__en-us_topic_0000001221774151_b17559174011464">Select APIs</strong>.</span></li><li id="apig_03_0019__en-us_topic_0000001221774151_li1218216522159"><span>Select the API group, environment, and required APIs.</span></li><li id="apig_03_0019__en-us_topic_0000001221774151_li131891433203"><span>Click <strong id="apig_03_0019__en-us_topic_0000001221774151_b914315914475">OK</strong>.</span><p><ul id="apig_03_0019__en-us_topic_0000001221774151_ul514320193525"><li id="apig_03_0019__en-us_topic_0000001221774151_li16143111911526">If an API no longer needs this policy, click <strong id="apig_03_0019__en-us_topic_0000001221774151_b4321503488">Unbind</strong> in the row that contains the API.</li><li id="apig_03_0019__en-us_topic_0000001221774151_li191431319145211">If there are multiple APIs that no longer need this policy, select these APIs, and click <strong id="apig_03_0019__en-us_topic_0000001221774151_b11659101474819">Unbind</strong> above the API list. You can unbind a policy from a maximum of 1000 APIs at a time.</li></ul>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -7,9 +7,9 @@
|
||||
<div class="section" id="asm_01_0020__en-us_topic_0000001542706401_section1486314595204"><h4 class="sectiontitle">Constraints</h4><ul id="asm_01_0020__en-us_topic_0000001542706401_ul186475910202"><li id="asm_01_0020__en-us_topic_0000001542706401_li1786417596203">ASM depends on the domain name resolution of CoreDNS. Before creating a service mesh for a cluster, ensure that the cluster has required resources and CoreDNS is running normally.</li><li id="asm_01_0020__li133817361244">The components of Istio 1.13 and 1.15 cannot run on nodes running CentOS or EulerOS 2.5. When creating a service mesh, do not specify these types of nodes as master nodes.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="asm_01_0020__en-us_topic_0000001542706401_section201371027102715"><h4 class="sectiontitle">Procedure</h4><ol id="asm_01_0020__en-us_topic_0000001542706401_ol1158918434276"><li id="asm_01_0020__en-us_topic_0000001542706401_li184614499427"><span>Log in to the ASM console.</span></li><li id="asm_01_0020__en-us_topic_0000001542706401_li125894431271"><span>Click <strong id="asm_01_0020__b205391310114513">Create Mesh</strong> in the upper right corner.</span></li><li id="asm_01_0020__en-us_topic_0000001542706401_li135891543162714"><span>Configure the following parameters.</span><p><ul id="asm_01_0020__en-us_topic_0000001542706401_ul75901043202711"><li id="asm_01_0020__en-us_topic_0000001542706401_li2092711501216"><strong id="asm_01_0020__en-us_topic_0000001542706401_b1094850142211">Mesh Edition</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p4479132261213">Only service meshes of the Basic edition are supported for commercial use.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li35901243162718"><strong id="asm_01_0020__b1101751604">Mesh Name</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p19590743152711">Enter a service mesh name, which consists of 4 to 64 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li35901243162718"><strong id="asm_01_0020__b22496209">Mesh Name</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p19590743152711">Enter a service mesh name, which consists of 4 to 64 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.</p>
|
||||
<p id="asm_01_0020__en-us_topic_0000001542706401_p11590144316275">Each name in the same account must be unique. After a service mesh is created, the name cannot be modified.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li3590184362716"><strong id="asm_01_0020__b1115042375">Istio Version</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p19590144310274">Select the Istio version supported by the service mesh.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li3590184362716"><strong id="asm_01_0020__b1611790005">Istio Version</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p19590144310274">Select the Istio version supported by the service mesh.</p>
|
||||
</li><li id="asm_01_0020__li20991123625914"><strong id="asm_01_0020__b54661518132116">Enable IPv6</strong><p id="asm_01_0020__p04381549215">Conditions for enabling IPv4/IPv6 dual stack for a service mesh</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_01_0020__table11439754142117" frame="border" border="1" rules="all"><thead align="left"><tr id="asm_01_0020__row1743955417212"><th align="left" class="cellrowborder" valign="top" width="12.379999999999999%" id="mcps1.3.4.2.3.2.1.4.3.1.6.1.1"><p id="asm_01_0020__p1643985417218">Service Mesh Edition</p>
|
||||
@ -42,19 +42,19 @@
|
||||
<div class="note" id="asm_01_0020__note18440654152111"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="asm_01_0020__ul1744075432120"><li id="asm_01_0020__li1744055413210"><strong id="asm_01_0020__b11396256101815">Enable IPv6</strong> is only available in Basic service meshes based on Istio 1.18 or later.</li><li id="asm_01_0020__li194404548216">IPv4/IPv6 dual stack cannot be enabled for a service mesh whose Istio version is upgraded to 1.18 or later.</li></ul>
|
||||
<ul id="asm_01_0020__ul144085482119"><li id="asm_01_0020__li1344010549212">IPv4/IPv6 dual stack cannot be disabled once it is enabled for a service mesh. IPv4/IPv6 dual stack cannot be enabled for an existing service mesh.</li></ul>
|
||||
</div></div>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li4590154315271"><strong id="asm_01_0020__b1657068806">Cluster</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p4590184313278">Select the cluster from the cluster list or enter the cluster name in the upper right corner of the list to search for the cluster. You can only select the clusters whose versions are supported by the current service mesh version.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li159044311277"><strong id="asm_01_0020__b871656394">Mesh Control Plane Node</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p125902437272">The control plane components of a Basic service mesh are installed in your cluster. You need to select a node for installing the control plane. If HA is required, you can select two or more nodes from different AZs.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li4590154315271"><strong id="asm_01_0020__b1825392822">Cluster</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p4590184313278">Select the cluster from the cluster list or enter the cluster name in the upper right corner of the list to search for the cluster. You can only select the clusters whose versions are supported by the current service mesh version.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li159044311277"><strong id="asm_01_0020__b553295356">Mesh Control Plane Node</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p125902437272">The control plane components of a Basic service mesh are installed in your cluster. You need to select a node for installing the control plane. If HA is required, you can select two or more nodes from different AZs.</p>
|
||||
<p id="asm_01_0020__en-us_topic_0000001542706401_p1959024392713">A selected node will be labeled with <strong id="asm_01_0020__b12113195612363">istio:master</strong>, and the components will be scheduled to that node.</p>
|
||||
</li><li id="asm_01_0020__li17225629125"><strong id="asm_01_0020__b182161818152520">Observability Configuration</strong><ul id="asm_01_0020__ul162251921123"><li id="asm_01_0020__li1522512214127"><strong id="asm_01_0020__b1443315218391">Tracing</strong><p id="asm_01_0020__p015131035712"><strong id="asm_01_0020__b1314122314192">Enable Call Chain</strong>: If this option is enabled, you can use distributed tracing to track requests in the service mesh.</p>
|
||||
<p id="asm_01_0020__p3225124129">- <strong id="asm_01_0020__b1649171110292">Sampling Rate</strong>: The number of requests generated by the tracing service/The total number of requests</p>
|
||||
<p id="asm_01_0020__p722519210123">- <strong id="asm_01_0020__b13853258294">Version</strong>: tracing service. If you select <strong id="asm_01_0020__b1028517591813">Third-party Jaeger/Zipkin service</strong>, you need to set <strong id="asm_01_0020__b613018597425">Service Address</strong> and <strong id="asm_01_0020__b665636154317">Service Port</strong>, which indicate the address and port number used by the third-party tracing service to receive requests.</p>
|
||||
<div class="note" id="asm_01_0020__note122518211219"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="asm_01_0020__ul1522613251216"><li id="asm_01_0020__li112261223127">Only Istio 1.15 or later support the third-party tracing service.</li><li id="asm_01_0020__li142761222131512">If you want to use the third-party Jaeger or Zipkin service, install it first. Then, obtain the service address.</li><li id="asm_01_0020__li1622612111211">The default service ports of Jaeger and Zipkin are both 9411. If you create a custom service port during Jaeger or Zipkin installation, replace <strong id="asm_01_0020__b1161449123214">Service Port</strong> with the actual value.</li></ul>
|
||||
<div class="note" id="asm_01_0020__note122518211219"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="asm_01_0020__ul1522613251216"><li id="asm_01_0020__li112261223127">Only Istio 1.15 and later versions support third-party tracing services.</li><li id="asm_01_0020__li142761222131512">If you want to use the third-party Jaeger or Zipkin service, install it first. Then, obtain the service address.</li><li id="asm_01_0020__li1622612111211">The default service ports of Jaeger and Zipkin are both 9411. If you create a custom service port during Jaeger or Zipkin installation, replace <strong id="asm_01_0020__b1161449123214">Service Port</strong> with the actual value.</li></ul>
|
||||
</div></div>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</p></li><li id="asm_01_0020__en-us_topic_0000001542706401_li185901043112713"><span>(Optional) Specify advanced settings.</span><p><ul id="asm_01_0020__en-us_topic_0000001542706401_ul195914431277"><li id="asm_01_0020__en-us_topic_0000001542706401_li105911243172720"><strong id="asm_01_0020__b1108310788">Namespace Injection Settings</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p0591154316270">Select a namespace and label it with <strong id="asm_01_0020__b0190101221818">istio-injection=enabled</strong>. After being restarted, all pods in the namespace will be automatically injected with istio-proxy sidecars.</p>
|
||||
</p></li><li id="asm_01_0020__en-us_topic_0000001542706401_li185901043112713"><span>(Optional) Specify advanced settings.</span><p><ul id="asm_01_0020__en-us_topic_0000001542706401_ul195914431277"><li id="asm_01_0020__en-us_topic_0000001542706401_li105911243172720"><strong id="asm_01_0020__b337428543">Namespace Injection Settings</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p0591154316270">Select a namespace and label it with <strong id="asm_01_0020__b0190101221818">istio-injection=enabled</strong>. After being restarted, all pods in the namespace will be automatically injected with istio-proxy sidecars.</p>
|
||||
<p id="asm_01_0020__en-us_topic_0000001542706401_p1459184332714">If you do not configure namespace injection, you can inject a sidecar on the <strong id="asm_01_0020__b1960806132112">Sidecar Management</strong> tab (<strong id="asm_01_0020__b86087612111">Mesh Configuration</strong> > <strong id="asm_01_0020__b196087611215">Sidecar Management</strong>) after the service mesh is created. For details, see <a href="asm_01_0041.html#asm_01_0041__section65931513505">Injecting a Sidecar</a>.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li1059184310276"><strong id="asm_01_0020__b109080228">Restart Existing Services</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p12591144362715"><span><img id="asm_01_0020__image879324619490" src="en-us_image_0000001920032153.png"></span>: The pods of existing services in the namespace will be restarted, which will temporarily interrupt your services. The istio-proxy sidecars can be automatically injected to the pods of existing services only after the pods are restarted.</p>
|
||||
</li><li id="asm_01_0020__en-us_topic_0000001542706401_li1059184310276"><strong id="asm_01_0020__b1505440256">Restart Existing Services</strong><p id="asm_01_0020__en-us_topic_0000001542706401_p12591144362715"><span><img id="asm_01_0020__image879324619490" src="en-us_image_0000001920032153.png"></span>: The pods of existing services in the namespace will be restarted, which will temporarily interrupt your services. The istio-proxy sidecars can be automatically injected to the pods of existing services only after the pods are restarted.</p>
|
||||
<p id="asm_01_0020__en-us_topic_0000001542706401_p195911343162718"><span><img id="asm_01_0020__en-us_topic_0000001542706401_image1736110311031" src="en-us_image_0000001494249996.png"></span>: The istio-proxy sidecars cannot be automatically injected into the pods of existing services. You need to manually restart the pods on the CCE console to inject the sidecars.</p>
|
||||
</li><li id="asm_01_0020__li103761117176"><strong id="asm_01_0020__b161488533415">Traffic Interception Settings</strong><div class="note" id="asm_01_0020__note9376117978"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="asm_01_0020__p2376181712720">By default, sidecars intercept all inbound and outbound traffic of pods. You can modify the default traffic rules in <strong id="asm_01_0020__b134331479345">Traffic Interception Settings</strong>.</p>
|
||||
</div></div>
|
||||
@ -67,9 +67,9 @@
|
||||
<p id="asm_01_0020__p11377181717712"><strong id="asm_01_0020__b20653518442">Outbound IP Ranges</strong>: IP address ranges separated by commas (,) in CIDR format. You can use this field to specify the IP ranges that will be included or excluded for outbound traffic redirection.</p>
|
||||
<ul id="asm_01_0020__ul1337716172078"><li id="asm_01_0020__li1377417579"><strong id="asm_01_0020__b39502030153411">Include only specified IP ranges</strong> means that the traffic from specified IP ranges will be redirected to the sidecar.</li></ul>
|
||||
<ul id="asm_01_0020__ul14377181711717"><li id="asm_01_0020__li3377171710719"><strong id="asm_01_0020__b393303213347">Exclude only specified IP ranges</strong> means that the traffic from IP ranges except the specified IP ranges will be redirected to the sidecar.</li></ul>
|
||||
</li><li id="asm_01_0020__li1611138125316"><strong id="asm_01_0020__b308289121">Resource Tags</strong><p id="asm_01_0020__p1711128135317">Enter the tag key and tag value. A maximum of 20 tags can be added.</p>
|
||||
</li><li id="asm_01_0020__li1611138125316"><strong id="asm_01_0020__b896573998">Resource Tags</strong><p id="asm_01_0020__p1711128135317">Enter the tag key and tag value. A maximum of 20 tags can be added.</p>
|
||||
</li></ul>
|
||||
</p></li><li id="asm_01_0020__en-us_topic_0000001542706401_li859154318271"><span>Review the service mesh configuration in <strong id="asm_01_0020__b298934016">Configuration List</strong> on the right of the page and click <strong id="asm_01_0020__b1869262857">Submit</strong>.</span><p><p id="asm_01_0020__en-us_topic_0000001542706401_p13591174382714">It takes about 1 to 3 minutes to create a service mesh. If the service mesh status changes from <strong id="asm_01_0020__b1089376003">Installing</strong> to <strong id="asm_01_0020__b341929893">Running</strong>, the service mesh is successfully created.</p>
|
||||
</p></li><li id="asm_01_0020__en-us_topic_0000001542706401_li859154318271"><span>Review the service mesh configuration in <strong id="asm_01_0020__b1410335113">Configuration List</strong> on the right of the page and click <strong id="asm_01_0020__b250962436">Submit</strong>.</span><p><p id="asm_01_0020__en-us_topic_0000001542706401_p13591174382714">It takes about 1 to 3 minutes to create a service mesh. If the service mesh status changes from <strong id="asm_01_0020__b1250689906">Installing</strong> to <strong id="asm_01_0020__b1089094307">Running</strong>, the service mesh is successfully created.</p>
|
||||
<div class="note" id="asm_01_0020__en-us_topic_0000001542706401_note14591184342712"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="asm_01_0020__en-us_topic_0000001542706401_p1459119432275">When the service mesh is enabled, the following operations are performed:</p>
|
||||
<ul id="asm_01_0020__en-us_topic_0000001542706401_ul859134311276"><li id="asm_01_0020__en-us_topic_0000001542706401_li195911043152719">Helm orchestrates the application into a Release as the resource of the service mesh control plane.</li></ul>
|
||||
</div></div>
|
||||
|
||||
@ -5,12 +5,15 @@
|
||||
<div class="section" id="asm_01_0041__section65931513505"><a name="asm_01_0041__section65931513505"></a><a name="section65931513505"></a><h4 class="sectiontitle">Injecting a Sidecar</h4><p id="asm_01_0041__p1820212632111">You can view the namespace and cluster that the injected sidecar belongs to. If no sidecar has been injected or you need to inject sidecars for more namespaces, perform the following operations:</p>
|
||||
<ol id="asm_01_0041__ol13641175216560"><li id="asm_01_0041__li683575385614"><span>Log in to the ASM console and click the name of the target service mesh to go to its details page.</span></li><li id="asm_01_0041__li987742619292"><span>In the navigation pane, choose <strong id="asm_01_0041__b23024965310246">Mesh Configuration</strong>. Then, click the <strong id="asm_01_0041__b79698741510246">Sidecar Management</strong> tab.</span></li><li id="asm_01_0041__li122863200343"><span>Click <strong id="asm_01_0041__b212025475310246">Sidecar Management</strong>, select a namespace, determine whether enable <strong id="asm_01_0041__b34328513417">Restart Existing Services</strong>, and click <strong id="asm_01_0041__b163426572510246">OK</strong>.</span><p><p id="asm_01_0041__p5867153384619">Parameter description:</p>
|
||||
<ul id="asm_01_0041__ul1213414267113"><li id="asm_01_0041__li151346264113"><strong id="asm_01_0041__b162639501293">Namespace</strong>: Select one or more namespaces. The system adds labels for namespaces based on Istio versions.<ul id="asm_01_0041__ul715833017173"><li id="asm_01_0041__li115810307178"><strong id="asm_01_0041__b93355351461">istio-injection=enabled</strong> can be used in Istio 1.13.9-r3 and earlier versions, as well as Istio 1.15.5-r2 and earlier versions.</li></ul>
|
||||
<ul id="asm_01_0041__ul196772518187"><li id="asm_01_0041__li6677853189"><strong id="asm_01_0041__b5658241104719">istio.io/rev=<revision></strong> can be used in Istio later than 1.13.9-r3, Istio later than 1.15.5-r2, and all Istio 1.18 versions.</li></ul>
|
||||
<ul id="asm_01_0041__ul196772518187"><li id="asm_01_0041__li6677853189"><strong id="asm_01_0041__b5658241104719">istio.io/rev=<revision></strong> can be used in Istio later than 1.13.9-r3, Istio later than 1.15.5-r2, all Istio 1.18 versions, and all Istio 1.28 versions.</li></ul>
|
||||
</li><li id="asm_01_0041__li1283731219"><strong id="asm_01_0041__b176898850910246">Restart Existing Services</strong><p id="asm_01_0041__p16974516217"><span><img id="asm_01_0041__image1251935012150" src="en-us_image_0000001930216052.png"></span>: Enabling <strong id="asm_01_0041__b178031814163717">Restart Existing Services</strong> will restart the pods of existing services and temporarily interrupt your services. New pods will have istio-proxy sidecars automatically injected.</p>
|
||||
<ul id="asm_01_0041__ul1893924912361"><li id="asm_01_0041__li149404492367">If you select a new namespace, an automatic injection label is added. After all pods running the Deployment in that namespace are restarted, the istio-proxy sidecars will be automatically injected into new pods.</li></ul>
|
||||
<ul id="asm_01_0041__ul330205410366"><li id="asm_01_0041__li5302135413618">If you deselect a namespace, the automatic injection label is deleted. After all pods running the Deployment in that namespace are restarted, new pods do not have istio-proxy sidecars.</li></ul>
|
||||
<ul id="asm_01_0041__ul157408585364"><li id="asm_01_0041__li074055833619">If there are pods that are not injected with sidecars in selected namespaces, all pods running the Deployment will be restarted to inject sidecars. If all pods have sidecars injected, the pods will not be restarted.</li></ul>
|
||||
<p id="asm_01_0041__p45731657222"><span><img id="asm_01_0041__image1736110311031" src="en-us_image_0000001256463368.png"></span>: When you do not enable <strong id="asm_01_0041__b198411563510">Restart Existing Services</strong>, the istio-proxy sidecars cannot be automatically injected into the pods of existing services. In this case, you need to manually restart the pods on the CCE console to inject the sidecars. This parameter affects only existing services. If the namespaces are labeled with <strong id="asm_01_0041__b1545117533412">istio-injection=enabled</strong>, sidecars will be automatically injected into new pods.</p>
|
||||
<p id="asm_01_0041__p45731657222"><span><img id="asm_01_0041__image1736110311031" src="en-us_image_0000001256463368.png"></span>: The istio-proxy sidecars cannot be automatically injected into the pods of existing services. You need to manually restart the pods on the CCE console to inject the sidecars. This parameter affects only existing services. If the namespaces are labeled with <strong id="asm_01_0041__b1545117533412">istio-injection=enabled</strong> or <strong id="asm_01_0041__b95971230195613">istio.io/rev=<revision></strong>, sidecars will be automatically injected into new pods.</p>
|
||||
<div class="caution" id="asm_01_0041__note1035861813226"><span class="cautiontitle"><img src="public_sys-resources/caution_3.0-en-us.png"> </span><div class="cautionbody"><p id="asm_01_0041__p191121442193617">This module does not provide the function of restarting services in a specific namespace. If a namespace is not selected, the automatic injection label will be removed from the namespace. After the workload in the namespace is restarted, the istio-proxy sidecar will not be automatically injected.</p>
|
||||
<p id="asm_01_0041__p735815185225">To inject a sidecar into a workload in a specified namespace, ensure that the namespace is selected and enabled. Then, go to the <strong id="asm_01_0041__b106411057172819">Workloads</strong> page of the CCE cluster console, select the workload, and choose <strong id="asm_01_0041__b173501542913">More</strong> > <strong id="asm_01_0041__b156784815297">Redeploy</strong>. After the workload is restarted, the istio-proxy sidecar is automatically injected.</p>
|
||||
</div></div>
|
||||
</li><li id="asm_01_0041__li975935132613"><strong id="asm_01_0041__b4935192843517">Traffic Interception Settings</strong><div class="note" id="asm_01_0041__note130182311537"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="asm_01_0041__p5301112325320">By default, sidecars intercept all inbound and outbound traffic of pods. You can modify the default traffic rules in <strong id="asm_01_0041__b15949143017359">Traffic Interception Settings</strong>.</p>
|
||||
</div></div>
|
||||
<p id="asm_01_0041__p10174123175619"><strong id="asm_01_0041__b97421432123511">Inbound Ports</strong>: Inbound ports separated by commas (,). You can use this field to specify the ports that will be included or excluded for inbound traffic redirection.</p>
|
||||
@ -23,7 +26,8 @@
|
||||
<ul id="asm_01_0041__ul13301528313"><li id="asm_01_0041__li5311221939"><strong id="asm_01_0041__b922854213514">Include only specified IP ranges</strong> means that the traffic from specified IP ranges will be redirected to the sidecar.</li></ul>
|
||||
<ul id="asm_01_0041__ul112121251130"><li id="asm_01_0041__li42121455318"><strong id="asm_01_0041__b19623164303511">Exclude only specified IP ranges</strong> means that the traffic from IP ranges except the specified IP ranges will be redirected to the sidecar.</li></ul>
|
||||
</li></ul>
|
||||
<div class="note" id="asm_01_0041__note1279618584133"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="asm_01_0041__ul97451116162713"><li id="asm_01_0041__li1974521615271">If the system displays a message indicating that modification of namespace injection is not enabled in the following clusters, you need to run the <strong id="asm_01_0041__b11447123395415">kubectl</strong> command to enable namespace injection. For details, see <a href="asm_faq_0036.html">How Do I Enable Namespace Injection for a Cluster?</a>.</li><li id="asm_01_0041__li12746181642719">After sidecar injection is enabled for a namespace of a cluster, sidecars are automatically injected for pods of all workloads in the namespace. If you do not want to inject sidecars for some workloads, see <a href="asm_faq_0037.html">How Do I Disable Sidecar Injection for Workloads?</a>.</li></ul>
|
||||
<div class="note" id="asm_01_0041__note1279618584133"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="asm_01_0041__ul3174175111130"><li id="asm_01_0041__li151741951141317">For details about why sidecar injection failed, see .</li></ul>
|
||||
<ul id="asm_01_0041__ul97451116162713"><li id="asm_01_0041__li1974521615271">If ASM displays a message indicating that modification of namespace injection is not enabled in the following clusters, you need to run the <strong id="asm_01_0041__b11447123395415">kubectl</strong> command to enable namespace injection. For details, see <a href="asm_faq_0036.html">How Do I Enable Namespace Injection for a Cluster?</a></li><li id="asm_01_0041__li12746181642719">After sidecar injection is enabled for a namespace of a cluster, sidecars are automatically injected for pods of all workloads in the namespace. If you do not want to inject sidecars for some workloads, see <a href="asm_faq_0037.html">How Do I Disable Sidecar Injection for Workloads?</a></li></ul>
|
||||
</div></div>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="asm_01_0124"></a><a name="asm_01_0124"></a>
|
||||
|
||||
<h1 class="topictitle1">Features in v1.18</h1>
|
||||
<div id="body0000001737146797"><ul id="asm_01_0124__ul1742120185319"><li id="asm_01_0124__li1842160195316">Istio 1.18 is supported.</li><li id="asm_01_0124__li1036314425311">CCE Turbo clusters v1.25, v1.27, v1.28, v1.29, and v1.30, as well as v1.31 are supported.</li><li id="asm_01_0124__li6393101715319">CCE clusters v1.25, v1.27, v1.28, v1.29, and v1.30, as well as v1.31 are supported.</li><li id="asm_01_0124__li1910522175320">Kubernetes Gateway API is supported.</li></ul>
|
||||
<div id="body0000001737146797"><ul id="asm_01_0124__ul1742120185319"><li id="asm_01_0124__li1842160195316">Istio 1.18 is supported.</li><li id="asm_01_0124__li1036314425311">CCE Turbo clusters v1.25, v1.27, v1.28, v1.29, v1.30, and v1.31, as well as v1.32 and v1.33 are supported.</li><li id="asm_01_0124__li6393101715319">CCE clusters v1.25, v1.27, v1.28, v1.29, v1.30, and v1.31 , as well as v1.32 and v1.33 are supported.</li><li id="asm_01_0124__li1910522175320">Kubernetes Gateway API is supported.</li></ul>
|
||||
<p id="asm_01_0124__p58433415527">For details, visit <a href="https://istio.io/latest/news/releases/1.18.x/" target="_blank" rel="noopener noreferrer">https://istio.io/latest/news/releases/1.18.x/</a>.</p>
|
||||
</div>
|
||||
<div>
|
||||
|
||||
17
docs/asm/umn/asm_01_0141.html
Normal file
17
docs/asm/umn/asm_01_0141.html
Normal file
@ -0,0 +1,17 @@
|
||||
<a name="asm_01_0141"></a><a name="asm_01_0141"></a>
|
||||
|
||||
<h1 class="topictitle1">Using IAM to Grant Access to ASM</h1>
|
||||
<div id="body0000002494975758"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="asm_01_0145.html">Using IAM Roles or Policies to Grant Access to ASM</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_01_0146.html">Using IAM Identity Policies to Grant Access to ASM</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0000001627845328.html">User Guide</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
66
docs/asm/umn/asm_01_0145.html
Normal file
66
docs/asm/umn/asm_01_0145.html
Normal file
@ -0,0 +1,66 @@
|
||||
<a name="asm_01_0145"></a><a name="asm_01_0145"></a>
|
||||
|
||||
<h1 class="topictitle1">Using IAM Roles or Policies to Grant Access to ASM</h1>
|
||||
<div id="body0000002526896091"><p id="asm_01_0145__en-us_topic_0000001489537442_p198079372297">System-defined permissions in provided by <a href="https://docs.otc.t-systems.com/en-us/usermanual/iam/iam_01_0026.html" target="_blank" rel="noopener noreferrer">Identity and Access Management (IAM)</a> let you control access to ASM. With IAM, you can:</p>
|
||||
<ul id="asm_01_0145__en-us_topic_0000001489537442_ul1848820457453"><li id="asm_01_0145__en-us_topic_0000001489537442_li348974516454">Create IAM users for personnel based on your enterprise's organizational structure. Each IAM user has their own identity credentials for accessing ASM resources.</li><li id="asm_01_0145__en-us_topic_0000001489537442_li11681126173515">Grant users only the permissions required to perform a given task based on their job responsibilities.</li><li id="asm_01_0145__en-us_topic_0000001489537442_li12185165313915">Entrust an account or a cloud service to perform efficient O&M on your ASM resources.</li></ul>
|
||||
<p id="asm_01_0145__en-us_topic_0000001489537442_p14662743155318">If your account meets your permissions requirements, you can skip this section.</p>
|
||||
<p id="asm_01_0145__en-us_topic_0000001489537442_p158501603165"><a href="#asm_01_0145__en-us_topic_0000001489537442_fig1351611812271">Figure 1</a> shows the process flow of role/policy-based authorization.</p>
|
||||
<div class="section" id="asm_01_0145__en-us_topic_0000001489537442_section17723185741610"><h4 class="sectiontitle">Prerequisites</h4><p id="asm_01_0145__en-us_topic_0000001489537442_p17286682272">Before granting permissions to user groups, learn about system-defined permissions in for ASM. To grant permissions for other services, learn about all <a href="https://docs.otc.t-systems.com/permissions/index.html" target="_blank" rel="noopener noreferrer">permissions</a> supported by IAM.</p>
|
||||
</div>
|
||||
<div class="section" id="asm_01_0145__en-us_topic_0000001489537442_section1189416161520"><h4 class="sectiontitle">Process Flow</h4><div class="fignone" id="asm_01_0145__en-us_topic_0000001489537442_fig1351611812271"><a name="asm_01_0145__en-us_topic_0000001489537442_fig1351611812271"></a><a name="en-us_topic_0000001489537442_fig1351611812271"></a><span class="figcap"><b>Figure 1 </b>Process of granting ASM permissions using role/policy-based authorization</span><br><span><img id="asm_01_0145__en-us_topic_0000001489537442_image35161382273" src="en-us_image_0000002526896489.png"></span></div>
|
||||
<ol id="asm_01_0145__en-us_topic_0000001489537442_ol10176191312813"><li id="asm_01_0145__en-us_topic_0000001489537442_li10176121316284"><a name="asm_01_0145__en-us_topic_0000001489537442_li10176121316284"></a><a name="en-us_topic_0000001489537442_li10176121316284"></a>On the IAM console, <a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0030.html" target="_blank" rel="noopener noreferrer">create a user group and assign permissions to it</a>.<p id="asm_01_0145__en-us_topic_0000001489537442_p41762137286">Create a user group on the IAM console, and assign the <strong id="asm_01_0145__b18180133023513">ASM ReadOnlyAccess</strong> permissions to the group.</p>
|
||||
</li><li id="asm_01_0145__en-us_topic_0000001489537442_li181761413162818"><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0031.html" target="_blank" rel="noopener noreferrer">Create an IAM user and add it to the user group</a>.<p id="asm_01_0145__en-us_topic_0000001489537442_p16177613182816">On the IAM console, create a user and add it to the user group created in <a href="#asm_01_0145__en-us_topic_0000001489537442_li10176121316284">1</a>.</p>
|
||||
</li><li id="asm_01_0145__en-us_topic_0000001489537442_li1177513202816"><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0032.html" target="_blank" rel="noopener noreferrer">Log in as the IAM user</a> and verify permissions.<p id="asm_01_0145__en-us_topic_0000001489537442_p1317741312289">In the authorized region, perform the following operations:</p>
|
||||
<ul id="asm_01_0145__en-us_topic_0000001489537442_ul1692751312242"><li id="asm_01_0145__en-us_topic_0000001489537442_li205729227246">Choose <strong id="asm_01_0145__b1623482611425">Service List</strong> > <strong id="asm_01_0145__b11306103015437">Application Service Mesh</strong>. Click <strong id="asm_01_0145__b2155175674318">Buy Mesh</strong> on the ASM console. If a message appears indicating that you have insufficient permissions to perform the operation, the <strong id="asm_01_0145__b7209151616449">ASM ReadOnlyAccess</strong> policy is in effect.</li><li id="asm_01_0145__en-us_topic_0000001489537442_li1857212212418">Choose another service from <strong id="asm_01_0145__b1545117611422">Service List</strong>. If a message appears indicating that you have insufficient permissions to access the service, the <strong id="asm_01_0145__b104520624218">ASM ReadOnlyAccess</strong> policy is in effect.</li></ul>
|
||||
</li></ol>
|
||||
</div>
|
||||
<div class="section" id="asm_01_0145__en-us_topic_0000001489537442_section7529733164812"><h4 class="sectiontitle">Example Custom Policies</h4><p id="asm_01_0145__p576211773818">You can create custom policies to supplement the system-defined policies of ASM. For details about actions supported in custom policies, see .</p>
|
||||
<p id="asm_01_0145__en-us_topic_0000001489537442_p1391019913815">To create a custom policy, choose either visual editor or JSON.</p>
|
||||
<ul id="asm_01_0145__en-us_topic_0000001489537442_ul1146431393818"><li id="asm_01_0145__en-us_topic_0000001489537442_li5764181518386">Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy grammar.</li><li id="asm_01_0145__en-us_topic_0000001489537442_li546410135389">JSON: Create a JSON policy or edit an existing one.</li></ul>
|
||||
<p id="asm_01_0145__p2477135725615">For details, see .</p>
|
||||
<p id="asm_01_0145__p10716518386">The following lists examples of common ASM custom policies.</p>
|
||||
<ul id="asm_01_0145__en-us_topic_0000001489537442_ul2504185715494"><li id="asm_01_0145__en-us_topic_0000001489537442_li5504357164912">Example 1: Grant permissions to create service meshes.<pre class="screen" id="asm_01_0145__en-us_topic_0000001489537442_screen48273211535">{
|
||||
"Version": "1.1",
|
||||
"Statement": [
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"asm:mesh:create"
|
||||
]
|
||||
}
|
||||
]
|
||||
}</pre>
|
||||
</li><li id="asm_01_0145__en-us_topic_0000001489537442_li3652938178">Example 2: Grant permissions to deny service mesh deletion.<p id="asm_01_0145__en-us_topic_0000001489537442_p1892813119464"><a name="asm_01_0145__en-us_topic_0000001489537442_li3652938178"></a><a name="en-us_topic_0000001489537442_li3652938178"></a>A policy with only "Deny" permissions must be used together with other policies. If the permissions granted to an IAM user contain both "Allow" and "Deny", the "Deny" permissions take precedence over the "Allow" permissions.</p>
|
||||
<pre class="screen" id="asm_01_0145__en-us_topic_0000001489537442_screen39281011144617">{
|
||||
"Version": "1.1",
|
||||
"Statement": [
|
||||
{
|
||||
"Effect": "Deny",
|
||||
"Action": [
|
||||
"asm:mesh:createGateway"
|
||||
]
|
||||
}
|
||||
]
|
||||
}</pre>
|
||||
</li><li id="asm_01_0145__en-us_topic_0000001489537442_li8475316125413">Example 3: Create a custom policy containing multiple actions.<p id="asm_01_0145__en-us_topic_0000001489537442_p466319313484"><a name="asm_01_0145__en-us_topic_0000001489537442_li8475316125413"></a><a name="en-us_topic_0000001489537442_li8475316125413"></a>A custom policy can contain the actions of one or multiple services that are of the same type (global or project-level). Example policy containing actions of multiple services:</p>
|
||||
<pre class="screen" id="asm_01_0145__screen125841914164916">{
|
||||
"Version": "1.1",
|
||||
"Statement": [
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"cce:cluster:create"
|
||||
"asm:mesh:create"
|
||||
]
|
||||
}
|
||||
]
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="asm_01_0141.html">Using IAM to Grant Access to ASM</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
70
docs/asm/umn/asm_01_0146.html
Normal file
70
docs/asm/umn/asm_01_0146.html
Normal file
@ -0,0 +1,70 @@
|
||||
<a name="asm_01_0146"></a><a name="asm_01_0146"></a>
|
||||
|
||||
<h1 class="topictitle1">Using IAM Identity Policies to Grant Access to ASM</h1>
|
||||
<div id="body0000002494976322"><p id="asm_01_0146__en-us_topic_0000001543558165_p198079372297">System-defined permissions in provided by <a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0026.html" target="_blank" rel="noopener noreferrer">Identity and Access Management (IAM)</a> let you control access to ASM. With IAM, you can:</p>
|
||||
<ul id="asm_01_0146__en-us_topic_0000001543558165_ul1848820457453"><li id="asm_01_0146__en-us_topic_0000001543558165_li348974516454">Create IAM users or user groups for personnel based on your enterprise's organizational structure. Each IAM user has their own identity credentials for accessing ASM resources.</li><li id="asm_01_0146__en-us_topic_0000001543558165_li11681126173515">Grant users only the permissions required to perform a given task based on their job responsibilities.</li><li id="asm_01_0146__en-us_topic_0000001543558165_li12185165313915">Entrust an account or a cloud service to perform efficient O&M on your ASM resources.</li></ul>
|
||||
<p id="asm_01_0146__en-us_topic_0000001543558165_p14662743155318">If your account meets your permissions requirements, you can skip this section.</p>
|
||||
<p id="asm_01_0146__en-us_topic_0000001543558165_p158501603165"><a href="#asm_01_0146__en-us_topic_0000001543558165_fig1351611812271">Figure 1</a> shows the process flow of identity policy-based authorization.</p>
|
||||
<div class="section" id="asm_01_0146__en-us_topic_0000001543558165_section17723185741610"><h4 class="sectiontitle">Prerequisites</h4><p id="asm_01_0146__en-us_topic_0000001543558165_p17286682272">Before granting permissions, learn about system-defined permissions in . To grant permissions for other services, learn about all <a href="https://docs.otc.t-systems.com/permissions/index.html" target="_blank" rel="noopener noreferrer">permissions</a> supported by IAM.</p>
|
||||
</div>
|
||||
<div class="section" id="asm_01_0146__en-us_topic_0000001543558165_section1189416161520"><h4 class="sectiontitle">Process Flow</h4><div class="fignone" id="asm_01_0146__en-us_topic_0000001543558165_fig1351611812271"><a name="asm_01_0146__en-us_topic_0000001543558165_fig1351611812271"></a><a name="en-us_topic_0000001543558165_fig1351611812271"></a><span class="figcap"><b>Figure 1 </b>Process of granting ASM permissions using identity policy-based authorization</span><br><span><img id="asm_01_0146__en-us_topic_0000001543558165_image35161382273" src="en-us_image_0000002526896571.png"></span></div>
|
||||
<ol id="asm_01_0146__en-us_topic_0000001543558165_ol10176191312813"><li id="asm_01_0146__en-us_topic_0000001543558165_li10176121316284">On the IAM console, .<p id="asm_01_0146__en-us_topic_0000001543558165_p41762137286"><a name="asm_01_0146__en-us_topic_0000001543558165_li10176121316284"></a><a name="en-us_topic_0000001543558165_li10176121316284"></a>Create a user or user group on the IAM console.</p>
|
||||
</li><li id="asm_01_0146__en-us_topic_0000001543558165_li16925112804614"> (<strong id="asm_01_0146__b15261138162215">ASMReadOnlyPolicy</strong> as an example) to the user or user group.</li><li id="asm_01_0146__en-us_topic_0000001543558165_li1177513202816"><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0032.html" target="_blank" rel="noopener noreferrer">Log in as the IAM user</a> and verify permissions.<p id="asm_01_0146__en-us_topic_0000001543558165_p1317741312289">In the authorized region, perform the following operations:</p>
|
||||
<ul id="asm_01_0146__en-us_topic_0000001543558165_ul1692751312242"><li id="asm_01_0146__en-us_topic_0000001543558165_li205729227246">Choose <strong id="asm_01_0146__b160142117265">Service List</strong> > <strong id="asm_01_0146__b760112213264">Application Service Mesh</strong>. Click <strong id="asm_01_0146__b1660272114269">Buy Mesh</strong> on the ASM console. If a message appears indicating that you have insufficient permissions to perform the operation, <strong id="asm_01_0146__b160262182618">ASMReadOnlyPolicy</strong> is in effect.</li><li id="asm_01_0146__en-us_topic_0000001543558165_li1857212212418">Choose another service from <strong id="asm_01_0146__b113084327264">Service List</strong>. If a message appears indicating that you have insufficient permissions to access the service, <strong id="asm_01_0146__b030863242611">ASMReadOnlyPolicy</strong> is in effect.</li></ul>
|
||||
</li></ol>
|
||||
</div>
|
||||
<div class="section" id="asm_01_0146__en-us_topic_0000001543558165_section7529733164812"><h4 class="sectiontitle">Example Custom Identity Policies</h4><p id="asm_01_0146__p19154121744816">You can create custom identity policies to supplement the system-defined identity policies of ASM. For details about actions supported in custom identity policies, see .</p>
|
||||
<p id="asm_01_0146__en-us_topic_0000001543558165_p1391019913815">To create a custom identity policy, choose either visual editor or JSON.</p>
|
||||
<ul id="asm_01_0146__en-us_topic_0000001543558165_ul1146431393818"><li id="asm_01_0146__en-us_topic_0000001543558165_li5764181518386">Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy grammar.</li><li id="asm_01_0146__en-us_topic_0000001543558165_li546410135389">JSON: Create a JSON policy or edit an existing one.</li></ul>
|
||||
<p id="asm_01_0146__p160623765212">For details, see .</p>
|
||||
<p id="asm_01_0146__p17139055195519">When creating a custom identity policy, use the Resource element to specify the resources the identity policy applies to and use the Condition element (service-specific condition keys) to control when the identity policy is in effect. For details about the supported resource types and condition keys, see .</p>
|
||||
<p id="asm_01_0146__p310122114562">The following provides examples of custom ASM identity policies.</p>
|
||||
<ul id="asm_01_0146__en-us_topic_0000001543558165_ul2504185715494"><li id="asm_01_0146__en-us_topic_0000001543558165_li5504357164912">Example 1: Grant permissions to create service meshes.<pre class="screen" id="asm_01_0146__en-us_topic_0000001543558165_screen25351137165916">{
|
||||
"Version": "5.0",
|
||||
"Statement": [
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"asm:mesh:create",
|
||||
"asm:mesh:createGateway"
|
||||
]
|
||||
}
|
||||
]
|
||||
}</pre>
|
||||
</li><li id="asm_01_0146__en-us_topic_0000001543558165_li8475316125413">Example 2: Create a custom identity policy containing multiple actions.<p id="asm_01_0146__en-us_topic_0000001543558165_p164313514480"><a name="asm_01_0146__en-us_topic_0000001543558165_li8475316125413"></a><a name="en-us_topic_0000001543558165_li8475316125413"></a></p>
|
||||
<p id="asm_01_0146__en-us_topic_0000001543558165_p466319313484">A custom identity policy can contain the actions of one or more services. Example identity policy containing multiple actions:</p>
|
||||
<pre class="screen" id="asm_01_0146__en-us_topic_0000001543558165_screen46646311485">{
|
||||
"Version": "5.0",
|
||||
"Statement": [
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"asm:mesh:create",
|
||||
"asm:mesh:createGateway"
|
||||
]
|
||||
},
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"evs:volumes:create",
|
||||
"evs:volumes:list"
|
||||
]
|
||||
},
|
||||
{
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"ecs:cloudServers:createServers",
|
||||
"ecs:cloudServers:listServersDetails"
|
||||
]
|
||||
}
|
||||
]
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="asm_01_0141.html">Using IAM to Grant Access to ASM</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -4,8 +4,6 @@
|
||||
<div id="body39451090"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="asm_productdesc_0017.html">Infographic for ASM</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_productdesc_0001.html">Introduction</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_productdesc_0002.html">Advantages</a></strong><br>
|
||||
@ -14,6 +12,8 @@
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_productdesc_0004.html">Notes and Constraints</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_productdesc_0019.html">Permissions</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_productdesc_0005.html">Basic Concepts</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_productdesc_0006.html">Recommended Node Specifications</a></strong><br>
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
</tr>
|
||||
<tr id="asm_productdesc_0004__row2060314173555"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.3.2.3.1.1 "><p id="asm_productdesc_0004__p760391712553">1.18</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.3.2.3.1.2 "><p id="asm_productdesc_0004__p14822277556">v1.25, v1.27, v1.28, v1.29, v1.30, or v1.31</p>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.3.2.3.1.2 "><p id="asm_productdesc_0004__p14822277556">v1.25, v1.27, v1.28, v1.29, v1.30, v1.31, v1.32, or v1.33</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
<a name="asm_productdesc_0017"></a><a name="asm_productdesc_0017"></a>
|
||||
|
||||
<h1 class="topictitle1">Infographic for ASM</h1>
|
||||
<div id="body0000001209484931"><p id="asm_productdesc_0017__p1289416386116"></p>
|
||||
<p id="asm_productdesc_0017__p837613199456"><span><img id="asm_productdesc_0017__image73201388158" src="en-us_image_0000002043652974.png"></span></p>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="asm_pd_0001.html">Service Overview</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
593
docs/asm/umn/asm_productdesc_0019.html
Normal file
593
docs/asm/umn/asm_productdesc_0019.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,6 +1,6 @@
|
||||
<a name="asm_qs_0002"></a><a name="asm_qs_0002"></a>
|
||||
|
||||
<h1 class="topictitle1">Enabling Istio for a Cluster </h1>
|
||||
<h1 class="topictitle1">Enabling Istio for a Cluster</h1>
|
||||
<div id="body0000001168400759"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 618 KiB |
BIN
docs/asm/umn/en-us_image_0000002526896489.png
Normal file
BIN
docs/asm/umn/en-us_image_0000002526896489.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
BIN
docs/asm/umn/en-us_image_0000002526896571.png
Normal file
BIN
docs/asm/umn/en-us_image_0000002526896571.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
@ -10,6 +10,8 @@
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="asm_01_0016.html">Application Service Mesh</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_01_0141.html">Using IAM to Grant Access to ASM</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_01_0017.html">Creating a Service Mesh</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_01_0023.html">Mesh Management</a></strong><br>
|
||||
|
||||
@ -1168,7 +1168,7 @@
|
||||
"code":"64",
|
||||
"des":"This API is used to query BMS flavors.The flavors you obtained using this API are all the flavors in the system. The flavors whose names starting with physical are BMS fl",
|
||||
"doc_type":"api",
|
||||
"kw":"QueryingBMS Flavors,BMS Flavor Query (OpenStack Nova APIs),API Reference",
|
||||
"kw":"Querying BMS Flavors,BMS Flavor Query (OpenStack Nova APIs),API Reference",
|
||||
"search_title":"",
|
||||
"metedata":[
|
||||
{
|
||||
@ -1177,7 +1177,7 @@
|
||||
"opensource":"false;true"
|
||||
}
|
||||
],
|
||||
"title":"QueryingBMS Flavors",
|
||||
"title":"Querying BMS Flavors",
|
||||
"githuburl":""
|
||||
},
|
||||
{
|
||||
|
||||
@ -569,7 +569,7 @@
|
||||
{
|
||||
"desc":"This API is used to query BMS flavors.The flavors you obtained using this API are all the flavors in the system. The flavors whose names starting with physical are BMS fl",
|
||||
"product_code":"bms",
|
||||
"title":"QueryingBMS Flavors",
|
||||
"title":"Querying BMS Flavors",
|
||||
"uri":"en-us_topic_0000002374101029.html",
|
||||
"doc_type":"api",
|
||||
"p_code":"63",
|
||||
|
||||
@ -66,7 +66,7 @@
|
||||
<td class="cellrowborder" valign="top" width="18.75%" headers="mcps1.3.4.2.1.5.1.3 "><p id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_p15406610135318">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="41.010000000000005%" headers="mcps1.3.4.2.1.5.1.4 "><p id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_p1040881015311">Specifies the flavor ID.</p>
|
||||
<p id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_p7741128113511">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_text9235625735">BMS</span><span id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_text32351725734"></span><span id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_text1726413615226"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">QueryingBMS Flavors</a> API.</p>
|
||||
<p id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_p7741128113511">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_text9235625735">BMS</span><span id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_text32351725734"></span><span id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_text1726413615226"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">Querying BMS Flavors</a> API.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_row058811420527"><td class="cellrowborder" valign="top" width="19.85%" headers="mcps1.3.4.2.1.5.1.1 "><p id="EN-US_TOPIC_0000002340063012__en-us_topic_0053158693_p5413201085313">name</p>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<div id="body8662426"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="en-us_topic_0000002374101029.html">QueryingBMS Flavors</a></strong><br>
|
||||
<li class="ulchildlink"><strong><a href="en-us_topic_0000002374101029.html">Querying BMS Flavors</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="en-us_topic_0000002374260893.html">Querying Details About a BMS Flavor</a></strong><br>
|
||||
</li>
|
||||
|
||||
@ -40,7 +40,7 @@
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_section61879170105534"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_p740355415918">None</p>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_section558544482614"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_p10597356103517">Deleting tags from a <span id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_text198292661016">BMS</span><span id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_text1582192631015"></span><span id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_text128252611106"></span> (ID: 53206ed0-56de-4d6b-b7ee-ffc62ca26f43)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_screen464516211288"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DELETE</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags</span>
|
||||
<div class="section" id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_section558544482614"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_p10597356103517">Deleting tags from a <span id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_text8992548111218">BMS</span><span id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_text15803221423"></span><span id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_text205161451161216"></span> (ID: 53206ed0-56de-4d6b-b7ee-ffc62ca26f43)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002340063052__en-us_topic_0060410928_screen464516211288"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DELETE</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags</span>
|
||||
</pre></div></td></tr></table></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="EN-US_TOPIC_0000002340222784"></a><a name="EN-US_TOPIC_0000002340222784"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying Details About a <span id="en-us_topic_0053158707_text1027592519399">BMS</span><span id="en-us_topic_0053158707_text15747146155714"></span><span id="en-us_topic_0053158707_text140512416526"></span></h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_section11242227"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p58120972">This API is used to query details about a <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1255371312571">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text655311138571"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text3250194116527"></span> based on the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1616071111576">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1968164914717"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text17913193345212"></span> ID.</p>
|
||||
<h1 class="topictitle1">Querying Details About a <span id="en-us_topic_0053158707_text82769982712">BMS</span><span id="en-us_topic_0053158707_text464425125113"></span><span id="en-us_topic_0053158707_text17210351154415"></span></h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_section11242227"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p58120972">This API is used to query details about a <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text13300726142719">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text330072616275"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text13003268277"></span> based on the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1027592519399">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text9288151912716"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text18288111910277"></span> ID.</p>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_section34071180"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p60095679153449">GET /v2.1/{project_id}/servers/{server_id}</p>
|
||||
<p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p166491815184611"><a href="#EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_table17908225144614">Table 1</a> lists the parameters.</p>
|
||||
@ -26,7 +26,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p44882061">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p11568292">Specifies the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text4643191910575">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1164321920576"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1160810541523"></span> ID.</p>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p11568292">Specifies the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1374115752718">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text974165702718"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text874195762714"></span> ID.</p>
|
||||
<p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_en-us_topic_0113746489_text895314101319">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_en-us_topic_0113746489_text1695320481317"></span> console or by calling the API <a href="en-us_topic_0000002340063012.html">Querying BMSs</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -54,7 +54,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25.872587258725872%" headers="mcps1.3.5.2.1.4.1.2 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p17222571164727">Object</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.28512851285129%" headers="mcps1.3.5.2.1.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p36377578">Specifies <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text16186172419575">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text61861241579"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text086211516530"></span> information. For details, see <a href="#EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_table6149040">Table 2</a>.</p>
|
||||
<td class="cellrowborder" valign="top" width="51.28512851285129%" headers="mcps1.3.5.2.1.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p36377578">Specifies <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text106691417152810">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text11670121720283"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text126701017192816"></span> information. For details, see <a href="#EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_table6149040">Table 2</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -73,7 +73,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p58359570">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.07000000000001%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p29504734">Specifies the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text7317182665718">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text133181026145719"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text84953103537"></span> name.</p>
|
||||
<td class="cellrowborder" valign="top" width="51.07000000000001%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p29504734">Specifies the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1777322332818">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1877422372818"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1477482392813"></span> name.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_row64216018"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p34114937">id</p>
|
||||
@ -126,7 +126,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p64678211">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.07000000000001%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p4443775">Specifies the ID of the tenant owning the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text2081565516571">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text6815185511572"></span>. The value is in UUID format.</p>
|
||||
<td class="cellrowborder" valign="top" width="51.07000000000001%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p4443775">Specifies the ID of the tenant owning the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text5484324182912">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text17484524112916"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1484524172910"></span>. The value is in UUID format.</p>
|
||||
<p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p3869154710124">This parameter specifies the same meaning as <strong id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_b77201547172520">project_id</strong>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -164,7 +164,7 @@
|
||||
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p56232959">Map<String,Array of <a href="#EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_table1656029015527">address</a> objects></p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.07000000000001%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p57420266">Specifies <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1415758145810">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text51579895819"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1892589115415"></span> network addresses. Specifies the VPC used by the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text165043251041">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text4504325344"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text0739191765416"></span>.</p>
|
||||
<ul id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_ul1374698716"><li id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_li19748786115"><strong id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_b4513174116384">key</strong>: indicates the ID of the VPC used by the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text11581151634614">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text32761321124610"></span>.</li><li id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_li417552217213"><strong id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_b438874712486">value</strong> indicates the VPC details.</li></ul>
|
||||
<ul id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_ul1374698716"><li id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_li19748786115"><strong id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_b4513174116384">key</strong>: indicates the ID of the VPC used by the <span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1012201113306">BMS</span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text1212171113305"></span><span id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_text17121811183017"></span>.</li><li id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_li417552217213"><strong id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_b438874712486">value</strong> indicates the VPC details.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_row61793156165818"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002340222784__en-us_topic_0053158707_p39189735165818">security_groups</p>
|
||||
|
||||
@ -27,7 +27,7 @@
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0057973064_p60507121">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0057973064_p2129750">Specifies the flavor ID.</p>
|
||||
<p id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_p1461914516495">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0053158674_text374914110111">BMS</span><span id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0053158674_text1749131818"></span><span id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0053158674_text2096916710416"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">QueryingBMS Flavors</a> API.</p>
|
||||
<p id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_p1461914516495">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0053158674_text374914110111">BMS</span><span id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0053158674_text1749131818"></span><span id="EN-US_TOPIC_0000002340222808__en-us_topic_0114885743_en-us_topic_0053158674_text2096916710416"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">Querying BMS Flavors</a> API.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_p64913614151519">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_p23511349151519">Specifies the <span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_text16563976299145">BMS</span><span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_text13363426949145"></span><span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_text10498469789145"></span> ID.</p>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_p23511349151519">Specifies the <span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_text650552035611">BMS</span><span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_text750520202567"></span><span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_text1750542012566"></span> ID.</p>
|
||||
<p id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_en-us_topic_0113746489_text895314101319">BMS</span><span id="EN-US_TOPIC_0000002340222816__en-us_topic_0053158611_en-us_topic_0113746489_text1695320481317"></span> console or by calling the API <a href="en-us_topic_0000002340063012.html">Querying BMSs</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -1,6 +1,6 @@
|
||||
<a name="EN-US_TOPIC_0000002374101009"></a><a name="EN-US_TOPIC_0000002374101009"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying Details About <span id="en-us_topic_0053158679_text15957111672810">BMS</span><span id="en-us_topic_0053158679_text89571016162815"></span><span id="en-us_topic_0053158679_text12957316202813"></span>s</h1>
|
||||
<h1 class="topictitle1">Querying Details About <span id="en-us_topic_0053158679_text1027592519399">BMS</span><span id="en-us_topic_0053158679_text4856929649"></span><span id="en-us_topic_0053158679_text1254014314258"></span>s</h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_section33716833"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_p67077904152933">This API is used to query details about <span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text892812331348">BMS</span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text1968164914717"></span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text131001882253"></span>s.</p>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_section29822855153557"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_ul45877015153613"><li id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_li4809898812125">The query result returned by this API includes both ECSs and BMSs. You need to filter out the BMSs using the flavor used to create the BMSs or the tags added to the BMSs during BMS creation.</li><li id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_li53072464153613">If the image is used as the search criteria, other search criteria and pagination criteria are not supported. If both the image and other filter criteria are specified, the image filter criterion is used. If the query criteria do not contain the image filter criterion, API functions are not restricted.</li></ul>
|
||||
@ -66,7 +66,7 @@
|
||||
<td class="cellrowborder" valign="top" width="18.75%" headers="mcps1.3.4.2.1.5.1.3 "><p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_p15406610135318">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="41.010000000000005%" headers="mcps1.3.4.2.1.5.1.4 "><p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_p1040881015311">Specifies the flavor ID.</p>
|
||||
<p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_p7741128113511">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_text9235625735">BMS</span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_text32351725734"></span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_text1726413615226"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">QueryingBMS Flavors</a> API.</p>
|
||||
<p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_p7741128113511">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_text9235625735">BMS</span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_text32351725734"></span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_text1726413615226"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">Querying BMS Flavors</a> API.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_row058811420527"><td class="cellrowborder" valign="top" width="19.85%" headers="mcps1.3.4.2.1.5.1.1 "><p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158693_p5413201085313">name</p>
|
||||
@ -449,7 +449,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_p43090708192944">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.07000000000001%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_p55603620192944">Specifies the status of the<span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_text129271650165813">BMS</span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_text10927150135811"></span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text141991929162811"></span> host.</p>
|
||||
<td class="cellrowborder" valign="top" width="51.07000000000001%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_p55603620192944">Specifies the status of the host that accommodates the <span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text96155695712">BMS</span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text46105655713"></span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text186135610577"></span>.</p>
|
||||
<ul id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_ul30670539192944"><li id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_li7599401192944"><strong id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_b842352706183126">UP</strong>: The host is normal.</li><li id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_li1285751192944"><strong id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_b1498018510183149">UNKNOWN</strong>: The host status is unknown.</li><li id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_li11571767192944"><strong id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_b842352706183156">DOWN</strong>: the host is abnormal.</li><li id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_li37037040192944"><strong id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_b842352706183211">MAINTENANCE</strong>: The host is being maintained.</li><li id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_li64897909192944">Empty string: There is no <span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_text184142536587">BMS</span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_text1841435385810"></span><span id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_text5546034112815"></span> host information.</li></ul>
|
||||
<p id="EN-US_TOPIC_0000002374101009__en-us_topic_0053158679_en-us_topic_0053158707_p47210269192944">This is a new parameter in micro version 2.16.</p>
|
||||
</td>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<a name="EN-US_TOPIC_0000002374101029"></a><a name="EN-US_TOPIC_0000002374101029"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying<span id="en-us_topic_0053158684_text68606276113">BMS</span><span id="en-us_topic_0053158684_text1947382572"></span> Flavors</h1>
|
||||
<h1 class="topictitle1">Querying <span id="en-us_topic_0053158684_text68606276113">BMS</span><span id="en-us_topic_0053158684_text1947382572"></span> Flavors</h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_section57769674"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_p6915811">This API is used to query <span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text1310274425711">BMS</span><span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text12102184410575"></span><span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text844715419398"></span> flavors.</p>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_section60580832213029"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_p91137314513">The flavors you obtained using this API are all the flavors in the system. The flavors whose names starting with <strong id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_b774618481833">physical</strong> are <span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text2011614481575">BMS</span><span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text9116154865713"></span><span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text163229599390"></span> flavors and can be used to create <span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text8552165010578">BMS</span><span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text35525504572"></span><span id="EN-US_TOPIC_0000002374101029__en-us_topic_0053158684_text1862149408"></span>s.</p>
|
||||
|
||||
@ -136,7 +136,7 @@
|
||||
<td class="cellrowborder" valign="top" width="24.43%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_p43431730185333">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.74999999999999%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_p5719410617654">Specifies the key and value pair of the metadata.</p>
|
||||
<ul id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_ul1049861817191"><li id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_li1413563592416">Each key or value contains fewer than 256 characters.</li><li id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_li2073683916242">The value does not support the following special characters:<p id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_p1821315403243"><a name="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_li2073683916242"></a><a name="en-us_topic_0053158712_li2073683916242"></a>\"</p>
|
||||
<ul id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_ul1049861817191"><li id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_li1413563592416">Each key or value contains fewer than 256 characters and cannot be left blank.</li><li id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_li2073683916242">The value does not support the following special characters:<p id="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_p1821315403243"><a name="EN-US_TOPIC_0000002374260885__en-us_topic_0053158712_li2073683916242"></a><a name="en-us_topic_0053158712_li2073683916242"></a>\"</p>
|
||||
</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@ -64,7 +64,7 @@
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_table22651992144025"></a><a name="en-us_topic_0053158696_table22651992144025"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_table22651992144025" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_b355592318">address</strong> parameter structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_row15576094144025"><th align="left" class="cellrowborder" valign="top" width="25.41%" id="mcps1.3.6.3.2.4.1.1"><p id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_p355273111016">Parameter</p>
|
||||
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_table22651992144025"></a><a name="en-us_topic_0053158696_table22651992144025"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_table22651992144025" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_b1932703555">address</strong> parameter structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_row15576094144025"><th align="left" class="cellrowborder" valign="top" width="25.41%" id="mcps1.3.6.3.2.4.1.1"><p id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_p355273111016">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="23.419999999999998%" id="mcps1.3.6.3.2.4.1.2"><p id="EN-US_TOPIC_0000002374260889__en-us_topic_0053158696_p16554153131017">Type</p>
|
||||
</th>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<a name="EN-US_TOPIC_0000002374260893"></a><a name="EN-US_TOPIC_0000002374260893"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying Details About a <span id="en-us_topic_0053158674_text6424161564610">BMS</span><span id="en-us_topic_0053158674_text1242451564617"></span><span id="en-us_topic_0053158674_text54243150461"></span> Flavor</h1>
|
||||
<h1 class="topictitle1">Querying Details About a <span id="en-us_topic_0053158674_text68606276113">BMS</span><span id="en-us_topic_0053158674_text611312477019"></span><span id="en-us_topic_0053158674_text858612512404"></span> Flavor</h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_section64833508"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_p40261524">This API is used to query details about a <span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text14401156606">BMS</span><span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text1947382572"></span><span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text183631256124010"></span> flavor, such as the flavor name, CPU cores, and memory.</p>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_section46630661"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_p6133425516420">GET /v2.1/{project_id}/flavors/{flavor_id}</p>
|
||||
@ -27,7 +27,7 @@
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_p60507121">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_p2129750">Specifies the flavor ID.</p>
|
||||
<p id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_p1153834112450">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text374914110111">BMS</span><span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text1749131818"></span><span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text2096916710416"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">QueryingBMS Flavors</a> API.</p>
|
||||
<p id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_p1153834112450">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text374914110111">BMS</span><span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text1749131818"></span><span id="EN-US_TOPIC_0000002374260893__en-us_topic_0053158674_text2096916710416"></span> console or using the <a href="en-us_topic_0000002374101029.html#EN-US_TOPIC_0000002374101029">Querying BMS Flavors</a> API.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user