Jump to

• Request
• Response

Get information about an index

get

/20190828/tables/{tableNameOrId}/indexes/{indexName}

Get information about a single index.

Request

Path Parameters

• indexName: string
  The name of a table's index.
• 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.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Index metadata.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : Index

Type: object

Information about an index.

Show Source

• compartmentId(optional): string
  Compartment Identifier.
• 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
  Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

  The state of an index.
• name(optional): string
  Index name.
• tableId(optional): string
  the OCID of the table to which this index belongs.
• tableName(optional): string
  The name of the table to which this index belongs.

{
    "description":"Information about an index.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Index name.",
            "type":"string"
        },
        "compartmentId":{
            "description":"Compartment Identifier.",
            "type":"string"
        },
        "tableName":{
            "description":"The name of the table to which this index belongs.",
            "type":"string"
        },
        "tableId":{
            "description":"the OCID of the table to which this index belongs.",
            "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",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "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