사용량 제한 업데이트¶
POST /api/v1/workspace/{workspace_uuid}/usage_limit/update
개요¶
지정된 워크스페이스의 사용량 제한 구성을 전체 업데이트합니다.
호출 전 및 사용 단계¶
-
사용량 제한 조회를 사용하여 현재 구성을 읽고, 업데이트된 전체 config를 준비합니다. 이 API는 기존 구성을 전체 교체하므로, 특정 데이터 유형을 생략하면 기존 구성 항목이 제거됩니다.
-
현재 사이트의 External API 쓰기 권한으로 JSON을 제출합니다. 워크스페이스 구성에 기록되면 서비스가 데이터 서비스로 동기화합니다.
-
응답 오류 또는 시간 초과가 발생하면 먼저 해당 워크스페이스에 저장된 config를 조회하여 저장 여부를 확인한 후, 목표한 전체 구성에 따라 처리합니다. 성공 응답을 받으면 content는 저장된 구성 레코드입니다.
DF_EXTERNAL_API_URL, DF_EXTERNAL_ACCESS_KEY, DF_EXTERNAL_SECRET_KEY를 설정한 후 예제를 실행합니다. 예제의 워크스페이스 UUID, 브랜드 및 구성 값을 실제 값으로 바꿉니다. 서명 버전은 v20240417입니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| workspace_uuid | string | Y | 대상 사이트의 유효한 워크스페이스 UUID를 사용해야 합니다. 예: wksp_example가져오기 또는 입력 방법: 워크스페이스 목록에서 content.data[].uuid를 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 서명 버전이며, 아래 예제에서는 v20240417을 사용합니다. 예: v20240417가져오기 또는 입력 방법: 예제와 동일하게 입력하며 서명 알고리즘에 대응합니다. |
|
| X-Df-Access-Key | string | Y | 요청 AK 정보 예: <access-key>가져오기 또는 입력 방법: External API 관리자가 할당합니다. |
| X-Df-Signature | string | Y | 서명 정보 예: <hex-signature>가져오기 또는 입력 방법: 예제에 따라 메서드, nonce, 경로, 타임스탬프 및 실제 전송된 JSON 바이트에 대해 HMAC-SHA256을 계산합니다. |
| X-Df-Timestamp | string | Y | 요청 시 타임스탬프 예: 1785456000가져오기 또는 입력 방법: 호출 시점의 현재 Unix 초를 입력합니다(예: date +%s 실행). |
| X-Df-Nonce | string | Y | 요청 시 생성되는 임시 코드 예: b53b47e12e514616ad8cb1f17cb66dce가져오기 또는 입력 방법: 요청할 때마다 새로운 임의 값을 생성합니다(예: uuid.uuid4().hex). |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| config | json | Y | 사용 가능한 키는 logging(로그), tracing(분산 추적), rum(RUM), dialing(신서틱 테스트), profile(프로파일링), network(네트워크), session_replay(세션 리플레이), keyevent(이벤트), siem(보안 분석), backup_log(로그 백업), data_forwarding(데이터 전송), metric(메트릭)입니다. 각 항목의 openLimit은 필수 불리언 값이며, value는 선택적 정수입니다. {}를 전송하면 빈 구성으로 저장됩니다. null 허용: False 예: {"logging": {"openLimit": true, "value": 1000}}가져오기 또는 입력 방법: 사용량 제한 조회에서 기존 구성을 읽고, 비즈니스 요구 사항을 병합한 후 전체 객체를 제출합니다. 테넌트 제한 방안은 사이트 관리자가 확인합니다. |
파라미터 추가 설명¶
대상 데이터 유형별로 제한 값을 입력할 수 있습니다. 데이터 유형마다 측정 기준이 다르며, 실제 적용은 대상 사이트 구성에 따릅니다.
요청 예제¶
import hmac
import json
import os
import time
import uuid
import requests
server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/workspace/wksp_example/usage_limit/update"
method = "POST"
body = json.dumps({'config': {'logging': {'openLimit': True, 'value': 1000}}}, ensure_ascii=False, separators=(',', ':')).encode('utf-8')
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = f"{method} {nonce} {path} {timestamp} ".encode("utf-8") + body
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload, "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,
"Content-Type": "application/json",
}
response = requests.request(method, server + path, headers=headers, data=body, timeout=15)
response.raise_for_status()
data = response.json()["content"]
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.workspaceUUID | string | 구성이 속한 워크스페이스입니다. |
| content.keyCode | string | 구성 키이며 UsageLimit으로 고정됩니다. |
| content.config | object | 저장된 전체 구성입니다. |
| content.config[데이터 유형].openLimit | boolean | 해당 데이터 유형의 제한 사용 여부입니다. |
| content.config[데이터 유형].value | integer | 선택적 제한 값이며, 데이터 유형과 사이트의 실제 측정 규칙에 따라 해석됩니다. |
{
"code": 200,
"content": {
"workspaceUUID": "wksp_example",
"keyCode": "UsageLimit",
"config": {
"logging": {
"openLimit": true,
"value": 1000
}
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 필드 유형, 필수 여부 또는 제약 조건이 파라미터 표와 일치하지 않음 | 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. | 필드, 유형 및 제약 조건을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류입니다. | content의 reason, line 및 column을 읽은 후 수정합니다. |
| 400 | ft.JsonFormatError | JSON 형식은 유효하지만 전체 Body가 JSON 객체가 아님 | JSON 형식 오류입니다. | 파라미터를 중괄호로 구성된 JSON 객체 안에 넣습니다. |
| 400 | ft.ParamsValidateError | 구성 객체에 알 수 없는 데이터 유형 또는 키가 포함되어 있거나, 필드에 openLimit이 없음 / 유형이 일치하지 않음 | 파라미터 검증에 실패했으며, 메시지에 필드 상세 정보가 포함됩니다. | 파라미터 설명에 따라 config의 각 항목을 확인합니다. |
| 406 | ft.KodoCommonApiErr | 동기화 또는 일일 사용량 조회가 200을 반환하지 않았고 다른 상태로 직접 매핑되지 않음. 일부 업스트림 오류는 업스트림 HTTP 상태를 유지합니다. | 시스템 내부 오류이며 업스트림 오류 설명이 포함될 수 있습니다. | 먼저 저장된 구성을 조회한 후 동기화 상태를 확인합니다. |