DisableExecuteStatement

更新时间:
复制 MD 格式

Disables ExecuteStatement API access for a Hologres instance.

Operation description

Disables the OpenAPI SQL execution feature on a Hologres instance. Once disabled, all ExecuteStatement calls return an error. Call EnableExecuteStatement to re-enable.

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}/disableExecuteStatement HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

instanceId

string

No

Hologres instance ID.

hgpostcn-cn-xxxxx

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

Response structure.

requestId

string

Request ID.

E3F4B2A7-1234-5678-9ABC-DEF012345678

data

boolean

true: operation succeeded. false: operation failed.

success

boolean

Whether the request succeeded.

errorCode

string

Error code returned on failure.

InvalidParameterValue

errorMessage

string

Error message returned on failure.

Invalid parameter value (for example, the SQL statement is empty or too long)

httpStatusCode

string

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.