Pre-General Availability: 2022-08-18. This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Jump to

• Request
• Response

Get query execution report

get

/20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/executionReport

Request

Supported Media Types

• application/json

Path Parameters

• projectId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of Query Service project
• queryExecutionId: string
  Minimum Length: 1

  Maximum Length: 255

  The ID of the asynchronous request.

Query Parameters

• level: string
  Query execution Report level, supported values are 'BASIC' or 'FULL'

  Default Value: BASIC

  Allowed Values: [ "BASIC", "FULL" ]

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

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

Type: object

Execution Report.

Show Source

• elapsedTime(optional): string
  SQL statement execution time.
• plan(optional): object PlanCollection
  Execution Plan details.
• sqlStatement: string
  SQL statement.
• stats(optional): object StatsCollection
  Execution statistics.
• timeEnded(optional): string(date-time)
  The time the query completed. An RFC3339 formatted datetime string.

  Example: 2019-03-29T09:36:42.000Z
• timeStarted: string(date-time)
  The time the query started. An RFC3339 formatted datetime string.

  Example: 2019-03-29T09:36:42.000Z

{
    "type":"object",
    "description":"Execution Report.",
    "required":[
        "timeStarted",
        "sqlStatement"
    ],
    "properties":{
        "elapsedTime":{
            "type":"string",
            "description":"SQL statement execution time."
        },
        "timeStarted":{
            "type":"string",
            "description":"The time the query started. An RFC3339 formatted datetime string.",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z"
        },
        "timeEnded":{
            "type":"string",
            "description":"The time the query completed. An RFC3339 formatted datetime string.",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z"
        },
        "sqlStatement":{
            "type":"string",
            "description":"SQL statement."
        },
        "stats":{
            "$ref":"#/definitions/StatsCollection"
        },
        "plan":{
            "$ref":"#/definitions/PlanCollection"
        }
    }
}

Nested Schema : PlanCollection

Type: object

Execution Plan details.

Show Source

• items: array items
  Array of query operations.

{
    "type":"object",
    "description":"Execution Plan details.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of query operations.",
            "items":{
                "$ref":"#/definitions/PlanOperationSummary"
            }
        }
    }
}

Nested Schema : StatsCollection

Type: object

Execution statistics.

Show Source

• items: array items
  Array of statistics.

{
    "type":"object",
    "description":"Execution statistics.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of statistics.",
            "items":{
                "$ref":"#/definitions/StatsSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Array of query operations.

Show Source

• Array of: object PlanOperationSummary
  Query execution plan summary

{
    "type":"array",
    "description":"Array of query operations.",
    "items":{
        "$ref":"#/definitions/PlanOperationSummary"
    }
}

Nested Schema : PlanOperationSummary

Type: object

Query execution plan summary

Show Source

• bytes(optional): number(int64)
  Bytes.
• cost(optional): number(int64)
  Operation costs.
• id: number(int64)
  Operation identifier
• ioCosts(optional): number(int64)
  Consumed I/O resources.
• name: string
  Operation name, e.g. TABLE ACCESS BY INDEX ROWID.
• object(optional): string
  Table name.
• ocpuCosts(optional): number(int64)
  Consumed OCPU resources.
• owner(optional): string
  Object's owner
• parentId: number(int64)
  Parent operation identifier
• rawStats(optional): object RawStatsCollection
  Execution raw statistics.

{
    "type":"object",
    "description":"Query execution plan summary",
    "required":[
        "id",
        "parentId",
        "name"
    ],
    "properties":{
        "id":{
            "type":"number",
            "description":"Operation identifier",
            "format":"int64"
        },
        "parentId":{
            "type":"number",
            "description":"Parent operation identifier",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Operation name, e.g. TABLE ACCESS BY INDEX ROWID."
        },
        "ocpuCosts":{
            "type":"number",
            "description":"Consumed OCPU resources.",
            "format":"int64"
        },
        "ioCosts":{
            "type":"number",
            "description":"Consumed I/O resources.",
            "format":"int64"
        },
        "cost":{
            "type":"number",
            "description":"Operation costs.",
            "format":"int64"
        },
        "bytes":{
            "type":"number",
            "description":"Bytes.",
            "format":"int64"
        },
        "object":{
            "description":"Table name.",
            "type":"string"
        },
        "owner":{
            "description":"Object's owner",
            "type":"string"
        },
        "rawStats":{
            "$ref":"#/definitions/RawStatsCollection"
        }
    }
}

Nested Schema : RawStatsCollection

Type: object

Execution raw statistics.

Show Source

• items: array items
  Array of raw statistics.

{
    "type":"object",
    "description":"Execution raw statistics.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of raw statistics.",
            "items":{
                "$ref":"#/definitions/RawStatsSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Array of raw statistics.

Show Source

• Array of: object RawStatsSummary
  Raw statistics

{
    "type":"array",
    "description":"Array of raw statistics.",
    "items":{
        "$ref":"#/definitions/RawStatsSummary"
    }
}

Nested Schema : RawStatsSummary

Type: object

Raw statistics

Show Source

• desc(optional): string
  Raw stat description.
• name: string
  Raw stat name.
• value: number(int64)
  Metric value.

{
    "type":"object",
    "description":"Raw statistics",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Raw stat name."
        },
        "value":{
            "type":"number",
            "description":"Metric value.",
            "format":"int64"
        },
        "desc":{
            "type":"string",
            "description":"Raw stat description."
        }
    }
}

Nested Schema : items

Type: array

Array of statistics.

Show Source

• Array of: object StatsSummary
  Statistics

{
    "type":"array",
    "description":"Array of statistics.",
    "items":{
        "$ref":"#/definitions/StatsSummary"
    }
}

Nested Schema : StatsSummary

Type: object

Statistics

Show Source

• metric: string
  Allowed Values: [ "ELAPSED_TIME", "CPU_TIME", "USER_IO_WAIT_TIME", "CONCURRENCY_WAIT_TIME", "CLUSTER_WAIT_TIME", "PLSQL_EXEC_TIME", "OTHER_WAIT_TIME", "BUFFER_GETS", "DISK_READS", "DIRECT_WRITES", "READ_REQS", "READ_BYTES", "WRITE_REQS", "WRITE_BYTES", "RET_BYTES" ]

  Metric name.
• value: number(int64)
  Metric value.

{
    "type":"object",
    "description":"Statistics",
    "required":[
        "metric",
        "value"
    ],
    "properties":{
        "metric":{
            "type":"string",
            "description":"Metric name.",
            "enum":[
                "ELAPSED_TIME",
                "CPU_TIME",
                "USER_IO_WAIT_TIME",
                "CONCURRENCY_WAIT_TIME",
                "CLUSTER_WAIT_TIME",
                "PLSQL_EXEC_TIME",
                "OTHER_WAIT_TIME",
                "BUFFER_GETS",
                "DISK_READS",
                "DIRECT_WRITES",
                "READ_REQS",
                "READ_BYTES",
                "WRITE_REQS",
                "WRITE_BYTES",
                "RET_BYTES"
            ]
        },
        "value":{
            "type":"number",
            "description":"Metric value.",
            "format":"int64"
        }
    }
}

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

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

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

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

Back to Top