Introduction
Last updated: 2025-06-25
Use the IBM Db2 SaaS API to access data, view and create database objects, administer, and monitor your IBM Db2 SaaS service.
These APIs are applicable only for the Standard and Enterprise Plans.
Java developers can use this SDK to interact with IBM Db2 SaaS.
Node (Javascript) developers can use this SDK to interact with IBM Db2 SaaS.
Python developers can use this SDK to interact with IBM Db2 SaaS.
Go developers can use this SDK to interact with IBM Db2 SaaS.
Security
Every request must include the Authorization HTTP header with the value Bearer [access_token]. An access token can be obtained in one of three ways:
- Using the
/auth/tokensendpoint - Creating an IAM access token
- Generating an IBM Cloud IAM oauth-token
The token is used by IBM Db2 SaaS to identify who you are.
Every request must include the X-Deployment-Id HTTP header with the value of your IBM Db2 SaaS tenant deployment ID (The id starts with crn).
Some API methods (for example: /schemas and /sql_jobs) also support direct access to the database using HTTP headers.
For example:
X-DB-Userid:[database_user],
X-DB-Password:[database_password],
X-DB-URL:jdbc:db2://[host]:[port]/[database]:[property] for Db2 data sources
add dataservertype (DB2LUW, DB2Z) in property, if dataservertype key
for Db2 data source is not specified, the default is DB2LUW.
IBM Db2 SaaS negotiates SSL connections using the TLS v1.2 protocol.
If you are using the latest version of cURL, protocol negotiation will happen automatically using TLS v1.2.
If you are using an older version of cURL, you will need to specify the --tlsv1.2 option in your cURL commands.
authToken
Authorize using Bearer [access_token]. The access token can be obtained by authenticating with the /auth/tokens endpoint or use the API key to generate an IAM Bearer Token.
Value
- API Key
- Header
- Authorization
Third-party libraries
You can optionally use the okhttp jquery httpclientthird-party library to make requests to the console API.
Methods
Request a new access token
Authenticates the user credentials and returns an access token that can be used when invoking the operations.
POST /auth/tokens
Request
User credentials
The user's ID
The user's password
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/auth/tokens" payload := strings.NewReader("{\"userid\":\"<ADD STRING VALUE>\",\"password\":\"<ADD STRING VALUE>\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"userid\":\"<ADD STRING VALUE>\",\"password\":\"<ADD STRING VALUE>\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/auth/tokens") .post(body) .addHeader("content-type", "application/json") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/auth/tokens", "headers": { "content-type": "application/json", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({userid: '<ADD STRING VALUE>', password: '<ADD STRING VALUE>'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"userid\":\"<ADD STRING VALUE>\",\"password\":\"<ADD STRING VALUE>\"}" headers = { 'content-type': "application/json", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/auth/tokens", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/auth/tokens -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"userid":"<ADD STRING VALUE>","password":"<ADD STRING VALUE>"}'
Request
No Request Parameters
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/auth/token/publickey" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/auth/token/publickey") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/auth/token/publickey", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/auth/token/publickey", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/auth/token/publickey -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Sets a new password using dswebToken
Sets a new password using the dswebToken obtained from /auth/reset.
PUT /auth/password
Request
New password and dswebToken
New password
dswebToken received by email
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/auth/password" payload := strings.NewReader("{\"password\":\"<ADD STRING VALUE>\",\"dswebToken\":\"<ADD STRING VALUE>\"}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"password\":\"<ADD STRING VALUE>\",\"dswebToken\":\"<ADD STRING VALUE>\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/auth/password") .put(body) .addHeader("content-type", "application/json") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/auth/password", "headers": { "content-type": "application/json", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({password: '<ADD STRING VALUE>', dswebToken: '<ADD STRING VALUE>'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"password\":\"<ADD STRING VALUE>\",\"dswebToken\":\"<ADD STRING VALUE>\"}" headers = { 'content-type': "application/json", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/auth/password", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/auth/password -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"password":"<ADD STRING VALUE>","dswebToken":"<ADD STRING VALUE>"}'
Copy database to a new provision database
Provision new database by copy from current database
POST /manage/copy_db
Request
name of the new cloned system
Example:
clone-instance-namwregion of the new cloned system
Example:
us-southresource plan id
Example:
dashDBStandardwhether it's HA
Example:
trueresource group
Example:
ea345q3-ddfe34q-sdfdaasdkey protect key
Example:
defaultbackup id
Example:
crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712storage allocated to the new cloned system
Example:
20480tags for the new cloned system
Examples:[ "tag" ]
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/manage/copy_db" payload := strings.NewReader("{\"name\":\"clone-instance-namw\",\"target\":\"us-south\",\"resource_plan_id\":\"dashDBStandard\",\"high_availability\":true,\"resource_group\":\"ea345q3-ddfe34q-sdfdaasd\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\",\"key_protect_key\":\"default\",\"members_disk_allocation_mb\":\"20480\",\"tags\":[\"<ADD STRING VALUE>\"]}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("accept", "application/json") req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"name\":\"clone-instance-namw\",\"target\":\"us-south\",\"resource_plan_id\":\"dashDBStandard\",\"high_availability\":true,\"resource_group\":\"ea345q3-ddfe34q-sdfdaasd\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\",\"key_protect_key\":\"default\",\"members_disk_allocation_mb\":\"20480\",\"tags\":[\"<ADD STRING VALUE>\"]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/manage/copy_db") .post(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/manage/copy_db", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ name: 'clone-instance-namw', target: 'us-south', resource_plan_id: 'dashDBStandard', high_availability: true, resource_group: 'ea345q3-ddfe34q-sdfdaasd', backup_id: 'crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712', key_protect_key: 'default', members_disk_allocation_mb: '20480', tags: ['<ADD STRING VALUE>'] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"name\":\"clone-instance-namw\",\"target\":\"us-south\",\"resource_plan_id\":\"dashDBStandard\",\"high_availability\":true,\"resource_group\":\"ea345q3-ddfe34q-sdfdaasd\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\",\"key_protect_key\":\"default\",\"members_disk_allocation_mb\":\"20480\",\"tags\":[\"<ADD STRING VALUE>\"]}" headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/manage/copy_db", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/manage/copy_db -H 'accept: application/json' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"name":"clone-instance-namw","target":"us-south","resource_plan_id":"dashDBStandard","high_availability":true,"resource_group":"ea345q3-ddfe34q-sdfdaasd","backup_id":"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712","key_protect_key":"default","members_disk_allocation_mb":"20480","tags":["<ADD STRING VALUE>"]}'
Response
task ID of the copy request
Example:
crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:task:3562g234fgsdggdCRN of the new cloned system
Example:
crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01::status of the copy request
Example:
runningcreation time of the copy request
Example:
2020-03-26T02:45:35.000Zname of the new cloned instance
Example:
runningregion of the new cloned instance
Example:
us-south
Status Code
Copy db successfully
Bad request
Error
No Sample Response
Request
Path Parameters
Encoded deployment id
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/connectioninfo/{DEPLOYMENT_ID} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Lists all data load jobs using Db2 load utility technology
Lists all data load jobs for the user.
GET /load_jobs
Request
No Request Parameters
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/load_jobs" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/load_jobs") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/load_jobs", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/load_jobs", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/load_jobs -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Information about a data load job
Load job ID
User ID of who requested the load
Execution status of a data load job
Data load request
Meta information of an resource. Metadata is ready-only and values are auto-generated by the system.
Status Code
Data load jobs
Error payload
No Sample Response
Request
Data load job details
Type of data source. It can take the values 'SERVER', 'S3', or 'IBMCloud'.
Allowable values: [
SERVER,S3,IBMCloud]Schema name where the target table is located
Table name where data should be loaded
Modifies how the source data should be interpreted
- file_options
The character encoding of the source file. Valid values are listed in Supported territory codes and code pages. Default value is "1208" (corresponds to UTF-8).
Specifies whether or not the source file includes column names in a header row. IBM Db2 SaaS does not support this function, so the only acceptable value is NO.
Allowable values: [
no]Default:
noSingle character used as column delimiter. Default value is comma (","). The character can also be specified using the format 0xJJ, where JJ is the hexadecimal representation of the character. Valid delimiters can be hexadecimal values from 0x00 to 0x7F, except for binary zero (0x00), line-feed (0x0A), carriage return (0x0D), space (0x20), and decimal point (0x2E).
Default:
,A valid date format, such as "DD-MM-YY", "YYYY-MMM-DD", "DD/MM/YYY", "M/D/YYYY", "M/DD", "YYYY". For a full list of supported formats, see Valid file type modifiers for the load utility - ASCII file formats (ASC/DEL), in the LOAD command reference.
Default:
YYYY-MM-DDA valid time format, such as "HH-MM-SS", "H:MM:SS TT", "HH:MM", "H:MM TT", "H:M", "H:M:S". For a full list of supported formats, see Valid file type modifiers for the load utility - ASCII file formats (ASC/DEL), in the LOAD command reference.
Default:
HH:MM:SSA valid timestamp format, such as "YYYY-MM-DD HH:MM:SS", "DD/MM/YYYY H:MM TT", "MMM DD YYYY HH:MM:SS TT". For a full list of supported formats, see Valid file type modifiers for the load utility - ASCII file formats (ASC/DEL), in the LOAD command reference.
Default:
YYYY-MM-DD HH:MM:SS
If set to 'INSERT' data is appended to the existing table data. If set to 'REPLACE' the table data is replaced with the data being loaded.
Allowable values: [
INSERT,REPLACE]Default:
INSERTMaximum number of rows to be loaded. If set to zero or not specified, all rows from the source data are loaded. Not supported in multi-partitioned (MPP) IBM Db2 Warehouse SaaS environments.
Default:
0Maximum number of warnings that are tolerated before failing the load operation. A warning is generated for each row that is not loaded correctly.
Default:
1000Required when load_type is set to "S3" or "SOFTLAYER". It specifies how to located the data to be loaded from a cloud storage service.
- cloud_source
URL of the cloud storage endpoint where data is located. Amazon S3 valid endpoints are "s3.amazonaws.com", "s3.us-east-2.amazonaws.com", "s3-us-west-1.amazonaws.com, "s3-us-west-2.amazonaws.com", "s3.ca-central-1.amazonaws.com", "s3.ap-south-1.amazonaws.com", "s3.ap-northeast-2.amazonaws.com", "s3-ap-southeast-1.amazonaws.com", "s3-ap-southeast-2.amazonaws.com", "s3-ap-northeast-1.amazonaws.com", "s3.eu-central-1.amazonaws.com", "s3-eu-west-1.amazonaws.com", "s3.eu-west-2.amazonaws.com", "s3-sa-east-1.amazonaws.com". SoftLayer object storage valid endpoints are "https://ams01.objectstorage.softlayer.net/auth/v1.0", "https://che01.objectstorage.softlayer.net/auth/v1.0", "https://dal05.objectstorage.softlayer.net/auth/v1.0", "https://fra02.objectstorage.softlayer.net/auth/v1.0", "https://hkg02.objectstorage.softlayer.net/auth/v1.0", "https://lon02.objectstorage.softlayer.net/auth/v1.0", "https://mel01.objectstorage.softlayer.net/auth/v1.0", "https://mex01.objectstorage.softlayer.net/auth/v1.0", "https://mil01.objectstorage.softlayer.net/auth/v1.0", "https://mon01.objectstorage.softlayer.net/auth/v1.0", "https://par01.objectstorage.softlayer.net/auth/v1.0", "https://sao01.objectstorage.softlayer.net/auth/v1.0", "https://seo01.objectstorage.softlayer.net/auth/v1.0", "https://sjc01.objectstorage.softlayer.net/auth/v1.0", "https://sng01.objectstorage.softlayer.net/auth/v1.0", "https://syd01.objectstorage.softlayer.net/auth/v1.0", "https://tok02.objectstorage.softlayer.net/auth/v1.0", "https://tor01.objectstorage.softlayer.net/auth/v1.0", "https://wdc.objectstorage.softlayer.net/auth/v1.0".
Path used to find and retrieve the data in the cloud storage service
Username (SoftLayer) or Access Key (S3).
API Key (SoftLayer) or Secret Key (S3).
Required when load_type is set to "SERVER". It specifies how to source filein the server.
- server_source
File path in the server relative to the user's home folder.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/load_jobs" payload := strings.NewReader("{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"cloud_source\":{\"endpoint\":\"<ADD STRING VALUE>\",\"path\":\"<ADD STRING VALUE>\",\"auth_id\":\"<ADD STRING VALUE>\",\"auth_secret\":\"<ADD STRING VALUE>\"},\"server_source\":{\"file_path\":\"<ADD STRING VALUE>\"},\"file_options\":{\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"date_format\":\"YYYY-MM-DD\",\"time_format\":\"HH:MM:SS\",\"timestamp_format\":\"YYYY-MM-DD HH:MM:SS\"}}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"cloud_source\":{\"endpoint\":\"<ADD STRING VALUE>\",\"path\":\"<ADD STRING VALUE>\",\"auth_id\":\"<ADD STRING VALUE>\",\"auth_secret\":\"<ADD STRING VALUE>\"},\"server_source\":{\"file_path\":\"<ADD STRING VALUE>\"},\"file_options\":{\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"date_format\":\"YYYY-MM-DD\",\"time_format\":\"HH:MM:SS\",\"timestamp_format\":\"YYYY-MM-DD HH:MM:SS\"}}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/load_jobs") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/load_jobs", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ load_source: 'SERVER', load_action: 'INSERT', schema: '<ADD STRING VALUE>', table: '<ADD STRING VALUE>', max_row_count: 0, max_warning_count: 1000, cloud_source: { endpoint: '<ADD STRING VALUE>', path: '<ADD STRING VALUE>', auth_id: '<ADD STRING VALUE>', auth_secret: '<ADD STRING VALUE>' }, server_source: {file_path: '<ADD STRING VALUE>'}, file_options: { code_page: '<ADD STRING VALUE>', has_header_row: 'no', column_delimiter: ',', date_format: 'YYYY-MM-DD', time_format: 'HH:MM:SS', timestamp_format: 'YYYY-MM-DD HH:MM:SS' } })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"cloud_source\":{\"endpoint\":\"<ADD STRING VALUE>\",\"path\":\"<ADD STRING VALUE>\",\"auth_id\":\"<ADD STRING VALUE>\",\"auth_secret\":\"<ADD STRING VALUE>\"},\"server_source\":{\"file_path\":\"<ADD STRING VALUE>\"},\"file_options\":{\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"date_format\":\"YYYY-MM-DD\",\"time_format\":\"HH:MM:SS\",\"timestamp_format\":\"YYYY-MM-DD HH:MM:SS\"}}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/load_jobs", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/load_jobs -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"load_source":"SERVER","load_action":"INSERT","schema":"<ADD STRING VALUE>","table":"<ADD STRING VALUE>","max_row_count":0,"max_warning_count":1000,"cloud_source":{"endpoint":"<ADD STRING VALUE>","path":"<ADD STRING VALUE>","auth_id":"<ADD STRING VALUE>","auth_secret":"<ADD STRING VALUE>"},"server_source":{"file_path":"<ADD STRING VALUE>"},"file_options":{"code_page":"<ADD STRING VALUE>","has_header_row":"no","column_delimiter":",","date_format":"YYYY-MM-DD","time_format":"HH:MM:SS","timestamp_format":"YYYY-MM-DD HH:MM:SS"}}'
Response
Confirmation of load job created
Load job ID
User ID of who created the job
Describes the source of the data being loaded
If set to 'INSERT' data is appended to the existing table data. If set to 'REPLACE' the table data is replaced with the data being loaded. The default is 'INSERT'.
Target database name
Schema name where the target table is located
Table name where data will be loaded to
Job overall status
Status Code
load jobs.
Error payload
No Sample Response
Returns details about a load job including its progress
Returns details about a load job including its progress.
GET /load_jobs/{id}Request
Path Parameters
Load job ID
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/load_jobs/{id}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/load_jobs/{id}") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/load_jobs/{id}", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/load_jobs/{id}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/load_jobs/{id} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Information about a data load job
Load job ID
User ID of who requested the load
Execution status of a data load job
Data load request
Meta information of an resource. Metadata is ready-only and values are auto-generated by the system.
Status Code
Data load job
Not authorized to access load job
Job not found
Error payload
No Sample Response
Removes load job from history
Removes a data load job from history. This operation has no effect on the data already loaded. In-progress jobs cannot be deleted.
DELETE /load_jobs/{id}Request
Path Parameters
Load job ID
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/load_jobs/{id}" req, _ := http.NewRequest("DELETE", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/load_jobs/{id}") .delete(null) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "DELETE", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/load_jobs/{id}", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("DELETE", "/dbapi/v4/load_jobs/{id}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X DELETE https://{HOSTNAME}/dbapi/v4/load_jobs/{id} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Downloads log file for a data load job
Downloads log file for a data load job
GET /load_jobs/{log_path}/logRequest
Path Parameters
Base64 encode and URL encode with ([deployment id]/[log file name]) the log file name we can get from /load_jobs/{id}
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/load_jobs/{log_path}/log" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "file") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/load_jobs/{log_path}/log") .get() .addHeader("content-type", "file") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/load_jobs/{log_path}/log", "headers": { "content-type": "file", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "file", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/load_jobs/{log_path}/log", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/load_jobs/{log_path}/log -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: file' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Request
No Request Parameters
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/db_update" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/db_update") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/db_update", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/db_update", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/db_update -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Request
db2 version
Example:
1.9.1leave it as empty
Default:
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/db_update" payload := strings.NewReader("{\"scheduled_timestamp\":\"<ADD STRING VALUE>\",\"target_version\":\"1.9.1\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("accept", "application/json") req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"scheduled_timestamp\":\"<ADD STRING VALUE>\",\"target_version\":\"1.9.1\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/db_update") .post(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/db_update", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({scheduled_timestamp: '<ADD STRING VALUE>', target_version: '1.9.1'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"scheduled_timestamp\":\"<ADD STRING VALUE>\",\"target_version\":\"1.9.1\"}" headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/db_update", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/db_update -H 'accept: application/json' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"scheduled_timestamp":"<ADD STRING VALUE>","target_version":"1.9.1"}'
Response
- task
Example:
crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712Example:
crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01::Example:
completedExample:
10
Status Code
Db2 database update was triggered successfully.
Bad request
Error
No Sample Response
Query the list of object schemas
Query the list of object schemas.
GET /admin/schemas/obj_type/{obj_type}Request
Path Parameters
Object type.
Allowable values: [
table,hadooptable,view,index,mqt,alias,sequence,procedure,nickname,udt,function,datalake_table]
Query Parameters
Object type.
Whether to show system objects.
Allowable values: [
true,false]The amount of return records.
Default:
500
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Create schema
Creates a new schema. Any user with enough database authority can create schemas using dbapi directly. Regular users can create new schemas indirectly by creating a new table or other database object and specifying the name of the new schema where the object will be placed.
POST /admin/schemas
Request
Schema name.
Example:
TESTSCHEMAAuthorization ID.
Example:
SYSIBM
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas" payload := strings.NewReader("{\"name\":\"TESTSCHEMA\",\"authorization\":\"SYSIBM\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"name\":\"TESTSCHEMA\",\"authorization\":\"SYSIBM\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({name: 'TESTSCHEMA', authorization: 'SYSIBM'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"name\":\"TESTSCHEMA\",\"authorization\":\"SYSIBM\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/schemas", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/schemas -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"name":"TESTSCHEMA","authorization":"SYSIBM"}'
Drops multiple schemas
Drops multiple schema. An error is returned if the schema contains any objects.
PUT /admin/schemas/delete
Request
Schema name.
Example:
TESTSCHEMA
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/delete" payload := strings.NewReader("[{\"name\":\"TESTSCHEMA\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"name\":\"TESTSCHEMA\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/delete") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/delete", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{name: 'TESTSCHEMA'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"name\":\"TESTSCHEMA\"}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/schemas/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/schemas/delete -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"name":"TESTSCHEMA"}]'
Request
Query Parameters
Object type.
Allowable values: [
TABLE,VIEW,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,SCHEMA,UDT]Schema name of the object. For table and database, this parameter is not required.
Name of the object. For database, this parameter is not required.
The amount of return records.
Default:
1000
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Request
Allowable values: [
VIEW,SCHEMA,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,INDEX,TABLESPACE]Example:
VIEWDefault:
1000Example:
10- filter
Example:
SYSCATExample:
TABLES
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges" payload := strings.NewReader("{\"obj_type\":\"VIEW\",\"rows_return\":10,\"filter\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\"}]}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"obj_type\":\"VIEW\",\"rows_return\":10,\"filter\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\"}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ obj_type: 'VIEW', rows_return: 10, filter: [{schema: 'SYSCAT', obj_name: 'TABLES'}] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"obj_type\":\"VIEW\",\"rows_return\":10,\"filter\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\"}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/privileges", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/privileges -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"obj_type":"VIEW","rows_return":10,"filter":[{"schema":"SYSCAT","obj_name":"TABLES"}]}'
Request
Example:
true- privileges
Example:
SYSCATExample:
TABLESAllowable values: [
VIEW,SCHEMA,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,INDEX,TABLESPACE]Example:
VIEW- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges" payload := strings.NewReader("{\"stop_on_error\":true,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"stop_on_error\":true,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ stop_on_error: true, privileges: [ { schema: 'SYSCAT', obj_name: 'TABLES', obj_type: 'VIEW', grantee: {authid: 'PUBLIC', authid_type: 'GROUP'}, grant: ['select'], revoke: ['insert'] } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"stop_on_error\":true,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/privileges", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/privileges -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"stop_on_error":true,"privileges":[{"schema":"SYSCAT","obj_name":"TABLES","obj_type":"VIEW","grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["select"],"revoke":["insert"]}]}'
Request
Query Parameters
Type of operation.
Allowable values: [
more]
Only when the action is more, this parameter is needed.
- objects
Schema name.
Example:
SCHEMA_NAME
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - depobj = Generates the basic DDL statements. - privilege = Generate the authorization DDL statements such as GRANT statements.
Examples:[ "depobj", "privilege" ]Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Example:
;
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/ddl?action=more" payload := strings.NewReader("{\"objects\":[{\"schema\":\"SCHEMA_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"objects\":[{\"schema\":\"SCHEMA_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/ddl?action=more") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/ddl?action=more", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({objects: [{schema: 'SCHEMA_NAME'}], options: [{}], stat_terminator: ';'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"objects\":[{\"schema\":\"SCHEMA_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/schemas/ddl?action=more", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/schemas/ddl?action=more' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"objects":[{"schema":"SCHEMA_NAME"}],"options":[{}],"stat_terminator":";"}'
Request
Schema name of the object.
Example:
TABLE_SCHEMAUnqualified name of the object.
Example:
TABLE_NAME- column_info
Data type
Example:
DECIMALMaximum length of the data; 0 for distinct types. The LENGTH column indicates precision for DECIMAL fields, and indicates the number of bytes of storage required for decimal floating-point columns; that is, 8 and 16 for DECFLOAT(16) and DECFLOAT(34), respectively.
Example:
5Scale if the column type is DECIMAL or number of digits of fractional seconds if the column type is TIMESTAMP; 0 otherwise.
Name of the column.
Example:
COL_NAMENullability attribute for the column.
Example:
true
Use object storage or not.
Example:
Y
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables" payload := strings.NewReader("{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"objStorage\":\"Y\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"objStorage\":\"Y\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ schema: 'TABLE_SCHEMA', table: 'TABLE_NAME', objStorage: 'Y', column_info: [ { data_type: 'DECIMAL', length: 5, scale: {}, column_name: 'COL_NAME', nullable: true } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"objStorage\":\"Y\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/tables", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/tables -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"schema":"TABLE_SCHEMA","table":"TABLE_NAME","objStorage":"Y","column_info":[{"data_type":"DECIMAL","length":5,"scale":{},"column_name":"COL_NAME","nullable":true}]}'
Request
Example:
TABLE_SCHEMAExample:
TABLE_NAME
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/delete" payload := strings.NewReader("[{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/delete") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/delete", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'TABLE_SCHEMA', table: 'TABLE_NAME'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\"}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/tables/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/tables/delete -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"TABLE_SCHEMA","table":"TABLE_NAME"}]'
Get table definition
Get table definition.
GET /admin/schemas/{schema_name}/tables/{table_name}/definitionRequest
Path Parameters
Schema name of the object.
Table name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Query table data
Fetches the table data up to a maximum of 100,000 rows. Currently it's not possible to retrieve data from tables that contain CLOB, BLOB or DBCLOB values.
GET /admin/schemas/{schema_name}/tables/{table_name}/dataRequest
Path Parameters
Schema name of the object.
Table name.
Query Parameters
The amount of return records.
Default:
1000
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get column detail properties
Get column detail properties.
GET /admin/schemas/{schema_name}/tables/{table_name}/columns/{column_name}/propertiesRequest
Path Parameters
Schema name of the object.
Table name.
Column name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the column.
Unqualified name of the table, view, or nickname that contains the column.
Schema name of the table, view, or nickname that contains the column.
Unqualified name of the data type for the column.
Maximum length of the data; 0 for distinct types.
Scale if the column type is DECIMAL or number of digits of fractional seconds if the column type is TIMESTAMP; 0 otherwise.
Nullability attribute for the column.
Default value for the column of a table expressed as a constant, special register, or cast-function appropriate for the data type of the column. Can also be the keyword NULL. Values might be converted from what was specified as a default value. For example, date and time constants are shown in ISO format, cast-function names are qualified with schema names, and identifiers are delimited. Null value if a DEFAULT clause was not specified or the column is a view column.
Whether the column is logged.
Whether the column is compacted.
Compress.
Identity.
Type of generated column.
Row change timestamp.
Start value of the sequence. The null value if the sequence is an alias.
Increment value. The null value if the sequence is an alias.
Minimum value of the sequence. The null value if the sequence is an alias.
Maximum value of the sequence. The null value if the sequence is an alias.
Indicates whether or not the sequence can continue to generate values after reaching its maximum or minimum value.
Number of sequence values to pre-allocate in memory for faster access. 0 indicates that values of the sequence are not to be preallocated. In a partitioned database, this value applies to each database partition. -1 if the sequence is an alias.
Indicates whether or not the sequence numbers must be generated in order of request.
Maximum size in bytes of the internal representation of an instance of an XML document, a structured type, or a LOB data type, that can be stored in the base table; 0 when not applicable.
Whether it is a primary key.
The column's numerical position within the table's distribution key; 0 or the null value if the column is not in the distribution key. The null value for columns of subtables and hierarchy tables.
Status Code
Get column detail properties.
Not authorized.
Object not found.
Error payload
No Sample Response
Request
No Request Parameters
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/meta/datatype" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/meta/datatype") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/meta/datatype", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/tables/meta/datatype", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/tables/meta/datatype -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Whether it is an identity column.
Unqualified name of the data type.
Whether there is a data type check constraint.
Default length of the data.
Maximum length of the data.
Default precision of the data.
Maximum precision of the data.
Scale for distinct types or reference representation types based on the built-in DECIMAL type; the number of digits of fractional seconds for distinct types based on the built-in TIMESTAMP type; 6 for the built-in TIMESTAMP type; 0 for all other types (including DECIMAL itself).
Status Code
Get the metadata type.
Error payload
No Sample Response
Request
Query Parameters
Type of operation.
Allowable values: [
create,alter,more]
Schema name of the object. Only When the action is create or alter, this parameter is needed.
Example:
TABLE_SCHEMAUnqualified name of the object. Only When the action is create or alter, this parameter is needed.
Example:
TABLE_NAMEOnly When the action is create or alter, this parameter is needed.
- column_info
Data type
Example:
DECIMALMaximum length of the data; 0 for distinct types. The LENGTH column indicates precision for DECIMAL fields, and indicates the number of bytes of storage required for decimal floating-point columns; that is, 8 and 16 for DECFLOAT(16) and DECFLOAT(34), respectively.
Example:
5Scale if the column type is DECIMAL or number of digits of fractional seconds if the column type is TIMESTAMP; 0 otherwise.
Name of the column.
Example:
COL_NAMENullability attribute for the column.
Example:
true
Use object storage or not.
Example:
YOnly when the action is more, this parameter is needed.
- objects
Schema name of the object.
Example:
TABLE_SCHEMAUnqualified name of the object.
Example:
TABLE_NAME
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - view = Generate the CREATE VIEW DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
Examples:[ "create", { "creatorname": "creatorID" }, "depobj", "view", "privilege" ]Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Example:
;
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create" payload := strings.NewReader("{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"objStorage\":\"Y\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}],\"objects\":[{\"schema\":\"TABLE_SCHEMA\",\"name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"objStorage\":\"Y\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}],\"objects\":[{\"schema\":\"TABLE_SCHEMA\",\"name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/ddl?action=create", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ schema: 'TABLE_SCHEMA', table: 'TABLE_NAME', objStorage: 'Y', column_info: [ { data_type: 'DECIMAL', length: 5, scale: {}, column_name: 'COL_NAME', nullable: true } ], objects: [{schema: 'TABLE_SCHEMA', name: 'TABLE_NAME'}], options: [{}], stat_terminator: ';' })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"objStorage\":\"Y\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}],\"objects\":[{\"schema\":\"TABLE_SCHEMA\",\"name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/tables/ddl?action=create", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"schema":"TABLE_SCHEMA","table":"TABLE_NAME","objStorage":"Y","column_info":[{"data_type":"DECIMAL","length":5,"scale":{},"column_name":"COL_NAME","nullable":true}],"objects":[{"schema":"TABLE_SCHEMA","name":"TABLE_NAME"}],"options":[{}],"stat_terminator":";"}'
Get distributin keys
Get distributin keys.
GET /admin/schemas/{schema_name}/tables/{table_name}/distribution_keysRequest
Path Parameters
Schema name of the table.
Name of the table.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get data distributin property
Get data distributin property.
GET /admin/schemas/{schema_name}/tables/{table_name}/distributions/propertiesRequest
Path Parameters
Schema name of the table.
Name of the table.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get partition expressions
Get partition expressions.
GET /admin/schemas/{schema_name}/tables/{table_name}/partitions/expressionsRequest
Path Parameters
Schema name of the table.
Name of the table.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get data partitions
Get data partitions.
GET /admin/schemas/{schema_name}/tables/{table_name}/partitionsRequest
Path Parameters
Schema name of the table.
Name of the table.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the data partition.
Inclusiveness
Low key value (a string representation of an SQL value) for this data partition.
High key value (a string representation of an SQL value) for this data partition.
Table space for this data partition.
Table space that stores long data.
Table spaces indexed by all partitions of this data partition.
Status Code
Get data partitions.
Invalid parameters.
Not authorized.
Error payload
No Sample Response
Request
Target table space of move.
Example:
TABLE_SPACE- tables
Name of the the schema.
Name of the the table.
Name of the source table space.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/move_activity" payload := strings.NewReader("{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"table_space\":\"<ADD STRING VALUE>\"}]}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"table_space\":\"<ADD STRING VALUE>\"}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/move_activity") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/move_activity", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ table_space: 'TABLE_SPACE', tables: [ { schema_name: '<ADD STRING VALUE>', table_name: '<ADD STRING VALUE>', table_space: '<ADD STRING VALUE>' } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"table_space\":\"<ADD STRING VALUE>\"}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/tables/move_activity", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/tables/move_activity -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"table_space":"TABLE_SPACE","tables":[{"schema_name":"<ADD STRING VALUE>","table_name":"<ADD STRING VALUE>","table_space":"<ADD STRING VALUE>"}]}'
Move tables script
Get script of move tables to another tablespace.
POST /admin/tables/move_activity/script
Request
Target table space of move.
Example:
TABLE_SPACE- tables
Name of the the schema.
Name of the the table.
Name of the source table space.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/move_activity/script" payload := strings.NewReader("{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"table_space\":\"<ADD STRING VALUE>\"}]}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"table_space\":\"<ADD STRING VALUE>\"}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/move_activity/script") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/move_activity/script", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ table_space: 'TABLE_SPACE', tables: [ { schema_name: '<ADD STRING VALUE>', table_name: '<ADD STRING VALUE>', table_space: '<ADD STRING VALUE>' } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"table_space\":\"<ADD STRING VALUE>\"}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/tables/move_activity/script", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/tables/move_activity/script -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"table_space":"TABLE_SPACE","tables":[{"schema_name":"<ADD STRING VALUE>","table_name":"<ADD STRING VALUE>","table_space":"<ADD STRING VALUE>"}]}'
Request
Target table space of copy.
Example:
TABLE_SPACE- tables
Name of the the schema.
Name of the the table.
Name of the target schema.
Name of the target table.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/copy_activity" payload := strings.NewReader("{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"target_schema\":\"<ADD STRING VALUE>\",\"target_table\":\"<ADD STRING VALUE>\"}]}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"target_schema\":\"<ADD STRING VALUE>\",\"target_table\":\"<ADD STRING VALUE>\"}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/copy_activity") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/copy_activity", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ table_space: 'TABLE_SPACE', tables: [ { schema_name: '<ADD STRING VALUE>', table_name: '<ADD STRING VALUE>', target_schema: '<ADD STRING VALUE>', target_table: '<ADD STRING VALUE>' } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"target_schema\":\"<ADD STRING VALUE>\",\"target_table\":\"<ADD STRING VALUE>\"}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/tables/copy_activity", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/tables/copy_activity -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"table_space":"TABLE_SPACE","tables":[{"schema_name":"<ADD STRING VALUE>","table_name":"<ADD STRING VALUE>","target_schema":"<ADD STRING VALUE>","target_table":"<ADD STRING VALUE>"}]}'
Copy tables script
Get script of copy tables to another tablespace.
POST /admin/tables/copy_activity/script
Request
Target table space of copy.
Example:
TABLE_SPACE- tables
Name of the the schema.
Name of the the table.
Name of the target schema.
Name of the target table.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/copy_activity/script" payload := strings.NewReader("{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"target_schema\":\"<ADD STRING VALUE>\",\"target_table\":\"<ADD STRING VALUE>\"}]}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"target_schema\":\"<ADD STRING VALUE>\",\"target_table\":\"<ADD STRING VALUE>\"}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/copy_activity/script") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/copy_activity/script", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ table_space: 'TABLE_SPACE', tables: [ { schema_name: '<ADD STRING VALUE>', table_name: '<ADD STRING VALUE>', target_schema: '<ADD STRING VALUE>', target_table: '<ADD STRING VALUE>' } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"table_space\":\"TABLE_SPACE\",\"tables\":[{\"schema_name\":\"<ADD STRING VALUE>\",\"table_name\":\"<ADD STRING VALUE>\",\"target_schema\":\"<ADD STRING VALUE>\",\"target_table\":\"<ADD STRING VALUE>\"}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/tables/copy_activity/script", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/tables/copy_activity/script -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"table_space":"TABLE_SPACE","tables":[{"schema_name":"<ADD STRING VALUE>","table_name":"<ADD STRING VALUE>","target_schema":"<ADD STRING VALUE>","target_table":"<ADD STRING VALUE>"}]}'
Get the latest status after last updated time
Get the latest status after last updated time.
POST /admin/tables/tasks/status
Request
Last updated time.
Example:
1684828233690
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tables/tasks/status" payload := strings.NewReader("{\"last_updated_time\":1684828233690}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"last_updated_time\":1684828233690}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tables/tasks/status") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tables/tasks/status", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({last_updated_time: 1684828233690})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"last_updated_time\":1684828233690}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/tables/tasks/status", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/tables/tasks/status -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"last_updated_time":1684828233690}'
Query view detail properties
Query view detail properties.
GET /admin/schemas/{schema_name}/views/{view_name}/propertiesRequest
Path Parameters
Schema name of the view.
Name of the view.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the view.
Schema name of the view.
View check.
Whether it is read-only.
Whether it is valid.
Whether to optimize the query.
Authorization ID of the owner of the view.
Owner type.
Time at which the object was created.
Time at which the object was last altered.
Time at which any change was last made to recorded statistics for this object. The null value if statistics are not collected.
Full text of the view CREATE statement, exactly as typed.
Status Code
Query view detail properties.
Not authorized.
Object not found.
Error payload
No Sample Response
Request
Schema name.
Example:
VIEW_SCHEMAView name.
Example:
VIEW_NAME
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/views/delete" payload := strings.NewReader("[{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/views/delete") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/views/delete", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'VIEW_SCHEMA', view: 'VIEW_NAME'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/views/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/views/delete -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"VIEW_SCHEMA","view":"VIEW_NAME"}]'
Request
Path Parameters
Schema name of the object.
View name.
Query Parameters
The amount of return records.
Default:
1000
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get View definition
Get view definition.
GET /admin/schemas/{schema_name}/views/{view_name}/definitionRequest
Path Parameters
Schema name of the object.
View name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Request
Query Parameters
Type of operation.
Allowable values: [
create,alter,more]
Schema name. Only When the action is create or alter, this parameter is needed.
Example:
VIEW_SCHEMAView name. This parameter is required to modify the view.
Example:
VIEW_NAMEOnly when the action is more, this parameter is needed.
- objects
Schema name.
Example:
VIEW_SCHEMAView name.
Example:
VIEW_NAME
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
Examples:[ "create", { "creatorname": "creatorID" }, "depobj", "privilege" ]Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Example:
;
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/views/ddl?action=create" payload := strings.NewReader("{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\",\"objects\":[{\"schema\":\"VIEW_SCHEMA\",\"name\":\"VIEW_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\",\"objects\":[{\"schema\":\"VIEW_SCHEMA\",\"name\":\"VIEW_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/views/ddl?action=create") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/views/ddl?action=create", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ schema: 'VIEW_SCHEMA', view: 'VIEW_NAME', objects: [{schema: 'VIEW_SCHEMA', name: 'VIEW_NAME'}], options: [{}], stat_terminator: ';' })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\",\"objects\":[{\"schema\":\"VIEW_SCHEMA\",\"name\":\"VIEW_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/views/ddl?action=create", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/views/ddl?action=create' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"schema":"VIEW_SCHEMA","view":"VIEW_NAME","objects":[{"schema":"VIEW_SCHEMA","name":"VIEW_NAME"}],"options":[{}],"stat_terminator":";"}'
Get the dependencies of the object
Get the dependencies of the object.
GET /admin/schemas/{schema_name}/{obj_type}/{object_name}/dependenciesRequest
Path Parameters
Schema name of the object.
Type of object.
Allowable values: [
tables,views,nicknames,sequences,aliases,mqts,procedures,functions,udts]Name of the object.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get the dependencies of the tablespace
Get the dependencies of the tablespace.
GET /admin/tablespaces/{tablespace}/dependenciesRequest
Path Parameters
Tablespace name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Query bufferpool detail properties
Query bufferpool detail properties.
GET /admin/bufferpools/{bufferpool_name}/propertiesRequest
Path Parameters
Name of the object.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the buffer pool.
Whether the buffer pool is automatically managed by DB2.
Number of pages in a block.
Default number of pages in this buffer pool on database partitions in this database partition group.
Number of pages of the buffer pool that are to be in a block-based area. A block-based area of the buffer pool is only used by prefetchers doing a sequential prefetch.
Page size for this buffer pool on database partitions in this database partition group.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query constraint detail properties
Query constraint detail properties.
GET /admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/propertiesRequest
Path Parameters
Schema name of the object.
Table name.
Name of the constraint.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the constraint.
Unqualified name of the table to which this constraint applies.
Schema name of the table to which this constraint applies.
Indicates the constraint type.
Referencing key.
Referencing table.
Referencing schema.
Whether it is a enforce constraint.
Members.
Update rule.
Delete rule.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query index detail properties
Query index detail properties.
GET /admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/propertiesRequest
Path Parameters
Schema name of the object.
Table name.
Name of the index.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the index.
Schema name of the index.
Name of the column.
Unqualified name of the table or nickname on which the index is defined.
Schema name of the table or nickname on which the index is defined.
Name of the table space.
Type of index.
Whether it is unique.
Whether it is a clustering index
Specifies whether index compression is activated
Whether the index supports reverse scanning
Percentage of each index page to be reserved during the initial building of the index.
Percentage of each index level 2 page to be reserved during initial building of the index.
Authorization ID of the owner of the index.
Owner type.
Whether it is system generated.
Time when the index was created.
Date when the index was last used by any DML statement to perform a scan, or used to enforce referential integrity constraints. This column is not updated when the index is used on an HADR standby database, nor is it updated when rows are inserted into the table on which the index is defined. The default value is '0001-01-01'. This value is updated asynchronously not more than once within a 24 hour period and might not reflect usage within the last 15 minutes.
Last time that any change was made to the recorded statistics for this index. The null value if no statistics are available.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query trigger detail properties
Query trigger detail properties.
GET /admin/schemas/{schema_name}/triggers/{trigger_name}/propertiesRequest
Path Parameters
Schema name of the object.
Name of the trigger.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the trigger.
Unqualified name of the table or view to which this trigger applies.
Schema name of the table or view to which this trigger applies.
Schema name of the trigger.
Time at which triggered actions are applied to the base table, relative to the event that fired the trigger.
Event that fires the trigger.
evel of granularity.
Whether the trigger is valid.
Indicates whether the trigger is secure for row and column access control.
Full text of the CREATE TRIGGER statement, exactly as typed.
User-provided comments, or the null value.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query MQT detail properties
Query MQT detail properties.
GET /admin/schemas/{schema_name}/mqts/{mqt_name}/propertiesRequest
Path Parameters
Schema name of the object.
Name of the MQT.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the materialized query table.
Schema name of the materialized query table.
Name of the primary table space for the table.
Name of the table space that holds all indexes created on this table.
Name of the table space that holds all long data (LONG or LOB column types) for this table.
Authorization ID of the owner of the materialized query table.
Owner type.
Table organization.
Compression mode for the table.
Row compression mode for the table.
Refresh mode.
Percentage of each page to be reserved for future inserts.
Drop rule.
Volatile.
For row-organized tables, controls how rows are inserted into pages.
Data capture.
Indicates the preferred lock granularity for tables that are accessed by data manipulation language (DML) statements.
Specifies whether the created temporary table is logged.
For REFRESH = 'D' or 'O', time at which the data was last refreshed (REFRESH TABLE statement); null value otherwise.
Time at which the object was created.
Time at which the object was last altered.
Time at which any change was last made to recorded statistics for this object. The null value if statistics are not collected.
Properties for a table.
Full text of the materialized query table CREATE statement, exactly as typed.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query UDF detail properties
Query UDF detail properties.
GET /admin/schemas/{schema_name}/functions/{specific_name}/propertiesRequest
Path Parameters
Schema name of the object.
Name of the UDF.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the UDF.
Schema name of the UDF.
The full text of the CREATE FUNCTION statement.
Name of the routine instance (might be system-generated).
Implementation language for the routine body (or for the source function body, if this function is sourced on another function).
Parameter style that was declared when the routine was created.
Indicates what type of SQL statements, if any, the database manager should assume is contained in the routine.
Whether the result is deterministic.
Whether the function has external side-effects.
Indicates whether the transaction is committed on successful return from this procedure.
Whether the routine can be executed in parallel.
Indicates if there is a fence.
Implementation
Authorization ID of the owner.
Owner type.
Time at which the object was created.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query tablespace detail properties
Query tablespace detail properties.
GET /admin/tablespaces/{table_space}/propertiesRequest
Path Parameters
Tablespace name of the object.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/tablespaces/{table_space}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/tablespaces/{table_space}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the table space.
Name of the database partition group that is associated with this table space.
Name of the buffer pool.
Name of the storage group the table space is using.
Type of data that can be stored in this table space.
Type of table space.
Indicates if it is reclaimable.
Indicates whether or not tables in this table space can be recovered after a drop table operation.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query procedure detail properties
Query procedure detail properties.
GET /admin/schemas/{schema_name}/procedures/{specific_name}/propertiesRequest
Path Parameters
Schema name of the object.
Name of the procedure.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the procedure.
Schema name of the procedure.
The full text of the CREATE PROCEDURE statement.
Name of the routine instance (might be system-generated).
Implementation language for the routine body (or for the source function body, if this function is sourced on another function).
Parameter style that was declared when the routine was created.
Indicates what type of SQL statements, if any, the database manager should assume is contained in the routine.
Whether the result is deterministic.
Whether the function has external side-effects.
Indicates whether the transaction is committed on successful return from this procedure.
Whether the routine can be executed in parallel.
Indicates if there is a fence.
Implementation.
Authorization ID of the owner.
Owner type.
Time at which the object was created.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query sequence detail properties
Query sequence detail properties.
GET /admin/schemas/{schema_name}/sequences/{sequence_name}/propertiesRequest
Path Parameters
Schema name of the object.
Name of the sequence.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the sequence.
Schema name of the sequence.
Unqualified name of the data type.
Precision of the data type of the sequence.
Start value of the sequence.
Increment value.
Maximum value of the sequence.
Minimum value of the sequence.
Indicates whether or not the sequence can continue to generate values after reaching its maximum or minimum value.
Number of sequence values to pre-allocate in memory for faster access.
Indicates whether or not the sequence numbers must be generated in order of request.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query package detail properties
Query package detail properties.
GET /admin/schemas/{schema_name}/packages/{package_name}/propertiesRequest
Path Parameters
Schema name of the object.
Name of the package.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the package.
Schema name of the package.
Default schema name used for unqualified names in static SQL statements.
Authorization ID of the binder and owner of the package.
Authorization ID of the binder and owner of the package.
Cursor blocking option.
Number of sections in the package.
Optimization class under which this package was bound. Used for rebind operations.
Value of the EXPLSNAP bind option.
SQL path in effect when the package was bound.
Text of the SQL statement.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query UDT detail properties
Query UDT detail properties.
GET /admin/schemas/{schema_name}/udts/{type_name}/propertiesRequest
Path Parameters
Schema name of the object.
Name of the user-defined type.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the data type.
Schema name of the module to which the data type belongs.
Maximum length of the type.
Scale for distinct types or reference representation types based on the built-in DECIMAL type; the number of digits of fractional seconds for distinct types based on the built-in TIMESTAMP type; 6 for the built-in TIMESTAMP type; 0 for all other types (including DECIMAL itself).
For distinct types or array types, the unqualified name of the source data type. For user-defined structured types, the unqualified built-in type name of the reference representation type. Null for other data types.
For distinct types or array types, the schema name of the source data type. For user-defined structured types, the schema name of the built-in type of the reference representation type. Null for other data types.
Meta type.
User-provided comments
Indicates whether the type can be instantiated.
Indicates whether the user-defined type can have subtypes.
Maximum length of a structured type that can be kept with a base table row; 0 otherwise.
Status Code
Returned result was successful.
Not authorized.
Object not found.
Error payload
No Sample Response
Query alias detail properties
Query alias detail properties.
GET /admin/schemas/{schema_name}/aliases/{alias_name}/propertiesRequest
Path Parameters
Schema name of the object.
Alias name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the object.
Schema name of the object.
The name of the object referenced by the alias.
The schema name of the object referenced by the alias.
Authorization ID of the owner.
Owner type.
Time at which the object was created.
Time at which the object was last altered.
Status Code
Query alias detail properties.
Not authorized.
Schema or alias not found.
Error payload
No Sample Response
Get table detail properties
Get table detail properties.
GET /admin/schemas/{schema_name}/tables/{table_name}/propertiesRequest
Path Parameters
Schema name of the object.
Table name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Unqualified name of the object.
Schema name of the object.
Type of object.
Name of the primary table space for the table.
Name of the table space that holds all indexes created on this table.
Name of the table space that holds all long data (LONG or LOB column types) for this table.
Table organization.
Type of temporal table.
Drop rule.
Volatile.
Compression mode for the table.
Row compression mode for the table.
Clustered.
Indicates how data is distributed among database partitions in a partitioned database system.
Average length (in bytes) of both compressed and uncompressed rows in this table; -1 if statistics are not collected.
Status of the object.
For row-organized tables, controls how rows are inserted into pages.
Primary key.
Total number of rows in the table; -1 if statistics are not collected.
Time at which the object was created.
Date when the table was last used by any DML statement or the LOAD command.
Time at which the object was last altered.
Time at which any change was last made to recorded statistics for this object. The null value if statistics are not collected.
Percentage of each page to be reserved for future inserts.
Data capture.
Indicates the preferred lock granularity for tables that are accessed by data manipulation language (DML) statements.
Specifies whether the created temporary table is logged.
Authorization ID of the owner.
Owner type.
Status Code
Get table detail properties.
Not authorized.
Object not found.
Error payload
No Sample Response
Request
The schema of the object based.
Example:
SYSCATThe name of the object based.
Example:
TABLESAlias name.
Example:
ALIAS_NAMEAlias schema.
Example:
ALIAS_SCHEMA
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/aliases" payload := strings.NewReader("{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/aliases") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/aliases", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ base_obj_schema: 'SYSCAT', base_obj_name: 'TABLES', alias_name: 'ALIAS_NAME', alias_schema: 'ALIAS_SCHEMA' })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/aliases", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/aliases -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"base_obj_schema":"SYSCAT","base_obj_name":"TABLES","alias_name":"ALIAS_NAME","alias_schema":"ALIAS_SCHEMA"}'
Request
Alias schema.
Example:
ALIAS_SCHEMAAlias name.
Example:
ALIAS_NAME
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/aliases/delete" payload := strings.NewReader("[{\"schema\":\"ALIAS_SCHEMA\",\"alias\":\"ALIAS_NAME\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"ALIAS_SCHEMA\",\"alias\":\"ALIAS_NAME\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/aliases/delete") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/aliases/delete", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'ALIAS_SCHEMA', alias: 'ALIAS_NAME'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"ALIAS_SCHEMA\",\"alias\":\"ALIAS_NAME\"}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/aliases/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/aliases/delete -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"ALIAS_SCHEMA","alias":"ALIAS_NAME"}]'
Request
Query Parameters
Type of operation.
Allowable values: [
create,more]
The schema of the object based. Only When the action is create, this parameter is needed.
Example:
SYSCATThe name of the object based. Only When the action is create, this parameter is needed.
Example:
TABLESAlias name. Only When the action is create, this parameter is needed.
Example:
ALIAS_NAMEAlias schema. Only When the action is create, this parameter is needed.
Example:
ALIAS_SCHEMAOnly when the action is more, this parameter is needed.
- objects
Schema name of the object.
Example:
ALIAS_SCHEMAUnqualified name of the object.
Example:
ALIAS_NAMESchema name of the based object.
Example:
TABLE_SCHEMAUnqualified name of the based object.
Example:
TABLE_NAME
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - view = Generate the CREATE VIEW DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
Examples:[ "create", { "creatorname": "creatorID" }, "depobj", "view", "privilege" ]Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Example:
;
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create" payload := strings.NewReader("{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\",\"objects\":[{\"schema\":\"ALIAS_SCHEMA\",\"name\":\"ALIAS_NAME\",\"base_schema\":\"TABLE_SCHEMA\",\"base_name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\",\"objects\":[{\"schema\":\"ALIAS_SCHEMA\",\"name\":\"ALIAS_NAME\",\"base_schema\":\"TABLE_SCHEMA\",\"base_name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/aliases/ddl?action=create", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ base_obj_schema: 'SYSCAT', base_obj_name: 'TABLES', alias_name: 'ALIAS_NAME', alias_schema: 'ALIAS_SCHEMA', objects: [ { schema: 'ALIAS_SCHEMA', name: 'ALIAS_NAME', base_schema: 'TABLE_SCHEMA', base_name: 'TABLE_NAME' } ], options: [{}], stat_terminator: ';' })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\",\"objects\":[{\"schema\":\"ALIAS_SCHEMA\",\"name\":\"ALIAS_NAME\",\"base_schema\":\"TABLE_SCHEMA\",\"base_name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/aliases/ddl?action=create", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"base_obj_schema":"SYSCAT","base_obj_name":"TABLES","alias_name":"ALIAS_NAME","alias_schema":"ALIAS_SCHEMA","objects":[{"schema":"ALIAS_SCHEMA","name":"ALIAS_NAME","base_schema":"TABLE_SCHEMA","base_name":"TABLE_NAME"}],"options":[{}],"stat_terminator":";"}'
Request
Path Parameters
Schema name of the object.
Alias name.
Query Parameters
The amount of return records.
Default:
1000
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get the SQL statement template for creating MQT table
Get the SQL statement template for creating MQT table.
POST /admin/mqts/ddl
Request
Query Parameters
Allowable values: [
create,more]
Schema name of the object. Only When the action is create, this parameter is needed.
Example:
schemaNameOnly when the action is more, this parameter is needed.
- objects
Schema name of the object.
Example:
MQT_SCHEMAUnqualified name of the object.
Example:
MQT_NAME
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - view = Generate the CREATE VIEW DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
Examples:[ "create", { "creatorname": "creatorID" }, "depobj", "view", "privilege" ]Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Example:
;
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE" payload := strings.NewReader("{\"schema\":\"schemaName\",\"objects\":[{\"schema\":\"MQT_SCHEMA\",\"name\":\"MQT_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"schemaName\",\"objects\":[{\"schema\":\"MQT_SCHEMA\",\"name\":\"MQT_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ schema: 'schemaName', objects: [{schema: 'MQT_SCHEMA', name: 'MQT_NAME'}], options: [{}], stat_terminator: ';' })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"schema\":\"schemaName\",\"objects\":[{\"schema\":\"MQT_SCHEMA\",\"name\":\"MQT_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"schema":"schemaName","objects":[{"schema":"MQT_SCHEMA","name":"MQT_NAME"}],"options":[{}],"stat_terminator":";"}'
Request
Example:
schemaNameExample:
mqtName
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/mqts/delete" payload := strings.NewReader("[{\"schema\":\"schemaName\",\"mqt\":\"mqtName\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"schemaName\",\"mqt\":\"mqtName\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/mqts/delete") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/mqts/delete", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'schemaName', mqt: 'mqtName'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"schemaName\",\"mqt\":\"mqtName\"}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/mqts/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/mqts/delete -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"schemaName","mqt":"mqtName"}]'
Get the definition of MQT table
Get the definition of MQT table.
GET /admin/schemas/{schema_name}/mqts/{mqt_name}/definitionRequest
Path Parameters
Schema name
mqt name
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get the data of specified mqt table
Get the data of specified mqt table.
GET /admin/schemas/{schema_name}/mqts/{mqt_name}/dataRequest
Path Parameters
Query Parameters
Default:
1000
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get authentications through the authid filter
Get authentications through the authid filter
GET /admin/privileges/authentications
Request
Query Parameters
0 means return all query results
Default:
0
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get the privieles of auth id
Get the privieles of auth id
GET /admin/privileges/{authid_type}/{authid}/{obj_type}Request
Path Parameters
authid type
Allowable values: [
GROUP,USER,ROLE]Authorization id.
Type of object
Allowable values: [
VIEW,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,INDEX,TABLESPACE]
Query Parameters
Default:
1000
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get SQL statement of grant or revoke privileges
Get SQL statement of grant or revoke privileges
POST /admin/privileges/dcl
Request
Example:
SYSCATExample:
TABLESAllowable values: [
VIEW,SCHEMA,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,INDEX,TABLESPACE]Example:
VIEW- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/dcl" payload := strings.NewReader("[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/dcl") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/dcl", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([ { schema: 'SYSCAT', obj_name: 'TABLES', obj_type: 'VIEW', grantee: {authid: 'PUBLIC', authid_type: 'GROUP'}, grant: ['select'], revoke: ['insert'] } ])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/privileges/dcl", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/privileges/dcl -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"SYSCAT","obj_name":"TABLES","obj_type":"VIEW","grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["select"],"revoke":["insert"]}]'
Request
Example:
authid
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/roles" payload := strings.NewReader("{\"authid\":\"authid\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"authid\":\"authid\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/roles", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({authid: 'authid'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"authid\":\"authid\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/privileges/roles", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/privileges/roles -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"authid":"authid"}'
Grant or revoke the privilges of role
Grant or revoke the privilges of role
PUT /admin/privileges/roles
Request
- privileges
Example:
SYSCATExample:
TABLESAllowable values: [
VIEW,SCHEMA,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,INDEX,TABLESPACE]Example:
VIEW- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/roles" payload := strings.NewReader("{\"stop_on_error\":false,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"stop_on_error\":false,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/roles", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ stop_on_error: false, privileges: [ { schema: 'SYSCAT', obj_name: 'TABLES', obj_type: 'VIEW', grantee: {authid: 'PUBLIC', authid_type: 'GROUP'}, grant: ['select'], revoke: ['insert'] } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"stop_on_error\":false,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/privileges/roles", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/privileges/roles -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"stop_on_error":false,"privileges":[{"schema":"SYSCAT","obj_name":"TABLES","obj_type":"VIEW","grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["select"],"revoke":["insert"]}]}'
Request
Path Parameters
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName" req, _ := http.NewRequest("DELETE", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName") .delete(null) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "DELETE", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/roles/roleName", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("DELETE", "/dbapi/v4/admin/privileges/roles/roleName", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X DELETE https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get the membership of authid
Get the membership of authid
GET /admin/privileges/roles/{authid_type}/{authid}Request
Path Parameters
authid type
Allowable values: [
USER,GROUP,ROLE]authid
Query Parameters
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get SQL statement of grant or revoke role
Get SQL statement of grant or revoke role
POST /admin/privileges/roles/dcl
Request
- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl" payload := strings.NewReader("[{\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"<ADD STRING VALUE>\"],\"revoke\":[\"<ADD STRING VALUE>\"]}]") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"<ADD STRING VALUE>\"],\"revoke\":[\"<ADD STRING VALUE>\"]}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/roles/dcl", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([ { grantee: {authid: 'PUBLIC', authid_type: 'GROUP'}, grant: ['<ADD STRING VALUE>'], revoke: ['<ADD STRING VALUE>'] } ])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"<ADD STRING VALUE>\"],\"revoke\":[\"<ADD STRING VALUE>\"]}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/privileges/roles/dcl", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["<ADD STRING VALUE>"],"revoke":["<ADD STRING VALUE>"]}]'
Get SQL statement for grant or revoke privileges
Get SQL statement for grant or revoke privileges
POST /admin/privileges/multiple_objtypes/dcl
Request
- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
- privileges
Allowable values: [
VIEW,SCHEMA,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,INDEX,TABLESPACE]- objects
Example:
SYSCATExample:
TABLES
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl" payload := strings.NewReader("{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}]}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}]}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/multiple_objtypes/dcl", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ grantee: [{authid: 'PUBLIC', authid_type: 'GROUP'}], privileges: [ { obj_type: 'VIEW', grant: ['select'], objects: [{schema: 'SYSCAT', obj_name: 'TABLES', specific_name: '<ADD STRING VALUE>'}] } ] })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}]}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/privileges/multiple_objtypes/dcl", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"privileges":[{"obj_type":"VIEW","grant":["select"],"objects":[{"schema":"SYSCAT","obj_name":"TABLES","specific_name":"<ADD STRING VALUE>"}]}]}'
Grant or revole privileges for multiple objects and objects type
Grant or revole privileges for multiple objects and objects type
PUT /admin/privileges/multiple_objtypes
Request
- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
- privileges
Allowable values: [
VIEW,SCHEMA,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,INDEX,TABLESPACE]- objects
Example:
SYSCATExample:
TABLES
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes" payload := strings.NewReader("{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}],\"stop_on_error\":false}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}],\"stop_on_error\":false}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/multiple_objtypes", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ grantee: [{authid: 'PUBLIC', authid_type: 'GROUP'}], privileges: [ { obj_type: 'VIEW', grant: ['select'], objects: [{schema: 'SYSCAT', obj_name: 'TABLES', specific_name: '<ADD STRING VALUE>'}] } ], stop_on_error: false })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}],\"stop_on_error\":false}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/privileges/multiple_objtypes", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"privileges":[{"obj_type":"VIEW","grant":["select"],"objects":[{"schema":"SYSCAT","obj_name":"TABLES","specific_name":"<ADD STRING VALUE>"}]}],"stop_on_error":false}'
Get the SQL statement for grant or revoke multiple roles
Get the SQL statement for grant or revoke multiple roles
POST /admin/privileges/multiple_roles/dcl
Request
- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl" payload := strings.NewReader("[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}]") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/multiple_roles/dcl", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([ { grantee: [{authid: 'PUBLIC', authid_type: 'GROUP'}], grant: ['SYSTS_USR'], revoke: ['SYSTS_USR'] } ])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/privileges/multiple_roles/dcl", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"grant":["SYSTS_USR"],"revoke":["SYSTS_USR"]}]'
Request
- privileges
- grantee
Example:
PUBLICAllowable values: [
GROUP,ROLE,USER]Example:
GROUP
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles" payload := strings.NewReader("{\"privileges\":[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}],\"stop_on_error\":false}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"privileges\":[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}],\"stop_on_error\":false}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/privileges/multiple_roles", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ privileges: [ { grantee: [{authid: 'PUBLIC', authid_type: 'GROUP'}], grant: ['SYSTS_USR'], revoke: ['SYSTS_USR'] } ], stop_on_error: false })); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"privileges\":[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}],\"stop_on_error\":false}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/privileges/multiple_roles", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"privileges":[{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"grant":["SYSTS_USR"],"revoke":["SYSTS_USR"]}],"stop_on_error":false}'
Request
Query Parameters
Type of operation.
Allowable values: [
create]
Type of the connection attribute.
Allowable values: [
GetWorkloadDDLTemplate,GetWorkloadDDLBySessionAuthID,GetWorkloadDDLByApplName,GetWorkloadDDLByClientIPAddr,GetWorkloadDDLBySystemAuthID,GetWorkloadDDLByClientUserID,GetWorkloadDDLByClientApplName,GetWorkloadDDLByClientWrkstnname,GetWorkloadDDLByClientAcctng]Example:
GetWorkloadDDLTemplateEnable collect activity data or not.
Example:
true
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create" payload := strings.NewReader("{\"categorization\":\"GetWorkloadDDLTemplate\",\"enable_coll_act_data\":true}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"categorization\":\"GetWorkloadDDLTemplate\",\"enable_coll_act_data\":true}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/workloads/ddl?action=create", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({categorization: 'GetWorkloadDDLTemplate', enable_coll_act_data: true})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"categorization\":\"GetWorkloadDDLTemplate\",\"enable_coll_act_data\":true}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/workloads/ddl?action=create", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"categorization":"GetWorkloadDDLTemplate","enable_coll_act_data":true}'
Request
Query Parameters
The amount of return records.
Default:
1000Workload name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Identifier for the workload.
Name of the workload.
Type of the connection attribute. 1 = APPLNAME 2 = SYSTEM_USER 3 = SESSION_USER 4 = SESSION_USER GROUP 5 = SESSION_USER ROLE 6 = CURRENT CLIENT_USERID 7 = CURRENT CLIENT_APPLNAME 8 = CURRENT CLIENT_WRKSTNNAME 9 = CURRENT CLIENT_ACCTNG 10 = ADDRESS
Value of the connection attribute.
Specifies what activity data should be collected by the applicable event monitor. D = Activity data with details N = None S = Activity data with details and section environment V = Activity data with details and values. Applies when the COLLECT column is set to 'C' W = Activity data without details X = Activity data with details, section environment, and values
Specifies what activity data should be collected by the applicable event monitor. D = Activity data with details N = None S = Activity data with details and section environment V = Activity data with details and values. Applies when the COLLECT column is set to 'C' W = Activity data without details X = Activity data with details, section environment, and values
Status Code
Return the list of workloads
Error payload
No Sample Response
Request
Example:
SEQUENCE_SCHEMAExample:
SEQUENCE_NAME
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/sequences/delete" payload := strings.NewReader("[{\"schema\":\"SEQUENCE_SCHEMA\",\"sequence\":\"SEQUENCE_NAME\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("accept", "application/json") req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"SEQUENCE_SCHEMA\",\"sequence\":\"SEQUENCE_NAME\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/sequences/delete") .put(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/sequences/delete", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'SEQUENCE_SCHEMA', sequence: 'SEQUENCE_NAME'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"SEQUENCE_SCHEMA\",\"sequence\":\"SEQUENCE_NAME\"}]" headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/sequences/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/sequences/delete -H 'accept: application/json' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"SEQUENCE_SCHEMA","sequence":"SEQUENCE_NAME"}]'
Request
The schema name of procedure.
Example:
PROCEDURE_SCHEMAThe specific name of procedure.
Example:
PROCEDURE_NAME
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/procedures/delete" payload := strings.NewReader("[{\"schema\":\"PROCEDURE_SCHEMA\",\"procedure\":\"PROCEDURE_NAME\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("accept", "application/json") req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"PROCEDURE_SCHEMA\",\"procedure\":\"PROCEDURE_NAME\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/procedures/delete") .put(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/procedures/delete", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'PROCEDURE_SCHEMA', procedure: 'PROCEDURE_NAME'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"PROCEDURE_SCHEMA\",\"procedure\":\"PROCEDURE_NAME\"}]" headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/procedures/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/procedures/delete -H 'accept: application/json' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"PROCEDURE_SCHEMA","procedure":"PROCEDURE_NAME"}]'
Retrieve parameters for procedure
Retrieve parameters for procedure.
GET /admin/schemas/{schema_name}/procedures/{specific_name}/parametersRequest
Path Parameters
The schema name of the procedure
The specificname of procedure
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the parameter.
Unqualified name of the data type.
Length of the data type.
Scale if the data type is DECIMAL.
Row type of the data type.
Whether the aramater is passed in the form of a locator or not.
Status Code
Retrieve parameters for procedure.
Error information when get procedure parameters.
SQLException
SQLException
Error payload
No Sample Response
Request
Query Parameters
Allowable values: [
create]
The schema name of procedure.
Example:
PROCEDURE_SCHEMA
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create" payload := strings.NewReader("{\"schema\":\"PROCEDURE_SCHEMA\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("accept", "application/json") req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"PROCEDURE_SCHEMA\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create") .post(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/procedures/ddl?action=create", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({schema: 'PROCEDURE_SCHEMA'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"schema\":\"PROCEDURE_SCHEMA\"}" headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/procedures/ddl?action=create", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create' -H 'accept: application/json' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"schema":"PROCEDURE_SCHEMA"}'
Request
The schema name of function.
Example:
UDT_SCHEMAThe specific name of function.
Example:
UDT_NAME
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/functions/delete" payload := strings.NewReader("[{\"schema\":\"UDT_SCHEMA\",\"function\":\"UDT_NAME\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("accept", "application/json") req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"UDT_SCHEMA\",\"function\":\"UDT_NAME\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/functions/delete") .put(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/functions/delete", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'UDT_SCHEMA', function: 'UDT_NAME'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"UDT_SCHEMA\",\"function\":\"UDT_NAME\"}]" headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/functions/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/functions/delete -H 'accept: application/json' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"UDT_SCHEMA","function":"UDT_NAME"}]'
Retrieve parameters for specific udf
Retrieve parameters for specific udf.
GET /admin/schemas/{schema_name}/functions/{specific_name}/parametersRequest
Path Parameters
The schema name of the function.
The specific name of function.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Name of the parameter.
Unqualified name of the data type.
Length of the data type.
Scale if the data type is DECIMAL.
Row type of the data type.
Whether the aramater is passed in the form of a locator or not.
Status Code
Retrieve parameters for specific udf.
Error information when get procedure parameters
SQLException
SQLException
Error payload
No Sample Response
Request
Query Parameters
Allowable values: [
create]
The schema name of function.
Example:
UDF_SCHEMA
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create" payload := strings.NewReader("{\"schema\":\"UDF_SCHEMA\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("accept", "application/json") req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"UDF_SCHEMA\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create") .post(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/functions/ddl?action=create", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({schema: 'UDF_SCHEMA'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"schema\":\"UDF_SCHEMA\"}" headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/functions/ddl?action=create", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create' -H 'accept: application/json' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"schema":"UDF_SCHEMA"}'
Request
Schema name of UDT.
Example:
UDT_SCHEMAName of UDT.
Example:
UDT_NAME
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/udts/delete" payload := strings.NewReader("[{\"schema\":\"UDT_SCHEMA\",\"udt\":\"UDT_NAME\"}]") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"UDT_SCHEMA\",\"udt\":\"UDT_NAME\"}]"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/udts/delete") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "PUT", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/udts/delete", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify([{schema: 'UDT_SCHEMA', udt: 'UDT_NAME'}])); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "[{\"schema\":\"UDT_SCHEMA\",\"udt\":\"UDT_NAME\"}]" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("PUT", "/dbapi/v4/admin/udts/delete", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X PUT https://{HOSTNAME}/dbapi/v4/admin/udts/delete -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '[{"schema":"UDT_SCHEMA","udt":"UDT_NAME"}]'
Retrieve row definition for User-defined Type object
Retrieve row definition for User-defined Type object
GET /admin/schemas/{schema_name}/udts/{udt_name}/definitionRequest
Path Parameters
The schema name of User-defined Type.
The name of User-defined Type.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition") .get() .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Field name.
Unqualified name of the data type of the field.
Attribute name.
Unqualified name of the data type of an attribute.
Position of the field in the definition of the data type, starting with 0.
Length of the data type.
For decimal types, contains the scale of the data type.
Schema name of the data type.
Status Code
Retrieve row definition for User-defined Type object.
Not authorized.
Schema or alias not found.
Error payload
No Sample Response
Generate Create User-defined Types template
Generate Create User-defined Types template.
POST /admin/udts/ddl
Request
Query Parameters
Type of operation.
Allowable values: [
create]
Schema name of UDT.
Example:
UDT_SCHEMA
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create" payload := strings.NewReader("{\"schema\":\"UDT_SCHEMA\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"UDT_SCHEMA\"}"); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create") .post(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/admin/udts/ddl?action=create", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({schema: 'UDT_SCHEMA'})); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") payload = "{\"schema\":\"UDT_SCHEMA\"}" headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/admin/udts/ddl?action=create", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST 'https://{HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}' -d '{"schema":"UDT_SCHEMA"}'
Deletes a file in the Db2 temporary cloud object storage
Deletes a file in the Db2 temporary cloud object storage.
DELETE /home/{path}Request
Path Parameters
File path
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/home/{path}" req, _ := http.NewRequest("DELETE", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/home/{path}") .delete(null) .addHeader("content-type", "application/json") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "DELETE", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/home/{path}", "headers": { "content-type": "application/json", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("DELETE", "/dbapi/v4/home/{path}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X DELETE https://{HOSTNAME}/dbapi/v4/home/{path} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Download file from Db2 temporary cloud object storage
Download file from Db2 temporary cloud object storage.
GET /home_content/{path}Request
Custom Headers
Allowable values: [
application/json,application/octet-stream]
Path Parameters
File path
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/home_content/{path}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/octet-stream") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/home_content/{path}") .get() .addHeader("content-type", "application/octet-stream") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/home_content/{path}", "headers": { "content-type": "application/octet-stream", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/octet-stream", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/home_content/{path}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/home_content/{path} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/octet-stream' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Describes a file or folder.
Relative URL path for this file or folder.
Size in bytes. The size of a folder is the sum of the files directly under it, excluding subfolders.
List of files and folders
- contents
Relative URL path for this file or folder.
Size in bytes. The size of a folder will be -1.
Status Code
Metadata about a file or folder
File not found
Error payload
No Sample Response
Uploads a file to Db2 temporary cloud object storage
Uploads a file to Db2 temporary cloud object storage.
POST /home_content/{path}Request
Path Parameters
Target folder
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/home_content/{path}" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("content-type", "multipart/form-data") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/home_content/{path}") .post(null) .addHeader("content-type", "multipart/form-data") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/home_content/{path}", "headers": { "content-type": "multipart/form-data", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "multipart/form-data", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/home_content/{path}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/home_content/{path} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: multipart/form-data' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Describes a file or folder.
Relative URL path for this file or folder.
Size in bytes. The size of a folder is the sum of the files directly under it, excluding subfolders.
List of files and folders
- contents
Relative URL path for this file or folder.
Size in bytes. The size of a folder will be -1.
Status Code
Files successfully uploaded
Error payload
No Sample Response
Get the number of statements. **DB ADMIN ONLY**
Get the number of statements for a specified time frame.
GET /metrics/statements_count
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get the average number of statements executed every minutes. **DB ADMIN ONLY**
Get the average number of statements executed every minutes for a specified time frame.
GET /metrics/average_statements_rate
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get numbers of statements executed every minutes. **DB ADMIN ONLY**
Get numbers of statements executed every minutes for a specified time frame.
GET /metrics/statements_rate
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets a list of inflight executions
Gets a list of inflight executions.Only returns the same statement once and the last collected one between start and end.
GET /metrics/statements/inflight_executions
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
Field to set if include system statements in the return list
Default:
falseThe amount of return records. Limit and offset should be set together.
Default:
100The starting position of return records. Limit and offset should be set together
Default:
0Used to filter by IP address
Used to filter by statement text
Used to filter by application_name
Used to filter by session_auth_id
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets a list of current inflight executions
Gets a list of current inflight executions
GET /metrics/statements/inflight_executions/current/list
Request
Custom Headers
Database profile name.
Query Parameters
Field to set if include system statements in the return list
Default:
falseThe amount of return records. Limit and offset should be set together.
Default:
100The starting position of return records. Limit and offset should be set together
Default:
0Used to filter by IP address
Used to filter by statement text
Used to filter by application_name
Used to filter by session_auth_id
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Collection of in flight execution data
Number of statements.
from cache or not. If it's slow to get data from target database, then this API will retreve data from cache and get the last one. iscache identifies it is directly returned from db or from cache. true means from cache, false means from target database.
the collected timestamp from target database. This collected value can be used to set start and end for a history retrieval to get the same list later.
inflight statement Executions
Status Code
Returns a list of current inflight executions
Current user does not have permission to access this database
Database profile not found
Error payload
No Sample Response
Gets a infight execution detail
Gets a infight execution detail. Only returns the last one between start and end
GET /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}Request
Custom Headers
Database profile name.
Path Parameters
A system-wide unique ID for the application.
The unit of work identifier.
Counter which uniquely identifies an activity for an application within a given unit of work.
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
inflight statement Execution details
Application handle
Unit of work ID
Activity ID
Coordinator member
Entry time
Local start time
Total time
Queue time
Idle time
Exec time
Number of threshold violations
Workload manager total queue assignments
Executable ID
Effective isolation
Effective query degree
Actual runtime degree of intrapartition parallelism
Reserved for future use
Reserved for future use
Query cost estimate
Reserved for future use
SQL statement text
Activity state
Activity type
Application ID
Client IP address
Application name
System authorization identifier
Session authorization ID
Client application name
Client workstation name
Client accounting string
Client user ID
Client hostname
Client process ID
Client platform
Client product and version ID
Client port number
Workload name
Application ID
Service superclass name
Service subclass name
Total CPU time
Total routine invocations
FCM receives total
FCM sends total
Complex operations
All overflows
Maximum number of agents that were used
Number of concurrent agents
Total Sorts
Sort overflows
Sort Share Heap Currently Allocated
Max Share Heap Allocated Per Part Percent
Reserved for future use
Max estimated Share Heap Per Part Percent
Sort share heap high watermark
Max Share Heap Peak Per Part Percent
Hash Join Overflows
OLAP Function Overflows
Hash group by overflows
Post threshold sorts
Hash Join Threshold
OLAP function threshold
Hash group by threshold
Columnar vector consumer overflows
Post threshold columnar_vector consumers
Rows read
Rows modified
Rows returned
Lock waits
Lock waits global
Number of lock escalations
Number of global lock escalations
Deadlocks detected
Number of lock timeouts
Lock timeouts global
Number of cluster caching facility waits
Total log disk waits monitor element
Number of times full log buffer caused agents to wait
Unit of Work Log Space Used
Direct reads from database
Direct writes to database
FCM volume
Buffer pool hit ratio
Buffer pool data hit ratio
Buffer pool index hit ratio
Buffer pool XDA hit ratio
Buffer pool column hit ratio
Buffer pool temp hit ratio
Buffer pool temp logical reads
Buffer pool temp physical reads
Buffer pool logical reads
Buffer pool physical reads
Buffer pool writes
Rows deleted by a federation system
Rows inserted by a federation system
Rows updated by a federation system
Rows read by a federation system
Total number of execution times for a federation server
Total data read by external table readers
Total data written by external table writers
Total data sent to external table writers
Total data received from external table readers
Workload manager total queue time
Statement execution time
Total section processing time
Total section sort processing time
Total column-organized processing time
Other section processing time
Total routine user code processing time
Total activity wait time
Lock wait time global
Lock wait time local
Log buffer wait time
Log disk wait time
FCM wait time
cluster caching facility wait time
Time spent by a federation server
Total agent wait time for external table
Total extended latch wait time
Total buffer pool physical read time
Total buffer pool physical read time
Total buffer pool physical write time
Total buffer pool physical write time
Direct Read Time
Direct write time
Time waited for prefetch
Time waited for prefetch
Other wait time
Other processing time
Status Code
Returns a infight execution detail
Current user does not have permission to access this database
Database profile not found
Error payload
No Sample Response
Terminates a statement **DB ADMIN ONLY**
Terminates a statement
DELETE /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}Request
Custom Headers
Database profile name.
Path Parameters
A system-wide unique ID for the application.
The unit of work identifier.
Counter which uniquely identifies an activity for an application within a given unit of work.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}" req, _ := http.NewRequest("DELETE", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}") .delete(null) .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "DELETE", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("DELETE", "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X DELETE https://{HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Request
Custom Headers
Database profile name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/monitor/storage" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/monitor/storage") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/monitor/storage", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/monitor/storage", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/monitor/storage -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets storage usage history **DB ADMIN ONLY**
Gets a list of storage usage daily stats. Currenlty the history of the last seven days is returned.
GET /monitor/storage/history
Request
Custom Headers
Database profile name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/monitor/storage/history" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/monitor/storage/history") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/monitor/storage/history", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/monitor/storage/history", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/monitor/storage/history -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Storage utilization by schema **DB ADMIN ONLY**
Gets a list where each element represents a schema and its corresponding logical and physical sizes. Physical size is the amount of storage in disk allocated to objects in the schema. Logical size is the actual object size, which might be less than the physical size (e.g. in the case of a logical table truncation).
GET /monitor/storage/by_schema
Request
Custom Headers
Database profile name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/monitor/storage/by_schema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/monitor/storage/by_schema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/monitor/storage/by_schema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/monitor/storage/by_schema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/monitor/storage/by_schema -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Storage utilization of a schema **DB ADMIN ONLY**
Gets logical and physical sizes for one schema. Physical size is the amount of storage in disk allocated to objects in the schema. Logical size is the actual object size, which might be less than the physical size (e.g. in the case of a logical table truncation).
GET /monitor/storage/by_schema/{schema_name}Request
Custom Headers
Database profile name.
Path Parameters
Schema name
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/monitor/storage/by_schema/{schema_name}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/monitor/storage/by_schema/{schema_name}") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/monitor/storage/by_schema/{schema_name}", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/monitor/storage/by_schema/{schema_name}", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET https://{HOSTNAME}/dbapi/v4/monitor/storage/by_schema/{schema_name} -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Schema name
Amount of disk space logically allocated for row-organized data in all tables in the schema, reported in kilobytes.
Amount of disk space logically allocated for the indexes defined in all tables in the schema, reported in kilobytes.
Amount of disk space logically allocated for long field data in all tables in the schema, reported in kilobytes.
Amount of disk space logically allocated for LOB data in all tables in the schema, reported in kilobytes.
Amount of disk space logically allocated for XML data in all tables in the schema, reported in kilobytes.
Amount of disk space logically allocated for column-organized data in all tables in the schema, reported in kilobytes.
Total amount of logically allocated disk space for all tables in the schema, reported in kilobytes.
Amount of disk space physically allocated in all tables in the schema, reported in kilobytes.
Amount of disk space physically allocated for the indexes defined in all tables in the schema, reported in kilobytes.
Amount of disk space physically allocated for long field data in all tables in the schema, reported in kilobytes.
Amount of disk space logically allocated for LOB data in all tables in the schema, reported in kilobytes.
Amount of disk space physically allocated for XML data in all tables in the schema, reported in kilobytes.
Amount of disk space physically allocated for column-organized data in all tables in the schema, reported in kilobytes.
Total amount of physically allocated disk space for all tables in the schema, reported in kilobytes.
Status Code
Storage usage for a schema
Operation is only available to administrators
Schema does not exist
Error payload
No Sample Response
Get the maximum usage percent of storage. **DB ADMIN ONLY**
Get the maximum usage percent of storage for a specified time frame.
GET /metrics/max_storage
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get the usage percent of storage. **DB ADMIN ONLY**
Get the usage percent of storage for a specified time frame.
GET /metrics/storage
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get a table storage usage in a time range **DB ADMIN ONLY**
Get a table storage usage in a time range.
GET /metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseriesRequest
Custom Headers
Database profile name.
Path Parameters
Tabname
Tabschema
Query Parameters
end
start
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json;charset=utf-8") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE") .get() .addHeader("content-type", "application/json;charset=utf-8") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE", "headers": { "content-type": "application/json;charset=utf-8", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json;charset=utf-8", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json;charset=utf-8' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets a list for tables storage **DB ADMIN ONLY**
Gets a list for tables storage. Only returns the last collected data between start and end.
GET /metrics/tables/storage
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
Field to set if includes system tables in the return list
Default:
falseThe amount of return records. Limit and offset should be set together.
Default:
100The starting position of return records. Limit and offset should be set together
Default:
0Used to filter by schema
Used to filter by tabname
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets a table storage **DB ADMIN ONLY**
Gets a table storage. Only returns the last collected data between start and end.
GET /metrics/schemas/{tabschema}/tables/{tabname}/storageRequest
Custom Headers
Database profile name.
Path Parameters
Used to filter by schema
Used to filter by tabname
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets a list for schemas storage **DB ADMIN ONLY**
Gets a list for schemas storage. Only returns the last collected data between start and end.
GET /metrics/storage/schemas
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
Field to set if includes system schemas in the return list
Default:
falseThe amount of return records. Limit and offset should be set together.
Default:
100The starting position of return records. Limit and offset should be set together
Default:
0Used to filter by schema
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Get a schema used storage in a time range **DB ADMIN ONLY**
Get a schema used storage in a time range.
GET /metrics/storage/schemas/{tabschema}/timeseriesRequest
Custom Headers
Database profile name.
Path Parameters
Used to filter by schema
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json;charset=utf-8") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json;charset=utf-8") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json;charset=utf-8", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json;charset=utf-8", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json;charset=utf-8' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets a schema storage **DB ADMIN ONLY**
Gets a schema storage. Only returns the last collected data between start and end.
GET /metrics/storage/schemas/{tabschema}Request
Custom Headers
Database profile name.
Path Parameters
Used to filter by schema
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Runs a tables storage collection **DB ADMIN ONLY**
Runs asynchronously a tables storage collection. Only allow one thread to run at the same time. If there is already a thread running, the new request will not kick off a new one. The returned handle will be the already running one. If there is no thread running, a new handle will be returned.
POST /metrics/tables/storage/collector
Request
Custom Headers
Database profile name.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/tables/storage/collector" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/tables/storage/collector") .post(null) .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "POST", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/tables/storage/collector", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("POST", "/dbapi/v4/metrics/tables/storage/collector", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X POST https://{HOSTNAME}/dbapi/v4/metrics/tables/storage/collector -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets performance metrics for schemas **DB ADMIN ONLY**
Gets performance metrics for schemas. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/schemas
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
Field to set if include system schemas in the return list
Default:
falseField to set the amount of return records
Default:
100Field to set the starting position of return records.
Default:
0Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets performance metrics for schemas **DB ADMIN ONLY**
Gets current performance metrics for schemas.
GET /metrics/schemas/current/list
Request
Custom Headers
Database profile name.
Query Parameters
Field to set if include system schemas in the return list
Default:
falseField to set the amount of return records
Default:
100Field to set the starting position of return records.
Default:
0Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
a list of Sechmas
counts of statements
from cache or not. If it's slow to get data from target database, then this API will retreve data from cache and get the last one. iscache identifies it is directly returned from db or from cache. true means from cache, false means from target database.
the collected timestamp from target database. This collected value can be used to set start and end for a history retrieval to get the same list later.
Schema Perf
Status Code
returns performance of schemas
Current user does not have permission to access this database
Database profile not found
Error payload
No Sample Response
Gets performance metrics for one schema **DB ADMIN ONLY**
Gets performance metrics for one schema. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/schemas/{schema_name}Request
Custom Headers
Database profile name.
Path Parameters
Schema name
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Schema Perf
Table schema name
Table scans
Rows read
Rows inserted
Rows updated
Rows deleted
Logical reads
Physical reads
Buffer pool hit ratio
Rows read versus accessed
Logical data object pages
Logical index object pages
Logical XDA object pages
Logical LOB object pages
Logical Long object pages
Access per minute
Status Code
Returns performance metrics for one schema
Current user does not have permission to access this database
Database profile not found
Error payload
No Sample Response
Gets performance metrics on all members for one schema **DB ADMIN ONLY**
Gets performance metrics on all members for one schema. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/schemas/{schema_name}/membersRequest
Custom Headers
Database profile name.
Path Parameters
Schema name
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets performance metrics timeseries for one schema **DB ADMIN ONLY**
Gets performance metrics timeseries for one schema.
GET /metrics/schemas/{schema_name}/timeseriesRequest
Custom Headers
Database profile name.
Path Parameters
Schema name
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets performance of tables **DB ADMIN ONLY**
Gets performance of tables. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/tables
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
Field to set if include system tables in the return list
Default:
falseField to set the amount of return records
Default:
100Field to set the starting position of return records.
Default:
0Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets current performance of tables **DB ADMIN ONLY**
Gets current performance of tables.
GET /metrics/tables/current/list
Request
Custom Headers
Database profile name.
Query Parameters
Field to set if include system tables in the return list
Default:
falseField to set the amount of return records
Default:
100Field to set the starting position of return records.
Default:
0Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
A list of tables
A list of tables
from cache or not. If it's slow to get data from target database, then this API will retreve data from cache and get the last one. iscache identifies it is directly returned from db or from cache. true means from cache, false means from target database.
the collected timestamp from target database. This collected value can be used to set start and end for a history retrieval to get the same list later.
Table performance
Status Code
Returns performance of tables
Current user does not have permission to access this database
Database profile not found
Error payload
No Sample Response
Gets performance of one table **DB ADMIN ONLY**
Gets performance of one table. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/schemas/{schema_name}/tables/{table_name}Request
Custom Headers
Database profile name.
Path Parameters
Schema name
Table name
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Response
Table performance
Table schema name
Table name
Table type
Tablespace name
Table scans
Rows read
Rows inserted
Rows updated
Rows deleted
Logical reads
Physical reads
Buffer pool hit ratio
Rows read versus accessed
Logical data object pages
Logical index object pages
Logical XDA object pages
Logical LOB object pages
Logical Long object pages
Access per minute
Status Code
Returns performance of one table
Current user does not have permission to access this database
Database profile not found
Error payload
No Sample Response
Gets performance on all members for one table **DB ADMIN ONLY**
Gets performance on all members for one table. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/schemas/{schema_name}/tables/{table_name}/membersRequest
Custom Headers
Database profile name.
Path Parameters
Schema name
Table name
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets performance timeseries for one table **DB ADMIN ONLY**
Gets performance timeseries for one table.
GET /metrics/schemas/{schema_name}/tables/{table_name}/timeseriesRequest
Custom Headers
Database profile name.
Path Parameters
Schema name
Table name
Query Parameters
Start timestamp.
End timestamp.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets performance of tables and schemas **DB ADMIN ONLY**
Gets performance of tables and schemas. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/tableperformance
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
Field to set if include system tables in the return list
Default:
falseField to set the amount of return records
Default:
100Field to set the starting position of return records.
Default:
0Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://{HOSTNAME}/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("content-type", "application/json") req.Header.Add("x-db-profile", "SOME_STRING_VALUE") req.Header.Add("authorization", "Bearer {AUTH_TOKEN}") req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://{HOSTNAME}/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema") .get() .addHeader("content-type", "application/json") .addHeader("x-db-profile", "SOME_STRING_VALUE") .addHeader("authorization", "Bearer {AUTH_TOKEN}") .addHeader("x-deployment-id", "{DEPLOYMENT_ID}") .build(); Response response = client.newCall(request).execute();
var http = require("https"); var options = { "method": "GET", "hostname": "{HOSTNAME}", "port": null, "path": "/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", "headers": { "content-type": "application/json", "x-db-profile": "SOME_STRING_VALUE", "authorization": "Bearer {AUTH_TOKEN}", "x-deployment-id": "{DEPLOYMENT_ID}" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
import http.client conn = http.client.HTTPSConnection("{HOSTNAME}") headers = { 'content-type': "application/json", 'x-db-profile': "SOME_STRING_VALUE", 'authorization': "Bearer {AUTH_TOKEN}", 'x-deployment-id': "{DEPLOYMENT_ID}" } conn.request("GET", "/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
curl -X GET 'https://{HOSTNAME}/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema' -H 'authorization: Bearer {AUTH_TOKEN}' -H 'content-type: application/json' -H 'x-db-profile: SOME_STRING_VALUE' -H 'x-deployment-id: {DEPLOYMENT_ID}'
Gets current performance of tables and schemas **DB ADMIN ONLY**
Gets current performance of tables and schemas. If there are multiple collections. They’ll been aggregated averagely.
GET /metrics/tableperformance/current/list
Request
Custom Headers
Database profile name.
Query Parameters
Start timestamp.
End timestamp.
Field to set if include system tables in the return list
Default:
falseField to set the amount of return records
Default:
100Field to set the starting position of return records.
Default:
0Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.