All Products
Search

This Product

    ApsaraDB RDS:CloneParameterGroup

    Document Center

    ApsaraDB RDS:CloneParameterGroup

    Last Updated:Jun 01, 2023

    Replicates a parameter template to the current region or to another region.

    Operation Description

    You can configure a number of parameters at a time by using a parameter template and then apply the parameter template to an instance. For more information, see Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances or Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances.

    NoteThis operation is supported only when your instance runs MySQL or PostgreSQL.

    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:CloneParameterGroupWRITE
    • RDS
      acs:rds:*:{#accountId}:dbinstance/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the source region to which the parameter template belongs. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    TargetRegionIdstringYes

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

    		cn-qingdao
    ParameterGroupIdstringYes

    The ID of the parameter template. You can call the DescribeParameterGroups operation to query the most recent parameter templates in a region.

    		rpg-13ppdh****
    ParameterGroupNamestringYes

    The name of the parameter template in the destination region.

    		tartestgroup
    ParameterGroupDescstringYes

    The description of the parameter template in the destination region.

    		CloneGroup1

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		1D3D5995-6BDD-43B5-93B8-2C41A2ACD6AA

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1D3D5995-6BDD-43B5-93B8-2C41A2ACD6AA"
}

    Error codes

    HTTP status codeError codeError messageDescription
    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.
    400InvalidEngine.MalformedSpecified engine is not valid.The database engine is invalid. Specify a valid database engine.
    400InvalidEngineVersion.MalformedSpecified engine version is not valid.The database engine version is invalid. Check the database engine version and try again.
    400ParamNotExistThis param Not ExistThe parameter does not exist. Check parameter configurations.
    400ParamTypeErrorThe parameter type error.The parameter type is invalid.
    400ParamGroupOptionValue.NotSupportSpecified option value unsupported.-
    400ParamGroupsNotExistThe specified paramGroups does not exist.The parameter template cannot be found. You can call the DescribeParameterGroups operation to query the parameter templates that are available to a specified region.
    400InvalidParameters.MalformedOne or more of the request parameters provided are not valid.One or more of the request parameters provided are not valid, please check the API document
    400%sThe following parameters are prohibited: <br />%s-
    404ParamGroupOptionKey.NotFoundSpecified system parameter group option unregistered.-

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

    Change history

    Change timeSummary of changesOperation
    2023-05-09The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 404
    2022-10-28The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change