ModifyResourceControl - PolarDB - Alibaba Cloud Documentation Center

Modifies the CPU quota of an existing resource control rule in a specified PolarDB for MySQL cluster. You can modify the current quota value or switch between the maximum CPU percentage mode and the maximum CPU core count mode. You must specify one and only one of the MaxCpu and CpuCount parameters.

Operation description

Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. It does not support querying Resource Control CPU usage.

Before you begin

This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
The cluster kernel parameter loose_enable_resource_control must be set to ON.
MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
The maximum value of CpuCount is determined by the cluster kernel parameter resource_control_cpu_count_limit.

Important This is a notice.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the PolarDB cluster. Note You can call the DescribeRegions operation to query available regions.	cn-hangzhou
DBClusterId	string	Yes	The PolarDB cluster ID.	pc-**************
ResourceControlName	string	Yes	The name of the resource control rule. The name must be 1 to 63 ASCII bytes in length, start with a letter, and can contain only letters, digits, and underscores.	test_rc
MaxCpu	integer	No	The modified maximum CPU quota percentage. Valid values: 1 to 100. You must specify one and only one of this parameter and CpuCount.	30
CpuCount	integer	No	The modified maximum number of CPU cores. The minimum value is 1. The maximum value is determined by the cluster kernel parameter resource_control_cpu_count_limit. You must specify one and only one of this parameter and MaxCpu.	8

You must specify one and only one of the MaxCpu and CpuCount parameters.

Important This is a notice.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	47921222-0D37-4133-8C0D-017DC3******

Examples

Success response

JSON format

{
  "RequestId": "47921222-0D37-4133-8C0D-017DC3******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters.Malformed	The specified Resource Control parameter is not valid.
400	Database.ConnectError	Unable to connect to the database instance.
400	Database.ExecError	The Resource Control operation could not be executed on the database instance.
403	IncorrectDBInstanceType	Resource Control is not supported for the current DB cluster edition or kernel configuration.
403	AuthorizationFailure	The request is not authorized to operate Resource Control.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.