ListGateway - 查询私有网关列表

查询私有网关列表。

调试

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

授权信息

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

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

请求语法

GET /api/v2/gateways HTTP/1.1

请求参数

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

私有网关 ID。如何获取私有网关 ID,请参见 ListResources 接口返回结果中的 private_gateway_id 字段。

gw-1uhcqmsc7x22******
PageNumberinteger

网关列表的请求页码,默认为 1.

1
PageSizeinteger

分页查询时设置的每页显示的服务数量,默认为 100。

100
GatewayNamestring

私有网关别名。

mygateway1
ResourceNamestring

资源组 ID。如何获取资源组,请参见 ListResources 接口返回结果中的 ResourceId 字段。

eas-r-4gt8twzwllfo******

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

40325405-579C-4D82****
Gatewaysarray<object>

私有网关列表。

gatewayListobject

私有网关详情。

GatewayIdstring

私有网关 ID。

gw-1uhcqmsc7x22******
GatewayNamestring

私有网关别名。

mygateway1
InstanceTypestring

私有网关使用的机型。

2c4g
IntranetDomainstring

内网访问域名。

gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
InternetEnabledboolean

公网访问是否开启。

true
InternetDomainstring

公网访问域名。

gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com
CreateTimestring

私有网关创建时间。使用 UTC 时间。

2020-05-19T14:19:42Z
UpdateTimestring

私有网关更新时间。使用 UTC 时间。

2021-02-24T11:52:17Z
Statusstring

私有网关状态。

枚举值:
  • Creating创建中
  • Stopped已停止
  • Failed失败
  • Running运行中
  • Deleted已删除
  • Deleting删除中
  • Waiting等待中
Running
Replicasinteger

私有网关节点数。

2
IsDefaultboolean

是否默认私有网关。

true
ChargeTypestring

付费类型,取值如下:

  • PrePaid:预付费。
  • PostPaid:后付费。
PostPaid
SSLRedirectionEnabledboolean

HTTP 重定向 HTTPS 是否开启。

true
PageNumberinteger

返回查询的服务列表的当前页码。

1
PageSizeinteger

返回每页显示的服务数量。

100
TotalCountlong

网关总数。

5

示例

正常返回示例

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "Gateways": [
    {
      "GatewayId": "gw-1uhcqmsc7x22******",
      "GatewayName": "mygateway1",
      "InstanceType": "2c4g",
      "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
      "InternetEnabled": true,
      "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-02-24T11:52:17Z",
      "Status": "Running",
      "Replicas": 2,
      "IsDefault": true,
      "ChargeType": "PostPaid",
      "SSLRedirectionEnabled": true
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 5
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-11-28OpenAPI 返回结构发生变更查看变更详情
2024-10-11OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情