ListPolicyClasses - 擷取原則範本 - API Gateway

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

apig:ListPolicyClasses

none

*全部資源

*

無

請求文法

GET /v1/policy-classes HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
type	string	否	原則範本類型。	FlowControl
direction	string	否	策略出入站方向。出站：OutBound。入棧：InBound。雙方向：Both。	InBound
attachResourceType	string	否	策略支援掛載點類型。 HttpApi：HttpApi。 Operation：HttpApi 的 Operation。 GatewayRoute：網關路由。 GatewayService：網關服務。 GatewayServicePort：網關服務連接埠。 Domain：網關網域名稱。 Gateway：網關。	Operation
pageNumber	integer	否	頁碼，預設 1	1
pageSize	integer	否	分頁大小	10
attachResourceId	string	否	掛載資源 ID	route-001
gatewayId	string	否	網關 ID	gw-001

返回參數

名稱	類型	描述	樣本值
	object	返回結構體。
requestId	string	請求 ID。	23B45FA9-7208-5E55-B5CE-B6B2567DD822
code	string	響應碼。	Ok
message	string	響應訊息。	success
data	object	原則範本資訊。
pageNumber	integer	頁碼。	1
pageSize	integer	分頁大小。	10
totalSize	integer	總條數。	10
items	array	原則範本列表。
	PolicyClassInfo	原則範本資訊。

樣本

正常返回樣本

JSON格式

{
  "requestId": "23B45FA9-7208-5E55-B5CE-B6B2567DD822",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": [
      {
        "classId": "pc-cpqm0s94ckt1displ8ng",
        "name": "ConcurrencyLimit",
        "alias": "並發控制",
        "version": "1.0.0",
        "description": "通過控制並發線程數以保證系統的穩定性。適用於應用內部或下遊依賴出現不穩定的情境，例如慢SQL、下遊應用回應時間變長等。",
        "type": "FlowControl",
        "direction": "InBound",
        "attachableResourceTypes": [
          "Gateway"
        ],
        "executeStage": "POST",
        "executePriority": "1",
        "enableLog": true,
        "deprecated": false,
        "configExample": "{}"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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