将指定的资源控制规则绑定到 PolarDB MySQL 集群中的用户、数据库、查询或连接。绑定成功后,目标对象将受到该资源控制规则的 CPU 配额限制。
接口说明
Resource Control 用于限制 PolarDB MySQL 集群中指定用户、数据库、查询或连接可使用的 CPU 资源。本期开放创建、修改、删除、绑定和解绑能力,不提供 Resource Control CPU 使用率查询能力。
使用限制
仅适用于支持 Resource Control 的 PolarDB MySQL 集群版,PolarDB MySQL 标准版不支持。
集群内核参数 loose_enable_resource_control 必须设置为 ON。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
PolarDB 集群所在地域的 ID。 说明
可通过接口 DescribeRegions 查看可用的地域。 |
cn-beijing |
| DBClusterId |
string |
是 |
PolarDB 集群 ID。 |
pc-************** |
| ResourceControlName |
string |
是 |
资源控制规则名称。长度为 1~63 个 ASCII 字节,必须以英文字母开头,仅支持英文字母、数字和下划线。 |
test_rc |
| TargetType |
string |
是 |
绑定目标的类型。取值:USER、DATABASE、QUERY、CONNECTION,大小写不敏感。 |
USER |
| TargetValue |
string |
是 |
绑定目标的值。具体格式由 TargetType 决定,参见下表。 |
app_user |
TargetValue 取值规则:
| TargetType | TargetValue 说明 | 示例值 |
| USER | 数据库用户名。长度为 1~63 个 ASCII 字节,必须以英文字母开头,仅支持英文字母、数字和下划线。不支持包含 Host、通配符或引用符号的账号。 | app_user |
| DATABASE | 数据库名称。长度为 1~63 个 ASCII 字节,必须以英文字母开头,仅支持英文字母、数字和下划线。 | order_db |
| QUERY | 查询 ID。必须是不含符号、空格和前导零的十进制正整数,取值范围为 1~Long.MAX_VALUE。 | 12345 |
| CONNECTION | 连接 ID。必须是不含符号、空格和前导零的十进制正整数,取值范围为 1~Long.MAX_VALUE。 | 67890 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
6BD9CDE4-5E7B-4BF3-9BB8-83C73E****** |
示例
正常返回示例
JSON格式
{
"RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 当前的记录中不存在提供的 DBClusterId。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。