Jump to

• Request
• Response

Create a Table

post

/20190828/tables

Create a new table.

Request

Header Parameters

• opc-request-id: string
  The client request ID for tracing.
• opc-retry-token(optional): string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Body ()

Specifications for the new table.

Root Schema : CreateTableDetails

Type: object

Specifications for the new table.

Show Source

• compartmentId: string
  Compartment Identifier.
• ddlStatement: string
  Complete CREATE TABLE DDL statement.
• 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"}`
• name: string
  Minimum Length: 1

  Maximum Length: 256

  Table name.
• tableLimits: object TableLimits
  Throughput and storage limits configuration of a table.

{
    "description":"Specifications for the new table.",
    "type":"object",
    "required":[
        "name",
        "compartmentId",
        "ddlStatement",
        "tableLimits"
    ],
    "properties":{
        "name":{
            "description":"Table name.",
            "type":"string",
            "maxLength":256,
            "minLength":1
        },
        "compartmentId":{
            "description":"Compartment Identifier.",
            "type":"string"
        },
        "ddlStatement":{
            "description":"Complete CREATE TABLE DDL statement.",
            "type":"string"
        },
        "tableLimits":{
            "$ref":"#/definitions/TableLimits"
        },
        "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.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted the request. The table will be created.

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.
• opc-work-request-id: string
  Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

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

409 Response

Conflict

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