List Gateways

List data source access gateways with pagination. This API requires data source module permissions.

Endpoint: /openapi/v1/gateway/list

Method: GET

Request parameters

Parameter	Type	Required	Description
name	String	No	Gateway name keyword.
gatewayId	String	No	Gateway ID.
status	String	No	Gateway status.
current	Integer	No	Current page number, starting at 1. Default: 1.
pageSize	Integer	No	Records per page. Default: 10; maximum: 1000.

Response parameters

The response contains success, requestId, current, pageSize, total, and data. Each item in data contains the following fields.

Parameter	Type	Description
data[].id	String	Gateway ID.
data[].name	String	Gateway name.
data[].status	String	Gateway status.
data[].statusInfo	String	Status detail.
data[].dsCount	Integer	Number of associated data sources.
data[].lastConnectTime	DateTime	Last connection time.
data[].accountId	String	Creator account ID.
data[].openProxy	Boolean	Whether proxy is enabled.
data[].proxyIP	String	Proxy service IP address.
data[].proxyPort	Integer	Proxy service port.
data[].depGateway	String	ID of the dependent proxy gateway.
data[].depStub	String	ID of the dependent Stub gateway.
data[].tunnelId	String	ID of the bound private-network connection.
data[].regionId	String	Region ID of the Stub.
data[].gatewayNodeInfo	Object	Gateway node information.

Success response

{"success": true, "requestId": "<requestId>", "current": 1, "pageSize": 10, "total": 1, "data": [{"id": "<gatewayId>", "name": "example-gateway", "status": "running", "dsCount": 0}]}