すべてのプロダクト
Search

このプロダクト

    AnalyticDB:ModifyCollection

    ドキュメントセンター

    AnalyticDB:ModifyCollection

    最終更新日:Apr 02, 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:ModifyCollection

    update

    *Collection

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

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    任意

    データベースインスタンスの ID。

    説明

    地域内のすべての AnalyticDB for PostgreSQL インスタンス（およびそのインスタンス ID を含む）の詳細を照会するには、DescribeDBInstances 操作を呼び出します。

    gp-xxxxxxxxx
    NamespacePassword

    string

    必須

    名前空間のパスワード。

    testpassword
    Namespace

    string

    任意

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

    説明

    名前空間を作成するには CreateNamespace 操作を呼び出し、既存の名前空間を一覧表示するには ListNamespaces 操作を呼び出します。

    mynamespace
    Collection

    string

    必須

    コレクション名。

    説明

    すべてのコレクションを一覧表示するには、ListCollections 操作を呼び出します。

    document
    Metadata

    string

    必須

    メタデータフィールドの追加または変更操作を指定する JSON 文字列。必要な書式については、例をご参照ください。

    このパラメーターを使用して、新しいメタデータフィールドを追加したり、既存のメタデータフィールドの名前を変更したり、既存フィールドに対して暗黙的なデータ型変換を実行したりできます。

    詳細：

    新しいメタデータフィールドを追加するには、operations[*].operator = add を設定します。その後、operations[*].newMetaName でフィールド名を指定し、operations[*].newMetaType でデータ型を指定し、operations[*].fullTextRetrieval で全文検索を有効化します。

    既存のメタデータフィールドを変更するには、operations[*].operator = replace を設定します。operations[*].oldMetaName に現在のフィールド名を必ず指定してください。フィールド名を変更する場合は、operations[*].newMetaName に新しい名前を指定します。データ型を変更する場合は、operations[*].newMetaType に新しい型を指定します。

    説明

    • サポートされるデータ型の一覧については、「データの型」をご参照ください。money 型はサポートされていません。

    • 全文検索は、add 操作時のみフィールドに対して有効化でき、replace 操作では有効化できません。

    警告 id、vector、to_tsvector、source の各フィールド名は予約済みです。

    {"operations":[ {"operator":"add","newMetaType":"int","newMetaName":"ext1","fullTextRetrieval":true}, {"operator":"replace","oldMetaName":"ext2","newMetaName":"ext3"}, {"operator":"replace","newMetaType":"bigint","oldMetaName":"ext4"}, {"operator":"replace","newMetaType":"int","oldMetaName":"ext5","newMetaName":"ext6"} ]}
    RegionId

    string

    必須

    インスタンスのリージョン ID。

    cn-hangzhou
    WorkspaceId

    string

    任意

    複数のデータベースインスタンスを含むワークスペースの ID。このパラメーターまたは DBInstanceId のいずれかを指定する必要があります。両方を指定した場合、このパラメーターが優先されます。

    gp-ws-*****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    Message

    string

    応答メッセージ。

    Successful
    Metadata

    string

    コレクションのメタデータスキーマ。JSON 文字列として返されます。この文字列は、キーがフィールド名、値が対応するデータの型であるマップを表します。

    説明

    • サポートされるデータの型の一覧については、「データの型」をご参照ください。

    • money 型はサポートされていません。

    {"title":"text","content":"text","response":"int"}
    RequestId

    string

    リクエスト ID。

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

    string

    API リクエストのステータス。有効な値：

    • その他の値：リクエストが失敗しました。

    • success：リクエストが成功しました。

    success

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "Successful",
  "Metadata": "{\"title\":\"text\",\"content\":\"text\",\"response\":\"int\"}",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success"
}

    エラーコード

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

    変更履歴

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