すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeCollection

    ドキュメントセンター

    AnalyticDB:DescribeCollection

    最終更新日:Mar 21, 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:DescribeCollection

    create

    *Collection

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    任意

    インスタンス ID。

    説明

    DescribeDBInstances 操作を呼び出して、リージョン内のすべての AnalyticDB for PostgreSQL インスタンス (インスタンス ID を含む) の情報をクエリできます。

    gp-bp152460513z****
    Namespace

    string

    任意

    名前空間の名前。

    説明

    ListNamespaces 操作を呼び出して、名前空間のリストをクエリできます。

    mynamespace
    NamespacePassword

    string

    必須

    名前空間のパスワード。

    testpassword
    Collection

    string

    必須

    コレクションの名前。

    説明

    ListCollections 操作を呼び出して、コレクションのリストをクエリできます。

    document
    RegionId

    string

    必須

    インスタンスが属するリージョン ID。

    cn-hangzhou
    WorkspaceId

    string

    任意

    複数の AnalyticDB for PostgreSQL インスタンスで構成されるワークスペースの ID。`WorkspaceId` と `DBInstanceId` のいずれかのパラメーターを指定する必要があります。両方のパラメーターを指定した場合、`WorkspaceId` パラメーターが有効になります。

    gp-ws-*****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

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

    integer

    ベクトル次元の数。

    1024
    FullTextRetrievalFields

    string

    全文検索に使用されるフィールド。複数のフィールドはコンマ (,) で区切ります。

    title,content
    Metadata

    object

    ベクトルデータのメタデータ。MAP 形式の JSON 文字列です。キーはフィールド名を指定し、値はデータの型を指定します。

    **

    警告 `id`、`vector`、`to_tsvector` などの予約済みフィールドは使用できません。

    string

    メタデータ。

    {"title":"text","content":"text"}
    Metrics

    string

    距離メトリック。

    cosine
    Parser

    string

    全文検索に使用されるアナライザ。

    zh_cn
    DBInstanceId

    string

    インスタンス ID。

    gp-bp152460513z****
    RegionId

    string

    インスタンスが属するリージョン ID。

    cn-hangzhou
    Namespace

    string

    名前空間の名前。

    mynamespace
    Message

    string

    返されるメッセージ。

    success
    Status

    string

    リクエストが成功したかどうかを示します。有効な値：

    • success

    • fail

    success
    SupportSparse

    boolean

    疎ベクトルがサポートされているかどうかを示します。

    true
    SparseVectorMetrics

    string

    疎ベクトルインデックスの作成に使用されるメソッド。

    ip

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Dimension": 1024,
  "FullTextRetrievalFields": "title,content",
  "Metadata": {
    "key": "{\"title\":\"text\",\"content\":\"text\"}"
  },
  "Metrics": "cosine",
  "Parser": "zh_cn",
  "DBInstanceId": "gp-bp152460513z****",
  "RegionId": "cn-hangzhou",
  "Namespace": "mynamespace",
  "Message": "success",
  "Status": "success",
  "SupportSparse": true,
  "SparseVectorMetrics": "ip"
}

    エラーコード

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

    変更履歴

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