インデックス一覧の取得

This operation returns information about available indexes for a given table.

GET /indexes

List Indexes

cURL

curl --request GET \
  --url https://cloud.cdata.com/api/indexes \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "results": [
    {
      "affectedRows": 123,
      "schema": [
        {
          "catalogName": "<string>",
          "columnLabel": "<string>",
          "columnName": "<string>",
          "dataTypeName": "<string>",
          "length": 123,
          "nullable": true,
          "ordinal": 123,
          "precision": 123,
          "scale": 123,
          "schemaName": "<string>",
          "tableName": "<string>"
        }
      ],
      "rows": [
        [
          "<unknown>"
        ]
      ]
    }
  ],
  "error": {
    "message": "<string>"
  }
}

承認

Authorization · string · header · 必須

Basic Authentication with username and password. Use your PAT as the password. You can get your PAT from Connect AI by selecting Settings > Access Tokens.

クエリパラメータ

workspace · string

Restricts results to the specified workspace.

catalogName · string

Restricts results to the specified catalog.

schemaName · string

Restricts results to the specified schema.

tableName · string

Restricts results to the specified table.

indexName · string

Restricts results to the specified index.

unique · boolean

If true, only return unique indexes. If false, only return non-unique indexes. The default value is to return all indexes.

レスポンス

200 - application/json

OK

results · object[] | null

Show child attributes

error · object

Show child attributes