ListConsumerQuotaRules - API Gateway

查詢某個消費者上已配置的配額規則列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apig:ListConsumerQuotaRules

none

*Domain

acs:apig:{#regionId}:{#accountId}:consumer/{#ConsumerId}

無

請求文法

GET /v1/consumers/{consumerId}/quota-rules HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
consumerId	string	否	消費者 ID。	cs-d8kkaium1hks607xxxxx

請求參數

名稱	類型	必填	描述	樣本值
gatewayId	string	否	閘道 ID，可選。	gw-123456
keyword	string	否	規則名稱關鍵詞，用於模糊匹配。	daily
pageNumber	integer	否	頁碼。	1
pageSize	integer	否	每頁數量。	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
requestId	string	Id of the request	1234567890
code	string	狀態碼。	200
message	string	回應資訊。	success
data	object	回應資料。	{"totalSize":100}
totalSize	integer	配置的配額規則總條數。	100
pageNumber	integer	當前頁碼。	1
pageSize	integer	當前頁大小。	10
items	array<object>	規則列表。	[{"ruleId":"rule-001"}]
	object	規則條目。	{'ruleId':'rule-001','ruleName':'daily-token-limit'}
ruleId	string		qr-d8j7fpmm1hksxxxxxx
ruleName	string		daily-token-limit
gatewayId	string		gw-123456
gatewayName	string		prod-gateway
quotaDimension	string		token
quotaLimit	integer		1000
windowAlignment	string		calendar
ruleStatus	string	枚舉值： disabled : disabled enbaled : enbaled	enabled
periodType	string		week
periodMultiplier	string		30
timezone	string		UTC+8

樣本

正常返回樣本

JSON格式

{
  "requestId": "1234567890",
  "code": "200",
  "message": "success",
  "data": {
    "totalSize": 100,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "ruleId": "qr-d8j7fpmm1hksxxxxxx",
        "ruleName": "daily-token-limit",
        "gatewayId": "gw-123456",
        "gatewayName": "prod-gateway",
        "quotaDimension": "token",
        "quotaLimit": 1000,
        "windowAlignment": "calendar",
        "ruleStatus": "enabled",
        "periodType": "week",
        "periodMultiplier": "30",
        "timezone": "UTC+8"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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