文档

ListGatewaySlb - 查询网关入口SLB

更新时间:

查询网关入口SLB。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ListGatewaySlbRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GatewayUniqueIdstring

网关唯一标识 ID。

gw-1cef5440bf2d484db419fb264d4f****
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

EAB345F4-3AC3-560C-B653-65717703****
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

请求处理成功
Codeinteger

返回码。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Dataobject []

返回数据。

Idstring

ID

ID
SlbIdstring

SLB ID

lb-bp1kmnli3hdpreptw2ah3
SlbIpstring

SLB IP

121.199.XX.XX
SlbPortstring

SLB 端口。

80,443
Typestring

网络类型

  • PUB_NET:公网
  • PRIVATE_NET:私网
PUB_NET
GatewayIdstring

网关 ID。

1
GmtCreatestring

创建时间。

2022-01-14 14:39:16
GatewaySlbModestring

来源。

UserSelect
GatewaySlbStatusstring

关联状态。

Ready
StatusDescstring

状态备注。

关联中
VServerGroupIdstring

http 虚拟服务组 ID。

353
HttpPortinteger

HTTP 端口(虚拟服务组)。

80
HttpsPortinteger

HTTPS 端口(虚拟服务组)。

443
ServiceWeightinteger

服务权重。

80
EditEnableboolean

是否可编辑。

false
HttpsVServerGroupIdstring

https 虚拟服务组 ID。

353
VsMetaInfostring

虚拟服务器组元信息。

[{"protocol":"HTTP","vServerGroupName":"k8s/80/****","port":80,"vServerGroupId":"rsp-bp***"},{"protocol":"HTTPS","vServerGroupName":"k8s/443/***","port":443,"vServerGroupId":"rsp-bp*****"}]
VServiceListobject []

SLB 监听信息。

Portstring

端口。

443
Protocolstring

协议类型。

  • HTTPS
  • HTTP
HTTPS
VServerGroupIdstring

虚拟服务器组 ID。

rsp-bp183l2x70***
VServerGroupNamestring

虚拟服务器组名称。

k8s/31**0/***/istio-system/clusterid

示例

正常返回示例

JSON格式

{
  "RequestId": "EAB345F4-3AC3-560C-B653-65717703****",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": "ID",
      "SlbId": "lb-bp1kmnli3hdpreptw2ah3",
      "SlbIp": "121.199.XX.XX",
      "SlbPort": "80,443",
      "Type": "PUB_NET",
      "GatewayId": "1",
      "GmtCreate": "2022-01-14 14:39:16",
      "GatewaySlbMode": "UserSelect",
      "GatewaySlbStatus": "Ready",
      "StatusDesc": "关联中",
      "VServerGroupId": "353",
      "HttpPort": 80,
      "HttpsPort": 443,
      "ServiceWeight": 80,
      "EditEnable": false,
      "HttpsVServerGroupId": "353",
      "VsMetaInfo": "[{\"protocol\":\"HTTP\",\"vServerGroupName\":\"k8s/80/****\",\"port\":80,\"vServerGroupId\":\"rsp-bp***\"},{\"protocol\":\"HTTPS\",\"vServerGroupName\":\"k8s/443/***\",\"port\":443,\"vServerGroupId\":\"rsp-bp*****\"}]",
      "VServiceList": [
        {
          "Port": "443",
          "Protocol": "HTTPS",
          "VServerGroupId": "rsp-bp183l2x70***",
          "VServerGroupName": "k8s/31**0/***/istio-system/clusterid"
        }
      ],
      "SlbType": ""
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

变更历史

变更时间变更内容概要操作
2023-10-11OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-10OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-09-01OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