ListGateway - 查询网关信息列表 - 微服务引擎MSE

查询该网关列表信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
mse:ListGateway	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	页码。	1
PageSize	integer	否	每页展示实例数。	10
OrderItem	string	否	订单信息。	{}
DescSort	boolean	否	排序（暂时未使用）。	false
FilterParams	object	否	参数信息。
GatewayType	string	否	网关类型。	Ingress
Name	string	否	网关名称。	rutain-test
Vpc	string	否	专有网络。	vpc-bp13hhyjntbab7w****
GatewayUniqueId	string	否	网关唯一标识 ID。	gw-5017305290e14centbrveca****
InstanceId	string	否	实例 ID。	mse_ingresspre-cn-****
MseTag	string	否	资源标签。	[{"key":"tagkey","value":"tagvalue"}]
ResourceGroupId	string	否	资源组 ID。	rg-7y2uye*****
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	数据结构。
RequestId	string	请求 ID。	34300B3-52EC-5049-8C96-914098CF****
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	返回信息。	You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*
Code	integer	返回值。	200
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Data	object	Meta 返回信息。
TotalSize	long	总条数。	9
PageNumber	integer	页码。	1
PageSize	integer	每页条数。	10
Result	array<object>	返回数据。
Gateways	object	返回集合。
Id	long	网关 ID。	153
Name	string	网关名称。	tesa-test
GatewayUniqueId	string	网关唯一标识 ID。	gw-5017305290e14cebb8ce5cb6a4****
GatewayType	string	网关类型。	Ingress
Region	string	地域。	cn-hangzhou
PrimaryUser	string	用户信息。	18278117654342
Status	integer	网关状态 0 创建中 1 创建失败 2 运行中 3 变更中 4 缩容中 6 扩容中 8 删除中 9 停服待释放 10 重启中 11 重建中 12 升级中 13 升级失败	2
AhasOn	boolean	是否开启 AHAS。	false
ArmsOn	boolean	是否开启 ARMS。	false
Spec	string	规格。	MSE_GTW_1_2_200_c
Replica	integer	备份。	2
GmtCreate	string	创建时间。	2021-09-13 19:24:23
GmtModified	string	修改时间。	2021-09-13 19:24:23
StatusDesc	string	状态描述。	重启中
Slb	array<object>	SLB 集合。
slb	object	SLB 集合信息。
SlbIp	string	SLB IP。	153.12.XX.XX
SlbPort	string	SLB 端口。	80
SlbSpec	string	SLB 规格。	slb.s2.small
Type	string	网络类型 PUB_NET：公网 PRIVATE_NET：私网	PUB_NET
GatewaySlbStatus	string	网关 SLB 状态。	Ready
StatusDesc	string	状态描述。	创建中
GatewaySlbMode	string	网关 SLB 模式。	UserHost
SlbId	string	SLB ID。	lb-bp1ut8asdfgucjk****
InternetSlb	array<object>	互联网 SLB。
internetSlb	object	数据结构。
SlbIp	string	SLB IP。	153.12.XX.XX
SlbPort	string	SLB 端口。	slb.s2.small
SlbSpec	string	SLB 规格。	slb.s2.small
Type	string	类型。	PUB_NET
InternetNetworkFlow	string	网关流量。	20
GatewaySlbStatus	string	网关 SLB 状态。	Ready
StatusDesc	string	状态描述。	创建中
GatewaySlbMode	string	网关 SLB 模式。	UserHost
SlbId	string	SLB ID。	lb-bp1ut8asdfgucjk****
Upgrade	boolean	升级。	false
MustUpgrade	boolean	强制升级。	false
SupportWasm	boolean	是否支持 WASM。	true
CurrentVersion	string	当前版本。	0.1.0-mse-gw
AppVersion	string	应用版本。	1.0.1.0
LatestVersion	string	最新版本。	0.1.0-mse-gw
Vswitch2	string	交换机 2。	vsw-bpbrveck45nf****
InstanceId	string	实例 ID。	mse_ingresspost-cn-0jbvrcex****
ChargeType	string	付费类型。	POSTPAY
EndDate	string	到期日期。	4792060800000
Tag	string	标签。	test
InitConfig	object	配置信息。
EnableWaf	boolean	是否开启 WAF。	true
SupportWaf	boolean	是否支持 WAF。	true
GatewayVersion	string	网关版本。	1.2.9
RollBack	boolean	是否支持回滚。	false
MseTag	string	资源标签。	{"tagKey":"tagValue"}
ResourceGroupId	string	资源组 ID。	rg-97hg87vi****
TotalReplica	integer	总副本数（包括自动扩容副本数）。	4
Elastic	boolean	是否开启自动扩容。	true
ElasticReplica	integer	自动扩容副本数。	2
ElasticType	string	自动扩容类型，目前支持： CronHPA：按时间扩容	CronHPA
ElasticPolicy	object	自动扩容策略。
Elastic	boolean	是否开启自动扩容。	true
MaxReplica	integer	自动扩容最大实例数（水平扩容时使用）。	10
ElasticType	string	自动扩容类型，目前支持： CronHPA：按时间扩容	CronHPA
TimePolicyList	array<object>	自动扩容时间策略列表。
timePolicyList	object
DesiredReplica	integer	自动扩容期望副本数。	4
StartTime	string	自动扩容起始时间。	07:00
EndTime	string	自动扩容结束时间。	09:00
LoadWarningThreshold	boolean	网关按负载弹性的水位设置，true 表示开启警戒水位，false 表示开启安全水位
EnableScaleTimePolicyList	array<object>	允许缩容时间段
ElasticInstanceId	string	网关弹性实例 ID，使用自动扩容时返回。	mse_ingresselastic_public_cn-uqm3d0*****
VpcId	string	网关 VPC ID。	vpc-uf6heojei217tv14*****

