すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeApplicationParameters

    ドキュメントセンター

    PolarDB:DescribeApplicationParameters

    最終更新日:Dec 11, 2025

    指定されたアプリケーションとそのコンポーネントの現在のパラメーターとテンプレート情報を取得します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ApplicationId

    string

    必須

    アプリケーション ID。

    pa-**************
    ComponentIdList

    array

    任意

    サブコンポーネント ID のリスト。このパラメーターを指定すると、これらのコンポーネントのパラメーターとパラメーターテンプレートのみが返されます。

    string

    任意

    サブコンポーネント ID。

    pac-**************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    RequestId

    string

    リクエスト ID。

    3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
    Parameters

    object

    パラメーターの詳細。

    ComponentParameters

    array<object>

    パラメーター詳細のリストを含むサブコンポーネントのリスト。

    array<object>

    パラメーター詳細のリストを含むサブコンポーネント。

    ComponentType

    string

    サブコンポーネントのタイプ。

    supabase
    Parameters

    array<object>

    パラメーター詳細のリスト。

    object

    パラメーターの詳細。

    Status

    string

    ステータス。

    Applied
    ReadOnly

    boolean

    パラメーターが読み取り専用かどうかを示します。

    false
    Pattern

    string

    パラメーターの正規表現。

    ^[a-zA-Z0-9]{1,20}$
    Type

    string

    パラメーターのタイプ。

    string
    Description

    string

    パラメーターの説明。

    The name of the parameter
    Value

    string

    パラメーターの現在の値。

    value
    NeedRestart

    boolean

    パラメーターを変更した後にアプリケーションを再起動する必要があるかどうかを示します。

    false
    Default

    string

    パラメーターのデフォルト値。

    default value
    Name

    string

    パラメーター名。

    name
    ComponentId

    string

    サブコンポーネント ID またはアプリケーション ID。

    pac-**************
    ParameterTemplates

    object

    パラメーターテンプレートの詳細。

    ComponentParameterTemplates

    array<object>

    パラメーターテンプレート詳細のリストを含むサブコンポーネントのリスト。

    array<object>

    ComponentType

    string

    サブコンポーネントのタイプ。

    supabase
    Parameters

    array<object>

    パラメーターテンプレート詳細のリスト。

    object

    パラメーターテンプレートの詳細。

    Pattern

    string

    パラメーターの正規表現。

    ^[a-zA-Z0-9]{1,20}$
    Type

    string

    パラメーターのタイプ。

    string
    Description

    string

    パラメーターの説明。

    The name of the parameter
    ReadOnly

    boolean

    パラメーターが読み取り専用かどうかを示します。

    false
    Default

    string

    パラメーターのデフォルト値。

    default
    Name

    string

    パラメーター名。

    name
    NeedRestart

    boolean

    パラメーターを変更した後にアプリケーションを再起動する必要があるかどうかを示します。

    false
    ComponentId

    string

    サブコンポーネント ID またはアプリケーション ID。

    pac-**************

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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