GetExecuteStatementEnabled - Hologres - Alibaba Cloud Documentation Center

Operation description

This operation checks if the "Allow SQL execution through OpenAPI" feature is enabled for a specified Hologres instance. Returns true if the feature is enabled, and false otherwise. If enabled, you can call the ExecuteStatement operation to execute SQL statements.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/v1/instances/{instanceId}/executeStatementEnabled HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The ID of the instance.	hgpostcn-cn-zpr3426vm002

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC
data	boolean	Indicates whether SQL execution through OpenAPI is allowed (`true`) or not (`false`).	true
success	boolean	Indicates whether the request was successful.	True
errorCode	string	The error code that is returned if the request fails (when `success` is `false`). This parameter is empty if the request is successful (when `success` is `true`).	success
errorMessage	string	The error message that is returned if the request fails (when `success` is `false`). This parameter is empty if the request is successful (when `success` is `true`).	ok
httpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "requestId": "2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC",
  "data": true,
  "success": true,
  "errorCode": "success",
  "errorMessage": "ok",
  "httpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.