All Products
Search
Document Center

Hologres:GetHoloWebLoginSetting

Last Updated:May 21, 2026

Gets the external account login setting for HoloWeb.

Operation description

Checks whether external accounts are allowed to log in to HoloWeb for a specified Hologres instance. The operation returns true if external accounts are allowed and false otherwise.

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

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

Path Parameters

Parameter

Type

Required

Description

Example

instanceId

string

No

The instance ID.

hgprecn-cn-xxxxxxx

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The request ID.

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

Data

object

The returned data.

AllowExternalAccountsLogin

boolean

Indicates whether external accounts are allowed to log in.

true

Success

boolean

Indicates whether the request was successful. This is independent of the operation's result.

true

ErrorCode

string

The error code.

null

ErrorMessage

string

The error message.

null

HttpStatusCode

string

The HTTP status code.

200

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.