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

AnalyticDB:CreateIndex

最終更新日:Mar 21, 2026

インデックスを作成します。注:1. スカラーインデックスのみがサポートされています。2. インデックス作成中はテーブルが書き込みロックされます。3. 大容量のデータを持つテーブルにインデックスを作成する場合、インスタンスの CPU および I/O リソースが大幅に消費されます。これがインスタンスの可用性に影響を与える場合は、CancelCreateIndexJob を呼び出してインデックス作成をキャンセルしてください。

今すぐお試しください

この 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:CreateIndex

create

*Collection

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

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

cn-hangzhou

DBInstanceId

string

任意

クラスター ID。

説明

DescribeDBInstances 操作を呼び出して、指定されたリージョン内のすべての AnalyticDB for PostgreSQL (GPDB) インスタンスの ID をクエリできます。

gp-xxxxxxxxx

WorkspaceId

string

任意

複数の AnalyticDB for PostgreSQL インスタンスで構成されるワークスペースの ID です。このパラメーターと DBInstanceId の両方が空であることはできません。両方のパラメーターが指定された場合、本パラメーターの値が優先されます。

有効な値:

  • 内積

  • L2 距離

  • 余弦

gp-ws-*****

Namespace

string

必須

名前空間名。

説明

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

mynamespace

NamespacePassword

string

必須

名前空間のパスワード。

説明

このパラメーターの値は、CreateNamespace 操作によって指定されます。

testpassword

Collection

string

必須

コレクション名。

説明

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

testcollection

IndexName

string

任意

インデックス名。

testindex

IndexField

string

任意

インデックスフィールド。単一フィールドのみがサポートされており、メタデータで定義されたキーである必要があります。

title

IndexConfig

string

任意

インデックスパラメーター。このパラメーターを指定しない場合、B ツリーインデックスが作成されます。

説明
  • b-tree:B ツリーインデックスを作成するには、fillFactor パラメーターを 10 から 100 の間の値に設定します。デフォルト値: 90。

  • gin:GIN インデックスを作成するには、fastUpdate パラメーターを true または false に設定します。デフォルト値: true。

{"b-tree":{"fillFactor":90}} 或者 {"gin":{"fastUpdate":false}}

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエストの一意の ID。

ABB39CC3-4488-4857-905D-2E4A051D0521

Message

string

返されたメッセージ。

Successfully create job

Status

string

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

  • success

  • fail

success

JobId

string

ジョブ ID。ジョブのステータスをクエリしたり、ジョブをキャンセルしたりするために使用できます。

231460f8-75dc-405e-a669-0c5204887e91

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successfully create job",
  "Status": "success",
  "JobId": "231460f8-75dc-405e-a669-0c5204887e91"
}

エラーコード

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

変更履歴

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