すべてのプロダクト
Search

このプロダクト

    DataWorks:DsgUserGroupQueryUserList

    ドキュメントセンター

    DataWorks:DsgUserGroupQueryUserList

    最終更新日:Mar 21, 2026

    現在のテナントのユーザーまたはロールのリストを照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:DsgUserGroupQueryUserList

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    Success

    boolean

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

    • true

    • false

    true
    ErrorCode

    string

    エラーコード。

    1029030003
    ErrorMessage

    string

    エラーメッセージ。

    param error
    HttpStatusCode

    integer

    HTTP ステータスコード。

    400
    Data

    array<object>

    返された結果。

    object

    AccountName

    string

    ユーザーの名前。

    user1
    YunAccount

    string

    Alibaba Cloud アカウントまたは RAM ロールの名前。ユーザーグループを Alibaba Cloud アカウントまたは RAM ロールで作成した場合は、このパラメーターの戻り値を使用する必要があります。

    user:user1
    AccountType

    integer

    ユーザーのタイプ。有効な値：

    • 1～5：Alibaba Cloud アカウント

    • 6：RAM ロール

    2
    BaseId

    string

    ユーザー ID またはロール ID。

    234
    ParentAccountId

    string

    親ユーザー ID。RAM ユーザーを使用する場合、このパラメーターは必須です。

    123
    RequestId

    string

    リクエスト ID。

    102400001

    例

    成功レスポンス

    JSONJSON

    {
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "AccountName": "user1",
      "YunAccount": "user:user1",
      "AccountType": 2,
      "BaseId": "234",
      "ParentAccountId": "123"
    }
  ],
  "RequestId": "102400001"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 USERGROUP.ACCOUNTLISTSIZE.ERROR The number of account exceeds the limit.
    400 USERGROUP.ID.ERROR The user group ID does not match the tenant or does not exist.
    400 USERGROUP.LISTSIZE.ERROR The number of user groups exceeds the limit.
    400 USERGROUP.PAGESIZE.ERROR Page size is too large, maximum of 100.
    400 USERACCOUNT.OWNER.ERROR User list or owner user does not exist.
    400 PARAMS.ERROR param error.
    500 UNKNOWN.ERROR unknown error.
    403 PERMISSION.DENIED.ERROR Permission denied

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

    変更履歴

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