콘텐츠로 이동

사용자 지정 워크스페이스 바인딩 정보



POST /api/v1/workspace/{workspace_uuid}/bind_info/set

개요

필드별로 워크스페이스의 제품 표시, 이메일 문구 또는 콘솔 도메인을 업데이트합니다.

호출 전 확인 및 사용 단계

먼저 워크스페이스 상세를 조회하여 content.bindInfo를 확인합니다. 변경할 키만 제출합니다. 생략하면 기존 값이 유지되고, 빈 문자열을 전달하면 해당 재정의 항목이 삭제되어 표시가 사이트의 기본 설정으로 되돌아갈 수 있습니다. 이 작업에는 쓰기 권한이 필요합니다. 제출 후 워크스페이스 상세로 content.bindInfo를 확인합니다. 도메인 변경은 콘솔 주소가 포함된 링크에 영향을 줄 수 있습니다.

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 요청 파라미터

파라미터명 유형 필수 설명
name string 제품 표시 이름입니다.
빈 문자열 허용: True
예시: 示例观测平台
획득 또는 입력 방법: 표시하려는 제품 이름을 사용합니다. 삭제하려면 빈 문자열을 전달합니다.
companyInfo string 회사 설명입니다.
빈 문자열 허용: True
예시: 示例公司提供的运维服务
획득 또는 입력 방법: 해당 워크스페이스 사용자에게 표시하려는 회사 설명을 사용합니다. 삭제하려면 빈 문자열을 전달합니다.
emailHeader string 이메일 머리글입니다.
빈 문자열 허용: True
예시: 运维平台通知
획득 또는 입력 방법: 이메일에 필요한 머리글 텍스트를 입력합니다. 삭제하려면 빈 문자열을 전달합니다.
emailBottom string 이메일 바닥글입니다.
빈 문자열 허용: True
예시: 运维平台支持
획득 또는 입력 방법: 이메일에 필요한 바닥글 텍스트를 입력합니다. 삭제하려면 빈 문자열을 전달합니다.
domain string 콘솔 도메인으로, 프로토콜을 포함하지 않으며 포트를 포함할 수 있습니다.
빈 문자열 허용: True
예시: console.example.com
획득 또는 입력 방법: 액세스 구성이 완료된 콘솔 도메인을 입력합니다. 예: console.example.com. 삭제하려면 빈 문자열을 전달합니다.

파라미터 추가 설명

대상 사이트에서 할당한 External API 서명 자격 증명을 사용합니다.

요청 예제

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/bind_info/set"
method = "POST"
body = json.dumps({'name': '示例观测平台', 'domain': 'console.example.com'}, 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 boolean 업데이트 성공 시 true입니다.
{
  "code": 200,
  "content": true,
  "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 객체 안에 넣습니다.
401 ft.WKSPNotExistOrReleased 워크스페이스가 존재하지 않거나, 해제되었거나, 상태가 유효하지 않음 워크스페이스가 존재하지 않거나 해제되었습니다. 동일 사이트의 워크스페이스 목록에서 유효한 UUID를 다시 가져옵니다.

문서 평가

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