Jump to

• Request
• Response

Get Table Information

get

/20190828/tables/{tableNameOrId}

Get information of a table by its identifier.

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.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Table 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 : Table

Type: object

Complete metadata about a table.

Show Source

• compartmentId: string
  Compartment Identifier.
• ddlStatement(optional): string
  A DDL statement representing the schema.
• definedTags(optional): object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
• freeformTags(optional): object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• id: string
  Unique identifier that is immutable.
• 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 a table.
• name(optional): string
  Human-friendly table name, immutable.
• schema(optional): object Schema
  The table schema information as a JSON object.
• tableLimits(optional): object TableLimits
  Throughput and storage limits configuration of a table.
• timeCreated(optional): string(date-time)
  The time the the table was created. An RFC3339 formatted datetime string.
• timeUpdated(optional): string(date-time)
  The time the the table's metadata was last updated. An RFC3339 formatted datetime string.

{
    "description":"Complete metadata about a table.",
    "type":"object",
    "required":[
        "id",
        "compartmentId"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable.",
            "type":"string"
        },
        "name":{
            "description":"Human-friendly table name, immutable.",
            "type":"string"
        },
        "compartmentId":{
            "description":"Compartment Identifier.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the the table was created. An RFC3339 formatted\ndatetime string.\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the the table's metadata was last updated. An\nRFC3339 formatted datetime string.\n",
            "type":"string",
            "format":"date-time"
        },
        "tableLimits":{
            "$ref":"#/definitions/TableLimits"
        },
        "lifecycleState":{
            "description":"The state of a table.",
            "type":"string",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "lifecycleDetails":{
            "type":"string",
            "description":"A message describing the current state in more detail.\n"
        },
        "schema":{
            "$ref":"#/definitions/Schema"
        },
        "ddlStatement":{
            "type":"string",
            "description":"A DDL statement representing the schema."
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined\nname, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and\nscoped to a namespace.  Example: `{\"foo-namespace\":\n{\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values\nscoped to a namespace.  Example: `{\"bar-key\": \"value\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean\ntypes are supported.\n"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Defined tags for this resource. Each key is predefined and\nscoped to a namespace.  Example: `{\"foo-namespace\":\n{\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values\nscoped to a namespace.  Example: `{\"bar-key\": \"value\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean\ntypes are supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined\nname, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Nested Schema : Schema

Type: object

The table schema information as a JSON object.

Show Source

• columns: array columns
  The columns of a table.
• primaryKey: array primaryKey
  A list of column names that make up a key.
• shardKey: array shardKey
  A list of column names that make up a key.
• ttl: integer
  The default Time-to-Live for the table, in days.

{
    "description":"The table schema information as a JSON object.",
    "type":"object",
    "required":[
        "columns",
        "primaryKey",
        "shardKey",
        "ttl"
    ],
    "properties":{
        "columns":{
            "description":"The columns of a table.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Column"
            }
        },
        "primaryKey":{
            "description":"A list of column names that make up a key.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "shardKey":{
            "description":"A list of column names that make up a key.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ttl":{
            "description":"The default Time-to-Live for the table, in days.",
            "type":"integer"
        }
    }
}

Nested Schema : TableLimits

Type: object

Throughput and storage limits configuration of a table.

Show Source

• maxReadUnits: integer
  Maximum sustained read throughput limit for the table.
• maxStorageInGBs: integer
  Maximum size of storage used by the table.
• maxWriteUnits: integer
  Maximum sustained write throughput limit for the table.

{
    "description":"Throughput and storage limits configuration of a table.",
    "type":"object",
    "required":[
        "maxReadUnits",
        "maxWriteUnits",
        "maxStorageInGBs"
    ],
    "properties":{
        "maxReadUnits":{
            "description":"Maximum sustained read throughput limit for the table.",
            "type":"integer"
        },
        "maxWriteUnits":{
            "description":"Maximum sustained write throughput limit for the table.",
            "type":"integer"
        },
        "maxStorageInGBs":{
            "description":"Maximum size of storage used by the table.",
            "type":"integer"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values\nscoped to a namespace.  Example: `{\"bar-key\": \"value\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean\ntypes are supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Nested Schema : columns

Type: array

The columns of a table.

Show Source

• Array of: object Column
  A column of a table.

{
    "description":"The columns of a table.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Column"
    }
}

Nested Schema : primaryKey

Type: array

A list of column names that make up a key.

Show Source

• Array of: string

{
    "description":"A list of column names that make up a key.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : shardKey

Type: array

A list of column names that make up a key.

Show Source

• Array of: string

{
    "description":"A list of column names that make up a key.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Column

Type: object

A column of a table.

Show Source

• defaultValue(optional): string
  The column default value.
• isNullable(optional): boolean
  The column nullable flag.
• name(optional): string
  Minimum Length: 1

  Maximum Length: 64

  The column name.
• type(optional): string
  The column type.

{
    "description":"A column of a table.",
    "type":"object",
    "properties":{
        "name":{
            "description":"The column name.",
            "type":"string",
            "maxLength":64,
            "minLength":1
        },
        "type":{
            "description":"The column type.",
            "type":"string"
        },
        "isNullable":{
            "description":"The column nullable flag.",
            "type":"boolean"
        },
        "defaultValue":{
            "description":"The column default value.",
            "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