すべてのプロダクト
Search

このプロダクト

    PolarDB:AddFirewallRules

    ドキュメントセンター

    PolarDB:AddFirewallRules

    最終更新日:Sep 17, 2025

    SQL ファイアウォールルールを追加します。

    今すぐお試しください

    この 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:AddFirewallRules

    create

    *DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    pc-*****************

    RuleName

    string

    任意

    ファイアウォールルールの名前。ルール名は 1 つだけ指定できます。

    説明

    • DescribeFirewallRules 操作を呼び出して、ルール名を含む、ターゲットクラスターのすべてのファイアウォールルールの詳細を表示します。

    • 指定したルール名がクラスターに存在しない場合、システムは名前と RuleConfig パラメーターの値に基づいて新しいファイアウォールルールを自動的に作成します。

    testrule

    RuleConfig

    string

    任意

    追加するファイアウォールルールの構成パラメーターとその値を含む JSON 文字列。すべてのパラメーター値は文字列である必要があります。例: {"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}。JSON 文字列には、次のパラメーターが含まれています。

    • "id": 必須。ファイアウォールルールの名前。

    • "endpoint": 必須。インスタンスのエンドポイントに関する情報。

    {"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ。

    RequestId

    string

    リクエスト ID。

    2921D843-433A-5FB3-A03B-4EC093B219F8
    Message

    string

    応答メッセージ。

    Successful
    Success

    boolean

    リクエストの結果。有効な値:

    • true: リクエストは成功しました。

    • false: リクエストは失敗しました。

    True

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2921D843-433A-5FB3-A03B-4EC093B219F8",
  "Message": "Successful",
  "Success": true
}

    エラーコード

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

    変更履歴

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