現在のワークスペース情報を取得¶
GET /api/v1/workspace/get
概要¶
現在の API Key が所属するワークスペースの基本情報を取得します。
呼び出し前の準備と使用手順¶
リクエストにはワークスペース UUID やクエリパラメータは不要です。レスポンスの uuid から、呼び出し元の識別情報に対応するワークスペースを取得します。ワークスペース設定は短時間キャッシュされる場合があり、レスポンスの serverTime はサーバー時間です。以下のフィールドと例は主なフィールドを抜粋したものです。レスポンスに含まれるワークスペースの認証情報およびサービス設定は機密情報として扱ってください。
サイトドメイン一覧から、所属サイトの OpenAPI アドレスを選択してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI Key 認証情報。完全なキー値を使用し、API Key レコードの UUID は使用しません。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理で、本 API の権限を持つ Key を作成または取得します。 |
パラメータ補足¶
ワークスペースはリクエスト内の DF-API-KEY によって決定されます。
リクエスト例¶
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.uuid | string | ワークスペース UUID。後続で API の workspace_uuid パスまたは workspaceUUID リクエストフィールドに指定します。 |
| content.name | string | ワークスペースの表示名。 |
| content.desc | string | ワークスペースの説明。 |
| content.status | integer | ワークスペースのステータス。 |
| content.timezone | string | ワークスペースのタイムゾーン(例: Asia/Shanghai)。 |
| content.language | string | ワークスペースの言語設定。 |
| content.versionType | string | ワークスペースのバージョン種別。 |
| content.regionCode | string | サイト識別子。 |
| content.memberCount | integer | ワークスペースおよび関連チームメンバーの合計数。 |
| content.note | string | 現在の呼び出し元識別情報のワークスペース内での備考。 |
| content.logoUrl | string | ワークスペースのロゴ URL。空の場合があります。 |
| content.faviconUrl | string | ワークスペースのアイコン URL。空の場合があります。 |
| content.serverTime | integer | このレスポンス生成時のサーバー Unix 時間(ミリ秒)。キャッシュがヒットした場合は以前の値が再利用されます。 |
| content.datastore | object | ワークスペースのデータストレージ設定。 |
| content.durationSet | object | ワークスペースのデータタイプごとの保持設定。 |
| content.leftWildcard | boolean | 左あいまい検索を有効にするかどうか。 |
| content.logMultipleIndexCount | integer | ワークスペースのログ複数インデックス数の設定。 |
| content.durationUpdatedToday | boolean | 本日保持設定を変更済みの場合は true。条件を満たす場合にのみ表示されます。 |
| content.declaration | object または null | ワークスペースの公開宣言情報。 |
| content.token | string | ワークスペースのデータ書き込み認証情報。workspace.tokenRead がない場合は権限に応じてマスクされ、レスポンス内の値は機密として扱う必要があります。 |
{
"code": 200,
"content": {
"uuid": "wksp_example",
"name": "生产监控",
"desc": "生产服务观测",
"status": 0,
"timezone": "Asia/Shanghai",
"language": "zh",
"versionType": "pay",
"regionCode": "console",
"memberCount": 3,
"note": "",
"logoUrl": "",
"faviconUrl": "",
"serverTime": 1785456000000
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.NotFoundWorkspace | API Key に対応するワークスペースが存在しない、または利用できません | ワークスペースが存在しません。 | API Key と、その所属ワークスペースのステータスを確認してください。 |