Referensi API DescribeApplicationParameters & Skema Parameter - PolarDB - Alibaba Cloud - PolarDB

Mengambil parameter saat ini dan informasi template untuk aplikasi yang ditentukan beserta komponennya.

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

polardb:DescribeApplicationParameters

get

*全部资源

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	ID aplikasi.	pa-**************
ComponentIdList	array	No	Daftar ID subkomponen. Jika Anda menentukan parameter ini, operasi hanya mengembalikan parameter dan template parameter untuk komponen-komponen tersebut.
	string	No	The subcomponent ID.	pac-**************

Elemen respons

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
Parameters	object	The parameter details.
ComponentParameters	array<object>	A list of subcomponents that contain lists of parameter details.
	array<object>	A subcomponent that contains a list of parameter details.
ComponentType	string	The type of the component.	supabase
Parameters	array<object>	A list of parameter details.
	object	The parameter details.
Status	string	The status.	Applied
ReadOnly	boolean	Indicates whether the parameter is read-only.	false
Pattern	string	The regular expression for the parameter.	^[a-zA-Z0-9]{1,20}$
Type	string	The parameter type.	string
Description	string	The parameter description.	The name of the parameter
Value	string	The current value of the parameter.	value
NeedRestart	boolean	Indicates whether the application must be restarted for the parameter modification to take effect.	false
Default	string	The default value of the parameter.	default value
Name	string	The parameter name.	name
ComponentId	string	The component ID or the application ID.	pac-**************
ParameterTemplates	object	The details of the parameter template.
ComponentParameterTemplates	array<object>	A list of subcomponents that contain lists of parameter template details.
	array<object>
ComponentType	string	The type of the component.	supabase
Parameters	array<object>	A list of parameter template details.
	object	The parameter template details.
Pattern	string	The regular expression for the parameter.	^[a-zA-Z0-9]{1,20}$
Type	string	The parameter type.	string
Description	string	The parameter description.	The name of the parameter
ReadOnly	boolean	Indicates whether the parameter is read-only.	false
Default	string	The default value of the parameter.	default
Name	string	The parameter name.	name
NeedRestart	boolean	Indicates whether the application must be restarted for the parameter modification to take effect.	false
ComponentId	string	The component ID or the application ID.	pac-**************

Contoh

Respons sukses

JSONformat

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "Parameters": {
    "ComponentParameters": [
      {
        "ComponentType": "supabase",
        "Parameters": [
          {
            "Status": "Applied",
            "ReadOnly": false,
            "Pattern": "^[a-zA-Z0-9]{1,20}$",
            "Type": "string",
            "Description": "The name of the parameter",
            "Value": "value",
            "NeedRestart": false,
            "Default": "default value",
            "Name": "name"
          }
        ],
        "ComponentId": "pac-**************"
      }
    ]
  },
  "ParameterTemplates": {
    "ComponentParameterTemplates": [
      {
        "ComponentType": "supabase",
        "Parameters": [
          {
            "Pattern": "^[a-zA-Z0-9]{1,20}$",
            "Type": "string",
            "Description": "The name of the parameter",
            "ReadOnly": false,
            "Default": "default",
            "Name": "name",
            "NeedRestart": false
          }
        ],
        "ComponentId": "pac-**************"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.