This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

ListQuickQuery

1 - 1.2

get /v1/quick-query

Description

get quick query list console

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

TypeNameDescriptionSchemaDefault
querysort
optional		sort
Example : created_at:desc
stringcreated_dt:desc
querycluster_name
optional		cluster_name
Example :
stringNone
querycreated_by
optional		created_by
Example :
stringNone
queryquick_query_state
optional		state
Example :
enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING, STOPPED, STARTING, STOPPING, RESTARTING, TERMINATED, EDITING, DELETING, UNDEPLOYED)None
queryversion
optional		version
Example :
stringNone
queryquick_query_name
optional		quick_query_name
Example :
stringNone
querysize
required		size
Example : 20
integerNone
querypage
required		page
Example : 0
integerNone

Responses

HTTP CodeDescriptionSchema
200OKQuickQueryListSearchResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

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": ""
}

2 - 1.1

get /v1/quick-query

Description

get quick query list console

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260930

Parameters

TypeNameDescriptionSchemaDefault
querysort
optional		sort
Example : created_at:desc
stringcreated_dt:desc
querycluster_name
optional		cluster_name
Example :
stringNone
querycreated_by
optional		created_by
Example :
stringNone
queryquick_query_state
optional		state
Example :
enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING, STOPPED, STARTING, STOPPING, RESTARTING, TERMINATED, EDITING, DELETING, UNDEPLOYED)None
queryversion
optional		version
Example :
stringNone
queryquick_query_name
optional		quick_query_name
Example :
stringNone
querysize
required		size
Example : 20
integerNone
querypage
required		page
Example : 0
integerNone

Responses

HTTP CodeDescriptionSchema
200OKQuickQueryListSearchResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

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": ""
}

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.

VersionNot Before
1.020260701

Parameters

TypeNameDescriptionSchemaDefault
querysort
optional		sort
Example : created_at:desc
stringcreated_dt:desc
querycluster_name
optional		cluster_name
Example :
stringNone
querycreated_by
optional		created_by
Example :
stringNone
queryquick_query_state
optional		state
Example :
enum (ACTIVE, CREATING, RUNNING, ERROR, TERMINATING, DELETED, UPDATING, STOPPED, STARTING, STOPPING, RESTARTING, TERMINATED, EDITING, DELETING, UNDEPLOYED)None
queryversion
optional		version
Example :
stringNone
queryquick_query_name
optional		quick_query_name
Example :
stringNone
querysize
required		size
Example : 20
integerNone
querypage
required		page
Example : 0
integerNone

Responses

HTTP CodeDescriptionSchema
200OKQuickQueryListSearchResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

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": ""
}