Test a Private Connection Configuration

Test a complete private connection configuration without saving it first. This API requires data source module permissions.

Endpoint: /openapi/v1/tunnel/test

Method: POST

The request parameters are the same as Create a Private Connection.

Request example

{"name": "example-tunnel", "type": "access", "vendor": "aliyun", "vendorRegionId": "cn-hangzhou", "uid": "<uid>", "accessId": "<accessId>", "vpcId": "<vpcId>"}

Response parameters

data contains Boolean success, connection status, and errorMessage when the test fails.

Success response

{"success": true, "requestId": "<requestId>", "data": {"success": true, "status": "normal", "errorMessage": null}}