Jump to

• Request
• Response

Get Table Usage Information

get

/20190828/tables/{tableNameOrId}/usage

Get the usage information of a table.

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.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

  Default Value: 1000
• 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.
• timeEnd(optional): string(date-time)
  The end time to use for the request.
• timeStart(optional): string(date-time)
  The start time to use for the request. If no time range is set for this request, the most recent complete usage record is returned.

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 TableUsageSummary.

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

Type: object

Result of GetTableUsage.

Show Source

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

{
    "description":"Result of GetTableUsage.",
    "type":"object",
    "properties":{
        "items":{
            "description":"A page of TableUsageSummary objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TableUsageSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

A page of TableUsageSummary objects.

Show Source

• Array of: object TableUsageSummary
  TableUsageSummary represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity. In addition the count of throttling exceptions for the period is reported.

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

Nested Schema : TableUsageSummary

Type: object

TableUsageSummary represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity. In addition the count of throttling exceptions for the period is reported.

Show Source

• readThrottleCount(optional): integer
  The number of times reads were throttled due to exceeding the read throughput limit.
• readUnits(optional): integer
  Read throughput during the sampling period.
• secondsInPeriod(optional): integer
  The length of the sampling period.
• storageInGBs(optional): integer
  The size of the table, in GB.
• storageThrottleCount(optional): integer
  The number of times writes were throttled because the table exceeded its size limit.
• writeThrottleCount(optional): integer
  The number of times writes were throttled due to exceeding the write throughput limit.
• writeUnits(optional): integer
  Write throughput during the sampling period.

{
    "description":"TableUsageSummary represents a single usage record, or slice, that includes\ninformation about read and write throughput consumed during that period\nas well as the current information regarding storage capacity. In\naddition the count of throttling exceptions for the period is reported.\n",
    "type":"object",
    "properties":{
        "secondsInPeriod":{
            "description":"The length of the sampling period.",
            "type":"integer"
        },
        "readUnits":{
            "description":"Read throughput during the sampling period.",
            "type":"integer"
        },
        "writeUnits":{
            "description":"Write throughput during the sampling period.",
            "type":"integer"
        },
        "storageInGBs":{
            "description":"The size of the table, in GB.",
            "type":"integer"
        },
        "readThrottleCount":{
            "description":"The number of times reads were throttled due to exceeding\nthe read throughput limit.\n",
            "type":"integer"
        },
        "writeThrottleCount":{
            "description":"The number of times writes were throttled due to exceeding\nthe write throughput limit.\n",
            "type":"integer"
        },
        "storageThrottleCount":{
            "description":"The number of times writes were throttled because the table\nexceeded its size limit.\n",
            "type":"integer"
        }
    }
}

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