Skip to main content

List Private Network Connections

List private-network connections with pagination. This API requires data source module permissions.

Endpoint: /openapi/v1/tunnel/list

Method: GET

Request parameters

ParameterTypeRequiredDescription
nameStringNoPrivate-network connection name keyword. Uses fuzzy matching.
typeStringNoConnection type: access or manual.
vendorStringNoCloud vendor: aliyun, tencent, huawei, aws, ecloud, gcp, or baidu.
currentIntegerNoCurrent page number, starting at 1. Default: 1.
pageSizeIntegerNoRecords 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.

ParameterTypeDescription
data[].tunnelIdStringPrivate-network connection ID.
data[].nameStringPrivate-network connection name.
data[].typeStringConnection type.
data[].vendorStringCloud vendor.
data[].vendorRegionIdStringCloud-vendor region ID.
data[].uidStringCloud account UID.
data[].accessIdStringCloud access credential ID.
data[].vpcIdStringVPC ID.
data[].vpcNameStringVPC name.
data[].gatewayIdStringAssociated gateway ID.
data[].endpointIdStringEndpoint ID.
data[].endpointIpStringEndpoint IP address.
data[].statusStringnormal, invalid, or deleted.
data[].errorMessageStringError message.
data[].creatorIdStringCreator account ID.
data[].createTimeDateTimeCreation time.

Success response

{"success": true, "requestId": "<requestId>", "current": 1, "pageSize": 10, "total": 0, "data": []}