調用DescribeApplicationParameters介面擷取PolarDB應用組件的參數和參數模板-雲原生資料庫 PolarDB-阿里雲

擷取指定應用及其組件的當前參數和模板資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeApplicationParameters

get

*全部資源

*

無

請求文法

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	參數的Regex	^[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	參數的Regex	^[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-**************

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。