Referensi API ListUsers untuk Manajemen User DMS - Data Management

Mengambil detail pengguna.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
Tid	integer	No	ID tenant. Anda dapat memanggil operasi GetUserActiveTenant untuk mendapatkan ID tenant.	3***
Role	string	No	Peran yang diberikan kepada pengguna. Nilai yang valid: USER: pengguna biasa. DBA: database administrator (DBA). ADMIN: administrator Data Management (DMS). SECURITY_ADMIN: administrator keamanan. STRUCT_READ_ONLY: pengguna read-only skema. Catatan Untuk memeriksa peran Anda, arahkan pointer ke gambar profil di pojok kanan atas Konsol DMS.	DBA
UserState	string	No	Status pengguna. Nilai yang valid: NORMAL: Pengguna dalam kondisi normal. DISABLE: Pengguna dinonaktifkan. DELETE: Pengguna telah dihapus.	NORMAL
SearchKey	string	No	Kata kunci pencarian. Pencocokan fuzzy didukung.	test
PageNumber	integer	No	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 10, 20, 50, dan 100.** Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object
TotalCount	integer	Jumlah total entri yang dikembalikan.	3
RequestId	string	ID permintaan.	69161997-6030-53BA-A333-DBEC83B732FF
ErrorCode	string	Kode kesalahan yang dikembalikan jika permintaan gagal.	InvalidTid
ErrorMessage	string	Pesan kesalahan yang dikembalikan jika permintaan gagal.	Specified parameter Tid is not valid.
UserList	object
User	array<object>	Detail pengguna.
	array<object>	Detail pengguna.
State	string	Status pengguna. Nilai yang valid: NORMAL: Pengguna dalam kondisi normal. DISABLE: Pengguna dinonaktifkan. DELETE: Pengguna telah dihapus.	NORMAL
CurResultCount	integer	Jumlah baris yang ditanyakan pada hari ini.	0
UserId	string	ID pengguna.	8****
LastLoginTime	string	Waktu terakhir pengguna masuk ke konsol.	2021-11-08 13:43:43
MaxResultCount	integer	Jumlah maksimum baris yang dapat ditanyakan pada hari ini.	50000
ParentUid	string	ID Akun Alibaba Cloud pengguna.	140692647406****
RoleIdList	object
RoleIds	array	ID peran.
	integer	ID peran yang diberikan kepada pengguna. Nilai yang valid: 1: peran pengguna biasa. 2: peran DBA. 3: peran administrator DMS. 4: peran administrator keamanan. 6: peran pengguna read-only skema.	3
RoleNameList	object
RoleNames	array	Nama peran.
	string	Nama peran yang diberikan kepada pengguna. Nilai yang valid: USER: pengguna biasa. DBA: DBA. ADMIN: administrator DMS. SECURITY_ADMIN: administrator keamanan. STRUCT_READ_ONLY: pengguna read-only skema.	ADMIN
NickName	string	Nama panggilan pengguna.	test_NickName
MaxExecuteCount	integer	Jumlah maksimum kueri yang dapat dilakukan pada hari ini.	2000
CurExecuteCount	integer	Jumlah kueri yang telah dilakukan pada hari ini.	0
Mobile	string	Nomor telepon seluler pengguna. Catatan Sistem mengembalikan parameter ini jika Anda telah menyetel nomor telepon seluler di konsol. Untuk menyetel nomor telepon seluler di konsol, arahkan pointer ke gambar profil di pojok kanan atas dan klik ikon Edit di samping Notice. Sistem tidak mengembalikan parameter ini jika Anda belum menyetel nomor telepon seluler.	1389999****
Uid	string	ID Akun Alibaba Cloud.	167382665015****
Email	string	Alamat email yang digunakan untuk menerima notifikasi. Catatan Sistem mengembalikan parameter ini jika Anda telah menyetel alamat email di konsol. Untuk menyetel alamat email di konsol, arahkan pointer ke gambar profil di pojok kanan atas dan klik ikon Edit di samping Notice. Sistem tidak mengembalikan parameter ini jika Anda belum menyetel alamat email.	username@example.com
DingRobot	string	URL chatbot DingTalk yang digunakan untuk menerima notifikasi. Catatan Sistem mengembalikan parameter ini jika Anda telah menyetel URL chatbot DingTalk di konsol. Untuk menyetel URL chatbot DingTalk di konsol, arahkan pointer ke gambar profil di pojok kanan atas dan klik ikon Edit di samping Notice. Sistem tidak mengembalikan parameter ini jika Anda belum menyetel URL chatbot DingTalk.	https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef
Webhook	string	URL webhook yang digunakan untuk menerima notifikasi. Catatan Jika Anda telah menyetel URL webhook, DMS mengirimkan notifikasi ke URL yang ditentukan. Sistem tidak mengembalikan parameter ini jika Anda belum menyetel URL webhook.	http://dms-XXX.aliyun.com:8***
SignatureMethod	string	Metode signature yang digunakan untuk mengamankan koneksi saat menggunakan URL webhook. Nilai yang valid: NONE: tanpa signature. HMAC_SHA1: HMAC_SHA1.	HMAC_SHA1
NotificationMode	string	Metode notifikasi. Sistem mengembalikan satu atau beberapa nilai. Nilai yang valid: SMS: pesan teks EMAIL: email. DINGDING: DingTalk. DINGROBOT: chatbot DingTalk. WEBHOOK: webhook.	DINGROBOT
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "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
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.