すべてのプロダクト
Search
ドキュメントセンター

AnalyticDB:UpdateCollectionDataMetadata

最終更新日: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:UpdateCollectionDataMetadata

create

*Collection

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBInstanceId

string

任意

インスタンス ID。

説明

DescribeDBInstances API を呼び出すことで、ターゲットリージョン内のすべての AnalyticDB for PostgreSQL インスタンスの詳細 (インスタンス ID を含む) を表示できます。

gp-j788ghhjjxxxx

Namespace

string

任意

名前空間。

説明

ListNamespaces API を使用してリストを表示できます。

mynamespace

Collection

string

必須

コレクション名。

説明

ListCollections API を使用してリストを表示できます。

document

RegionId

string

必須

インスタンスが配置されているリージョン ID。

cn-hangzhou

NamespacePassword

string

必須

名前空間に対応するパスワード。

testpassword

Filter

string

任意

更新対象データのフィルター条件を SQL の WHERE 形式で指定します。このフィールドと Ids フィールドを同時に空にすることはできません。

business_value = 'chat_file_1'

Ids

array

任意

更新対象データの ID リスト。つまり、データアップロード時に指定した Row.Id です。このフィールドと Filter フィールドを同時に空にすることはできません。

string

任意

更新対象データの ID。

AC-2642a8744eba4c5eb7d7595d08306d15

Metadata

object

必須

更新するデータを MAP 形式の JSON 文字列で指定します。キーはフィールド名、値は新しいデータ値です。

{ "title": "new title", "content": "new content" }

any

任意

メタデータの値。

new title

WorkspaceId

string

任意

複数のデータベースインスタンスで構成されるワークスペースの ID。このパラメーターと DBInstanceId パラメーターを両方とも空にすることはできません。両方が指定された場合、このパラメーターが優先されます。

gp-ws-*****

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

ABB39CC3-4488-4857-905D-2E4A051D0521

Message

string

リクエストが失敗した場合の詳細情報。

failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password

Status

string

ステータス。次の値のいずれかです。

  • success:成功。

  • fail:失敗。

success

AppliedRows

integer

有効なエントリ数。

10

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "failed to connect database, detailMsg: getConnection fail::SQL State: 28P01, Error Code: 0, Error Message: FATAL: password",
  "Status": "success",
  "AppliedRows": 10
}

エラーコード

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

変更履歴

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