すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeKnowledgeBaseAttribute

    ドキュメントセンター

    PolarDB:DescribeKnowledgeBaseAttribute

    最終更新日:Aug 22, 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:DescribeKnowledgeBaseAttribute

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-beijing
    KnowledgeBaseId

    string

    必須

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

    pkb-xxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    E56531A4-E552-40BA-9C58-137B80******
    KnowledgeBaseId

    string

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

    pkb-xxxxx
    Name

    string

    ナレッジベースの名前。

    testName
    Description

    string

    ナレッジベースの説明。

    testDesc
    KnowledgeSpaceId

    string

    ナレッジスペースの ID。

    pks-xxxxxx
    KnowledgeBaseType

    string

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

    • PUBLIC

    • PERSONAL

    PUBLIC
    TotalDocs

    integer

    ドキュメントの総数。

    1
    TotalSizeBytes

    integer

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

    318881
    Status

    string

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

    Activation
    CreationTime

    string

    作成時間。

    2020-08-14T05:58:42Z
    SearchMode

    string

    検索モード。有効な値:

    • balanced (デフォルト)

    • precise

    • semantic

    • knn

    • rrf

    balanced
    BindingAppCount

    integer

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

    2
    ShardCount

    integer

    シャードの数。

    15

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******",
  "KnowledgeBaseId": "pkb-xxxxx",
  "Name": "testName",
  "Description": "testDesc",
  "KnowledgeSpaceId": "pks-xxxxxx",
  "KnowledgeBaseType": "PUBLIC",
  "TotalDocs": 1,
  "TotalSizeBytes": 318881,
  "Status": "Activation",
  "CreationTime": "2020-08-14T05:58:42Z",
  "SearchMode": "balanced",
  "BindingAppCount": 2,
  "ShardCount": 15
}

    エラーコード

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

    変更履歴

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