获取网关列表 - ListGateways
功能介绍
该API用于获取网关列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v3/meshes/{mesh_id}/gateways
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
mesh_id |
是 |
String |
网格ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
gateways |
Array of VirtualGatewayInstance objects |
网关实例列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
gatewayName |
String |
网关名称 |
|
cluster |
GatewayCluster object |
网关对应的入口服务所属的集群 |
|
address |
String |
外部访问地址 |
|
protocol |
String |
网关协议 |
|
certList |
Array of CertServer objects |
tls终止使用的证书 |
|
status |
String |
网关状态 |
|
namespace |
String |
网关所在命名空间 |
|
externalIPs |
String |
网关gateway service对应的外网IP,即elb ip |
|
ASMStyled |
ASMStyled object |
网关支持ASM Console能力 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取网关列表成功 |
错误码
请参见错误码。