取得¶
GET /api/v1/workspace/{workspace_uuid}/get
概要¶
UUID を指定して、現在のサイトの有効なワークスペースを 1 つ取得します。
呼び出し前の準備と使用手順¶
まずワークスペース一覧から UUID を取得し、その後に具体的なワークスペースを照会します。フィールド表と例では一般的なフィールドを抜粋しています。完全なレスポンスにはワークスペースの認証情報が含まれる可能性があるため、レスポンスは機密情報として扱ってください。
例では External API の署名バージョン v20240417 を使用します。対象サイトの External API アドレス、Access Key、Secret Key をそれぞれ DF_EXTERNAL_API_URL、DF_EXTERNAL_ACCESS_KEY、DF_EXTERNAL_SECRET_KEY に設定してください。例の ID は実際の値に置き換えてください。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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>取得・入力方法: Secret Key を使用し、GET、nonce、リクエストパスと元のクエリ文字列、タイムスタンプ、空文字列からなるテキストに対して HMAC-SHA256 を実行し、その 16 進数の結果を取得します。 |
| X-Df-Timestamp | string | Y | リクエスト時のタイムスタンプ 例: 1785456000取得・入力方法: 呼び出し時の現在の Unix 秒を入力します(例: date +%s を実行)。 |
| X-Df-Nonce | string | Y | リクエスト時に生成する一時コード 例: b53b47e12e514616ad8cb1f17cb66dce取得・入力方法: リクエストごとに新しいランダム値を生成します(例: uuid.uuid4().hex)。 |
パラメータ補足説明¶
現在の対象サイトに割り当てられた External API 署名認証情報を使用します。
リクエスト例¶
import hmac
import os
import time
import uuid
from urllib.parse import urlencode
import requests
server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/workspace/wksp_example/get"
query = {}
if query:
path += "?" + urlencode(query)
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = " ".join(("GET", nonce, path, timestamp, ""))
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload.encode(), "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,
}
result = requests.get(server + path, headers=headers, timeout=15)
result.raise_for_status()
data = result.json()["content"]
レスポンス¶
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.bindInfo | object または null | ワークスペースレベルのブランドテキスト、メール、ドメインのオーバーライド設定。 |
| content.brandKey | string | ワークスペースに関連付けられたサイトブランド識別子。 |
{
"code": 200,
"content": {
"uuid": "wksp_example",
"name": "生产监控",
"desc": "生产服务观测",
"status": 0,
"timezone": "Asia/Shanghai",
"language": "zh",
"brandKey": "truewatch",
"bindInfo": {
"name": "示例观测平台",
"domain": "console.example.com"
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.NotFoundWorkspace | 指定した UUID に対応する有効なワークスペースが存在しない、またはそのワークスペースのステータスが有効ではない場合 | 指定されたワークスペースが見つかりません。 | 現在のサイトのワークスペース一覧から有効な UUID を再取得します。 |