1. 概述

神策分析在 1.5 版本裡面推出了“ 多專案 ”功能。本文介紹多專案管理工具的使用方法。

多專案管理工具提供如下幾個功能:

  1. 列出所有專案
  2. 新建專案
  3. 更新專案顯示名
  4. 刪除專案
  5. 回收已刪除專案的資源
  6. 重置登入系統的密碼

此外:

  • 關於專案重置功能請參見 多專案;
  • 雲版多專案相關操作請聯繫值班同學處理;  

2. 使用方法

請在 sa_cluster 帳戶下使用該工具。從 root 切換到 sa_cluster 帳戶的方法:

su - sa_cluster
BASH
  • 請注意 su 與 sa_cluster 中間的減號。

2.1. 列出所有專案

執行以下命令可以列出所有專案:

project_tools -m list
BASH
spadmin project -m list
BASH

運行輸出樣例如下:

--------------------------------------
project.id: 1
name: default
cname: 預設專案
status: AVAILABLE
super_token: FFNJ24C31
normal_token: 8FWI1GN1F
create_time: 2016-06-29 23:46:39.0
--------------------------------------
 
當前共 1 個有效 project.
許可允許最多使用 2 個專案.
CODE

其中 status 共有 3 種取值,分別含義如下:

  • CREATED: 已經建立,不能匯入數據,一般出現在剛建立專案的前 1 分鐘內,之後轉為 PREPARED;
  • PREPARED: 可以匯入,但還不能查詢,該狀態一般出現在新專案建立還沒有匯入數據;
  • AVAILABLE: 可以查詢,即已經匯入行為事件數據; 

2.2. 新建專案

執行以下命令可以新建專案:

project_tools -m create -n <專案名稱> [-c <專案顯示名>] -p <新專案admin的密碼> [--normal_token <數據匯入 Normal Token>] [--super_token <數據匯入 Super Token>]
BASH
spadmin project -m create -n <專案名稱> [-c <專案顯示名>] -p <新專案admin的密碼> [--normal_token <數據匯入 Normal Token>] [--super_token <數據匯入 Super Token>] [--disable_schema_limited]
BASH

1.17 版本新建專案預設開啟數據強校驗模式,如需關閉可參考下方 .多專案管理工具使用說明 v2.0#更新專案設定 的命令,關於數據強校驗模式可以參考文件 數據強校驗模式

參數解釋:

  • -n, --name: 專案名稱,需要是一個合法的變量名,即英文大小寫字母、數字以及下底線組成,第一個字元不能為數字;
  • -p, --password: 新專案的admin帳號的密碼;
  • -c, --cname: 專案顯示名,可以是中文名,用於介面顯示。此參數可選,若不輸入則專案顯示名同專案名稱;
  • --normal_token: 1.6 新增設定項,專案的 Normal Token。可選參數,若不設置則值為空;
  • --super_token: 1.6 新增設定項,專案的 Super Token。可選參數,若不設置則值為空;
  • --disable_schema_limited 關閉數據強校驗模式 (1.17 版本開始支援)。

例子:

project_tools -m create -n my_project -c 我的專案 -p PasswordTest123
BASH
spadmin project -m create -n my_project -c 我的專案 -p PasswordTest123 --disable_schema_limited
BASH


執行以上命令即可建立名為 my_project ,顯示名為“我的專案”的新專案,登入時使用帳號 admin,密碼 PasswordTest123。

在建立這個帳號之後,就可以使用這個帳號登入相應的專案,然後再在介面上建立帳號和分配權限了。

  • 若當前專案個數已達到許可所限制的專案數最大值,則無法再建立新專案。您可以刪除專案或更換許可後再建立新專案。 

2.3. 更新專案設定

執行以下命令可以更新專案設定:

project_tools -m update -n <專案名稱> [-c <專案顯示名>] [--normal_token <數據匯入 Normal Token>] [--super_token <數據匯入 Super Token>] [--clear_normal_token] [--clear_super_token]
BASH
spadmin project -m update -n <專案名稱> [-c <專案顯示名>] [--normal_token <數據匯入 Normal Token>] [--super_token <數據匯入 Super Token>] [--clear_normal_token] [--clear_super_token] [--disable_schema_limited]
BASH

參數解釋:

  • -n, --name: 要修改設定的專案名;
  • -c, --cname: 設置專案顯示名,可選參數;
  • --normal_token: 1.6 新增設定項,設置專案的 Normal Token,可選參數;
  • --super_token: 1.6 新增設定項,設置專案的 Super Token,可選參數;
  • --clear_normal_token: 1.6 新增設定項,將 Normal Token 設置為空值,可選參數;
  • --clear_super_token: 1.6 新增設定項,將 Super Token 設置為空值,可選參數;
  • --enable_schema_limited 開啟數據強校驗模式 (1.17 版本開始支援)
  • --disable_schema_limited 關閉數據強校驗模式 (1.17 版本開始支援)

例子:

project_tools -m update -n my_project -c 新的專案
BASH
spadmin project -m update -n my_project -c 新的專案 --disable_schema_limited
BASH

2.4. 刪除專案

執行以下命令可以刪除專案:

project_tools -m delete -n <專案名稱>
BASH
spadmin project -m delete -n <專案名稱>
BASH

參數解釋: 

  • -n, --name: 刪除專案的專案名稱;

例子:

project_tools -m delete -n my_project
BASH
spadmin project -m delete -n my_project
BASH
  • 請注意:專案刪除後不可恢復,請謹慎操作!
  • 預設專案 default 不能刪除,但可以重置。關於重置功能請參見 多專案

2.5. 回收已刪除專案的資源

執行以下命令可以回收已刪除專案的資源:

project_tools -m purge
BASH
spadmin project -m purge
BASH
  • 請注意:該操作運作時間較長,請耐心等待!

2.6. 用戶工具(神策分析版本 < 1.14)

使用這個工具可以重置 admin 密碼:

user_tools -username admin -password PASSWORD -project default 
BASH

參數解釋:

  • -username: 指定用戶名(無限制),若指定用戶不存在則建立,權限為管理員;
  • -password: 指定用戶密碼(無限制);
  • -project: 指定專案英文名; 

2.7. 用戶工具(神策分析版本 >= 1.14) 

使用這個工具可以重置 admin 密碼:

spadmin account -u admin -P PASSWORD -p default -r analyst
BASH

參數解釋:

  • -u: 指定用戶名(必須為信箱格式),必選;
  • -P: 指定用戶密碼(必須使用 8 至 30 個字母、數字和符號的組合),必選;
  • -p: 指定專案英文名,必選;
  • -r: 指定角色英文名,修改密碼非必選,建立新用戶必選。預設有 admin(管理員)、analyst(分析師)、guest(普通用戶)三種,如果要指定自定義角色,請聯繫值班同學處理。
  • -g: 指定是否為平台帳號,預設為 false(僅限 1.15)