コンテンツにスキップ

一覧取得



GET /api/v1/workspace/list

概要

現在のサイトで参照可能な、削除されていないワークスペースをページ単位で一覧表示します。

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

まず名前または UUID で検索し、結果に含まれる uuid を使ってワークスペースの詳細、クォータ、またはロールを照会できます。検索で複数のワークスペースが返された場合は、名前と UUID を確認してください。フィールド表とサンプルには一般的なフィールドを示しています。API はワークスペースのクレデンシャル情報を返す可能性があるため、ログやチケットにはトラブルシューティングに必要なフィールドのみを残してください。

サンプルは External API 署名バージョン v20240417 を使用します。対象サイトの External API アドレス、Access Key、Secret Key をそれぞれ DF_EXTERNAL_API_URL、DF_EXTERNAL_ACCESS_KEY、DF_EXTERNAL_SECRET_KEY に設定してください。サンプルの ID は実際の値に置き換えてください。

リクエストヘッダー

パラメータ名 型 必須 説明
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 です。

Query リクエストパラメータ

パラメータ名 型 必須 説明
search string 名前、UUID のあいまい一致をサポートし、内部数値 ID の完全一致も可能です。省略または空の場合、キーワードによるフィルタリングは行いません。
null 許可: False
例: 生产
取得または入力方法: コンソールまたは管理バックエンドで確認できるワークスペース名、UUID の一部、または既知の内部数値 ID を入力します。
pageIndex integer ページ番号。デフォルトは 1 です。
null 許可: False
$minValue: 1
例: 1
取得または入力方法: 1 から 1 ページずつ増やし、レスポンスのページ番号で確認します。
pageSize integer 1 ページあたりの件数。デフォルトは 10 です。1 から 100 の範囲で指定できます。
null 許可: False
$minValue: 1
$maxValue: 100
例: 10
取得または入力方法: クライアントが必要とするページ容量を整数で入力します。

パラメータ補足説明

現在の対象サイトに割り当てられた 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/list"
query = {'search': '生产', 'pageIndex': 1, 'pageSize': 10}
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.data array<object> 本ページの結果。レコードがない場合は空の配列です。
content.data[].uuid string ワークスペース UUID。以降、API の workspace_uuid パスまたは workspaceUUID リクエストフィールドに指定します。
content.data[].name string ワークスペースの表示名。
content.data[].desc string ワークスペースの説明。
content.data[].status integer ワークスペースのステータス。
content.data[].timezone string ワークスペースのタイムゾーン。例: Asia/Shanghai。
content.data[].language string ワークスペースの言語設定。
content.pageInfo object ページ情報。
content.pageInfo.pageIndex integer 現在のページ番号。1 から始まります。
content.pageInfo.pageSize integer 1 ページあたりの件数。
content.pageInfo.count integer 現在のページで返されたレコード数。
content.pageInfo.totalCount integer 条件を満たすワークスペースの総数。総ページ数の計算に使用します。
{
  "code": 200,
  "content": {
    "data": [
      {
        "uuid": "wksp_example",
        "name": "生产监控",
        "desc": "生产服务观测",
        "status": 0,
        "timezone": "Asia/Shanghai",
        "language": "zh"
      }
    ],
    "pageInfo": {
      "pageIndex": 1,
      "pageSize": 10,
      "count": 1,
      "totalCount": 1
    }
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed クエリパラメータが宣言されていない、または数値がパラメータ表の制約を超えている メッセージにフィールドまたはルールが示されます。 パラメータ名、型、および値の範囲を確認してください。

フィードバック

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