コンテンツにスキップ

変更



POST /api/v1/workspace/{workspace_uuid}/modify

概要

ワークスペース名、クエリのオン/オフ、マルチインデックス、データ保持ポリシーを調整します。

呼び出し前と使用手順

まずワークスペース詳細とインデックステンプレート一覧を読み取り、元の設定を保存します。変更するフィールドのみを送信します。同時に、通常ストレージでは現在のisOpenLogMultipleIndexを明示的に指定し、省略時にマルチインデックスが無効になるのを避けます。保持期間を変更するとクエリ可能な範囲に影響し、短くすると期限切れデータのクリーンアップがトリガーされる可能性があります。インデックスマージモードを切り替えると、保持期間が再計算され、カスタムテンプレートがクリアされます。成功後は詳細とインデックステンプレートを再読み取りして確認し、データのクエリ/収集を確認します。この操作では先に保存してからダウンストリームへ同期する場合があるため、失敗後は設定と実際のリソースをそれぞれ確認する必要があります。

ルートパラメータ

パラメータ名 型 必須 説明
workspace_uuid string Y 対象ワークスペースのUUID。アカウントUUIDでも収集Tokenでもありません。
例: wksp_example001
取得または入力方法: ワークスペース一覧のcontent.data[].uuid、または作成成功時のcontent.wsInfo.uuidから取得し、サイトとワークスペース名を確認します。

リクエストヘッダー

パラメータ名 型 必須 説明
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秒を生成します。

リクエストボディパラメータ

