全部產品
Search
文件中心

API Gateway:ListPolicyClasses

更新時間:Jul 01, 2026

取得策略範本。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apig:ListPolicyClasses

none

*All Resource

*

無 無

請求文法

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

錯誤碼

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

變更歷史

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