すべてのプロダクト
Search

このプロダクト

    Data Management:ListUsers

    ドキュメントセンター

    Data Management:ListUsers

    最終更新日: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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:ListUsers

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID。 GetUserActiveTenant 操作を呼び出して、テナント ID を取得できます。

    3***
    Role

    string

    任意

    ユーザーに割り当てられているロール。 有効値：

    • USER：一般ユーザー。

    • DBA：データベース管理者 (DBA)。

    • ADMIN：Data Management (DMS) 管理者。

    • SECURITY_ADMIN：セキュリティ管理者。

    • STRUCT_READ_ONLY：スキーマ読み取り専用ユーザー。

    説明

    ロールを確認するには、DMS コンソールの右上隅にあるプロフィール画像にポインターを合わせます。

    DBA
    UserState

    string

    任意

    ユーザーのステータス。 有効値：

    • NORMAL：ユーザーは通常の状態です。

    • DISABLE：ユーザーは無効化されています。

    • DELETE：ユーザーは削除されています。

    NORMAL
    SearchKey

    string

    任意

    検索キーワード。 あいまい一致がサポートされています。

    test
    PageNumber

    integer

    任意

    返すページ番号。

    1
    PageSize

    integer

    任意

    各ページに返す件数です。有効な値は 10、20、50、100 で、デフォルト値は 10 です。

    **

    有効な値: 10、20、50、および 100。**** デフォルト値: 10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    返されたエントリの総数。

    3
    RequestId

    string

    リクエストの ID。

    69161997-6030-53BA-A333-DBEC83B732FF
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコード。

    InvalidTid
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージ。

    Specified parameter Tid is not valid.
    UserList

    object

    User

    array<object>

    ユーザーの詳細。

    array<object>

    ユーザーの詳細。

    State

    string

    ユーザーのステータス。 有効値：

    • NORMAL：ユーザーは通常の状態です。

    • DISABLE：ユーザーは無効化されています。

    • DELETE：ユーザーは削除されています。

    NORMAL
    CurResultCount

    integer

    当日にクエリされた行数。

    0
    UserId

    string

    ユーザーの ID。

    8****
    LastLoginTime

    string

    ユーザーが最後にコンソールにログインした時間。

    2021-11-08 13:43:43
    MaxResultCount

    integer

    当日にクエリできる最大行数。

    50000
    ParentUid

    string

    ユーザーの Alibaba Cloud アカウントの ID。

    140692647406****
    RoleIdList

    object

    RoleIds

    array

    ロールの ID。

    integer

    ユーザーに割り当てられているロールの ID。 有効値：

    • 1：一般ユーザーロール。

    • 2：DBA ロール。

    • 3：DMS 管理者ロール。

    • 4：セキュリティ管理者ロール。

    • 6：スキーマ読み取り専用ユーザーロール。

    3
    RoleNameList

    object

    RoleNames

    array

    ロールの名前。

    string

    ユーザーに割り当てられているロールの名前。 有効値：

    • USER：一般ユーザー。

    • DBA：DBA。

    • ADMIN：DMS 管理者。

    • SECURITY_ADMIN：セキュリティ管理者。

    • STRUCT_READ_ONLY：スキーマ読み取り専用ユーザー。

    ADMIN
    NickName

    string

    ユーザーのニックネーム。

    test_NickName
    MaxExecuteCount

    integer

    当日に実行できるクエリの最大数。

    2000
    CurExecuteCount

    integer

    当日に実行されたクエリの数。

    0
    Mobile

    string

    ユーザーの携帯電話番号。

    説明

    • コンソールで携帯電話番号を設定している場合、システムはこのパラメーターを返します。 コンソールで携帯電話番号を設定するには、右上隅のプロフィール画像にポインターを合わせ、[通知] の横にある編集アイコンをクリックします。

    • 携帯電話番号を設定していない場合、システムはこのパラメーターを返しません。

    1389999****
    Uid

    string

    Alibaba Cloud アカウントの ID。

    167382665015****
    Email

    string

    通知の受信に使用されるメールアドレス。

    説明

    • コンソールでメールアドレスを設定している場合、システムはこのパラメーターを返します。 コンソールでメールアドレスを設定するには、右上隅のプロフィール画像にポインターを合わせ、[通知] の横にある編集アイコンをクリックします。

    • メールアドレスを設定していない場合、システムはこのパラメーターを返しません。

    username@example.com
    DingRobot

    string

    通知の受信に使用される DingTalk チャットボット URL。

    説明

    • コンソールで DingTalk チャットボット URL を設定している場合、システムはこのパラメーターを返します。 コンソールで DingTalk チャットボット URL を設定するには、右上隅のプロフィール画像にポインターを合わせ、[通知] の横にある編集アイコンをクリックします。

    • DingTalk チャットボット URL を設定していない場合、システムはこのパラメーターを返しません。

    https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef
    Webhook

    string

    通知の受信に使用される Webhook URL。

    説明

    • Webhook URL を設定している場合、DMS は指定された URL に通知を送信します。

    • Webhook URL を設定していない場合、システムはこのパラメーターを返しません。

    http://dms-XXX.aliyun.com:8***
    SignatureMethod

    string

    Webhook URL を使用する際に接続を保護するために使用される署名メソッド。 有効値：

    • NONE：署名なし。

    • HMAC_SHA1：HMAC_SHA1。

    HMAC_SHA1
    NotificationMode

    string

    通知方法。 システムは 1 つ以上の値を返します。 有効値：

    • SMS：ショートメッセージ

    • EMAIL：メール。

    • DINGDING：DingTalk。

    • DINGROBOT：DingTalk チャットボット。

    • WEBHOOK：Webhook。

    DINGROBOT
    Success

    boolean

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

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

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

    true

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 3,
  "RequestId": "69161997-6030-53BA-A333-DBEC83B732FF",
  "ErrorCode": "InvalidTid",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "UserList": {
    "User": [
      {
        "State": "NORMAL",
        "CurResultCount": 0,
        "UserId": "8****",
        "LastLoginTime": "2021-11-08 13:43:43",
        "MaxResultCount": 50000,
        "ParentUid": "140692647406****",
        "RoleIdList": {
          "RoleIds": [
            3
          ]
        },
        "RoleNameList": {
          "RoleNames": [
            "ADMIN"
          ]
        },
        "NickName": "test_NickName",
        "MaxExecuteCount": 2000,
        "CurExecuteCount": 0,
        "Mobile": "1389999****",
        "Uid": "167382665015****",
        "Email": "username@example.com",
        "DingRobot": "https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef",
        "Webhook": "http://dms-XXX.aliyun.com:8***",
        "SignatureMethod": "HMAC_SHA1",
        "NotificationMode": "DINGROBOT"
      }
    ]
  },
  "Success": true
}

    エラーコード

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

    変更履歴

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