作成¶
POST /api/v1/workspace/create
概要¶
ワークスペースを作成し、オーナーを指定して収集トークン、ストレージ、デフォルトリソースを初期化します。
呼び出し前と使用手順¶
使用前に、対象サイトのストレージエンジンとワークスペースのデフォルトバージョンが設定済みであることを確認し、ログイン可能なオーナーアカウントを選択します。最小リクエストでは name と ownerUuid のみが必要です。その他はサイトデフォルトを優先して使用します。成功後は content.wsInfo.uuid を保存し、詳細/インデックステンプレートのクエリで最終設定を確認します。この操作は名前による重複排除ではなく、冪等キーもありません。重複送信すると複数のワークスペースが生成される可能性があります。アカウントのワークスペース、デフォルトトークン、チャンネル、デフォルトのオンコールポリシーなどの初期化は複数段階にわたり、データベースが先にコミットされてからリソースサービスが呼び出される可能性があります。HTTP 200 と空の問題マーカーは、すべての下流データベース作成が完了したことを保証しません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 例と一致させる必要があり、省略したままこのアルゴリズムを使用し続けることはできません。 例: v20240417取得または入力方法: このページの元のパスおよびリクエストボディの署名アルゴリズムと組み合わせて入力します。 |
|
| X-Df-Access-Key | string | Y | ここでは7項目がすべて書き込み操作であり、External の書き込み権限が必要です。 例: <external-access-key>取得または入力方法: サイト管理者が w 権限を持つ External API AK を割り当てます。ワークスペースの OpenAPI Key ではありません。 |
| X-Df-Nonce | string | Y | 再送信のたびにこの値と署名も更新します。 例: 97d275ee9f774315a7885ba7347acbd9取得または入力方法: 各リクエストで uuid.uuid4().hex を再生成します。 |
| X-Df-Signature | string | Y | 大文字のメソッド、nonce、元の完全パス、timestamp、および元の UTF-8 リクエストボディをスペースで連結し、HMAC-SHA256 の hex ダイジェストを取得します。 例: <hmac-sha256-hex>取得または入力方法: 対応する SK を使用し、External API 署名認証 と以下の Python テンプレートに従って計算します。 |
| X-Df-Timestamp | string | Y | 例の固定時刻を再利用できません。サイトの署名有効ウィンドウ内である必要があります。 例: 1785427200取得または入力方法: 送信時に str(int(time.time())) で現在の Unix 秒を生成します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| brandKey | string | 任意。省略または空値の場合はサイトのデフォルトブランドにフォールバックします。値を指定する場合はサイトで許可された集合内である必要があり、null は使用できません。 null を許可: False 例: guance取得または入力方法: サイト管理者から許可されたブランド識別子を取得します。 |
|
| desc | string | 任意の説明。省略時は空文字列となり、明示的に空文字列を渡すこともできます。null を許可すると宣言されていますが格納列は非 null のため、null は避けてください。 空文字列を許可: True null を許可: True 例: 接口文档演示工作空间取得または入力方法: このワークスペースの用途を入力します。 |
|
| durationSet | object | 任意のオブジェクト。値は日数に小文字の d を付けたものです。省略時はサイトの該当ワークスペースバージョンのデフォルト保持期間を使用します。不足している種別はデフォルト設定から補完されます。作成フローではすべてのカスタム保持期間の範囲を統一的にチェックしません。確認済みのサイト選択可能値を使用してください。成功しても、すべての下流データベース作成が完了したことを意味しません。 例: {"logging": "7d"}取得または入力方法: まずインデックステンプレート一覧から現在の durationSet、esIndexMerged、datastore を取得し、実際のバージョン/エンジンに応じて選択します。 |
|
| durationSet.apm | string | インデックスをマージしたアプリケーションパフォーマンスデータの標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.backup_log | string | バックアップログの標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.keyevent | string | イベントの標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.logging | string | デフォルトログの標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.network | string | ネットワークデータの標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.rp | string | メトリクス時系列の標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.rum | string | リアルユーザーモニタリング(RUM)の標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.security | string | インスペクション/セキュリティデータの標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| durationSet.tracing | string | アプリケーショントレースの標準保持期間。作成時の最終インデックスモードがこのキーをサポートする場合にのみ使用します。未指定または空文字列の場合はサイトデフォルトにフォールバックできます。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースまたは同一バージョンのワークスペースのインデックステンプレート一覧の対応フィールドから取得し、サイトの許可範囲に合わせて調整します。 |
|
| enableRumMultipleTable | integer | 任意の整数 0/1 または null。現在の作成ロジックではこの入力パラメータを無視し、実際にはサイトの enableRumMultipleTable デフォルト設定を使用します。リポジトリのデフォルトは有効です。 null を許可: True 選択可能値: [0, 1] 例: 1取得または入力方法: 新規ワークスペースの実際の値はサイト管理者が設定します。作成後は変更インターフェースで調整できます。 |
|
| esIndexMerged | boolean | 任意。省略時はサイト設定を使用し、リポジトリのデフォルトは false です。明示的なカスタムログストレージインスタンスと true は同時に使用できません。SLS/Beaver では最終的に false に強制されます。 null を許可: False 例: false取得または入力方法: 対象のストレージエンジンとデータ型の分離要件に応じて選択します。カスタムログインスタンスでは false を推奨します。 |
|
| isOpenCustomMappingRule | boolean | 任意のブール値。省略時はサイト設定を使用し、リポジトリのデフォルトは false です。null は使用できません。 null を許可: False 例: false取得または入力方法: 組織のカスタムフィールドマッピングの必要性に応じて選択します。 |
|
| isOpenLogMultipleIndex | boolean | 任意のブール値。省略時はサイト設定を使用し、リポジトリのデフォルトは true です。SLS/Beaver では強制的に有効になります。false は新規作成のみを制限し、既存インデックスは削除しません。 null を許可: False 例: true取得または入力方法: カスタムログインデックスの作成を許可する必要がある場合は true に設定します。 |
|
| language | string | 任意。省略時は zh です。空文字列はそのまま保存され、自動的に zh にはなりません。null を許可すると宣言されていますが、非 null の格納制約により保存に失敗する可能性があるため、明示的に列挙値を使用することを推奨します。 空文字列を許可: True null を許可: True 選択可能値: ['zh', 'en', 'zh-hant', 'id', 'ja', 'ko'] 例: zh取得または入力方法: ワークスペースの利用者に応じて zh、en、zh-hant、id、ja、ko のいずれかを選択します。 |
|
| leftWildcard | boolean | 任意のブール値。省略時はサイト設定を使用し、リポジトリのデフォルトは false です。 null を許可: False 例: false取得または入力方法: アスタリスクで始まる曖昧検索が必要な場合は true に設定し、実際のクエリ性能を評価してください。 |
|
| logMultipleIndexCount | int | 任意の整数。省略時はサイトのデフォルト数量を使用します。マルチインデックスが有効な場合にのみ、数量設定の生成に使用されます。SLS/Beaver では負の値にできず、0 は数量制限なしを意味します。通常ストレージでは正数を使用し、null は使用できません。 null を許可: False 例: 30取得または入力方法: 組織のマルチインデックス使用量に応じて選択します。リポジトリのデフォルトは 30 で、サイト側で上書きできます。 |
|
| loggingCutSize | int | 任意の整数(単位: バイト)。省略時はサイト設定を使用し、リポジトリのデフォルトは 10240 です。0 などの空値はストレージエンジンごとにデフォルトへフォールバックし、分割の無効化を意味しません。 null を許可: False 例: 10240取得または入力方法: サイトのログサイズ要件に応じてバイト数を指定します。通常はサイトデフォルトを再利用します。 |
|
| maxSearchResultCount | integer | 任意。0 はここで追加の結果件数上限を設定しないことを意味します。省略時はサイト設定を使用し、リポジトリのデフォルトは 0 です。1 ページあたりの件数とは異なり、null は使用できません。 null を許可: False 例: 0取得または入力方法: クライアントが許容できるクエリ結果件数に応じて選択します。非負の整数を推奨します。 |
|
| name | string | Y | 必須の名前。上限は 256 文字と宣言されていますが、現在のデータベース列は 128 文字です。長い値で保存失敗が発生しないよう、128 文字以内に収めることを推奨します。名前は冪等キーではありません。 null を許可: False 最大長: 256 例: API示例空间取得または入力方法: 業務側が新しいワークスペースに識別しやすい名前を指定します。 |
| ownerUuid | string | Y | 必須のアカウント UUID。フィールド名は ownerUuid です。削除済み/存在しないアカウントは拒否されます。現在の検証では無効化アカウントも受け入れますが、無効化アカウントは正常にログインできません。成功後、このアカウントは Owner ロールを取得します。Owner のいないワークスペースを作成しないよう、空文字列を渡さないでください。 空文字列を許可: False 例: acnt_example001取得または入力方法: アカウント一覧の content.data[].uuid からこのワークスペースのオーナーを選択します。正常に有効化されたアカウントを選択することを推奨します。 |
| storageTypeUUID | string | 任意。省略、null、または空文字列の場合はサイトのデフォルトログストレージを使用します。明示的に指定する場合、esIndexMerged=true と同時に使用できません。この External エントリには datastoreCfg 資格情報パラメータがないため、追加の資格情報が必要なカスタム SLS インスタンスをこのエントリから選択しないでください。 null を許可: True 例: esinst_example001取得または入力方法: サイト管理バックエンドのストレージエンジン設定からアクティブなログストレージインスタンス UUID を取得します。管理者に提供を依頼できます。datastore 内のエンジン名ではありません。 |
パラメータ補足説明¶
サイトレベルの External API 資格情報で w 権限を持つものを使用します。認証方式はExternal API 署名認証を参照してください。例では v20240417 に従って署名を計算し、署名と送信には同じパス、Query、元のリクエストボディを使用します。すべての例はデモ値であり、実行前に実際の対象へ置き換えてください。書き込みリクエストがタイムアウトまたは 500 を返した場合は、まず現在の状態を照会し、確認してから再試行するかどうかを判断してください。
リクエスト例¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 対象サイトのアドレスおよび管理者が割り当てた External API AK/SK に置き換えます。
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'POST'
path = '/api/v1/workspace/create'
query = {}
data = {'name': 'API示例空间', 'ownerUuid': 'acnt_example001', 'desc': '接口文档演示工作空间', 'esIndexMerged': False, 'isOpenLogMultipleIndex': True, 'language': 'zh'}
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
レスポンス¶
HTTP 200、application/json、共通レスポンスエンベロープです。業務結果は content にあり、External は declaration を自動注入しません。ワークスペースオブジェクト内の declaration はそれ自身が保存するフィールドです。
| フィールド | 型 | 説明 |
|---|---|---|
| content.accountInfo | 文字列配列 | 新規ワークスペースに参加したアカウント UUID。この公開インターフェースには通常、指定した ownerUuid のみが含まれます。 |
| content.wsInfo.id | integer | サイト内のレコード連番。後続の呼び出しでは uuid を使用します。 |
| content.wsInfo.uuid | string | ワークスペース UUID。 |
| content.wsInfo.status | integer | 0 は正常、3 は削除済みマーク。削除時の返却スナップショットは 3 です。 |
| content.wsInfo.creator | string | 作成者識別子。External 作成では通常 sys です。 |
| content.wsInfo.updator | string | 最終更新者。未更新の場合は空になることがあります。 |
| content.wsInfo.createAt | integer | 作成時刻(Unix 秒)。 |
| content.wsInfo.deleteAt | integer | 削除時刻(Unix 秒)。未削除の場合は通常 -1。 |
| content.wsInfo.updateAt | integer | 更新時刻(Unix 秒)。まだ更新されていない場合は通常 -1。 |
| content.wsInfo.name | string | ワークスペースの表示名。 |
| content.wsInfo.token | string | ワークスペースのデフォルト収集トークン。資格情報として保存され、External AK/SK として使用できません。例ではプレースホルダー値を使用しています。 |
| content.wsInfo.cliToken | string | ワークスペースの CLI 資格情報。資格情報として保存され、例には実際の値は含まれません。 |
| content.wsInfo.dbUUID | string | メトリクスデータベースレコードの UUID。 |
| content.wsInfo.esInstanceUUID | string | 実際のログストレージインスタンス UUID。 |
| content.wsInfo.dashboardUUID | string | ワークスペースのデフォルトビュー識別子。未設定の場合は空です。 |
| content.wsInfo.exterId | string | 外部システムのワークスペース識別子。通常は空です。このページで書き込み可能なフィールドではありません。 |
| content.wsInfo.rpName | string | メトリクス保持ポリシーの内部別名。durationSet.rp の代替として使用しないでください。 |
| content.wsInfo.desc | string | ワークスペースの説明。 |
| content.wsInfo.durationSet | object または null | データ型ごとに保存された標準ストレージ期間。キーはエンジン、バージョン、インデックスマージ状態によって変化し、値は例えば 7d です。 |
| content.wsInfo.storagePolicy | object または null | データ型ごとに保存された長期ストレージポリシー。ここでの長期ポリシーは標準の durationSet と区別されます。 |
| content.wsInfo.datastore | object または null | データ型ごとに保存された実際のストレージエンジン。例えば metric=guancedb、logging=doris です。 |
| content.wsInfo.lastDqlDataCheckTime | object または null | データ型ごとに記録された直近の DQL データチェック情報。システムが保守する動的オブジェクトです。 |
| content.wsInfo.declaration | object または null | ワークスペース自身の組織および業務宣言。organization、business を含む場合があります。これはワークスペースの列であり、External の共通レスポンスに自動注入されるフィールドではありません。 |
| content.wsInfo.esIndexSettings | object または null | データ型ごとに保存されたインデックス設定オブジェクト。空オブジェクトはワークスペースレベルのカスタムテンプレートがないことを示し、下流にデフォルトテンプレートがないことを意味しません。 |
| content.wsInfo.bindInfo | object または null | ワークスペースのブランドテキスト、メール、ドメインの上書きオブジェクト。キー定義はバインド情報の設定を参照してください。 |
| content.wsInfo.versionType | string | ワークスペースバージョン。例えば free、freeEdition、pay、enterprise、unlimited です。作成時はサイト設定を使用し、このインターフェースではバージョン入力パラメータを提供しません。 |
| content.wsInfo.billingState | string | 課金状態識別子。例えば free、normal、arrearage、expired、unlimited です。 |
| content.wsInfo.bossStation | string | 請求センターノード識別子。例えば CN、SG、または空文字列です。 |
| content.wsInfo.brandKey | string | ワークスペースのブランド識別子。 |
| content.wsInfo.enablePublicDataway | integer | パブリック Dataway を許可するか。1 有効、0 無効。 |
| content.wsInfo.isOpenLogMultipleIndex | integer または boolean | ログマルチインデックスの新規作成を許可するか。1 有効、0 無効。既存インデックスはこれによって削除されません。 |
| content.wsInfo.esIndexMerged | integer | インデックスをマージするか。1 マージ、0 分割。 |
| content.wsInfo.supportJsonMessage | integer | JSON メッセージサポートフラグ。1 有効、0 無効。 |
| content.wsInfo.isLocked | integer | ワークスペースロックフラグ。1 ロック、0 未ロック。 |
| content.wsInfo.lockMode | string | ロックモード。例えば none、writeLocked。 |
| content.wsInfo.lockAt | integer | ロック時刻(Unix 秒)。未設定の場合は通常 -1。 |
| content.wsInfo.delayDeleteAt | integer | 遅延クリーンアップ計時ポイント(Unix 秒)。クリーンアップ待ちフローにない場合は通常 -1。 |
| content.wsInfo.inviteAudit | integer | メンバー招待審査を有効にするか。1 有効、0 無効。 |
| content.wsInfo.makeResourceExceptionCode | string | リソース初期化の問題マーカー。空の場合があります。作成フローでは content のトップレベルにも最新の問題マーカーを返します。 |
| content.wsInfo.loggingCutSize | integer | 巨大ログの分割単位(バイト)。 |
| content.wsInfo.language | string | ワークスペースの言語識別子。 |
| content.wsInfo.noviceGuide | boolean | 初心者ガイドフラグ。 |
| content.wsInfo.timezone | string | ワークスペースのタイムゾーン。未設定の場合は空です。 |
| content.wsInfo.menuStyle | string | メニュースタイル識別子。未設定の場合は空です。 |
| content.wsInfo.tenantId | integer | ワークスペースのテナント ID。作成レスポンスはテナント ID 生成前にスナップショットを取得するため -1 になる可能性があり、後続で詳細から最終値を読み取ります。 |
| content.wsInfo.isOpenCustomMappingRule | integer | カスタムマッピングルールのスイッチ。1 有効、0 無効。 |
| content.wsInfo.enableRumMultipleTable | integer | RUM テーブル分割スイッチ。1 有効、0 無効。 |
| content.wsInfo.enableMFA | boolean | MFA を要求するか。 |
| content.wsInfo.disableQueryAcceleration | integer | クエリ高速化の無効化フラグ。1 無効、0 無効化しない。 |
| content.wsInfo.disableDataWrite | integer | 書き込み無効化フラグ。1 無効、0 無効化しない。 |
| content.wsInfo.disableDataWriteAt | integer | 書き込み無効化時刻(Unix 秒)。未設定の場合は通常 -1。 |
| content.wsInfo.logBackupQueryTimeLimit | integer | バックアップログのクエリ時間帯制限値(単位: 時間)。 |
| content.wsInfo.engineSetting | object | エンジン専用設定の動的オブジェクト。履歴上の nodegroup フィールドは出力時に node_group に正規化されます。 |
| content.wsInfo.enableAI | boolean | ワークスペースの AI 全体スイッチ。 |
| content.wsInfo.enableAPIKeySecurityDisplayPolicy | boolean | API Key の安全な表示ポリシーのスイッチ。 |
| content.wsInfo.enableObsyAISubscriptionBilling | boolean | Obsy AI サブスクリプション課金スイッチ。 |
| content.wsInfo.tokenIpSet | object または null | ワークスペーストークンの IP アクセス制限設定の動的オブジェクト。このページでは返却のみで、これらのリクエストパラメータでは変更できません。 |
| content.wsInfo.singleConfig | object または null | ワークスペース機能設定の動的オブジェクト。ワークスペースに既存の設定を優先し、ここで固定の設定キーを保証するものではありません。 |
| content.wsInfo.issueUpgrade | boolean | インシデントアップグレード機能のスイッチ。 |
| content.wsInfo.durationSet.{データ型} | string | そのデータ型の標準保持期間。例: rp、logging、keyevent、tracing、rum、apm、network、backup_log。現在の設定に応じて他の読み取り専用キーが存在する場合があります。 |
| content.wsInfo.storagePolicy.{データ型} | object | その型の長期ポリシー。一般的に rp、logging を使用します。 |
| content.wsInfo.storagePolicy.{データ型}.longStorageEnabled | boolean | 長期ストレージを有効にするか。 |
| content.wsInfo.storagePolicy.{データ型}.longStorageDuration | string | 長期の総保持期間。例えば 180d。無効化後は通常空文字列です。 |
| content.wsInfo.datastore.{データ型} | string | その型で使用されるエンジン名。例えば es、doris、scopedb、volctls、sls、guancedb。インスタンス UUID ではありません。 |
| content.wsInfo.declaration.organization | string | 組織名。宣言設定がある場合に提供されます。 |
| content.wsInfo.declaration.business | string | 業務説明。宣言設定がある場合に提供されます。 |
| content.wsInfo.esIndexSettings.{データ型} | object | 対応する型のインデックス設定。 |
| content.wsInfo.esIndexSettings.{データ型}.number_of_shards | integer | プライマリシャード数。出現するかどうかはエンジンに依存します。 |
| content.wsInfo.esIndexSettings.{データ型}.number_of_replicas | integer | レプリカ数。 |
| content.wsInfo.esIndexSettings.{データ型}.rollover_max_size | integer | シャードロールオーバーしきい値。インターフェースはエンジン定義に従って透過的に渡します。 |
| content.wsInfo.esIndexSettings.{データ型}.hot_retention | integer | ホットデータの保持期間(時間)。 |
| content.wsInfo.esIndexSettings.{データ型}.cold_retention | integer | オプションのコールドデータ保持期間(時間)。 |
| content.wsInfo.esIndexSettings.{データ型}.archive_retention | integer | オプションのアーカイブデータ保持期間(時間)。 |
| content.wsInfo.esIndexSettings.{データ型}.openAdvancedConfig | integer | 詳細設定フラグ。通常 0 または 1。 |
| content.wsInfo.engineSetting.node_group | string | オプションのエンジンノードグループ識別子。その他の設定項目は対応するエンジンによって決まります。 |
| content.wsInfo.bindInfo.{設定項目} | JSON 値 | 既存のブランド上書き値。キーの意味はバインド情報設定インターフェースに従います。 |
| content.wsInfo.lastDqlDataCheckTime.{データ型} | JSON 値 | その型のシステム保守チェック値。クエリ結果ではありません。 |
| content.wsInfo.tokenIpSet.{設定項目} | JSON 値 | 既存のトークン IP ポリシー。読み取り後はその構造を保持し、これに基づいて External 認証ヘッダーを構築しません。 |
| content.wsInfo.singleConfig.{設定項目} | JSON 値 | 既存の機能設定値。具体的な型とキーは対応する機能設定の取り決めに従います。 |
| content.makeResourceExceptionCode | string | リソース作成の問題マーカー。空文字列、noPermissionCreateProject、または addDataStoreFailure。現在は主に SLS/VolcTLS のデータベース作成結果に使用され、他の下流の失敗が必ずしもこのフィールドに書き込まれるとは限りません。 |
{
"code": 200,
"content": {
"accountInfo": [
"acnt_example001"
],
"wsInfo": {
"id": 1001,
"uuid": "wksp_example001",
"status": 0,
"creator": "sys",
"updator": "",
"createAt": 1785427200,
"deleteAt": -1,
"updateAt": -1,
"name": "API示例空间",
"token": "<workspace-token>",
"cliToken": "<workspace-cli-token>",
"dbUUID": "ifdb_example001",
"esInstanceUUID": "esinst_example001",
"dashboardUUID": "",
"exterId": "",
"rpName": "",
"desc": "接口文档演示工作空间",
"durationSet": {
"rp": "7d",
"logging": "7d",
"keyevent": "7d",
"tracing": "7d",
"rum": "7d",
"network": "1d"
},
"storagePolicy": {},
"datastore": {
"metric": "guancedb",
"logging": "doris",
"keyevent": "doris",
"tracing": "doris",
"rum": "doris",
"network": "doris",
"lineage": "doris"
},
"lastDqlDataCheckTime": {},
"declaration": {
"organization": "示例组织",
"business": ""
},
"esIndexSettings": {},
"bindInfo": {},
"versionType": "unlimited",
"billingState": "normal",
"bossStation": "",
"brandKey": "guance",
"enablePublicDataway": 1,
"isOpenLogMultipleIndex": true,
"esIndexMerged": 0,
"supportJsonMessage": 1,
"isLocked": 0,
"lockMode": "none",
"lockAt": -1,
"delayDeleteAt": -1,
"inviteAudit": 0,
"makeResourceExceptionCode": "",
"loggingCutSize": 10240,
"language": "zh",
"noviceGuide": false,
"timezone": "",
"menuStyle": "",
"tenantId": -1,
"isOpenCustomMappingRule": 0,
"enableRumMultipleTable": 1,
"enableMFA": false,
"disableQueryAcceleration": 0,
"disableDataWrite": 0,
"disableDataWriteAt": -1,
"logBackupQueryTimeLimit": 24,
"engineSetting": {},
"enableAI": false,
"enableAPIKeySecurityDisplayPolicy": false,
"enableObsyAISubscriptionBilling": false,
"tokenIpSet": {},
"singleConfig": {},
"issueUpgrade": true
},
"makeResourceExceptionCode": ""
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
以下の表は、このインターフェースの業務検証および確認済みの主なエラー分岐を示します。下流サービスは具体的なエラーに応じて他の 4xx エラーを返す場合があります。通常の 5xx および未知の例外はグローバル処理を経て ft.InternalServerError を返します。書き込みリクエストでは、現在の設定とエラー content を組み合わせて既に反映されたかを判断する必要があり、HTTP ステータスだけでロールバックを推測することはできません。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | JSON トップレベルがオブジェクトではない | 一部の JSON ファイル形式エラー | パラメータ表に従って JSON オブジェクトを送信し、配列や null をリクエストボディ全体として使用しないでください。 |
| 406 | ft.InvalidBrandKey | brandKey がサイトで許可された集合内にない | ブランド識別子 {} が無効です。 |
サイト管理者に許可されたブランド識別子を確認してください。 |
| 404 | ft.NotFoundAccount | ownerUuid が存在しない、または削除済みアカウントを指している | 指定されたアカウントが見つかりません | アカウント一覧から有効なアカウントを選択します。 |
| 404 | ft.NamespaceDatastoreNotFound | ワークスペースのデフォルトデータ型に対応するストレージエンジン設定がない | {} のストレージタイプが見つかりません | 管理者にサイトのデータ型とストレージ設定を補完してもらってください。 |
| 404 | ft.NoExistsTimeDbInstance | サイトにアクティブなデフォルト時系列データベースインスタンスがない | 時系列データベース設定が見つかりません | 管理者に先にサイトの時系列ストレージ設定を完了してもらってください。 |
| 406 | ft.InvalidParameterV2 | storageTypeUUID がアクティブなストレージインスタンスを指していない | パラメータ {} の値 {} が無効です |
管理者から有効なログインスタンス UUID を再取得してください。 |
| 406 | ft.ForbiddenExmergeStoreageBoth | 明示的な storageTypeUUID と esIndexMerged=true を同時に使用 | インデックスマージが有効な場合、ストレージタイプを選択できません | esIndexMerged=false に設定するか、storageTypeUUID を省略してデフォルトインスタンスを使用します。 |
| 400 | ft.LogIndexCfgQuantityIllegal | SLS/Beaver の logMultipleIndexCount が 0 未満 | 不正なログマルチインデックス数量 | 非負の整数を使用します。数量上限が必要な場合は正数を使用します。 |
| 406 | ft.CurrentVersionUnsupportRp | 対応バージョンのデフォルト保持ポリシーがない、または RP が利用可能な設定を取得できない | 現在のバージョンは rp:{} をサポートしていません |
そのサイトで確認済みのデフォルト保持期間を使用し、管理者にワークスペースバージョン設定を確認してもらってください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ、リソースサービス、または未処理のパラメータ変換例外 | 内部エラー | traceId を保存して管理者に連絡してください。設定と下流の実際の状態を先に確認し、失敗応答をそのまま保存されていないと見なさないでください。また、盲目的に作成を繰り返したりローテーションしたりしないでください。 |