Shuts down the ExecuteStatement API access permissions for a specified Hologres instance.
Operation description
Disables the OpenAPI SQL execution feature for a specified Hologres instance. After the feature is disabled, all ExecuteStatement calls return an error. You can call EnableExecuteStatement to re-enable the feature.
Try it now
Test
RAM authorization
Request syntax
POST /api/v1/instances/{instanceId}/disableExecuteStatement HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
No |
The Hologres instance ID. |
hgpostcn-cn-xxxxx |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| requestId |
string |
The request ID. |
E3F4B2A7-1234-5678-9ABC-DEF012345678 |
| data |
boolean |
Indicates whether the operation is successful. Valid values:
|
|
| success |
boolean |
Indicates whether the operation is successful. |
|
| errorCode |
string |
The error code. This parameter is empty if the operation is successful. |
InvalidParameterValue |
| errorMessage |
string |
The error message. This parameter is empty if the operation is successful. |
|
| 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": "",
"httpStatusCode": "200"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.