ListGateway - 查询私有网关列表_人工智能平台 PAI(PAI)-阿里云帮助中心

查询私有网关列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

eas:ListGateway

list

*全部资源

*

无

请求语法

GET /api/v2/gateways HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	否	私有网关 ID。如何获取私有网关 ID，请参见 ListResources 接口返回结果中的 private_gateway_id 字段。	gw-1uhcqmsc7x22******
PageNumber	integer	否	网关列表的请求页码，默认为 1.	1
PageSize	integer	否	分页查询时设置的每页显示的服务数量，默认为 100。	100
GatewayName	string	否	私有网关别名。	mygateway1
ResourceName	string	否	资源组 ID。如何获取资源组，请参见 ListResources 接口返回结果中的 ResourceId 字段。	eas-r-4gt8twzwllfo******
InternetEnabled	boolean	否
Status	string	否
ChargeType	string	否
Sort	string	否
Order	string	否
GatewayType	string	否

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	40325405-579C-4D82****
Gateways	array<object>	私有网关列表。
	object	私有网关详情。
GatewayId	string	私有网关 ID。	gw-1uhcqmsc7x22******
GatewayName	string	私有网关别名。	mygateway1
InstanceType	string	私有网关使用的机型。	2c4g
IntranetDomain	string	内网访问域名。	gw-1uhcqmsc7x22****-1801786532****-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
InternetEnabled	boolean	公网访问是否开启。	true
InternetDomain	string	公网访问域名。	gw-1uhcqmsc7x22****-1801786532****.cn-wulanchabu.pai-eas.aliyuncs.com
CreateTime	string	私有网关创建时间。使用 UTC 时间。	2020-05-19T14:19:42Z
UpdateTime	string	私有网关更新时间。使用 UTC 时间。	2021-02-24T11:52:17Z
Status	string	私有网关状态。枚举值： Creating : 创建中 Stopped : 已停止 Failed : 失败 Running : 运行中 Deleted : 已删除 Deleting : 删除中 Waiting : 等待中	Running
Replicas	integer	私有网关节点数。	2
IsDefault	boolean	是否默认私有网关。	true
ChargeType	string	付费类型，取值如下： PrePaid：预付费。 PostPaid：后付费。	PostPaid
SSLRedirectionEnabled	boolean	HTTP 重定向 HTTPS 是否开启。	true
IntranetEnabled	boolean
PageNumber	integer	返回查询的服务列表的当前页码。	1
PageSize	integer	返回每页显示的服务数量。	100
TotalCount	integer	网关总数。	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,
      "IntranetEnabled": true
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 5
}

错误码

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

变更历史

更多信息，参考变更详情。