This is the multi-page printable view of this section. Click here to print.
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Quick Query service and how to call CLI.
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | SUPPORTED | 20260701 |
scp-cli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]
Check if resource is verified to be modified/created
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| node_pool_validation_request required | array | node_pool_validation_request | '{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}' |
| cluster_id optional | string | cluster_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| is_engine_type_private optional | boolean | is_engine_type_private | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
| Name | Description | Example |
|---|---|---|
| min_spec_node_pool | min_spec_node_pool | [] |
| result | result |
scp-cli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]
Check if resource is verified to be modified/created
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| node_pool_validation_request required | array | node_pool_validation_request | '{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}' |
| cluster_id optional | string | cluster_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| is_engine_type_private optional | boolean | is_engine_type_private | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
| Name | Description | Example |
|---|---|---|
| min_spec_node_pool | min_spec_node_pool | [] |
| result | result |
scp-cli quick-query check quick query duplication
--quick_query_name <value>
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
| Name | Description | Example |
|---|---|---|
| result | result |
scp-cli quick-query check quick query duplication
--quick_query_name <value>
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
| Name | Description | Example |
|---|---|---|
| result | result |
scp-cli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]
[--tags <value>]
[--kubernetes_engine_create_request_tags <value>]
Create Quick Query.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quickquery_version required | string | version | - |
| quick_query_name required | string | quick_query_name | - |
| max_query required | string | max_query | - |
| is_engine_type_private required | boolean | is_engine_type_private | - |
| image_id required | string | image_id | - |
| dsc_domain required | string | dsc_domain | - |
| domain required | string | domain | - |
| vpc_id required | string | vpc_id | - |
| volume_id required | string | volume_id | - |
| subnet_id required | string | subnet_id | - |
| security_group_id_list required | array | security_group_id_list | - |
| kubernetes_engine_name required | string | kubernetes_engine_name | - |
| k8s_version required | string | k8s_version | - |
| cloud_logging_enabled required | boolean | cloud_logging_enabled | - |
| node_pool_create_requests required | array | 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": ""}' |
| cifs_volume_id optional | string | cifs_volume_id | - |
| lb_id optional | string | lb_id | - |
| public_acl_ip_address optional | string | public_acl_ip_address | - |
| description optional | string | description | - |
| dsc_console_ip optional | string | dsc_console_ip | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
| instance_id optional | string | instance_id | - |
| product_group_id optional | string | product_group_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
| tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
| kubernetes_engine_create_request_tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
scp-cli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]
[--tags <value>]
[--kubernetes_engine_create_request_tags <value>]
Create Quick Query.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quickquery_version required | string | version | - |
| quick_query_name required | string | quick_query_name | - |
| max_query required | string | max_query | - |
| is_engine_type_private required | boolean | is_engine_type_private | - |
| image_id required | string | image_id | - |
| dsc_domain required | string | dsc_domain | - |
| domain required | string | domain | - |
| vpc_id required | string | vpc_id | - |
| volume_id required | string | volume_id | - |
| subnet_id required | string | subnet_id | - |
| security_group_id_list required | array | security_group_id_list | - |
| kubernetes_engine_name required | string | kubernetes_engine_name | - |
| k8s_version required | string | k8s_version | - |
| cloud_logging_enabled required | boolean | cloud_logging_enabled | - |
| node_pool_create_requests required | array | 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": ""}' |
| cifs_volume_id optional | string | cifs_volume_id | - |
| lb_id optional | string | lb_id | - |
| public_acl_ip_address optional | string | public_acl_ip_address | - |
| description optional | string | description | - |
| dsc_console_ip optional | string | dsc_console_ip | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
| instance_id optional | string | instance_id | - |
| product_group_id optional | string | product_group_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
| tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
| kubernetes_engine_create_request_tags optional | array | tags | '{"key": "Key", "value": "Value"}' |
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
scp-cli quick-query delete quick query
--quick_query_id <value>
delete quick query
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
scp-cli quick-query delete quick query
--quick_query_id <value>
delete quick query
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
scp-cli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]
get quick query list console
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| page required | integer | page | 0 |
| size required | integer | size | 20 |
| sort optional | string | sort | created_at:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| quick_query_state optional | **** | state | - |
| quickquery_version optional | string | version | - |
| quick_query_name optional | string | quick_query_name | - |
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
scp-cli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]
get quick query list console
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| page required | integer | page | 0 |
| size required | integer | size | 20 |
| sort optional | string | sort | created_at:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| quick_query_state optional | **** | state | - |
| quickquery_version optional | string | version | - |
| quick_query_name optional | string | quick_query_name | - |
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
scp-cli quick-query list quick query images
get quick query image versions
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
scp-cli quick-query list quick query images
get quick query image versions
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
scp-cli quick-query show quick query
--quick_query_id <value>
Get Quick Query details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | {} |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| description | description | |
| domain | domain | |
| dsc_console_domain | dsc_console_domain | |
| dsc_domain | dsc_domain | |
| dsc_oidc_domain | dsc_oidc_domain | |
| host_alias_list | domain | [] |
| hosts_file | hosts_file | |
| is_active_image | is_active_image | |
| is_engine_type_private | is_engine_type_private | |
| max_query | max_query | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_information | node_information | [] |
| provisioning_state | provisioning_state | |
| query_engine_spec | query_engine_spec | {} |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
scp-cli quick-query show quick query
--quick_query_id <value>
Get Quick Query details.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | {} |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| description | description | |
| domain | domain | |
| dsc_console_domain | dsc_console_domain | |
| dsc_domain | dsc_domain | |
| dsc_oidc_domain | dsc_oidc_domain | |
| host_alias_list | domain | [] |
| hosts_file | hosts_file | |
| is_active_image | is_active_image | |
| is_engine_type_private | is_engine_type_private | |
| max_query | max_query | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_information | node_information | [] |
| provisioning_state | provisioning_state | |
| query_engine_spec | query_engine_spec | {} |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
scp-cli quick-query update quick query description
--quick_query_id <value>
--description <value>
update quick query description
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| description required | string | description | - |
scp-cli quick-query update quick query description
--quick_query_id <value>
--description <value>
update quick query description
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| description required | string | description | - |
scp-cli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
update quick query domain
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| domain required | string | domain | - |
scp-cli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
update quick query domain
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| domain required | string | domain | - |
scp-cli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
update quick query dsc domain
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| dsc_domain required | string | dsc_domain | - |
scp-cli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
update quick query dsc domain
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| dsc_domain required | string | dsc_domain | - |
scp-cli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
update quick query engine
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| replica required | string | replica | - |
| memory required | string | memory | - |
| cpu required | string | cpu | - |
| cluster_size optional | string | cluster_size | - |
scp-cli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
update quick query engine
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| replica required | string | replica | - |
| memory required | string | memory | - |
| cpu required | string | cpu | - |
| cluster_size optional | string | cluster_size | - |
scp-cli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
update quick query host alias
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
scp-cli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
update quick query host alias
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20260701 |
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |