查詢網關列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（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": [
{
"key": "",
"value": ""
}
]
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-03 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-11-20 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-08-06 | OpenAPI 返回結構發生變更 | 查看變更詳情 |