All Products
Search

This Product

    ApsaraDB RDS:ModifyParameterGroup

    Document Center

    ApsaraDB RDS:ModifyParameterGroup

    Last Updated:Apr 17, 2024

    Modifies the parameter template of an instance.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL

    References

    Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:ModifyParameterGroupWRITE
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ParameterGroupIdstringYes

    The parameter template ID. You can call the DescribeParameterGroups operation to query the parameter template ID.

    		rpg-13ppdh****
    ParameterGroupNamestringNo

    The parameter template name.

    • The name can contain letters, digits, periods (.), and underscores (_). It must start with a letter.
    • It can be 8 to 64 characters in length.
    Note If you do not specify this parameter, the original name of the parameter template is retained.
    		testgroup1
    ParameterGroupDescstringNo

    The new description of the parameter template. The description can be up to 200 characters in length.

    Note If you do not specify this parameter, the original description of the parameter template is retained.
    		test
    ParametersstringNo

    A JSON string that consists of parameters and their values in the parameter template. Format: {"Parameter 1":"Value of Parameter 1","Parameter 2":"Value of Parameter 2"...}. For more information about the parameters that can be modified, see Modify the parameters of an ApsaraDB RDS for MySQL instance or Modify the parameters of an ApsaraDB RDS for PostgreSQL instance.

    Note

    • If ModifyMode is set to Individual and this parameter is specified, the new parameters overwrite the parameters in the original parameter template.

    • If you set ModifyMode to Collectivity and specify this parameter, the new parameters are added to the original parameter template, or the parameters in the original parameter template are modified.

    • If you do not specify this parameter, the parameters in the original parameter template remain unchanged.

    		{"back_log":"3000"}
    RegionIdstringYes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    Note The region of a parameter template cannot be changed. You can call the CloneParameterGroup operation to replicate a parameter template to a specific region.
    		cn-hangzhou
    ModifyModestringNo

    The modification mode of the parameter template. Valid values:

    • Collectivity (default): adds new parameters or modifies parameters in the original parameter template.
    Note If ModifyMode is set to Collectivity, the system adds the value of Parameters to the parameter template or modifies the corresponding parameters in the parameter template. Other parameters in the original parameter template are not affected.
    • Individual: overwrites original parameters.
    Note If ModifyMode is set to Individual, the system uses the value of Parameters to overwrite the original parameter in the parameter template.
    		Collectivity
    ResourceGroupIdstringNo

    The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.

    		rg-acfmy****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    ParameterGroupIdstring

    The parameter template ID.

    		rpg-13ppdh****
    RequestIdstring

    The request ID.

    		857DC00B-7B85-4853-8B27-AD65EB618BC6

    Examples

    Sample success responses

    JSONformat

    {
  "ParameterGroupId": "rpg-13ppdh****",
  "RequestId": "857DC00B-7B85-4853-8B27-AD65EB618BC6"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.MalformedThe specified parameter "Parameters" is not valid.-
    400ParamGroupsNotExistThis paramGroups not exist-
    400%sThe following parameters are prohibited: <br />%s-
    400ParamGroupsNameInvalidThe parameter group name is invalid.The name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, decimal points (.), and underscores (_). The name must start with a letter.
    400InvalidParameterGroupId.MalformedSpecified parameterGroupId is not valid.The parameter template ID that is specified by the parameterGroupId parameter is invalid. You can call the DescribeParameterGroups operation to query the IDs of parameter templates.
    400ParamGroupsNotExistOrTypeNotSupportThe parameter group does not exist or its type is not supported.The paramGroups does not exist or its type is not supported.
    400ParamNotExistThis param Not ExistThe parameter does not exist. Check parameter configurations.
    400ParamTypeErrorThe parameter type error.The parameter type is invalid.
    400ParamGroupsDescInvalidThe maximum length of parameter group description is exceeded.The description of the parameter template can be up to 200 characters in length.
    400InvalidParameterValue.NotStandardInvalid parameter format.The value of the parameter is invalid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-07-25The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ResourceGroupId
    2023-05-09The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-03-01The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2022-10-28The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2022-06-23API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400