パラメータ名 型 必須 説明
storagePolicy.rp object メトリクスの長期ストレージ設定。送信しない他のカテゴリは保持されます。このカテゴリに空オブジェクトを指定すると無効として処理されます。
例: {"longStorageEnabled": false}
取得または入力方法: 現在のインデックステンプレート一覧のstoragePolicy.rpから取得し、目的のポリシーに従って変更します。
storagePolicy.rp.longStorageEnabled boolean falseで明示的に無効、trueで有効。カテゴリオブジェクトが存在しこのキーを省略した場合はfalseに正規化され、元のポリシーが無効になる可能性があります。元のポリシーを保持するにはカテゴリオブジェクト全体を省略します。無効にしても標準durationSetは変更されません。
例: false
取得または入力方法: 長期保持が必要かどうかに応じてJSONブール値を選択します。
storagePolicy.rp.longStorageDuration string 有効時に入力し、無効時は省略可能。標準期間と長期期間を直接合計しないでください。
例: 180d
取得または入力方法: サイトで許可されている長期期間から選択し、そのタイプの現在または今回の標準保持期間より長くする必要があります。
storagePolicy.logging object ログの長期ストレージ設定。送信しない他のカテゴリは保持されます。このカテゴリに空オブジェクトを指定すると無効として処理されます。
例: {"longStorageEnabled": false}
取得または入力方法: 現在のインデックステンプレート一覧のstoragePolicy.loggingから取得し、目的のポリシーに従って変更します。
storagePolicy.logging.longStorageEnabled boolean falseで明示的に無効、trueで有効。カテゴリオブジェクトが存在しこのキーを省略した場合はfalseに正規化され、元のポリシーが無効になる可能性があります。元のポリシーを保持するにはカテゴリオブジェクト全体を省略します。無効にしても標準durationSetは変更されません。
例: false
取得または入力方法: 長期保持が必要かどうかに応じてJSONブール値を選択します。
storagePolicy.logging.longStorageDuration string 有効時に入力し、無効時は省略可能。標準期間と長期期間を直接合計しないでください。
例: 180d
取得または入力方法: サイトで許可されている長期期間から選択し、そのタイプの現在または今回の標準保持期間より長くする必要があります。
disableQueryAcceleration integer オプションの整数0/1。省略時は保持。nullを許可すると宣言されていますが、現在の実装ではint(null)が500を発生させるため、クライアントはnullを送信しないでください。
nullを許可: True
選択可能な値: [0, 1]
例: 0
取得または入力方法: 現在の詳細から読み取った後、0(無効化しない)または1(無効化する)を選択します。
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を許可すると宣言されていますが、現在の実装ではint(null)が500を発生させるため、クライアントはnullを送信しないでください。
nullを許可: True
選択可能な値: [0, 1]
例: 1
取得または入力方法: RUMデータのテーブル分割の必要に応じて、1(有効)または0(無効)を選択します。
esIndexMerged boolean オプション。省略時は保持。logging=esの場合のみ切り替え可能。切り替えると一部の保持ポリシーが再計算され、ワークスペースのカスタムインデックス設定がクリアされるため、事前にテンプレートをバックアップしてください。
nullを許可: False
例: false
取得または入力方法: まずインデックステンプレート一覧で現在のesIndexMergedとdatastore.loggingを確認します。
isOpenCustomMappingRule boolean オプションのブール値。省略時は保持。nullにはできません。
nullを許可: False
例: false
取得または入力方法: まずワークスペース詳細から現在のスイッチを読み取り、調整するかどうかを決定します。
isOpenLogMultipleIndex boolean オプションのブール値ですが、通常ストレージでは省略するとfalseとして処理され、新規マルチインデックスが無効になる可能性があります。SLS/Beaverではこのスイッチは本フィールドでは変更されません。falseでも既存のインデックスは削除されません。
nullを許可: False
例: true
取得または入力方法: ワークスペース詳細から現在のisOpenLogMultipleIndexを読み取り、通常の変更時は現在値を明示的に渡して保持します。
leftWildcard boolean オプションのブール値。省略時は保持。falseで無効、trueで有効。nullにはできません。
nullを許可: False
例: false
取得または入力方法: 左側ワイルドカードのあいまい検索要件に応じて選択します。保持する場合は省略します。
logMultipleIndexCount int オプション。省略時は保持。通常ストレージでは>=1、SLS/Beaverでは>=0で、0は数量制限なしを意味します。nullにはできません。
nullを許可: False
例: 30
取得または入力方法: ビジネス上のインデックス数に応じて選択するか、事前に管理者へ現在の数量制限を確認します。
loggingCutSize int オプションの整数。非ゼロかつ変更時にダウンストリームへ通知して更新します。0ではカットは無効にならず、元の値も変更されません。nullにはできません。
nullを許可: False
例: 10240
取得または入力方法: 既存のloggingCutSizeを再利用するか、実際の巨大ログポリシーに応じてバイト数を指定します。
maxSearchResultCount integer オプションの整数。省略時は元の設定を変更しません。レスポンスで同名の値が省略された場合は0となり、これによって元の設定がクリアされたと判断できません。nullにはできません。
nullを許可: False
例: 0
取得または入力方法: クライアントのクエリ結果総量の必要に応じて選択します。0はここで追加制限を課さないことを意味します。
name string オプション。省略時は保持。最大256文字と宣言されていますが、ストレージ列との互換性のため128文字以内を推奨します。nullにはできません。
nullを許可: False
最大長: 256
例: API示例空间新名称
取得または入力方法: 新しいワークスペース表示名を入力します。
storagePolicy json オプションのオブジェクト。データタイプのキーごとに更新し、完全置換ではありません。省略またはトップレベル{}では元のポリシーをクリアしません。あるカテゴリに空オブジェクトを渡すと無効として正規化されます。rp、loggingのみを使用することを推奨します。あるタイプを無効にする場合はlongStorageEnabled=falseを明示的に指定してください。nullにはできません。長期ストレージは総保持期間であり、そのタイプの標準保持期間より長くする必要があります。ログはscopedbかつpay/enterprise/unlimitedでのみサポートされます。メトリクスは課金タイプに適合する必要があり、payおよび請求センターが有効なunlimitedではmetric_point_totalが要求され、enterpriseなども明示的なtimeseries課金を拒否します。リポジトリのデフォルトではpayのログは90d/120d/180d/360dを選択可能、payのメトリクスはさらに540d/720dを選択可能です。enterprise/unlimitedのログは1d〜1800d、メトリクスは1d〜3600dが許可され、引き続き標準保持期間より長くする必要があります。実際に選択可能な集合と範囲はサイト設定によって上書きされます。
nullを許可: False
例: {"logging": {"longStorageEnabled": false}}
取得または入力方法: インデックステンプレート一覧から現在のstoragePolicyとdurationSetを読み取り、エンジン、バージョン、課金タイプを確認します。

パラメータ補足説明

w権限を持つサイトレベルのExternal API資格情報を使用します。認証方式はExternal API 署名認証を参照してください。例はv20240417に従って署名を計算し、署名と送信で同じパス、Query、元のリクエストボディを使用します。すべての例はデモ用の値です。実行前に実際のターゲットに置き換えてください。書き込みリクエストがタイムアウトまたは500になった場合は、まず現状をクエリし、確認してから再試行するかどうかを決定してください。

長期ストレージは総保持期間であり、そのタイプの標準保持期間より長くする必要があります。ログはscopedbかつpay/enterprise/unlimitedでのみサポートされます。メトリクスは課金タイプに適合する必要があり、payおよび請求センターが有効なunlimitedではmetric_point_totalが要求され、enterpriseなども明示的なtimeseries課金を拒否します。リポジトリのデフォルトではpayのログは90d/120d/180d/360dを選択可能、payのメトリクスはさらに540d/720dを選択可能です。enterprise/unlimitedのログは1d〜1800d、メトリクスは1d〜3600dが許可され、引き続き標準保持期間より長くする必要があります。実際に選択可能な集合と範囲はサイト設定によって上書きされます。

