ListGateway - 查詢網關資訊列表 - Microservices Engine

查詢該網關列表資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:ListGateway

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	頁碼。	1
PageSize	integer	否	每頁展示執行個體數。	10
OrderItem	string	否	訂單資訊。	{}
DescSort	boolean	否	排序（暫時未使用）。	false
FilterParams	object	否	參數資訊。
GatewayType	string	否	網關類型。	Ingress
Name	string	否	網關名稱。	rutain-test
Vpc	string	否	專用網路。	vpc-bp13hhyjntbab7w****
GatewayUniqueId	string	否	網關唯一標識 ID。	gw-5017305290e14centbrveca****
InstanceId	string	否	執行個體 ID。	mse_ingresspre-cn-****
MseTag	string	否	資源標籤。	[{"key":"tagkey","value":"tagvalue"}]
ResourceGroupId	string	否	資源群組 ID。	rg-7y2uye*****
AcceptLanguage	string	否	返回資訊的語言類型： zh：中文 en：英文	zh

返回參數

名稱	類型	描述	樣本值
	object	資料結構。
RequestId	string	請求 ID。	34300B3-52EC-5049-8C96-914098CF****
HttpStatusCode	integer	HTTP 狀態代碼。	200
Message	string	返回資訊。	You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*
Code	integer	傳回值。	200
Success	boolean	請求結果，取值如下： `true`：請求成功。 `false`：請求失敗。	true
Data	object	Meta 返回資訊。
TotalSize	integer	總條數。	9
PageNumber	integer	頁碼。	1
PageSize	integer	每頁條數。	10
Result	array<object>	返回資料。
	array<object>	返回集合。
Id	integer	網關 ID。	153
Name	string	網關名稱。	tesa-test
GatewayUniqueId	string	網關唯一標識 ID。	gw-5017305290e14cebb8ce5cb6a4****
GatewayType	string	網關類型。	Ingress
Region	string	地區。	cn-hangzhou
PrimaryUser	string	使用者資訊。	18278117654342
Status	integer	網關狀態 0 建立中 1 建立失敗 2 運行中 3 變更中 4 縮容中 6 擴容中 8 刪除中 9 停服待釋放 10 重啟中 11 重建中 12 升級中 13 升級失敗	2
AhasOn	boolean	是否開啟 AHAS。	false
ArmsOn	boolean	是否開啟 ARMS。	false
Spec	string	規格。	MSE_GTW_1_2_200_c
Replica	integer	備份。	2
GmtCreate	string	建立時間。	2021-09-13 19:24:23
GmtModified	string	修改時間。	2021-09-13 19:24:23
StatusDesc	string	狀態原因。	重啟中
Slb	array<object>	SLB 集合。
	object	SLB 集合資訊。
SlbIp	string	SLB IP。	153.12.XX.XX
SlbPort	string	SLB 連接埠。	80
SlbSpec	string	SLB 規格。	slb.s2.small
Type	string	網路類型 PUB_NET：公網 PRIVATE_NET：私網	PUB_NET
GatewaySlbStatus	string	網關 SLB 狀態。	Ready
StatusDesc	string	狀態原因。	建立中
GatewaySlbMode	string	網關 SLB 模式。	UserHost
SlbId	string	SLB ID。	lb-bp1ut8asdfgucjk****
InternetSlb	array<object>	互連網 SLB。
	object	資料結構。
