Jump to

• Request
• Response

Get a list of indexes on a table

get

/20190828/tables/{tableNameOrId}/indexes

Request

Path Parameters

• tableNameOrId: string
  A table name within the compartment, or a table OCID.

Query Parameters

• compartmentId(optional): string
  The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
• lifecycleState(optional): string
  Filter list by the lifecycle state of the item.

  Default Value: ALL

  Allowed Values: [ "ALL", "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

  Default Value: 1000
• name(optional): string
  Minimum Length: 1

  Maximum Length: 256

  A shell-globbing-style (*?[]) filter for names.

  Default Value: *
• page: string
  Minimum Length: 1

  Maximum Length: 1024

  The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
• sortBy(optional): string
  The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "name" ]
• sortOrder(optional): string
  The sort order to use, either 'ASC' or 'DESC'.

  Default Value: DESC

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of IndexSummary.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : IndexCollection

Type: object

Results of ListIndexes.

Show Source

• items(optional): array items
  A page of IndexSummary objects.

{
    "description":"Results of ListIndexes.",
    "type":"object",
    "properties":{
        "items":{
            "description":"A page of IndexSummary objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/IndexSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

A page of IndexSummary objects.

Show Source

• Array of: object IndexSummary
  Information about an index.

{
    "description":"A page of IndexSummary objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/IndexSummary"
    }
}

Nested Schema : IndexSummary

Type: object

Information about an index.

Show Source

• keys(optional): array keys
  A set of keys for a secondary index.
• lifecycleDetails(optional): string
  A message describing the current state in more detail.
• lifecycleState(optional): string
  The state of an index.
• name(optional): string
  Index name.

{
    "description":"Information about an index.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Index name.",
            "type":"string"
        },
        "keys":{
            "description":"A set of keys for a secondary index.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/IndexKey"
            }
        },
        "lifecycleState":{
            "description":"The state of an index.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Index/lifecycleState"
        },
        "lifecycleDetails":{
            "type":"string",
            "description":"A message describing the current state in more detail.\n"
        }
    }
}

Nested Schema : keys

Type: array

A set of keys for a secondary index.

Show Source

• Array of: object IndexKey
  Specifies a single key in a secondary index.

{
    "description":"A set of keys for a secondary index.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/IndexKey"
    }
}

Nested Schema : IndexKey

Type: object

Specifies a single key in a secondary index.

Show Source

• columnName: string
  The name of a column to be included as an index key.
• jsonFieldType(optional): string
  If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.
• jsonPath(optional): string
  If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key.

{
    "description":"Specifies a single key in a secondary index.",
    "type":"object",
    "required":[
        "columnName"
    ],
    "properties":{
        "columnName":{
            "description":"The name of a column to be included as an index key.",
            "type":"string"
        },
        "jsonPath":{
            "description":"If the specified column is of type JSON, jsonPath contains\na dotted path indicating the field within the JSON object\nthat will be the index key.\n",
            "type":"string"
        },
        "jsonFieldType":{
            "description":"If the specified column is of type JSON, jsonFieldType contains\nthe type of the field indicated by jsonPath.\n",
            "type":"string"
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry-after: number(float)
  A decimal number representing the number of seconds the client should wait before polling this endpoint again.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Back to Top