文档

ListGateway - 查询网关信息列表

更新时间:

查询该网关列表信息。

调试

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

授权信息

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

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

请求参数

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

页码。

1
PageSizeinteger

每页展示实例数。

10
OrderItemstring

订单信息。

{}
DescSortboolean

排序(暂时未使用)。

false
FilterParamsobject

参数信息。

GatewayTypestring

网关类型。

Ingress
Namestring

网关名称。

rutain-test
Vpcstring

专有网络。

vpc-bp13hhyjntbab7w****
GatewayUniqueIdstring

网关唯一标识 ID。

gw-5017305290e14centbrveca****
InstanceIdstring

实例 ID。

mse_ingresspre-cn-****
MseTagstring

资源标签。

[{"key":"tagkey","value":"tagvalue"}]
ResourceGroupIdstring

资源组 ID。

rg-7y2uye*****
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

34300B3-52EC-5049-8C96-914098CF****
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*
Codeinteger

返回值。

200
Successboolean

请求结果,取值如下:

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

Meta 返回信息。

TotalSizelong

总条数。

9
PageNumberinteger

页码。

1
PageSizeinteger

每页条数。

10
Resultobject []

返回数据。

Idlong

网关 ID。

153
Namestring

网关名称。

tesa-test
GatewayUniqueIdstring

网关唯一标识 ID。

gw-5017305290e14cebb8ce5cb6a4****
GatewayTypestring

网关类型。

Ingress
Regionstring

地域。

cn-hangzhou
PrimaryUserstring

用户信息。

18278117654342
Statusinteger

网关状态

  • 0 创建中
  • 1 创建失败
  • 2 运行中
  • 3 变更中
  • 4 缩容中
  • 6 扩容中
  • 8 删除中
  • 9 停服待释放
  • 10 重启中
  • 11 重建中
  • 12 升级中
  • 13 升级失败
2
AhasOnboolean

是否开启 AHAS。

false
ArmsOnboolean

是否开启 ARMS。

false
Specstring

规格。

MSE_GTW_1_2_200_c
Replicainteger

备份。

2
GmtCreatestring

创建时间。

2021-09-13 19:24:23
GmtModifiedstring

修改时间。

2021-09-13 19:24:23
StatusDescstring

状态描述。

重启中
Slbobject []

SLB 集合。

SlbIpstring

SLB IP。

153.12.XX.XX
SlbPortstring

SLB 端口。

80
SlbSpecstring

SLB 规格。

slb.s2.small
Typestring

网络类型

  • PUB_NET:公网
  • PRIVATE_NET:私网
PUB_NET
GatewaySlbStatusstring

网关 SLB 状态。

Ready
StatusDescstring

状态描述。

创建中
GatewaySlbModestring

网关 SLB 模式。

UserHost
SlbIdstring

SLB ID。

lb-bp1ut8asdfgucjk****
InternetSlbobject []

互联网 SLB。

SlbIpstring

SLB IP。

153.12.XX.XX
SlbPortstring

SLB 端口。

slb.s2.small
SlbSpecstring

SLB 规格。

slb.s2.small
Typestring

类型。

PUB_NET
InternetNetworkFlowstring

网关流量。

20
GatewaySlbStatusstring

网关 SLB 状态。

Ready
StatusDescstring

状态描述。

创建中
GatewaySlbModestring

网关 SLB 模式。

UserHost
SlbIdstring

SLB ID。

lb-bp1ut8asdfgucjk****
Upgradeboolean

升级。

false
MustUpgradeboolean

强制升级。

false
SupportWasmboolean

是否支持 WASM。

true
CurrentVersionstring

当前版本。

0.1.0-mse-gw
AppVersionstring

应用版本。

1.0.1.0
LatestVersionstring

最新版本。

0.1.0-mse-gw
Vswitch2string

交换机 2。

vsw-bpbrveck45nf****
InstanceIdstring

实例 ID。

mse_ingresspost-cn-0jbvrcex****
ChargeTypestring

付费类型。

POSTPAY
EndDatestring

到期日期。

4792060800000
Tagstring

标签。

test
InitConfigobject

配置信息。

EnableWafboolean

是否开启 WAF。

true
SupportWafboolean

是否支持 WAF。

true
GatewayVersionstring

网关版本。

1.2.9
RollBackboolean

是否支持回滚。

false
MseTagstring

资源标签。

{"tagKey":"tagValue"}
ResourceGroupIdstring

资源组 ID。

rg-97hg87vi****
TotalReplicainteger

总副本数(包括自动扩容副本数)。

4
Elasticboolean

是否开启自动扩容。

true
ElasticReplicainteger

自动扩容副本数。

2
ElasticTypestring

自动扩容类型,目前支持:

  • CronHPA:按时间扩容
CronHPA
ElasticPolicyobject

自动扩容策略。

Elasticboolean

是否开启自动扩容。

true
MaxReplicainteger

自动扩容最大实例数(水平扩容时使用)。

10
ElasticTypestring

自动扩容类型,目前支持:

  • CronHPA:按时间扩容
CronHPA
TimePolicyListobject []

自动扩容时间策略列表。

DesiredReplicainteger

自动扩容期望副本数。

4
StartTimestring

自动扩容起始时间。

07:00
EndTimestring

自动扩容结束时间。

09:00
ElasticInstanceIdstring

网关弹性实例 ID,使用自动扩容时返回。

mse_ingresselastic_public_cn-uqm3d0*****
VpcIdstring

网关 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"
            }
          ]
        },
        "ElasticInstanceId": "mse_ingresselastic_public_cn-uqm3d0*****",
        "VpcId": "vpc-uf6heojei217tv14*****",
        "MseVersion": "",
        "MaintenancePeriod": {
          "TimeZone": "",
          "StartTime": "",
          "EndTime": ""
        }
      }
    ]
  }
}

错误码

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-08-09OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-09OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-02-18API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-02-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)