ListGateway - 网关列表

更新时间:
复制 MD 格式

获取网关列表

接口说明

获取集群网关列表

调试

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

调试

授权信息

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

请求语法

POST /webapi/gateway/list HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

c-b25e21e24388****

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 请求状态码。

200

RequestId

string

请求 ID。

32A44F0D-BFF6-5664-999A-218BBDE7****

Success

boolean

请求是否成功。

false

ErrCode

string

错误码。

InvalidParams

ErrMessage

string

错误信息。

Invalid params: [instance not exists].

Data

array<object>

返回数据。

object

返回数据。

GatewayId

string

网关 ID。

13822

GatewayName

string

网关名称。

网关1

GatewayType

string

网关类型,一般为 Slb 或者 Privatezone

slb

InternalSlbId

string

内网 slbId

lb-123abc

PublicSlbId

string

公网 slbId

lb-abc123

EnablePublicNet

boolean

是否开启公网访问

true

FeNodeNumber

integer

网关节点数量

2

InternalDomain

string

内网访问域名

fe-c-b25e21e24388****-ab8sjd-internal.starrocks.aliyuncs.com

PublicDomain

string

公网访问域名

fe-c-b25e21e24388****-8s272d.starrocks.aliyuncs.com

PrivatezoneId

string

PrivatezoneId

a62des2123243881b9s2sa220k2l38m9

PublicSlbAclId

string

公网访问的权限控制 AclId

acl-hsb123ksi2

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE7****",
  "Success": false,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Data": [
    {
      "GatewayId": "13822",
      "GatewayName": "网关1",
      "GatewayType": "slb",
      "InternalSlbId": "lb-123abc",
      "PublicSlbId": "lb-abc123",
      "EnablePublicNet": true,
      "FeNodeNumber": 2,
      "InternalDomain": "fe-c-b25e21e24388****-ab8sjd-internal.starrocks.aliyuncs.com",
      "PublicDomain": "fe-c-b25e21e24388****-8s272d.starrocks.aliyuncs.com",
      "PrivatezoneId": "a62des2123243881b9s2sa220k2l38m9",
      "PublicSlbAclId": "acl-hsb123ksi2"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情