リクエスト例

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/wksp_example001/modify'
query = {}
data = {'name': 'API示例空间新名称', 'isOpenLogMultipleIndex': True}
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.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 ワークスペースのデフォルト収集Token。資格情報として保存され、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。作成時はサイト設定を取得し、このAPIではバージョンパラメータを提供しません。
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 ワークスペースTokenの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 シャードロールオーバーしきい値。APIはエンジン定義に従って透過的に渡します。
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値 既存のブランド上書き値。キーの意味はバインド情報設定APIを基準とします。
content.wsInfo.lastDqlDataCheckTime.{数据类型} JSON値 そのタイプのシステム管理チェック値。クエリ結果ではありません。
content.wsInfo.tokenIpSet.{配置项} JSON値 既存のToken IPポリシー。読み取り後にその構造を保持し、これに基づいてExternal認証ヘッダーを構築しません。
content.wsInfo.singleConfig.{配置项} JSON値 既存の機能設定値。具体的なタイプとキーは対応する機能設定の取り決めによります。
content.maxSearchResultCount integer 今回解析された最大検索結果数。この入力パラメータを省略した場合は0が返され、元の設定には非ゼロ値が保持されている可能性があります。
{
  "code": 200,
  "content": {
    "wsInfo": {
      "id": 1001,
      "uuid": "wksp_example001",
      "status": 0,
      "creator": "sys",
      "updator": "sys",
      "createAt": 1785427200,
      "deleteAt": -1,
      "updateAt": 1785427200,
      "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": 1,
      "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
    },
    "maxSearchResultCount": 0
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

下表に本APIのビジネス検証と確認済みの主なエラーブランチを示します。ダウンストリームサービスは具体的なエラーマッピングに応じて他の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.NotFoundWorkspace ワークスペースが存在しない、削除済み、または現在のアクティブ状態クエリを満たさない 指定されたワークスペースが見つかりません ワークスペース一覧から有効なUUIDを再取得し、状態を確認します。
429 ft.OperationTooFrequently 同一ワークスペースのストレージ設定ロックが占有されている、または実行中にロック所有権を失った 操作が頻繁すぎます。しばらくしてから再試行してください 後で現在の設定を読み取ってから、新しいnonceと署名で再試行します。実行中にロックを失った場合、すべての書き込みが発生しなかったと断定できません。
400 ft.InvalidActionForbiddenChange 非ESでマージ状態への切り替えを試みた、またはバージョン/エンジン/課金タイプがリクエストされた長期ストレージをサポートしていない 具体的なブランチに応じて返却。例:「ログがscopedbストレージのワークスペースのみ長期ストレージポリシーを有効化できます」 実際のdatastoreと課金タイプに応じてリクエストを調整します。
400 ft.LogIndexCfgQuantityIllegal 通常ストレージのインデックス数が1未満、またはSLS/Beaverの数量が0未満 不正なログマルチインデックス数 ストレージタイプに応じて数量を修正します。
400 ft.FreeWKSPLimit 無料プラン/フリープランが標準保持期間または長期ストレージポリシーを変更しようとした 無効な操作です。現在のワークスペースは無料プランです 現在の保持期間を維持するか、正式なアップグレードフローでワークスペースバージョンを変更します。
400 ft.IllegalDataKeepTime payバージョンで変更する標準保持期間がそのサイトで許可された集合にない 不正なデータ保持期間 サイトで選択可能な標準保持期間から選択します。
406 ft.InvalidDuration 保持期間が数字+dでない、または長期保持期間がそのバージョンで許可された集合にない 無効なduration 表内の形式とサイトの範囲を使用し、長期保持期間は標準値より長くする必要があります。
406 ft.InvalidDurationRange enterprise/unlimitedのカスタム保持期間が範囲外、または長期保持期間が標準保持期間以下 有効なデータ保持期間の範囲を超えています サイトで許可された範囲に従って標準および長期保持期間を調整します。
406 ft.CurrentVersionUnsupportRp 現在のバージョンが要求された保持ポリシー編集をサポートしていない 現在のバージョンはrp:{}をサポートしていません 管理者にワークスペースバージョンとストレージ設定を確認してください。
500 ft.InternalServerError データベース、キャッシュ、リソースサービス、または未処理のパラメータ変換例外 内部エラー traceIdを保存して管理者に連絡してください。設定とダウンストリームの実際の状態を先にクエリし、失敗レスポンスをそのまま未保存と見なさず、盲目的に作成やローテーションを繰り返さないでください。

フィードバック

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