Query parameters of specified nodes via DescribeDBNodesParameters-PolarDB-Alibaba Cloud - PolarDB

Mengkueri parameter untuk node tertentu dalam 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

polardb:DescribeDBNodesParameters

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID Kluster.	pc-****************
DBNodeIds	string	Yes	ID node. Anda dapat menentukan beberapa ID node. Pisahkan ID dengan tanda koma (,).	pi-**************,pi-**************

Elemen respons

Element	Type	Description	Example
	object
DBVersion	string	The version of the MySQL database. Valid values: 5.6 5.7 8.0	5.6
RequestId	string	The ID of the request.	9B7BFB11-C077-4FE3-B051-F69CEB******
DBType	string	The type of the database. The value is fixed as MySQL.	MySQL
Engine	string	The database engine of the cluster.	POLARDB
DBNodeIds	array<object>	The list of node IDs.
	array<object>
DBNodeId	string	The ID of the node.	pi-bp1r4qe3s534*****
RunningParameters	array<object>	The list of parameters that are running on the node.
	object
CheckingCode	string	The valid values of the parameter.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	The data type of the parameter value. Valid values: INT STRING B	INT
DefaultParameterValue	string	The default value of the parameter.	utf8
ForceRestart	boolean	Indicates whether a cluster restart is required to allow the parameter modification to take effect. Valid values: false true	true
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false true	true
ParameterDescription	string	The description of the parameter.	The server's default character set.
ParameterName	string	The name of the parameter.	character_set_server
ParameterStatus	string	The status of the parameter. Valid values: normal modifying	normal
ParameterValue	string	The value of the parameter.	utf8
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: yes. The modified parameter value is synchronized to other nodes. 1: no. You can customize the nodes to which the modified parameter value can be synchronized to.	1
ParamRelyRule	string	The dependencies of the parameter.	utf8
Factor	string	A divisor of the parameter. For a parameter of the integer or byte type, the valid values must be a multiple of Factor unless you set Factor to 0.	20

Contoh

Respons sukses

JSONformat

{
  "DBVersion": "5.6",
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBNodeIds": [
    {
      "DBNodeId": "pi-bp1r4qe3s534*****",
      "RunningParameters": [
        {
          "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
          "DataType": "INT",
          "DefaultParameterValue": "utf8",
          "ForceRestart": true,
          "IsModifiable": true,
          "ParameterDescription": "The server's default character set.",
          "ParameterName": "character_set_server",
          "ParameterStatus": "normal",
          "ParameterValue": "utf8",
          "IsNodeAvailable": "1",
          "ParamRelyRule": "utf8",
          "Factor": "20"
        }
      ]
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.
400	InvalidDBType.Malformed	The Specified DBType is not valid.
404	InvalidDBCluster.NotFound	The specified DBClusterId is not found.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.