全部產品
Search

搜尋本產品

    Quick BI：CreateUserGroup - 建立使用者組

    文件中心

    Quick BI：CreateUserGroup - 建立使用者組

    更新時間：Dec 24, 2025

    建立使用者組，可以指定父使用者組。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    quickbi-public:CreateUserGroup

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    UserGroupId

    string

    否

    使用者組唯一 ID。

    • 無需傳入，系統會自動產生；當使用者主動傳入 UserGroupId 時，以使用者傳入的 ID 作為使用者組 ID，使用者需要自行保證該 ID 在組織內唯一。

    • 格式校正：最大長度 64，不能為-1，

    pop0001
    UserGroupName

    string

    是

    使用者組名稱。

    • 格式校正：最大長度 255

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

    杭州財報
    UserGroupDescription

    string

    否

    使用者組描述。

    • 格式校正：最大長度 255

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

    使用者分組描述
    ParentUserGroupId

    string

    是

    父使用者組 ID。可以將建立的使用者組添加到該分組下：

    • 當輸入父使用者組 ID 時，建立的使用者組會添加到該 ID 的使用者組下。

    • 當輸入-1 時，建立的使用者組會添加到根目錄下。

    3d2c23d4-2b41-4af8-a1f5-f6390f32****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    36829379-0C38-5BC0-830A-92665BF77D4F
    Result

    string

    返回使用者組添加成功後的 ID。如果添加失敗，返回Null 字元串“”。

    f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
    Success

    boolean

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

    • true：請求成功

    • false：請求失敗

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "36829379-0C38-5BC0-830A-92665BF77D4F",
  "Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Usergroup.Not.Exist The user group does not exist.
    400 Duplicate.Name.Error The name already exists.
    400 UserGroup.Parent.NotFound The parent user group does not exist.
    400 Duplicate.UserGroup.Id Duplicated usergroupId %s.
    400 RootUserGroup.Create.Error organization %s has synchronized with other organizational structures, so user groups cannot be created under the root user group.
    400 UserGroup.Already.Synchronized Organization has synchronized with other organizational structures, so you are not allowed to add users under group.
    400 UserGroup.Layer.Limited The user group cannot have more than ten layers.
    400 UserGroup.ExceedsLimit.Error User group exceed limit, %s.
    400 Duplicate.UserGroupName.Error There is already a user group with the same name %s, please rename it before saving.

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

    變更歷史

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