Referensi API DescribeDBInstanceSSL untuk pengaturan SSL MongoDB - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Deskripsi operasi

To use this operation, the instance must meet the following requirements:

The instance status is Running.
The instance is a replica set instance or a sharded cluster instance.
- The replica set instance must be version 3.4 or later.
- The sharded cluster instance must use Enhanced SSDs (ESSDs).

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

dds:DescribeDBInstanceSSL

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans.	dds-bpxxxxxxxx

Elemen respons

Element	Type	Description	Example
	object
SSLExpiredTime	string	The expiration time of the SSL certificate. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2020-03-11T02:28:25Z
SSLStatus	string	The status of the SSL feature. Open: The SSL feature is enabled. Closed: The SSL feature is disabled.	Open
RequestId	string	The request ID.	36BB1BC2-789C-4BBA-A519-C5B388E4B0D4
CertCommonName	string	The name of the SSL certificate.	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
ForceEncryption	string	Specifies whether connections must be encrypted using SSL. Valid values: 1: Connections must be encrypted using SSL. 0: Connections do not need to be encrypted using SSL. Valid values: 0 : 0 1 : 1	0

Contoh

Respons sukses

JSONformat

{
  "SSLExpiredTime": "2020-03-11T02:28:25Z",
  "SSLStatus": "Open",
  "RequestId": "36BB1BC2-789C-4BBA-A519-C5B388E4B0D4",
  "CertCommonName": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
  "ForceEncryption": "0"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.