示例

正常返回示例

JSON格式

{
  "RequestId": "34300B3-52EC-5049-8C96-914098CF****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 153,
        "Name": "tesa-test",
        "GatewayUniqueId": "gw-5017305290e14cebb8ce5cb6a4****",
        "GatewayType": "Ingress",
        "Region": "cn-hangzhou",
        "PrimaryUser": "18278117654342",
        "Status": 2,
        "AhasOn": false,
        "ArmsOn": false,
        "Spec": "MSE_GTW_1_2_200_c",
        "Replica": 2,
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2021-09-13 19:24:23",
        "StatusDesc": "重启中",
        "Slb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "80",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "创建中",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "InternetSlb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "slb.s2.small",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "InternetNetworkFlow": "20",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "创建中",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "Upgrade": false,
        "MustUpgrade": false,
        "SupportWasm": true,
        "CurrentVersion": "0.1.0-mse-gw",
        "AppVersion": "1.0.1.0",
        "LatestVersion": "0.1.0-mse-gw",
        "Vswitch2": "vsw-bpbrveck45nf****",
        "InstanceId": "mse_ingresspost-cn-0jbvrcex****",
        "ChargeType": "POSTPAY",
        "EndDate": "4792060800000",
        "Tag": "test",
        "InitConfig": {
          "EnableWaf": true,
          "SupportWaf": true
        },
        "GatewayVersion": "1.2.9",
        "RollBack": false,
        "MseTag": "{\"tagKey\":\"tagValue\"}",
        "ResourceGroupId": "rg-97hg87vi****",
        "TotalReplica": 4,
        "Elastic": true,
        "ElasticReplica": 2,
        "ElasticType": "CronHPA",
        "ElasticPolicy": {
          "Elastic": true,
          "MaxReplica": 10,
          "ElasticType": "CronHPA",
          "TimePolicyList": [
            {
              "DesiredReplica": 4,
              "StartTime": "07:00",
              "EndTime": "09:00"
            }
          ],
          "LoadWarningThreshold": true,
          "EnableScaleTimePolicyList": [
            {
              "StartTime": "",
              "EndTime": ""
            }
          ]
        },
        "ElasticInstanceId": "mse_ingresselastic_public_cn-uqm3d0*****",
        "VpcId": "vpc-uf6heojei217tv14*****",
        "MseVersion": "",
        "MaintenancePeriod": {
          "TimeZone": "",
          "StartTime": "",
          "EndTime": ""
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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

变更历史

变更时间	变更内容概要	操作
2024-09-09	OpenAPI 返回结构发生变更	查看变更详情
2023-10-11	OpenAPI 返回结构发生变更	查看变更详情
2023-08-09	OpenAPI 返回结构发生变更	查看变更详情
2023-05-09	OpenAPI 返回结构发生变更	查看变更详情
2022-02-18	API 内部配置变更，不影响调用	查看变更详情
2022-02-18	OpenAPI 返回结构发生变更	查看变更详情