This is the multi-page printable view of this section. Click here to print.
APIs
- 1: CheckClusterResourceSizeForQuickQuery
- 2: CheckDuplicationQuickQueryName
- 3: CreateQuickQuery
- 4: DeleteQuickQuery
- 5: ListQuickQuery
- 6: ListQuickQueryImages
- 7: ShowQuickQuery
- 8: UpdateQuickQueryDescription
- 9: UpdateQuickQueryDomain
- 10: UpdateQuickQueryDscDomain
- 11: UpdateQuickQueryEngine
- 12: UpdateQuickQueryHostAlias
1 - CheckClusterResourceSizeForQuickQuery
1.1 - 1.2
post /v1/quick-query/validate-resources
Description
Check if resource is verified to be modified/created
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | QuickQueryValidateResourceRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryValidateResourceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/validate-resources
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"
Request body
{
"cluster_id": "",
"node_pool_validation_request": [
{
"auto_scale": "",
"desired_node_count": "",
"max_node_count": "",
"min_node_count": "",
"scale_name": ""
}
],
"quick_query_engine_request": {
"auto_scale": "",
"cluster_size": "",
"cpu": "",
"is_engine_type_private": "",
"memory": "",
"replica": ""
}
}
Example HTTP response
Response 200
{
"min_spec_node_pool": [
{
"cpu": "",
"is_node_pool_auto_scalable": "",
"memory": "",
"replica": ""
}
],
"result": ""
}
1.2 - 1.1
post /v1/quick-query/validate-resources
Description
Check if resource is verified to be modified/created
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260930 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | QuickQueryValidateResourceRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryValidateResourceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/validate-resources
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"
Request body
{
"cluster_id": "",
"node_pool_validation_request": [
{
"auto_scale": "",
"desired_node_count": "",
"max_node_count": "",
"min_node_count": "",
"scale_name": ""
}
],
"quick_query_engine_request": {
"auto_scale": "",
"cluster_size": "",
"cpu": "",
"is_engine_type_private": "",
"memory": "",
"replica": ""
}
}
Example HTTP response
Response 200
{
"min_spec_node_pool": [
{
"cpu": "",
"is_node_pool_auto_scalable": "",
"memory": "",
"replica": ""
}
],
"result": ""
}
1.3 - 1.0
post /v1/quick-query/validate-resources
Description
Check if resource is verified to be modified/created
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 |
|---|---|---|---|---|
| body | body required | QuickQueryValidateResourceRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryValidateResourceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/validate-resources
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"
Request body
{
"cluster_id": "",
"node_pool_validation_request": [
{
"auto_scale": "",
"desired_node_count": "",
"max_node_count": "",
"min_node_count": "",
"scale_name": ""
}
],
"quick_query_engine_request": {
"auto_scale": "",
"cluster_size": "",
"cpu": "",
"is_engine_type_private": "",
"memory": "",
"replica": ""
}
}
Example HTTP response
Response 200
{
"min_spec_node_pool": [
{
"cpu": "",
"is_node_pool_auto_scalable": "",
"memory": "",
"replica": ""
}
],
"result": ""
}
2 - CheckDuplicationQuickQueryName
2.1 - 1.2
get /v1/quick-query/{quick_query_name}/check-duplication
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | quick_query_name required | quick query name Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CheckResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_name}/check-duplication
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
{
"result": ""
}
2.2 - 1.1
get /v1/quick-query/{quick_query_name}/check-duplication
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260930 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | quick_query_name required | quick query name Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CheckResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_name}/check-duplication
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
{
"result": ""
}
2.3 - 1.0
get /v1/quick-query/{quick_query_name}/check-duplication
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
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_name required | quick query name Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CheckResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_name}/check-duplication
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
{
"result": ""
}
3 - CreateQuickQuery
3.1 - 1.2
post /v1/quick-query
Description
Create Quick Query.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | QuickQueryTotalCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query
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"
Request body
{
"kubernetes_engine_create_request": {
"cifs_volume_id": "",
"cloud_logging_enabled": "",
"k8s_version": "",
"kubernetes_engine_name": "",
"lb_id": "",
"public_acl_ip_address": "",
"security_group_id_list": [
""
],
"subnet_id": "",
"tags": [
{
"tag_key": "",
"tag_value": ""
}
],
"volume_id": "",
"vpc_id": ""
},
"node_pool_create_requests": [
{
"auto_recovery": false,
"auto_scale": false,
"desired_node_count": "",
"image_os": "",
"image_os_version": "",
"k8s_version": "",
"keypair_name": "",
"max_node_count": "",
"min_node_count": "",
"name": "",
"scale_name": "",
"volume_size": "",
"volume_type_name": "",
"zone": "kr-west1-a"
}
],
"quick_query_create_request": {
"description": "",
"domain": "",
"dsc_console_ip": "",
"dsc_domain": "",
"host_alias_list": [],
"image_id": "",
"instance_id": "",
"is_engine_type_private": "",
"max_query": "",
"product_group_id": "",
"query_engine_spec": {
"auto_scale": "",
"cluster_size": "",
"cpu": "",
"memory": "",
"replica": ""
},
"quick_query_name": "",
"version": ""
},
"tags": [
{
"tag_key": "",
"tag_value": ""
}
]
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
3.2 - 1.1
post /v1/quick-query
Description
Create Quick Query.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260930 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | QuickQueryTotalCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query
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"
Request body
{
"kubernetes_engine_create_request": {
"cifs_volume_id": "",
"cloud_logging_enabled": "",
"k8s_version": "",
"kubernetes_engine_name": "",
"lb_id": "",
"public_acl_ip_address": "",
"security_group_id_list": [
""
],
"subnet_id": "",
"tags": [],
"volume_id": "",
"vpc_id": ""
},
"node_pool_create_requests": [
{
"auto_recovery": false,
"auto_scale": false,
"desired_node_count": "",
"image_os": "",
"image_os_version": "",
"k8s_version": "",
"keypair_name": "",
"max_node_count": "",
"min_node_count": "",
"name": "",
"scale_name": "",
"volume_size": "",
"volume_type_name": ""
}
],
"quick_query_create_request": {
"description": "",
"domain": "",
"dsc_console_ip": "",
"dsc_domain": "",
"host_alias_list": [],
"image_id": "",
"instance_id": "",
"is_engine_type_private": "",
"max_query": "",
"product_group_id": "",
"query_engine_spec": {
"auto_scale": "",
"cluster_size": "",
"cpu": "",
"memory": "",
"replica": ""
},
"quick_query_name": "",
"version": ""
},
"tags": []
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
3.3 - 1.0
post /v1/quick-query
Description
Create Quick Query.
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 |
|---|---|---|---|---|
| body | body required | QuickQueryTotalCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query
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"
Request body
{
"kubernetes_engine_create_request": {
"cifs_volume_id": "",
"cloud_logging_enabled": "",
"k8s_version": "",
"kubernetes_engine_name": "",
"lb_id": "",
"public_acl_ip_address": "",
"security_group_id_list": [
""
],
"subnet_id": "",
"tags": [],
"volume_id": "",
"vpc_id": ""
},
"node_pool_create_requests": [
{
"auto_recovery": false,
"auto_scale": false,
"desired_node_count": "",
"image_os": "",
"image_os_version": "",
"k8s_version": "",
"keypair_name": "",
"max_node_count": "",
"min_node_count": "",
"name": "",
"scale_name": "",
"volume_size": "",
"volume_type_name": ""
}
],
"quick_query_create_request": {
"description": "",
"domain": "",
"dsc_console_ip": "",
"dsc_domain": "",
"host_alias_list": [],
"image_id": "",
"instance_id": "",
"is_engine_type_private": "",
"max_query": "",
"product_group_id": "",
"query_engine_spec": {
"auto_scale": "",
"cluster_size": "",
"cpu": "",
"memory": "",
"replica": ""
},
"quick_query_name": "",
"version": ""
},
"tags": []
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
4 - DeleteQuickQuery
4.1 - 1.2
delete /v1/quick-query/{quick_query_id}
Description
delete quick query
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 |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | 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 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
4.2 - 1.1
delete /v1/quick-query/{quick_query_id}
Description
delete quick query
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 |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | 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 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
4.3 - 1.0
delete /v1/quick-query/{quick_query_id}
Description
delete quick query
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 |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | 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 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
5 - ListQuickQuery
5.1 - 1.2
get /v1/quick-query
Description
get quick query list console
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : created_at:desc | string | created_dt:desc |
| query | cluster_name optional | cluster_name Example : | string | None |
| query | created_by optional | created_by Example : | string | None |
| query | quick_query_state optional | state Example : | enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING, STOPPED, STARTING, STOPPING, RESTARTING, TERMINATED, EDITING, DELETING, UNDEPLOYED) | None |
| query | version optional | version Example : | string | None |
| query | quick_query_name optional | quick_query_name Example : | string | None |
| query | size required | size Example : 20 | integer | None |
| query | page required | page Example : 0 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryListSearchResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query?size={size}&page={page}
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
{
"contents": [
{
"cluster_id": "",
"cluster_name": "",
"cluster_permission": {},
"cluster_request_failed": false,
"created_by": "",
"created_dt": "2024-01-15T10:30:00.000Z",
"modified_by": "",
"modified_dt": "",
"quick_query_id": "",
"quick_query_name": "",
"quick_query_state": "",
"quick_query_version": ""
}
],
"page": "",
"size": "",
"sort": [
""
],
"total_count": ""
}
5.2 - 1.1
get /v1/quick-query
Description
get quick query list console
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260930 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : created_at:desc | string | created_dt:desc |
| query | cluster_name optional | cluster_name Example : | string | None |
| query | created_by optional | created_by Example : | string | None |
| query | quick_query_state optional | state Example : | enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING, STOPPED, STARTING, STOPPING, RESTARTING, TERMINATED, EDITING, DELETING, UNDEPLOYED) | None |
| query | version optional | version Example : | string | None |
| query | quick_query_name optional | quick_query_name Example : | string | None |
| query | size required | size Example : 20 | integer | None |
| query | page required | page Example : 0 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryListSearchResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query?size={size}&page={page}
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
{
"contents": [
{
"cluster_id": "",
"cluster_name": "",
"cluster_permission": {},
"cluster_request_failed": false,
"created_by": "",
"created_dt": "2024-01-15T10:30:00.000Z",
"modified_by": "",
"modified_dt": "",
"quick_query_id": "",
"quick_query_name": "",
"quick_query_state": "",
"quick_query_version": ""
}
],
"page": "",
"size": "",
"sort": [
""
],
"total_count": ""
}
5.3 - 1.0
get /v1/quick-query
Description
get quick query list console
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 |
|---|---|---|---|---|
| query | sort optional | sort Example : created_at:desc | string | created_dt:desc |
| query | cluster_name optional | cluster_name Example : | string | None |
| query | created_by optional | created_by Example : | string | None |
| query | quick_query_state optional | state Example : | enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING, STOPPED, STARTING, STOPPING, RESTARTING, TERMINATED, EDITING, DELETING, UNDEPLOYED) | None |
| query | version optional | version Example : | string | None |
| query | quick_query_name optional | quick_query_name Example : | string | None |
| query | size required | size Example : 20 | integer | None |
| query | page required | page Example : 0 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuickQueryListSearchResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query?size={size}&page={page}
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
{
"contents": [
{
"cluster_id": "",
"cluster_name": "",
"cluster_permission": {},
"cluster_request_failed": false,
"created_by": "",
"created_dt": "2024-01-15T10:30:00.000Z",
"modified_by": "",
"modified_dt": "",
"quick_query_id": "",
"quick_query_name": "",
"quick_query_state": "",
"quick_query_version": ""
}
],
"page": "",
"size": "",
"sort": [
""
],
"total_count": ""
}
6 - ListQuickQueryImages
6.1 - 1.2
get /v1/quick-query/image-versions
Description
get quick query image versions
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageVersionsResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/image-versions
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
{
"contents": [
{
"image_attr": {
"k8s.version": "",
"os.type": ""
},
"image_id": "",
"image_name": "",
"version": ""
}
],
"total_count": ""
}
6.2 - 1.1
get /v1/quick-query/image-versions
Description
get quick query image versions
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260930 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageVersionsResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/image-versions
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
{
"contents": [
{
"image_attr": {
"k8s.version": "",
"os.type": ""
},
"image_id": "",
"image_name": "",
"version": ""
}
],
"total_count": ""
}
6.3 - 1.0
get /v1/quick-query/image-versions
Description
get quick query image versions
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageVersionsResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/image-versions
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
{
"contents": [
{
"image_attr": {
"k8s.version": "",
"os.type": ""
},
"image_id": "",
"image_name": "",
"version": ""
}
],
"total_count": ""
}
7 - ShowQuickQuery
7.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": ""
}
7.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": ""
}
7.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": ""
}
8 - UpdateQuickQueryDescription
8.1 - 1.2
put /v1/quick-query/{quick_query_id}/description
Description
update quick query description
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 |
| body | body required | QuickQueryDescriptionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | QuickQueryDescriptionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/description
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"
Request body
{
"description": ""
}
Example HTTP response
Response 202
{
"description": "",
"quick_query_id": ""
}
8.2 - 1.1
put /v1/quick-query/{quick_query_id}/description
Description
update quick query description
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 |
| body | body required | QuickQueryDescriptionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | QuickQueryDescriptionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/description
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"
Request body
{
"description": ""
}
Example HTTP response
Response 202
{
"description": "",
"quick_query_id": ""
}
8.3 - 1.0
put /v1/quick-query/{quick_query_id}/description
Description
update quick query description
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 |
| body | body required | QuickQueryDescriptionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | QuickQueryDescriptionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/description
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"
Request body
{
"description": ""
}
Example HTTP response
Response 202
{
"description": "",
"quick_query_id": ""
}
9 - UpdateQuickQueryDomain
9.1 - 1.2
put /v1/quick-query/{quick_query_id}/domain
Description
update quick query domain
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 |
| body | body required | QuickQueryDomainRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/domain
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"
Request body
{
"domain": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
9.2 - 1.1
put /v1/quick-query/{quick_query_id}/domain
Description
update quick query domain
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 |
| body | body required | QuickQueryDomainRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/domain
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"
Request body
{
"domain": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
9.3 - 1.0
put /v1/quick-query/{quick_query_id}/domain
Description
update quick query domain
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 |
| body | body required | QuickQueryDomainRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/domain
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"
Request body
{
"domain": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
10 - UpdateQuickQueryDscDomain
10.1 - 1.2
put /v1/quick-query/{quick_query_id}/dsc-domain
Description
update quick query dsc domain
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 |
| body | body required | QuickQueryDscDomainRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/dsc-domain
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"
Request body
{
"dsc_domain": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
10.2 - 1.1
put /v1/quick-query/{quick_query_id}/dsc-domain
Description
update quick query dsc domain
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 |
| body | body required | QuickQueryDscDomainRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/dsc-domain
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"
Request body
{
"dsc_domain": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
10.3 - 1.0
put /v1/quick-query/{quick_query_id}/dsc-domain
Description
update quick query dsc domain
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 |
| body | body required | QuickQueryDscDomainRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/dsc-domain
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"
Request body
{
"dsc_domain": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
11 - UpdateQuickQueryEngine
11.1 - 1.2
put /v1/quick-query/{quick_query_id}/engine
Description
update quick query engine
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 |
| body | body required | QuickQueryUpdateEngineRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/engine
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"
Request body
{
"cluster_size": "",
"cpu": "",
"memory": "",
"replica": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
11.2 - 1.1
put /v1/quick-query/{quick_query_id}/engine
Description
update quick query engine
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 |
| body | body required | QuickQueryUpdateEngineRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/engine
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"
Request body
{
"cluster_size": "",
"cpu": "",
"memory": "",
"replica": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
11.3 - 1.0
put /v1/quick-query/{quick_query_id}/engine
Description
update quick query engine
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 |
| body | body required | QuickQueryUpdateEngineRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/engine
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"
Request body
{
"cluster_size": "",
"cpu": "",
"memory": "",
"replica": ""
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
12 - UpdateQuickQueryHostAlias
12.1 - 1.2
put /v1/quick-query/{quick_query_id}/host-alias
Description
update quick query host alias
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 |
| body | body required | QuickQueryHostAliasRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/host-alias
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"
Request body
{
"host_alias_list": [
{
"hostnames": [
""
],
"ip": ""
}
]
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
12.2 - 1.1
put /v1/quick-query/{quick_query_id}/host-alias
Description
update quick query host alias
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 |
| body | body required | QuickQueryHostAliasRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/host-alias
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"
Request body
{
"host_alias_list": [
{
"hostnames": [
""
],
"ip": ""
}
]
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}
12.3 - 1.0
put /v1/quick-query/{quick_query_id}/host-alias
Description
update quick query host alias
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 |
| body | body required | QuickQueryHostAliasRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quick-query/{quick_query_id}/host-alias
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"
Request body
{
"host_alias_list": [
{
"hostnames": [
""
],
"ip": ""
}
]
}
Example HTTP response
Response 202
{
"project_id": "10a599e031e749b7b260868f441e862b",
"request_id": "10a599e031e749b7b260868f441e862b",
"resource_id": "10a599e031e749b7b260868f441e862b"
}