カスタムワークスペースバインド情報¶
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 を取得し直します。 |