콘텐츠로 이동

사용량 한도 조회



GET /api/v1/workspace/{workspace_uuid}/usage_limit/get

개요

지정한 워크스페이스에 저장된 사용량 한도 설정을 조회합니다.

호출 전 준비 사항 및 사용 단계

워크스페이스 목록의 UUID로 조회합니다. 아직 적용 중인 기록이 없으면 HTTP 200이며 content는 {}입니다. 빈 객체는 해당 워크스페이스의 전용 한도 기록을 찾지 못했을 뿐이며, 계속 쓰기가 가능한지 판단하려면 사이트 및 제품 할당량도 확인해야 합니다.

예제에서는 External API 서명 버전 v20240417을 사용합니다. 대상 사이트의 External API 주소, Access Key 및 Secret Key를 각각 DF_EXTERNAL_API_URL, DF_EXTERNAL_ACCESS_KEY, DF_EXTERNAL_SECRET_KEY로 설정합니다. 예제 ID는 실제 값으로 교체하십시오.

경로 파라미터

파라미터명 유형 필수 설명
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>
가져오기 또는 입력 방법: 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).

파라미터 추가 설명

현재 대상 사이트에 할당된 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/workspace/wksp_example/usage_limit/get"
query = {}
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.workspaceUUID string 한도가 속한 워크스페이스입니다.
content.keyCode string 구성 키이며 현재 UsageLimit입니다.
content.config object 데이터 유형별로 구성된 한도 설정입니다(예: logging). 각 유형의 한도는 해당 유형의 단위를 사용합니다.
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"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

조회에는 워크스페이스 미존재에 대한 별도 오류가 없으며, 공통 인증 오류와 실제 반환 내용을 기준으로 합니다.

문서 평가

이 페이지가 도움이 되었나요?