调用DescribeParameterGroups接口查询目标地域的参数模板列表。
参数模板可以批量管理实例的参数,您可以使用参数模板功能,快速应用模板到实例上。详情请参见使用参数模板。
说明 当前仅支持MySQL实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeParameterGroups |
系统规定参数,取值:DescribeParameterGroups。 |
RegionId | String | 是 | cn-hangzhou |
目标地域ID,可以通过接口DescribeRegions查看地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ParameterGroups | Array |
参数模板列表。 |
|
ParameterGroup | |||
CreateTime | String | 2019-11-21T01:48:39Z |
参数模板创建时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
Engine | String | mysql |
数据库引擎。 |
EngineVersion | String | 5.7 |
数据库版本。 |
ForceRestart | Integer | 1 |
应用该参数模板是否需要重启实例。取值:
|
ParamCounts | Integer | 2 |
参数模板内的参数数量。 |
ParameterGroupDesc | String | testgroup |
参数模板描述。 |
ParameterGroupId | String | rpg-xxxxxxx |
参数模板ID。 |
ParameterGroupName | String | test1234 |
参数模板名称。 |
ParameterGroupType | Integer | 1 |
参数模板类型。取值:
|
UpdateTime | String | 2019-11-21T02:21:35Z |
最近一次参数模板更新时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
RequestId | String | D4A23265-C5B6-42E1-98A0-EFA1EB42E723 |
请求ID。 |
SignalForOptimizeParams | Boolean | false |
目标地域是否有参数模板。取值:
|
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeParameterGroups
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<DescribeParameterGroupsResponse>
<RequestId>D4A23265-C5B6-42E1-98A0-EFA1EB42E723</RequestId>
<ParameterGroups>
<ParameterGroup>
<ParameterGroupType>1</ParameterGroupType>
<ParameterGroupName>testgroup123</ParameterGroupName>
<CreateTime>2019-11-21T01:48:39Z</CreateTime>
<ParameterGroupDesc></ParameterGroupDesc>
<ParamCounts>2</ParamCounts>
<UpdateTime>2019-11-21T01:48:39Z</UpdateTime>
<ForceRestart>1</ForceRestart>
<EngineVersion>5.7</EngineVersion>
<Engine>mysql</Engine>
<ParameterGroupId>rpg-xxxxxxx</ParameterGroupId>
</ParameterGroup>
<ParameterGroup>
<ParameterGroupType>1</ParameterGroupType>
<ParameterGroupName>test1234</ParameterGroupName>
<CreateTime>2019-11-21T01:42:38Z</CreateTime>
<ParameterGroupDesc></ParameterGroupDesc>
<ParamCounts>2</ParamCounts>
<UpdateTime>2019-11-21T01:42:38Z</UpdateTime>
<ForceRestart>1</ForceRestart>
<EngineVersion>5.7</EngineVersion>
<Engine>mysql</Engine>
<ParameterGroupId>rpg-xxxxxxx</ParameterGroupId>
</ParameterGroup>
</ParameterGroups>
</DescribeParameterGroupsResponse>
JSON
格式
{
"RequestId": "D4A23265-C5B6-42E1-98A0-EFA1EB42E723",
"ParameterGroups": {
"ParameterGroup": [
{
"ParameterGroupType": 1,
"ParameterGroupName": "testgroup123",
"CreateTime": "2019-11-21T01:48:39Z",
"ParameterGroupDesc": "",
"ParamCounts": 2,
"UpdateTime": "2019-11-21T01:48:39Z",
"ForceRestart": 1,
"EngineVersion": "5.7",
"Engine": "mysql",
"ParameterGroupId": "rpg-xxxxxxx"
},
{
"ParameterGroupType": 1,
"ParameterGroupName": "test1234",
"CreateTime": "2019-11-21T01:42:38Z",
"ParameterGroupDesc": "",
"ParamCounts": 2,
"UpdateTime": "2019-11-21T01:42:38Z",
"ForceRestart": 1,
"EngineVersion": "5.7",
"Engine": "mysql",
"ParameterGroupId": "rpg-xxxxxxx"
}
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交