Query Active Directory authentication settings by calling GetInstanceADAuthServer-Bastionhost-Alibaba Cloud - Bastionhost

Mengkueri pengaturan otentikasi Direktori Aktif (AD) pada bastion host.

Deskripsi operasi

Queries the Active Directory (AD) authentication settings of a bastion host. After you configure AD authentication, you can import AD-authenticated users into the bastion host. The imported users can then log on to the bastion host to perform O&M operations on servers.

Limit

This operation can be called up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered and your business may be affected. Take note of this limit when you call this operation.

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:GetInstanceADAuthServer

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID bastion host. Catatan Anda dapat memanggil operasi DescribeInstances untuk mengkueri ID bastion host.	bastionhost-cn-st220aw****
RegionId	string	No	ID Wilayah bastion host. Catatan Untuk informasi lebih lanjut tentang Pemetaan antara ID wilayah dan nama wilayah, lihat Wilayah dan zona.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50
AD	object	The settings of AD authentication.
Account	string	The distinguished name (DN) of the AD server account.	cn=Manager,dc=test,dc=com
BaseDN	string	The Base DN of the AD server.	dc=test,dc=com
Domain	string	The domain on the AD server.	domain
EmailMapping	string	The field that is used to indicate the email address of a user on the AD server.	emailAttr
Filter	string	The condition that is used to filter users.	(&(objectClass=top))
IsSSL	boolean	Indicates whether SSL is supported. Valid values: true false	true
MobileMapping	string	The field that is used to indicate the mobile phone number of a user on the AD server.	mobileAttr
NameMapping	string	The field that is used to indicate the name of a user on the AD server.	nameAttr
HasPassword	boolean	Indicates whether passwords are required. Valid values: true: false	true
Port	integer	The port that is used to access the AD server.	389
Server	string	The address of the AD server.	192.168.XX.XX
StandbyServer	string	The address of the secondary AD server.	192.168.XX.XX

Contoh

Respons sukses

JSONformat

{
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50",
  "AD": {
    "Account": "cn=Manager,dc=test,dc=com",
    "BaseDN": "dc=test,dc=com",
    "Domain": "domain",
    "EmailMapping": "emailAttr",
    "Filter": "(&(objectClass=top))",
    "IsSSL": true,
    "MobileMapping": "mobileAttr",
    "NameMapping": "nameAttr",
    "HasPassword": true,
    "Port": 389,
    "Server": "192.168.XX.XX",
    "StandbyServer": "192.168.XX.XX"
  }
}

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.