EnableExecuteStatement - Enable SQL execution via OpenAPI | Hologres - Hologres

Operation description

Enables SQL execution via OpenAPI for a specified Hologres instance. Once enabled, RAM accounts with the hologram:ExecuteStatement permission can run SQL statements through the ExecuteStatement API. Use GetExecuteStatementEnabled to check the current status, or DisableExecuteStatement to turn off this feature.

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

POST /api/v1/instances/{instanceId}/enableExecuteStatement HTTP/1.1

Path Parameters

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

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	E3F4B2A7-1234-5678-9ABC-DEF012345678
data	boolean	The operation result. A value of `true` indicates success; `false` indicates failure.
success	boolean	Whether the API call succeeded.
errorCode	string	The error code returned on failure.	InvalidParameterValue
errorMessage	string	The error message returned on failure.	Example error message
httpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "requestId": "E3F4B2A7-1234-5678-9ABC-DEF012345678",
  "data": false,
  "success": false,
  "errorCode": "InvalidParameterValue",
  "errorMessage": "Invalid parameter value (for example, the SQL statement is empty or too long)",
  "httpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.