コンテンツにスキップ

ワークスペースのカスタム情報を設定



POST /api/v1/workspace/bind_info/set

概要

現在のワークスペースのカスタム表示と通知のバインド情報を設定します。

呼び出し前の準備と使用手順

現在のワークスペースで workspace.setManage 権限を持つ OpenAPI Key を使用します。スコープは現在の Key が属するワークスペースであり、Body で他の workspaceUUID を渡すことはサポートされていません。

送信された name/companyInfo/emailHeader/emailBottom/domain のみを、現在のワークスペースの bindInfo にマージします。省略したキーは保持され、明示的な空文字列はクリアされます。{} を送信した場合も更新日時が変更されます。name は表示用にバインドする製品名であり、ワークスペース名ではありません。brandKey は変更せず、ブランド設定も切り替えません。

domain は元の文字列のまま保存されます。成功をドメイン接続の受け入れ検証と見なすことはできません。DNS、TLS 証明書、プロキシ設定は管理者が別途完了する必要があります。成功時は content=true となり、新しいオブジェクトは返されません。現在のワークスペース の content.bindInfo から読み戻せます(詳細は約60秒キャッシュされるため、更新が必要です)。既存の未知の履歴 bindInfo キーは保持されます。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
companyInfo string 任意の文字列。省略した場合は保持され、空文字列の場合はクリアされます。
空文字列を許可: True
例: 示例公司的服务说明
取得または入力方法: このワークスペースで表示する会社/サービスの紹介を入力します。
domain string 任意の文字列。省略した場合は保持され、空文字列の場合はクリアされます。現在の実装では URL/ドメイン形式の検証は行わず、DNS、HTTPS 証明書、ゲートウェイルーティングの設定やドメイン所有権の確認も行いません。呼び出し元が別途準備する必要があります。
空文字列を許可: True
例: portal.example.com
取得または入力方法: サイト/ネットワーク管理者が準備済みのドメインを指定します。ポートを含めることはできますが、プロトコルは含めません。
emailBottom string 任意の文字列。メールフッターに表示するテキスト。省略した場合は保持され、空文字列の場合はクリアされます。
空文字列を許可: True
例: 请联系您的服务管理员
取得または入力方法: 通知内容を担当する管理者が提供します。
emailHeader string 任意の文字列。メールヘッダーに表示するテキスト。省略した場合は保持され、空文字列の場合はクリアされます。
空文字列を許可: True
例: 服务通知
取得または入力方法: 通知内容を担当する管理者が提供します。
name string 任意の文字列。省略した場合は以前の値が保持され、空文字列の場合はクリアされます。これを使用してワークスペースの name やシステムのブランド識別子を変更しないでください。
空文字列を許可: True
例: Guance
取得または入力方法: 現在のワークスペースで表示する製品名を入力します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/workspace/bind_info/set' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"Guance","companyInfo":"示例公司的服务说明","domain":"portal.example.com"}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content boolean 保存済みの場合は true。ドメイン/DNS/証明書が利用可能であること、またはクライアントキャッシュが更新済みであることを証明するものではありません。
{
  "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 に従って JSON を修正してください。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトではない 一部の JSON ファイルの形式エラー パラメータ表の JSON オブジェクトを送信してください。
401 ft.WKSPNotExistOrReleased 現在のワークスペースが存在しない、またはアクティブ状態ではない ワークスペースが存在しない/または解放済み 有効なワークスペースの Key を使用し、状態を確認してください。
500 ft.InternalServerError bindInfo の履歴構造の異常、データベース保存の失敗 内部エラー 現在のワークスペース詳細で保存されたかを確認し、失敗が続く場合は traceId を提供してください。

フィードバック

このページは役に立ちましたか?