This is the multi-page printable view of this section. Click here to print.
ShowQuickQuery
1 - 1.2
get /v1/quick-query/{quick_query_id}
Description
Get Quick Query details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | quick_query_id required | quick_query_id Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryDetailResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = quick-query 1.2"
Example HTTP response
Response 200
{
"cluster_id": "",
"cluster_name": "",
"cluster_permission": {},
"cluster_request_failed": false,
"created_dt": "2024-01-15T10:30:00.000Z",
"description": "",
"domain": "",
"dsc_console_domain": "",
"dsc_domain": "",
"dsc_oidc_domain": "",
"host_alias_list": [
{}
],
"hosts_file": "",
"is_active_image": "",
"is_engine_type_private": "",
"max_query": "",
"modified_dt": "2024-01-15T10:30:00.000Z",
"namespace_name": "",
"node_information": [],
"provisioning_state": "",
"query_engine_spec": "",
"quick_query_id": "",
"quick_query_name": "",
"quick_query_state": "",
"quick_query_version": ""
}
2 - 1.1
get /v1/quick-query/{quick_query_id}
Description
Get Quick Query details.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260930 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | quick_query_id required | quick_query_id Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryDetailResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = quick-query 1.1"
Example HTTP response
Response 200
{
"cluster_id": "",
"cluster_name": "",
"cluster_permission": {},
"cluster_request_failed": false,
"created_dt": "2024-01-15T10:30:00.000Z",
"description": "",
"domain": "",
"dsc_console_domain": "",
"dsc_domain": "",
"dsc_oidc_domain": "",
"host_alias_list": [
{}
],
"hosts_file": "",
"is_active_image": "",
"is_engine_type_private": "",
"max_query": "",
"modified_dt": "2024-01-15T10:30:00.000Z",
"namespace_name": "",
"node_information": [],
"provisioning_state": "",
"query_engine_spec": "",
"quick_query_id": "",
"quick_query_name": "",
"quick_query_state": "",
"quick_query_version": ""
}
3 - 1.0
get /v1/quick-query/{quick_query_id}
Description
Get Quick Query details.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | quick_query_id required | quick_query_id Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryDetailResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = quick-query 1.0"
Example HTTP response
Response 200
{
"cluster_id": "",
"cluster_name": "",
"cluster_permission": {},
"cluster_request_failed": false,
"created_dt": "2024-01-15T10:30:00.000Z",
"description": "",
"domain": "",
"dsc_console_domain": "",
"dsc_domain": "",
"dsc_oidc_domain": "",
"host_alias_list": [
{}
],
"hosts_file": "",
"is_active_image": "",
"is_engine_type_private": "",
"max_query": "",
"modified_dt": "2024-01-15T10:30:00.000Z",
"namespace_name": "",
"node_information": [],
"provisioning_state": "",
"query_engine_spec": "",
"quick_query_id": "",
"quick_query_name": "",
"quick_query_state": "",
"quick_query_version": ""
}