GetExecuteStatementEnabled - 查询实例是否开启ExecuteStatement功能-实时数仓 Hologres(Hologres)-阿里云帮助中心

接口说明

查询指定 Hologres 实例是否已开启"允许通过 OpenAPI 执行 SQL"功能。返回 true 表示已开启，false 表示未开启。开启后可通过 ExecuteStatement 接口执行 SQL。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

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

路径参数

名称	类型	必填	描述	示例值
instanceId	string	否	实例 ID。该参数必填。	hgpostcn-cn-zpr3426vm002

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	2C2ECDC1-FBAD-14A5-AA4A-96BC787FBDBC
data	boolean	true:允许 OpenAPI SQL 执行调用；false：未允许 OpenAPI SQL 执行调用	true
success	boolean	调用是否成功	True
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	success
errorMessage	string	当 success 为 false，返回业务错误信息；当 success 为 true，返回空值。	ok
httpStatusCode	string	HTTP 状态码	200

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。