全部產品
Search

搜尋本產品

    Quick BI：AddUser

    文件中心

    Quick BI：AddUser

    更新時間：Sep 09, 2026

    新增組織成員。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    quickbi-public:AddUser

    create

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AdminUser deprecated

    boolean

    否

    是否賦予組織管理員角色。取值範圍：

    • true：是

    • false：否

    重要 參數已過期不推薦使用，當傳入 RoleIds 時該參數無效。

    true
    AuthAdminUser deprecated

    boolean

    否

    是否賦予組織權限管理員角色。取值範圍：

    • true：是

    • false：否

    重要 參數已過期不推薦使用，當傳入 RoleIds 時該參數無效。

    true
    UserType

    integer

    是

    組織成員的使用者類型。取值範圍：

    • 1 ：開發者

    • 2 ：訪客

    • 3 ：分析師

    枚舉值：

    • 1 :

      開發者。

    • 2 :

      訪客。

    • 3 :

      分析師。

    1
    AccountId

    string

    否

    阿里雲帳號 ID。

    警告 Quick BI 於 2024 年 12 月 31 日之後發布的版本，AccountId 將作為必填參數，請在此之前，對您的 API 進行改造。

    191476xxxxx23754
    AccountName deprecated

    string

    否

    阿里雲帳號名稱。

    • 說明：如果是子帳號，格式為「主帳號：子帳號」。例如：master_test@aliyun.com:subaccount

    • 格式檢查：最大長度 50 個字元。

    xxxxxx@163.com
    NickName

    string

    是

    阿里雲帳號暱稱。

    • 格式檢查：最大長度 50 個字元。

    • 特殊格式校驗：中英文數字 _ \ / | () ] [

    張三
    RoleIds

    string

    否

    使用者綁定的預設或自訂組織角色 ID，用英文逗號「,」分隔，最多 3 個。取值範圍：

    • 組織管理員（預設角色）：111111111

    • 權限管理員（預設角色）：111111112

    • 普通使用者（預設角色）：111111113

    111111111,456
    CopilotModules

    string

    否

    使用者的智慧化模組配額，當啟用多個模組時，以英文逗號分隔。

    • qreport -- 小 Q 報告

    • qExploreNum -- 小 Q 探索版

    • smartQAskNum -- 小 Q 問數

    • smartQDevNum -- 小 Q 搭建

    qreport,qExploreNum

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    傳回新增阿里雲使用者的詳細資訊。

    AccountName

    string

    阿里雲帳戶。

    xxxxxx@163.com
    AdminUser

    boolean

    是否綁定了組織管理員角色。取值範圍：

    • true：是

    • false：否

    重要 參數已過期不推薦使用，當傳入 RoleIdList 時該參數無效

    true
    AuthAdminUser

    boolean

    是否綁定了權限管理員角色。取值範圍：

    • true：是

    • false：否

    重要 參數已過期不推薦使用，當傳入 RoleIdList 時該參數無效

    true
    NickName

    string

    阿里雲帳號暱稱。

    張三
    RoleIdList

    array

    使用者綁定的組織角色 ID 清單。

    integer

    組織角色 ID，最多 3 個，包括但不限於組織預設角色：

    • 組織管理員（預設角色）：111111111

    • 權限管理員（預設角色）：111111112

    • 普通使用者（預設角色）：111111113

    111111111
    CopilotModules

    array

    所擁有配額的智慧化模組。

    string

    所擁有配額的智慧化模組。

    qreport
    UserId

    string

    Quick BI 中的 UserID。

    b5d8fd9348cc4327****afb604
    UserType

    integer

    組織成員的使用者類型。取值範圍：

    • 1 ：開發者

    • 2 ：訪客

    • 3 ：分析師

    1
    Success

    boolean

    是否請求成功。取值範圍：

    • true：請求成功

    • false：請求失敗

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccountName": "xxxxxx@163.com",
    "AdminUser": true,
    "AuthAdminUser": true,
    "NickName": "张三",
    "RoleIdList": [
      111111111
    ],
    "CopilotModules": [
      "qreport"
    ],
    "UserId": "b5d8fd9348cc4327****afb604",
    "UserType": 1
  },
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Organization.Developers.ReachedTheUpperLimit The developers of the organization have reached the upper limit:%s 組織開發人員已達到上限 %s 人，請聯絡組織管理員升級開發人員數量。
    400 Organization.Viewers.ReachedTheUpperLimit The visitors of the organization have reached the upper limit:%s. 組織存取者已達到上限 %s 人，請聯絡組織管理員升級存取者數量。
    400 Organization.Analysts.ReachedTheUpperLimit The analysts of the organization have reached the upper limit:%s. 組織分析師已達到上限 %s 人，請聯絡組織管理員升級分析師數量。
    400 NickName.AlreadyIn.Organization The alias already exists. 暱稱已存在。
    400 User.AlreadyIn.Organization This user is already a member of the current organization. 該使用者已在其他組織中。
    400 Instance.Over.MaxLicense You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.
    400 AnalystUser.NotSupport.AdminOrDevRole Analyst users do not support granting workspace administrator or developer roles.
    400 Workspace.Not.Exist The group workspace does not exist. 群組空間不存在。
    400 Workspace.Type.Error The type of group workspace is invalid. 無效的群組空間類型。
    400 Viewer.AddInTo.Workspace Organization members with viewer type are not allowed to add to workspace: %s. 不允許將組織的訪客類型使用者新增至工作空間：%s。
    400 User.AlreadyIn.Workspace This user already exists. 該使用者已在群組空間中。
    400 User.AlreadyIn.Role The user is already assigned this role. 使用者已經擁有該角色。
    400 User.OrganizationRole.NotExist User %s must have role in organization. 使用者 %s 在組織中必須擁有一個角色。
    400 Viewer.CannotHave.CustomRole Organization viewer cannot have custom roles. 組織訪客不能具有自訂角色。
    400 UserAnalyst.NotSupport.ThisRole This role has permissions that analysts cannot grant. 該角色具有分析師無法授予的權限。
    400 RoleCount.ExceedsLimit.Error The user role cannot exceed three. 使用者角色不能超過三個。
    400 BindRole.NotExist.Error Bind role not exist, %s. 綁定的角色不存在，%s。
    400 DirtyData.Duplicate.User Dirty data,duplicate user: %s. 髒資料，重複的使用者：%s。
    400 Robot.Module.Exhausted The Quota of %s module has been exhausted. %s 模組的配額已耗盡。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。