ModifySQLRateLimitingRules

Updated at:

Modifies an SQL throttling rule.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:ModifySQLRateLimitingRules

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

The cluster ID. Call instructions: Engine compatibility note: Explicitly list the database types that support SQL throttling, such as PolarDB for MySQL 8.0 only, in the description of the DBClusterId parameter or the API prerequisites.

pc-**************

RuleName

string

Yes

The name of the SQL throttling rule. You can specify only one rule name at a time.

Note
  • You can call the DescribeSQLRateLimitingRules operation to query the details of all SQL throttling rules in the specified cluster, including the rule names.

  • If the specified rule name does not exist in the current cluster, the system automatically creates a new SQL throttling rule based on the name and the value of RuleConfig.

testrule

RuleConfig

string

Yes

The JSON string of the configuration parameters and their values for the SQL throttling rule to be modified. All parameter values are of the string type. Example: {"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}. Parameters:

  • "id": Required. The name of the throttling rule. The name must meet the following requirements:
    • The name cannot exceed 30 characters in length.

    • The name must consist of uppercase letters, lowercase letters, and digits. Call instructions: Complete sub-parameter documentation: Annotate the type, value range, business meaning, and conditional dependencies for each field, such as the enumeration values and meanings of match_mode, the values and meanings of throttle_mode, the valid ranges of waiting and concurrency, and the conditional requirement rules for endpoint.

{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}

Response elements

Element

Type

Description

Example

object

Schema of Response

{}

Message

string

The message returned for the request.

Note

If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.

Successful

RequestId

string

The request ID.

35D3E3DA-4650-407A-BFF5-59BFF1******

Success

boolean

The request result. Valid values:

  • true: The request is successful.

  • false: The request fails.

true

Examples

Success response

JSON format

{
  "Message": "Successful",
  "RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.