DescribeDrdsParams - 查询 DRDS 的参数列表-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调用DescribeDrdsParams接口查询参数列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
drds:DescribeDrdsParams	Read	instance acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
DrdsInstanceId	string	是	实例 ID。	DescribeDrdsParams
ParamLevel	string	是	参数级别，取值： INSTANCE：实例级别 DB：数据库级别	INSTANCE
DbName	string	否	数据库名称。	drds_test

返回参数

名称	类型	描述	示例值
	object
Success	boolean	查询是否成功。	true
RequestId	string	请求 ID。	2F7F8080-9132-4279-85D0-B7E5C4305162
List	object []	参数列表。
ParamDefaultValue	string	参数默认值。	1000
DbName	string	数据库名称。	drds_test
ParamLevel	string	参数级别。	INSTANCE
ParamName	string	参数名称。	慢SQL阈值
ParamEnglishName	string	参数英文名称。	SLOW_SQL_TIME
ParamType	string	参数类型。	CONFIG
ParamValue	string	参数值。	1000
ParamDesc	string	参数描述。	慢SQL阈值（单位：ms）
NeedRestart	boolean	是否需要重启。	true
ParamVariableName	string	参数变量名称。	slowSqlTime
ParamRanges	string	参数值区间。	[1000-900000]

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "2F7F8080-9132-4279-85D0-B7E5C4305162",
  "List": [
    {
      "ParamDefaultValue": "1000",
      "DbName": "drds_test",
      "ParamLevel": "INSTANCE",
      "ParamName": "慢SQL阈值",
      "ParamEnglishName": "SLOW_SQL_TIME",
      "ParamType": "CONFIG",
      "ParamValue": "1000",
      "ParamDesc": "慢SQL阈值（单位：ms）",
      "NeedRestart": true,
      "ParamVariableName": "slowSqlTime",
      "ParamRanges": "[1000-900000]"
    }
  ]
}

JSON格式

{
  "Success": true,
  "RequestId": "2F7F8080-9132-4279-85D0-B7E5C4305162",
  "List": [
    {
      "ParamDefaultValue": "1000",
      "DbName": "drds_test",
      "ParamLevel": "INSTANCE",
      "ParamName": "慢SQL阈值",
      "ParamEnglishName": "SLOW_SQL_TIME",
      "ParamType": "CONFIG",
      "ParamValue": "1000",
      "ParamDesc": "慢SQL阈值（单位：ms）",
      "NeedRestart": true,
      "ParamVariableName": "slowSqlTime",
      "ParamRanges": "[1000-900000]"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史