DescribeInstanceSecurityConfigs - ApsaraDB for OceanBase (Deprecated)

Melakukan pemeriksaan konfigurasi keamanan pada kluster.

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

oceanbase:DescribeInstanceSecurityConfigs

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID kluster OceanBase.	ob317v4uif****
CheckId	string	No	Pengidentifikasi unik pemeriksaan.	xxx

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	EE205C00-30E4-**-**-87E3A8A2AA0C
InstanceSecurityConfigs	object	Hasil yang dikembalikan.
TotalCheckCount	integer	Jumlah total item pemeriksaan keamanan untuk kluster.	5
TotalRiskCount	integer	Jumlah total risiko keamanan yang teridentifikasi untuk kluster.	0
SecurityConfigs	array<object>	Daftar item pemeriksaan.
	object	Hasil yang dikembalikan.
ConfigName	string	The name of the specific check item.	xxx
Risk	boolean	Specifies whether a risk is detected.	true
RiskDescription	string	Security recommendations.	xxx
ConfigGroup	string	The group of the check.	WHITELIST
ConfigDescription	string	The name of the check item.	校验集群白名单范围是否过大
CheckTime	string	Pengatur waktu pemeriksaan.	2023-08-07 15:30:00
InstanceId	string	ID kluster OceanBase.	ob317v4uif****
CheckId	string	Pengidentifikasi unik pemeriksaan.	xxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "InstanceSecurityConfigs": {
    "TotalCheckCount": 5,
    "TotalRiskCount": 0,
    "SecurityConfigs": [
      {
        "ConfigName": "xxx",
        "Risk": true,
        "RiskDescription": "xxx",
        "ConfigGroup": "WHITELIST",
        "ConfigDescription": "校验集群白名单范围是否过大"
      }
    ],
    "CheckTime": "2023-08-07 15:30:00",
    "InstanceId": "ob317v4uif****",
    "CheckId": "xxx"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.