查询网关列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apig:ListGateways | list | *Gateway acs:apig:{#regionId}:{#accountId}:gateway/* |
| 无 |
请求语法
GET /v1/gateways HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| gatewayId | string | 否 | 根据网关 ID 精确查询。 | gw-cpv4sqdl**** |
| pageNumber | integer | 否 | 分页页码。 | 1 |
| pageSize | integer | 否 | 分页大小。 | 10 |
| name | string | 否 | 根据网关名称精确查询。 | itemcenter-gateway |
| keyword | string | 否 | 关键字，按照全匹配搜索，不区分大小写。 | dev |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "5B626361-070A-56A7-B127-ADAC8F3655DB",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 6,
"items": [
{
"gatewayId": "gw-cpv54p5***",
"name": "itemcenter-gateway",
"chargeType": "POSTPAY",
"status": "Running",
"spec": "apigw.small.x1",
"replicas": "2",
"createTimestamp": 1719386834548,
"updateTimestamp": 1719386834548,
"expireTimestamp": 172086834548,
"createFrom": "Console",
"version": "2.0.2",
"targetVersion": "2.0.2",
"loadBalancers": [
{
"loadBalancerId": "nlb-xqwioje1c91r***",
"addressType": "Internet",
"type": "NLB",
"status": "Ready",
"address": "nlb-xoh3pghr***.cn-hangzhou.nlb.aliyuncs.com\n",
"addressIpVersion": "ipv4",
"mode": "Managed",
"gatewayDefault": true,
"ports": [
{
"protocol": "TCP",
"port": 443
}
]
}
],
"securityGroup": {
"securityGroupId": ""
},
"zones": [
{
"zoneId": "",
"vSwitch": {
"vSwitchId": ""
}
}
],
"vSwitch": {
"vSwitchId": ""
},
"vpc": {
"vpcId": ""
},
"resourceGroupId": "",
"tags": [
{
"tagKey": "",
"tagValue": ""
}
]
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |