すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeKnowledgeBases

    ドキュメントセンター

    PolarDB:DescribeKnowledgeBases

    最終更新日:Aug 28, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeKnowledgeBases

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-beijing
    KnowledgeSpaceId

    string

    任意

    ナレッジスペースの一意の識別子。

    pks-xxxxxx
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

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

    30
    Keyword

    string

    任意

    ナレッジベースを検索するためのキーワード。

    testkb
    Status

    string

    任意

    ナレッジベースのステータス。

    Activation

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    CDB3258F-B5DE-43C4-8935-CBA0CA******
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効な値: 30、50、100。

    デフォルト値: 30。

    30
    TotalRecordCount

    integer

    レコードの総数。

    1
    Items

    array<object>

    ナレッジベースのリスト。

    object

    KnowledgeBaseId

    string

    ナレッジベースの一意の識別子。

    pkb-xxxxxx
    Name

    string

    ナレッジベースの名前。

    testName
    Description

    string

    ナレッジベースの説明。

    testDesc
    KnowledgeSpaceId

    string

    ナレッジスペースの ID。

    pks-xxxxxx
    KnowledgeBaseType

    string

    ナレッジベースのタイプ。有効な値:

    • PUBLIC: パブリック。

    • PERSONAL: パーソナル。

    PUBLIC
    TotalDocs

    integer

    ドキュメントの総数。

    1
    TotalSizeBytes

    integer

    合計サイズ (バイト単位)。

    231984
    Status

    string

    ナレッジベースのステータス。

    Activation
    CreationTime

    string

    作成時間。

    2025-03-25T09:37:10Z
    BindingAppCount

    integer

    ナレッジベースにバインドされている AI アプリケーションの数。

    2

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "KnowledgeBaseId": "pkb-xxxxxx",
      "Name": "testName",
      "Description": "testDesc",
      "KnowledgeSpaceId": "pks-xxxxxx",
      "KnowledgeBaseType": "PUBLIC",
      "TotalDocs": 1,
      "TotalSizeBytes": 231984,
      "Status": "Activation",
      "CreationTime": "2025-03-25T09:37:10Z",
      "BindingAppCount": 2
    }
  ]
}

    エラーコード

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

    変更履歴

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