유효한 레벨 목록¶
GET /api/v1/issue-level/valid/list
개요¶
인시던트 관리에 사용되는 레벨과 해당 식별자를 나열합니다.
호출 전 준비 및 사용 단계¶
워크스페이스 목록에서 대상 UUID를 가져온 후 workspaceUUID에 전달합니다. 이름과 출처에 따라 레벨을 선택하고, 레벨 식별자가 필요한 후속 작업에서는 uuid를 사용합니다. 사이트 통합 레벨이 활성화된 경우 사이트 레벨만 반환합니다. 비활성화된 경우 워크스페이스 사용자 지정 레벨과 워크스페이스에서 비활성화되지 않은 시스템 기본 레벨을 반환합니다.
예제에서는 External API 서명 버전 v20240417을 사용합니다. 대상 사이트의 External API 주소, Access Key, Secret Key를 각각 DF_EXTERNAL_API_URL, DF_EXTERNAL_ACCESS_KEY, DF_EXTERNAL_SECRET_KEY로 설정합니다. 예시 ID는 실제 값으로 바꾸세요.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 서명 버전이며, 아래 예제에서는 v20240417을 사용합니다. 예시: v20240417가져오기 또는 입력 방법: 예제와 동일하게 입력하며, 서명 알고리즘과 대응합니다. |
|
| X-Df-Access-Key | string | Y | 요청 AK 정보 예시: <access-key>가져오기 또는 입력 방법: External API 관리자가 할당합니다. |
| X-Df-Signature | string | Y | 서명 정보 예시: <hex-signature>가져오기 또는 입력 방법: Secret Key로 GET, nonce, 요청 경로 및 원시 쿼리 문자열, 타임스탬프, 빈 문자열로 구성된 텍스트에 대해 HMAC-SHA256을 수행하고 16진수 결과를 사용합니다. |
| X-Df-Timestamp | string | Y | 요청 시점의 타임스탬프 예시: 1785456000가져오기 또는 입력 방법: 호출 시점의 현재 Unix 초를 입력합니다. 예: date +%s 실행. |
| X-Df-Nonce | string | Y | 요청 시 생성하는 임시 코드 예시: b53b47e12e514616ad8cb1f17cb66dce가져오기 또는 입력 방법: 매 요청마다 새 임의 값을 생성합니다. 예: uuid.uuid4().hex. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| workspaceUUID | string | 대상 워크스페이스 UUID입니다. 예시: wksp_example가져오기 또는 입력 방법: 워크스페이스 목록 응답의 content.data[].uuid에서 가져와 원래 값을 사용합니다. |
파라미터 추가 설명¶
현재 대상 사이트에 할당된 External API 서명 자격 증명을 사용합니다.
요청 예제¶
import hmac
import os
import time
import uuid
from urllib.parse import urlencode
import requests
server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/issue-level/valid/list"
query = {'workspaceUUID': 'wksp_example'}
if query:
path += "?" + urlencode(query)
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = " ".join(("GET", nonce, path, timestamp, ""))
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload.encode(), "sha256").hex()
headers = {
"X-Df-Access-Key": os.environ["DF_EXTERNAL_ACCESS_KEY"],
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-SVersion": "v20240417",
"X-Df-Signature": signature,
}
result = requests.get(server + path, headers=headers, timeout=15)
result.raise_for_status()
data = result.json()["content"]
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array<object> |
이 페이지의 결과이며, 레코드가 없으면 빈 배열입니다. |
| content[].uuid | string | 레벨 식별자이며, 반환된 원래 값을 사용합니다. |
| content[].name | string | 레벨 이름입니다. |
| content[].color | string | 표시 색상입니다. |
| content[].description | string | 레벨 설명입니다. |
| content[].isDefault | boolean | 시스템 기본 레벨은 이 식별자를 가집니다. |
| content[].isManage | boolean | 관리 백엔드에서 구성한 사이트 레벨은 이 식별자를 가질 수 있습니다. |
| content[].status | integer | 레벨 레코드 상태이며, 시스템 기본 항목에는 이 필드가 없을 수 있습니다. |
{
"code": 200,
"content": [
{
"uuid": "issue_level_example",
"name": "高",
"color": "#d93434",
"description": "需要关注",
"status": 0
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 전달함 | 메시지에 유효하지 않은 파라미터가 표시됩니다. | 파라미터 표에 나열되지 않은 필드를 제거합니다. |