すべてのプロダクト
Search

このプロダクト

    :ListDocumentCollections

    ドキュメントセンター

    :ListDocumentCollections

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:ListDocumentCollections

    create

    *Collection

    acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンスの ID です。

    説明

    リージョン内の AnalyticDB for PostgreSQL インスタンスの詳細（ID を含む）を確認するには、DescribeDBInstances 操作を呼び出してください。

    gp-xxxxxxxxx
    Namespace

    string

    任意

    名前空間です。デフォルト値：public。

    説明

    名前空間を作成するには、CreateNamespace 操作を呼び出してください。名前空間を一覧表示するには、ListNamespaces 操作を呼び出してください。

    mynamespace
    NamespacePassword

    string

    必須

    名前空間のパスワードです。

    説明

    このパスワードは、CreateNamespace 操作を呼び出す際に設定します。

    testpassword
    RegionId

    string

    必須

    インスタンスが存在するリージョンの ID です。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID です。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Status

    string

    作成ステータスです。有効な値は次のとおりです。

    • success：操作が成功しました。

    • fail：操作が失敗しました。

    success
    Message

    string

    応答メッセージです。

    success
    Count

    integer

    アイテムの総数です。

    10
    Items

    object

    CollectionList

    array<object>

    ドキュメントコレクションのリストです。

    object

    ドキュメントコレクションに関する情報です。

    CollectionName

    string

    ドキュメントコレクションの名前です。

    document
    EmbeddingModel

    string

    埋め込みアルゴリズムです。

    text-embeddding-v1
    Dimension

    integer

    ベクトルのディメンションです。

    1536
    FullTextRetrievalFields

    string

    全文検索に使用されるフィールドです。複数のフィールドを指定する場合は、カンマ (,) で区切ります。

    title
    Metadata

    string

    メタデータです。

    {'page': 'int', 'title': 'text'}
    Parser

    string

    全文検索に使用されるトークナイザーです。

    zh_cn
    Metrics

    string

    ベクトル類似性アルゴリズムです。

    cosine
    SupportSparse

    boolean

    疎ベクトルがサポートされているかどうかを示します。デフォルト値：false。

    true
    SparseRetrievalFields

    string

    疎ベクトルを構築するために使用されるメタデータフィールドです。複数のフィールドを指定する場合は、カンマ (,) で区切ります。

    title,abstract

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success",
  "Message": "success",
  "Count": 10,
  "Items": {
    "CollectionList": [
      {
        "CollectionName": "document",
        "EmbeddingModel": "text-embeddding-v1",
        "Dimension": 1536,
        "FullTextRetrievalFields": "title",
        "Metadata": "{'page': 'int', 'title': 'text'}",
        "Parser": "zh_cn",
        "Metrics": "cosine",
        "SupportSparse": true,
        "SparseRetrievalFields": "title,abstract"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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