全部产品
Search
文档中心

实时数仓Hologres:GetHoloWebLoginSetting - 查询HoloWeb登录权限

更新时间:May 21, 2026

获取holoweb登陆权限

接口说明

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

调试

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

调试

授权信息

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

请求语法

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

路径参数

名称

类型

必填

描述

示例值

instanceId

string

实例 id。

hgprecn-cn-xxxxxxx

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 id。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A

Data

object

true:成功;false:失败

AllowExternalAccountsLogin

boolean

是否允许外部账号登录

true

Success

boolean

请求结果,表示此次请求是否发生异常,和业务无关。

true

ErrorCode

string

错误码。

null

ErrorMessage

string

错误信息。

null

HttpStatusCode

string

http 状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A",
  "Data": {
    "AllowExternalAccountsLogin": true
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

错误码

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

变更历史

更多信息,参考变更详情