DescribeRateLimitPolicy - 查询限流策略 - 云原生数据库 PolarDB

查询限流策略。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeRateLimitPolicy

get

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-beijing
GwClusterId	string	是	网关实例 ID。	pg-xxxxxxx
PolicyId	string	否	限流策略 ID。	02eccf7c61cf4d05a543075ee907f3**
ScopeType	string	否	限流维度，枚举值： ConsumerGroup 用户组 Consumer 用户	ConsumerGroup
ScopeRefId	string	否	限流维度 ID（ConsumerGroup ID 或 Consumer ID）	cg-xxxxxxxx
PageSize	integer	否	每页记录数，取值范围如下： 30 50 100 默认值为 30。	30
PageNumber	integer	否	分页查询时的页码。默认值：1。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	CED079B7-A408-41A1-BFF1-EC608E******
TotalRecordCount	string	总的记录数量	1
PageSize	string	每页记录数，取值范围为 30、50、100，默认值为 30。	30
PageNumber	string	查询页码。	1
PageRecordCount	string	当前页记录数。	30
Items	array<object>	限流策略列表
	object	限流策略对象
PolicyId	string	限流策略 ID。	02eccf7c61cf4d05a543075ee907f3**
GwClusterId	string	网关实例 ID。	pg-xxxxxxxx
PolicyType	string	策略类型	RateLimit
ScopeType	string	限流维度，枚举值： ConsumerGroup 用户组 Consumer 用户	ConsumerGroup
ScopeRefId	string	限流维度 ID（ConsumerGroup ID 或 Consumer ID）	cg-xxxxxxx
RateLimitRpm	string	每分钟请求数限制	10
RateLimitTpm	string	每分钟 Token 数限	10
Status	string	限流策略状态，枚举值： Enabled 开启 Disabled 关闭	Enabled
GmtCreated	string	创建时间	2025-12-01T17:52:05+08:00
GmtModified	string	更新时间	2026-01-19T16:47:25+08:00

示例

正常返回示例

JSON格式

{
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
  "TotalRecordCount": "1",
  "PageSize": "30",
  "PageNumber": "1",
  "PageRecordCount": "30",
  "Items": [
    {
      "PolicyId": "02eccf7c61cf4d05a543075ee907f3**\n",
      "GwClusterId": "pg-xxxxxxxx",
      "PolicyType": "RateLimit",
      "ScopeType": "ConsumerGroup ",
      "ScopeRefId": "cg-xxxxxxx",
      "RateLimitRpm": "10",
      "RateLimitTpm": "10",
      "Status": "Enabled",
      "GmtCreated": "2025-12-01T17:52:05+08:00",
      "GmtModified": "2026-01-19T16:47:25+08:00"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。