DescribeDBNodesParameters による指定ノードのパラメータクエリ - PolarDB

クラスター内の指定されたノードのパラメーターを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeDBNodesParameters

get

*DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-****************
DBNodeIds	string	必須	ノードの ID。複数のノード ID を指定できます。ID はカンマ (,) で区切ります。	pi-**************,pi-**************

レスポンスフィールド

フィールド	型	説明	例
	object
DBVersion	string	MySQL データベースのバージョン。有効な値： 5.6 5.7 8.0	5.6
RequestId	string	リクエスト ID。	9B7BFB11-C077-4FE3-B051-F69CEB******
DBType	string	データベースのタイプ。値は MySQL に固定されています。	MySQL
Engine	string	クラスターのデータベースエンジン。	POLARDB
DBNodeIds	array<object>	ノード ID のリスト。
	array<object>
DBNodeId	string	ノードの ID。	pi-bp1r4qe3s534*****
RunningParameters	array<object>	ノードで実行されているパラメーターのリスト。
	object
CheckingCode	string	パラメーターの有効な値。	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	パラメーターのデータの型。有効な値： INT：整数 STRING：文字列 B：バイト	INT
DefaultParameterValue	string	パラメーターのデフォルト値。	utf8
ForceRestart	boolean	パラメーターの変更を有効にするために再起動が必要かどうかを示します。有効な値： false：いいえ true：はい	true
IsModifiable	boolean	パラメーターを変更できるかどうかを示します。有効な値： false：いいえ true：はい	true
ParameterDescription	string	パラメーターの説明。	The server's default character set.
ParameterName	string	パラメーターの名前。	character_set_server
ParameterStatus	string	パラメーターのステータス。有効な値： normal：通常 modifying：変更中	normal
ParameterValue	string	パラメーターの値。	utf8
IsNodeAvailable	string	パラメーターがグローバルパラメーターであるかどうかを示します。有効な値： 0：パラメーターはグローバルパラメーターです。パラメーターへの変更は、デフォルトで他のノードに適用され、キャンセルすることはできません。 1：パラメーターはグローバルパラメーターではありません。パラメーターの変更を適用するノードを指定できます。	1
ParamRelyRule	string	パラメーターの依存関係。	utf8
Factor	string	除数。整数型およびバイト型のパラメーターの場合、パラメーター値はこの係数の倍数である必要があります。係数を 0 にすることはできません。	20

例

成功レスポンス

JSONJSON

{
  "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"
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。