DescribeParameters - ApsaraDB for OceanBase (Deprecated)

Mengkueri daftar informasi parameter.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID Kluster OceanBase.	ob317v4uif****
Dimension	string	Yes	Tipe parameter. Nilai valid: CLUSTER dan TENANT.	TENANT
DimensionValue	string	No	Pengidentifikasi Sumber Daya tipe parameter. Anda dapat mengosongkan parameter ini untuk parameter kluster. Untuk parameter penyewa, tentukan TenantId penyewa.	ob2mr3oae0****

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Parameters	array<object>	Daftar parameter.
	object	Parameter tanggapan.
Description	string	Deskripsi parameter.	弱读允许的最大时间延迟时间
ValueType	string	Tipe nilai parameter. Nilai valid: ENUM: Enumerasi numerik. RANGE: Rentang numerik. TIME: Pengatur waktu. STRING: String. ENUM_MULTIPLE: Enumerasi numerik dengan beberapa pilihan. CAPACITY: Nilai kapasitas penyimpanan (K, M, G).	CAPACITY
CurrentValue	string	Nilai parameter saat ini.	600
NeedReboot	boolean	Apakah restart diperlukan setelah memodifikasi parameter ini. Nilai valid: true: Restart diperlukan. false: Restart tidak diperlukan.	false
Name	string	Nama parameter.	connect_timeout
DefaultValue	string	Nilai default parameter.	600s
RejectedValue	array	Rentang nilai yang ditolak untuk parameter. Formatnya adalah array dengan dua elemen string yang merepresentasikan rentang. Elemen pertama adalah nilai minimum, dan elemen kedua adalah nilai maksimum.
	string	Rentang nilai yang ditolak untuk parameter.	1s
AcceptableValue	array	Rentang nilai yang dapat diterima untuk parameter.
	string	Rentang nilai yang dapat diterima untuk parameter.	2s
Readonly	boolean	Apakah parameter bersifat read-only.	false
Unit	string	Unit nilai parameter saat ini.	s

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Parameters": [
    {
      "Description": "弱读允许的最大时间延迟时间",
      "ValueType": "CAPACITY",
      "CurrentValue": "600",
      "NeedReboot": false,
      "Name": "connect_timeout",
      "DefaultValue": "600s",
      "RejectedValue": [
        "1s"
      ],
      "AcceptableValue": [
        "2s"
      ],
      "Readonly": false,
      "Unit": "s"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.