DescribeApplicationParameters - 获取PolarDB应用组件参数_云原生数据库 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>	包含参数详情列表的子组件列表
	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>	包含参数模版详情列表的子组件列表
	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-**************

示例

正常返回示例

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。