すべてのプロダクト
Search

このプロダクト

    :GetTable

    ドキュメントセンター

    :GetTable

    最終更新日:Jun 17, 2026

    インデックステーブル情報を取得します。

    操作説明

    メソッド

    GET

    URI

    /openapi/ha3/instances/{instanceId}/tables/{tableName}
```.

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    searchengine:GetTable

    get

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    GET /openapi/ha3/instances/{instanceId}/tables/{tableName} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****
    tableName

    string

    必須

    インデックステーブル名。

    test_summary

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    リクエスト例

    

    GET /openapi/ha3/instances/{instanceId}/tables/{tableName}
```.

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエスト ID。

    2AE63638-5420-56DC-BF59-37D8174039A0
    result

    object

    応答結果。

    name

    string

    インデックス名。

    test_oss
    status

    string

    インデックステーブルのステータス (NEW、PUBLISH、IN_USE: 再現率エンジンバージョンが正常に作成された後の通常ステータス、NOT_USE、STOP_USE、RESTORE_USE、FAIL: ベクター取得バージョンの新しいバージョンで初回インデックス作成に失敗した時のステータス)。

    IN_USE
    dataProcessorCount

    integer

    データ更新リソースの数。

    1
    partitionCount

    integer

    データシャードの数。

    1
    dataSource

    object

    データソース構成。

    type

    string

    データソースのタイプ。 有効な値: odps、swift、saro、oss、unKnow。 odps、swift、oss のみがサポートされています。

    odps
    dataTimeSec

    integer

    増分データの UNIX タイムスタンプ。

    1715160176
    autoBuildIndex

    boolean

    インデックスを自動的に再構築するかどうかを示します。

    true
    config

    object

    データソース構成。

    endpoint

    string

    ODPS エンドポイント。

    http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
    accessKey

    string

    AccessKey ID。

    ak
    accessSecret

    string

    AccessKey シークレット。

    as
    project

    string

    ODPS データソースプロジェクトの名前。

    dp_pdm_marketing_prod
    partition

    string

    パーティション情報。

    ds=20220808
    table

    string

    saro または ODPS データソーステーブルの名前。

    test_add
    namespace

    string

    saro 名前空間。

    namespace
    path

    string

    HDFS パス。

    vendor/sebastian/comparator/src/exceptions
    ossPath

    string

    OSS ファイルのパス。

    /opensearch_index_data/sift_oss_test.data
    bucket

    string

    OSS バケット。

    heytea-ops-oss
    rawSchema

    string

    ユーザーが rawSchema を提供した場合、手動で組み立てることなく、そのまま HA3 スキーマ構造として使用されます。

    {}
    primaryKey

    string

    プライマリキーフィールド。

    id
    fieldSchema

    object

    フィールドマップコレクション、キー: フィールド名、値: フィールドタイプ。

    string

    id

    INT64
    vectorIndex

    array<object>

    インデックス構造。

    array<object>

    indexName

    string

    インデックススキーマの名前。

    test_odps
    vectorField

    string

    ベクターフィールド。

    source_image_vector
    sparseIndexField

    string

    疎ベクトルのインデックスフィールド。

    sparse_indices
    sparseValueField

    string

    疎ベクトルの値フィールド。

    sparse_values
    dimension

    string

    ベクターディメンション。

    128
    vectorIndexType

    string

    ベクターインデックスアルゴリズム。

    Qc
    distanceType

    string

    距離タイプ。

    SquaredEuclidean
    namespace

    string

    名前空間フィールド。

    namespace
    advanceParams

    object

    インデックススキーマ構成。

    buildIndexParams

    string

    インデックス構築パラメーター。

    { "proxima.qc.builder.quantizer_class": "Int8QuantizerConverter", "proxima.qc.builder.quantize_by_centroid": true, "proxima.qc.builder.optimizer_class": "BruteForceBuilder", "proxima.qc.builder.thread_count": 10, "proxima.qc.builder.optimizer_params": { "proxima.linear.builder.column_major_order": true }, "proxima.qc.builder.store_original_features": false, "proxima.qc.builder.train_sample_count": 3000000, "proxima.qc.builder.train_sample_ratio": 0.5 }
    searchIndexParams

    string

    インデックス取得パラメーター。

    {"proxima.qc.searcher.scan_ratio":0.01}
    minScanDocCnt

    string

    取得候補セット内のドキュメントの最小数。

    20000
    linearBuildThreshold

    string

    線形構築のしきい値。

    5000
    dataProcessConfig

    array<object>

    フィールド処理構成。

    array<object>

    フィールド処理構成。

    operator

    string

    フィールド処理メソッド。 有効な値: copy (ソースフィールドを宛先フィールドにコピーします) と vectorize (モデルを使用してソースフィールドをベクトル化し、ベクトルを宛先フィールドに格納します)。

    vectorize
    dstField

    string

    宛先フィールド。

    source_image_vector
    srcField

    string

    ソースフィールド。

    source_image
    params

    object

    モデル構成。

    vectorModel

    string

    ベクトル化モデル。

    clip
    vectorModal

    string

    データの型。

    image
    srcFieldConfig

    object

    ベクトル化情報のソース。

    ossEndpoint

    string

    OSS リージョンエンドポイント。

    oss-cn-hangzhou-internal.aliyuncs.com

    ossBucket

    string

    OSS バケット。

    test
    uid

    string

    Alibaba Cloud アカウントの ID。

    uid

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "name": "test_oss",
    "status": "IN_USE",
    "dataProcessorCount": 1,
    "partitionCount": 1,
    "dataSource": {
      "type": "odps",
      "dataTimeSec": 1715160176,
      "autoBuildIndex": true,
      "config": {
        "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
        "accessKey": "ak",
        "accessSecret": "as",
        "project": "dp_pdm_marketing_prod",
        "partition": "ds=20220808",
        "table": "test_add",
        "namespace": "namespace",
        "path": "vendor/sebastian/comparator/src/exceptions",
        "ossPath": "/opensearch_index_data/sift_oss_test.data",
        "bucket": "heytea-ops-oss"
      }
    },
    "rawSchema": "{}",
    "primaryKey": "id",
    "fieldSchema": {
      "key": "INT64"
    },
    "vectorIndex": [
      {
        "indexName": "test_odps",
        "vectorField": "source_image_vector",
        "sparseIndexField": "sparse_indices",
        "sparseValueField": "sparse_values",
        "dimension": "128",
        "vectorIndexType": "Qc",
        "distanceType": "SquaredEuclidean",
        "namespace": "namespace",
        "advanceParams": {
          "buildIndexParams": "{\n  \"proxima.qc.builder.quantizer_class\": \"Int8QuantizerConverter\",\n  \"proxima.qc.builder.quantize_by_centroid\": true,\n  \"proxima.qc.builder.optimizer_class\": \"BruteForceBuilder\",\n  \"proxima.qc.builder.thread_count\": 10,\n  \"proxima.qc.builder.optimizer_params\": {\n    \"proxima.linear.builder.column_major_order\": true\n  },\n  \"proxima.qc.builder.store_original_features\": false,\n  \"proxima.qc.builder.train_sample_count\": 3000000,\n  \"proxima.qc.builder.train_sample_ratio\": 0.5\n}",
          "searchIndexParams": "{\"proxima.qc.searcher.scan_ratio\":0.01}",
          "minScanDocCnt": "20000",
          "linearBuildThreshold": "5000"
        }
      }
    ],
    "dataProcessConfig": [
      {
        "operator": "vectorize",
        "dstField": "source_image_vector",
        "srcField": "source_image",
        "params": {
          "vectorModel": "clip",
          "vectorModal": "image",
          "srcFieldConfig": {
            "ossEndpoint": "oss-cn-hangzhou-internal.aliyuncs.com\n",
            "ossBucket": "test",
            "uid": "uid"
          }
        }
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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