SlbIp	string	SLB IP。	153.12.XX.XX
SlbPort	string	SLB 連接埠。	slb.s2.small
SlbSpec	string	SLB 規格。	slb.s2.small
Type	string	類型。	PUB_NET
InternetNetworkFlow	string	網關流量。	20
GatewaySlbStatus	string	網關 SLB 狀態。	Ready
StatusDesc	string	狀態原因。	建立中
GatewaySlbMode	string	網關 SLB 模式。	UserHost
SlbId	string	SLB ID。	lb-bp1ut8asdfgucjk****
Upgrade	boolean	升級。	false
MustUpgrade	boolean	強制升級。	false
SupportWasm	boolean	是否支援 WASM。	true
CurrentVersion	string	目前的版本。	0.1.0-mse-gw
AppVersion	string	應用版本。	1.0.1.0
LatestVersion	string	最新版本。	0.1.0-mse-gw
Vswitch2	string	交換器 2。	vsw-bpbrveck45nf****
InstanceId	string	執行個體 ID。	mse_ingresspost-cn-0jbvrcex****
ChargeType	string	付費類型。	POSTPAY
EndDate	string	到期日。	4792060800000
Tag	string	標籤。	test
InitConfig	object	配置資訊。
EnableWaf	boolean	是否開啟 WAF。	true
SupportWaf	boolean	是否支援 WAF。	true
GatewayVersion	string	網關版本。	1.2.9
RollBack	boolean	是否支援復原。	false
MseTag	string	資源標籤。	{"tagKey":"tagValue"}
ResourceGroupId	string	資源群組 ID。	rg-97hg87vi****
TotalReplica	integer	總副本數（包括自動擴容副本數）。	4
Elastic	boolean	是否開啟自動擴容。	true
ElasticReplica	integer	自動擴容副本數。	2
ElasticType	string	自動擴容類型，目前支援： CronHPA：按時間擴容	CronHPA
ElasticPolicy	object	自動擴容策略。
Elastic	boolean	是否開啟自動擴容。	true
MaxReplica	integer	自動擴容最大執行個體數（水平擴容時使用）。	10
ElasticType	string	自動擴容類型，目前支援： CronHPA：按時間擴容	CronHPA
TimePolicyList	array<object>	自動擴容時間策略列表。
	object
DesiredReplica	integer	自動擴容期望副本數。	4
StartTime	string	自動擴容起始時間。	07:00
EndTime	string	自動擴容結束時間。	09:00
LoadWarningThreshold	boolean	網關按負載彈性的水位設定，true 表示開啟警戒水位，false 表示開啟安全水位
EnableScaleTimePolicyList	array<object>	允許縮容時間段
	object
StartTime	string	開始時間。
EndTime	string	結束時間。
ElasticInstanceId	string	網關彈性執行個體 ID，使用自動擴容時返回。	mse_ingresselastic_public_cn-uqm3d0*****
VpcId	string	網關 VPC ID。	vpc-uf6heojei217tv14*****
MseVersion	string	叢集版本。
MaintenancePeriod	object	營運時間視窗。
TimeZone	string	時區。
StartTime	string	開始時間。
EndTime	string	結束時間。
GatewayEntry	array<object>	網關入口地址（適用普通執行個體專業版）
	object
NetType	string	入口網路類型 PRIVATE_NET：私網 PUB_NET：公網	PUB_NET
EntryDomain	string	入口網域名稱	gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com
IpList	array	入口 IP 列表
	string	入口 IP	1.2.3.4
HttpPorts	array	HTTP 監聽連接埠列表
	integer	HTTP 監聽連接埠	80
HttpsPorts	array	HTTPS 監聽連接埠列表
	integer	HTTPS 監聽連接埠	443
VersionLifecycle	string	版本生命週期

樣本

正常返回樣本

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"
            }
          ],
          "LoadWarningThreshold": true,
          "EnableScaleTimePolicyList": [
            {
              "StartTime": "",
              "EndTime": ""
            }
          ]
        },
        "ElasticInstanceId": "mse_ingresselastic_public_cn-uqm3d0*****",
        "VpcId": "vpc-uf6heojei217tv14*****",
        "MseVersion": "",
        "MaintenancePeriod": {
          "TimeZone": "",
          "StartTime": "",
          "EndTime": ""
        },
        "GatewayEntry": [
          {
            "NetType": "PUB_NET",
            "EntryDomain": "gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com",
            "IpList": [
              "1.2.3.4"
            ],
            "HttpPorts": [
              80
            ],
            "HttpsPorts": [
              443
            ]
          }
        ],
        "VersionLifecycle": ""
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalRequest	Invalid request:%s	非法請求： %s
400	InvalidParameter	Parameter error:%s	請求參數錯誤：%s
500	InternalError	Console error. Try again later:%s	控制台錯誤.稍後重試：%s
403	NoPermission	You are not authorized to perform this operation:%s	沒有許可權使用此介面：%s
404	NotFound	Not found:%s	資源不存在：%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。