All Products
Search
Document Center

OpenSearch:GetTableGeneration

Last Updated:Jul 16, 2024

Queries the status of an index version based on the ID of the full index version.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-pl32rf0js04
tableNamestringYes

The name of the table.

test_summary
generationIdlongYes

The ID of the full index version.

1708674867

Sample requests

GET /openapi/ha3/instances/{instanceId}/tables/{tableName}/index_versions/{generationId}

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

requestId

E7B7D598-B080-5C8E-AA35-D43EC0D5F886
resultobject

The result returned.

generationIdlong

generationId

1708674867
statusstring

starting, building, ready, stopped, failed

ready

Examples

Sample success responses

JSONformat

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "generationId": 1708674867,
    "status": "ready"
  }
}

Error codes

For a list of error codes, visit the Service error codes.