REST API for Oracle NoSQL Database Cloud Service

Get a List of Tables

get

/20190828/tables

Get a list of tables in a compartment.

Request

Query Parameters

compartmentId: string

The ID of a table's compartment.
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.

Response

Supported Media Types

application/json

200 Response

A collection of TableSummary.

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.

Root Schema : TableCollection

Type: object

Results of ListTables.

Show Source

items(optional): array items

A page of TableSummary objects.

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

Nested Schema : items

Type: array

A page of TableSummary objects.

Show Source

Array of: object TableSummary

Summary of the table.

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

Nested Schema : TableSummary

Type: object

Summary of the table.

Show Source

compartmentId: string

Compartment Identifier.
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 on creation.
lifecycleDetails(optional): string

A message describing the current state in more detail.
lifecycleState(optional): string

The state of a table.
name(optional): string

Human-friendly table name, also immutable.
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":"Summary of the table.",
    "type":"object",
    "required":[
        "id",
        "compartmentId"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation.",
            "type":"string"
        },
        "compartmentId":{
            "description":"Compartment Identifier.",
            "type":"string"
        },
        "name":{
            "description":"Human-friendly table name, also immutable.",
            "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",
            "x-obmcs-enumref":"#/definitions/Table/lifecycleState"
        },
        "lifecycleDetails":{
            "type":"string",
            "description":"A message describing the current state in more detail.\n"
        },
        "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 : 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.

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.

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.

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.

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.

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.

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.

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"
        }
    }
}