조회¶
GET /api/v1/workspace/{workspace_uuid}/get
개요¶
UUID로 현재 사이트의 유효한 워크스페이스 하나를 조회합니다.
호출 전 및 사용 단계¶
먼저 워크스페이스 목록에서 UUID를 가져온 다음 특정 워크스페이스를 조회합니다. 필드 표와 예시는 자주 사용하는 필드만 발췌했습니다. 전체 응답에는 워크스페이스 자격 증명이 포함될 수 있으므로 응답을 민감 정보로 취급하십시오.
예시는 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/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.uuid | string | 워크스페이스 UUID. 이후 API의 workspace_uuid 경로 또는 workspaceUUID 요청 필드에 넣습니다. |
| content.name | string | 워크스페이스 표시 이름. |
| content.desc | string | 워크스페이스 설명. |
| content.status | integer | 워크스페이스 상태. |
| content.timezone | string | 워크스페이스 시간대, 예: Asia/Shanghai. |
| content.language | string | 워크스페이스 언어 설정. |
| content.bindInfo | object 또는 null | 워크스페이스 수준의 브랜드 텍스트, 이메일 및 도메인 재정의 구성. |
| content.brandKey | string | 워크스페이스와 연결된 사이트 브랜드 식별자. |
{
"code": 200,
"content": {
"uuid": "wksp_example",
"name": "生产监控",
"desc": "生产服务观测",
"status": 0,
"timezone": "Asia/Shanghai",
"language": "zh",
"brandKey": "truewatch",
"bindInfo": {
"name": "示例观测平台",
"domain": "console.example.com"
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.NotFoundWorkspace | 지정한 UUID에 해당하는 유효한 워크스페이스가 존재하지 않거나 해당 워크스페이스 상태가 유효한 상태가 아닌 경우 | 지정한 워크스페이스를 찾을 수 없습니다. | 현재 사이트의 워크스페이스 목록에서 유효한 UUID를 다시 가져옵니다. |