Help Center/ Application Service Mesh/ API Reference/ API/ Gateway Management/ Obtaining the Gateway List
Updated on 2026-06-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Gateway List

Function

This API is used to obtain the gateway list.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    asm:mesh:listGateways

    List

    mesh *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /v3/meshes/{mesh_id}/gateways

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

mesh_id

Yes

String

Mesh ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

gateways

Array of VirtualGatewayInstance objects

Gateway instance list
Table 4 VirtualGatewayInstance

Parameter

Type

Description

gatewayName

String

Gateway name

cluster

GatewayCluster object

Cluster of the service corresponding to the gateway

address

String

External access address

protocol

String

Gateway protocol

certList

Array of CertServer objects

Certificate used for TLS termination

status

String

Gateway status

namespace

String

Namespace that the gateway belongs to

externalIPs

String

External IP address of the gateway service (ELB IP address)

ASMStyled

ASMStyled object

ASM console supported
Table 5 GatewayCluster

Parameter

Type

Description

id

String

Cluster ID

name

String

Cluster name
Table 6 CertServer

Parameter

Type

Description

secretName

String

Name of the secret for storing the certificate content

hosts

Array of strings

Certificate hosts

maxProtocolVersion

String

Supported latest TLS version

minProtocolVersion

String

Supported earliest TLS version
Table 7 ASMStyled

Parameter

Type

Description

traffic_manage

String

Whether ASM console traffic management is supported. If the value is NotMatch, the capability is not supported.

security

String

Whether ASM console service security is supported. If the value is NotMatch, the capability is not supported.

gateway_route

String

Whether ASM console gateway routing is supported. If the value is NotMatch, the capability is not supported.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The gateway list is obtained.

Error Codes

See Error Codes.

Parent topic: Gateway Management