すべてのプロダクト
Search

このプロダクト

    :CreateUserGroup

    ドキュメントセンター

    :CreateUserGroup

    最終更新日:Dec 24, 2025

    ユーザーグループを作成します。親ユーザーグループを指定できます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    quickbi-public:CreateUserGroup

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    UserGroupId

    string

    任意

    ユーザーグループの一意の ID。

    • UserGroupId パラメーターを指定しない場合、システムによって UserGroupId が自動的に生成されます。UserGroupId パラメーターを指定する場合、指定したユーザー ID がユーザーグループ ID として使用されます。ユーザー ID が組織内で一意であることを確認する必要があります。

    • フォーマット検証：最大長 64、-1 は使用できません。

    pop0001
    UserGroupName

    string

    必須

    RAM ユーザーグループの名前。

    • フォーマット検証：最大長 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 が返されます。追加に失敗した場合は、空の文字列 '' が返されます。

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

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。