Menggunakan ListUsers untuk menanyakan pengguna - Bastionhost - Alibaba Cloud - Bastionhost

Mengambil daftar pengguna untuk bastion host tertentu.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:ListUsers

get

*Semua Sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans bastion host yang daftar penggunanya ingin Anda kueri. Catatan Anda dapat memanggil operasi DescribeInstances untuk memperoleh parameter ini.	bastionhost-cn-st220aw****
RegionId	string	No	ID wilayah bastion host yang daftar penggunanya ingin Anda kueri. Catatan Untuk pemetaan antara ID wilayah dan nama wilayah, lihat Wilayah dan zona.	cn-hangzhou
PageNumber	string	No	Nomor halaman saat ini dalam kueri berhalaman. Nilai default: 1.	1
PageSize	string	No	Jumlah maksimum entri per halaman dalam kueri berhalaman. Nilai maksimum parameter PageSize adalah 100. Jumlah default entri per halaman adalah 20. Jika PageSize dibiarkan kosong, 20 entri akan dikembalikan secara default. Catatan Jangan biarkan PageSize kosong.	20
UserName	string	No	Nama logon pengguna yang ingin Anda kueri. Hanya pencocokan eksak yang didukung.	abc
DisplayName	string	No	Nama tampilan pengguna yang ingin Anda kueri. Hanya pencocokan eksak yang didukung.	testuser
Source	string	No	Sumber pengguna yang ingin Anda kueri. Nilai valid: Local: pengguna lokal Ram: pengguna Resource Access Management (RAM) AD: pengguna AD LDAP: pengguna LDAP	Local
Mobile	string	No	Nomor telepon seluler pengguna yang ingin Anda kueri. Hanya pencocokan eksak yang didukung.	1359999****
UserState	string	No	Status pengguna yang ingin Anda kueri. Nilai valid: Normal: normal Frozen: terkunci Expired: kedaluwarsa RemoteDeleted: sumber pengguna dihapus Inactive: tidak aktif karena tidak ada logon dalam waktu lama PasswordExpired: kata sandi kedaluwarsa RemoteDNChanged: DN pengguna diperbarui RemoteFrozen: dibekukan di sisi RAM	Normal
SourceUserId	string	No	Identitas unik pengguna yang ingin Anda kueri. Hanya pencocokan eksak yang didukung. Catatan Parameter ini adalah identitas unik pengguna Resource Access Management (RAM) yang sesuai dengan pengguna bastion host. Parameter ini berlaku ketika sumber pengguna yang baru dibuat adalah pengguna RAM (yaitu, Source diatur ke Ram). Anda dapat memanggil operasi ListUsers dari kontrol akses dan memperoleh parameter ini dari bidang UserId dalam tanggapan.	122748924538****
UserGroupId	string	No	ID kelompok pengguna yang ingin Anda kueri. Catatan Anda dapat memanggil operasi ListUserGroups untuk memperoleh parameter ini.	1

Saat Anda memanggil operasi ini, Anda harus menyertakan parameter permintaan umum API Alibaba Cloud selain parameter permintaan yang dijelaskan dalam topik ini. Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Parameter umum. Untuk format permintaan operasi ini, lihat contoh permintaan dalam topik ini.

Elemen respons

Element	Type	Description	Example
	object	Data tanggapan.
TotalCount	integer	Jumlah total pengguna yang dikembalikan.	1
RequestId	string	ID permintaan.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Users	array<object>	Daftar pengguna yang dikembalikan.
	object
DisplayName	string	Nama tampilan pengguna.	Bob
Email	string	Alamat email pengguna.	1099**@qq.com
Comment	string	Keterangan pengguna.	comment
MobileCountryCode	string	Kode negara nomor telepon seluler pengguna. Nilai valid: CN: Tiongkok daratan (+86) HK: Hong Kong (Tiongkok) (+852) MO: Makau (Tiongkok) (+853) TW: Taiwan (Tiongkok) (+886) RU: Rusia (+7) SG: Singapura (+65) MY: Malaysia (+60) ID: Indonesia (+62) DE: Jerman (+49) AU: Australia (+61) US: Amerika Serikat (+1) AE: Dubai (+971) JP: Jepang (+81) GB: Inggris Raya (+44) IN: India (+91) KR: Korea Selatan (+82) PH: Filipina (+63) CH: Swiss (+41) SE: Swedia (+46)	CN
Mobile	string	Nomor telepon seluler pengguna.	1359999****
UserId	string	ID pengguna.	1
Source	string	Sumber pengguna. Nilai valid: Local: pengguna lokal Ram: pengguna Resource Access Management (RAM) AD: pengguna AD LDAP: pengguna LDAP	Local
UserName	string	Nama logon pengguna.	abc_def
SourceUserId	string	Identitas unik pengguna. Catatan Parameter ini adalah identitas unik pengguna Resource Access Management (RAM) yang sesuai dengan pengguna bastion host. Parameter ini dikembalikan ketika sumber pengguna adalah pengguna RAM (yaitu, Source diatur ke Ram). Jika sumber pengguna adalah pengguna lokal (yaitu, Source diatur ke Local), parameter ini kosong.	122748924538****
UserState	array	Array status pengguna.
	string	Status pengguna. Nilai valid: Normal: normal Frozen: terkunci Expired: kedaluwarsa	["Normal"]
EffectiveStartTime	integer	Waktu mulai pengatur waktu periode validitas pengguna, dalam detik (format stempel waktu UNIX).	1669630029
EffectiveEndTime	integer	Waktu akhir pengatur waktu periode validitas pengguna, dalam detik (format stempel waktu UNIX).	1672502400
NeedResetPassword	boolean	Apakah kata sandi harus diatur ulang saat logon berikutnya. Nilai valid: true: Kata sandi harus diatur ulang. false: Kata sandi tidak perlu diatur ulang.	true
TwoFactorStatus	string	Status otentikasi dua faktor pengguna. Nilai valid: Global: mengikuti pengaturan global Disable: otentikasi dua faktor dinonaktifkan Enable: otentikasi dua faktor diaktifkan, mengikuti pengaturan pengguna individu	Enable
TwoFactorMethods	array	Array metode otentikasi dua faktor yang diaktifkan.
	string	Array metode otentikasi dua faktor yang diaktifkan. Maksimal satu metode yang didukung. Nilai valid: sms: SMS email: email dingtalk: DingTalk totp: token OTP gmusbkey: kunci USB kriptografi Tiongkok	[ "sms" ]
LanguageStatus	string	Pengaturan bahasa untuk notifikasi paket. Nilai valid: Global: mengikuti pengaturan global Custom: kustom	Custom
Language	string	Bahasa untuk notifikasi paket. Parameter ini diperlukan ketika LanguageStatus diatur ke Custom. Nilai valid: zh-cn: Bahasa Tionghoa Sederhana en: Bahasa Inggris	en

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Users": [
    {
      "DisplayName": "Bob",
      "Email": "1099**@qq.com",
      "Comment": "comment",
      "MobileCountryCode": "CN",
      "Mobile": "1359999****",
      "UserId": "1",
      "Source": "Local",
      "UserName": "abc_def",
      "SourceUserId": "122748924538****",
      "UserState": [
        "[\"Normal\"]"
      ],
      "EffectiveStartTime": 1669630029,
      "EffectiveEndTime": 1672502400,
      "NeedResetPassword": true,
      "TwoFactorStatus": "Enable",
      "TwoFactorMethods": [
        "[\n      \"sms\"\n]"
      ],
      "LanguageStatus": "Custom",
      "Language": "en"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.
500	InternalError	An unknown error occurred.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.