すべてのプロダクト
Search

このプロダクト

    API Gateway:ListPolicyClasses

    ドキュメントセンター

    API Gateway:ListPolicyClasses

    最終更新日:Mar 30, 2026

    ポリシーテンプレートを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    apig:ListPolicyClasses

    none

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /v1/policy-classes HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    type

    string

    任意

    テンプレートタイプ。

    FlowControl
    direction

    string

    任意

    ポリシーが適用されるトラフィックの方向。有効な値:

    • OutBound

    • InBound

    • Both

    InBound
    attachResourceType

    string

    任意

    サポートされているマウントポイントタイプ。有効な値:

    • HttpApi: HTTP API

    • Operation: HTTP API 内のオペレーション

    • GatewayRoute: ルート

    • GatewayService: サービス

    • GatewayServicePort: サービスポート

    • Domain: ドメイン名

    • Gateway: インスタンス

    Operation
    pageNumber

    integer

    任意

    返されるページのページ番号。デフォルト値: 1。

    1
    pageSize

    integer

    任意

    1 ページあたりのエントリ数。

    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

    1 ページあたりのエントリ数。

    10
    totalSize

    integer

    エントリの総数。

    10
    items

    array

    テンプレート。

    PolicyClassInfo

    テンプレート情報。

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。