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"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。