# \PrivateEndpointConnectionServiceAPI

All URIs are relative to *https://dedicated.tidbapi.com/v1beta1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**PrivateEndpointConnectionServiceCreatePrivateEndpointConnection**](PrivateEndpointConnectionServiceAPI.md#PrivateEndpointConnectionServiceCreatePrivateEndpointConnection) | **Post** /clusters/{clusterId}/tidbNodeGroups/{privateEndpointConnection.tidbNodeGroupId}/privateEndpointConnections | Create a private endpoint connection
[**PrivateEndpointConnectionServiceDeletePrivateEndpointConnection**](PrivateEndpointConnectionServiceAPI.md#PrivateEndpointConnectionServiceDeletePrivateEndpointConnection) | **Delete** /clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections/{privateEndpointConnectionId} | Delete a private endpoint connection
[**PrivateEndpointConnectionServiceGetPrivateEndpointConnection**](PrivateEndpointConnectionServiceAPI.md#PrivateEndpointConnectionServiceGetPrivateEndpointConnection) | **Get** /clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections/{privateEndpointConnectionId} | Get a private endpoint connection
[**PrivateEndpointConnectionServiceGetPrivateLinkService**](PrivateEndpointConnectionServiceAPI.md#PrivateEndpointConnectionServiceGetPrivateLinkService) | **Get** /clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateLinkService | Get the private link service of a TiDB Node Group
[**PrivateEndpointConnectionServiceListPrivateEndpointConnections**](PrivateEndpointConnectionServiceAPI.md#PrivateEndpointConnectionServiceListPrivateEndpointConnections) | **Get** /clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections | List private endpoint connections



## PrivateEndpointConnectionServiceCreatePrivateEndpointConnection

> V1beta1PrivateEndpointConnection PrivateEndpointConnectionServiceCreatePrivateEndpointConnection(ctx, clusterId, privateEndpointConnectionTidbNodeGroupId).PrivateEndpointConnection(privateEndpointConnection).Execute()

Create a private endpoint connection

### Example

```go
package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	clusterId := "clusterId_example" // string | 
	privateEndpointConnectionTidbNodeGroupId := "privateEndpointConnectionTidbNodeGroupId_example" // string | 
	privateEndpointConnection := *openapiclient.NewPrivateEndpointConnectionServiceCreatePrivateEndpointConnectionRequest("EndpointId_example") // PrivateEndpointConnectionServiceCreatePrivateEndpointConnectionRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceCreatePrivateEndpointConnection(context.Background(), clusterId, privateEndpointConnectionTidbNodeGroupId).PrivateEndpointConnection(privateEndpointConnection).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceCreatePrivateEndpointConnection``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PrivateEndpointConnectionServiceCreatePrivateEndpointConnection`: V1beta1PrivateEndpointConnection
	fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceCreatePrivateEndpointConnection`: %v\n", resp)
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**clusterId** | **string** |  | 
**privateEndpointConnectionTidbNodeGroupId** | **string** |  | 

### Other Parameters

Other parameters are passed through a pointer to a apiPrivateEndpointConnectionServiceCreatePrivateEndpointConnectionRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------


 **privateEndpointConnection** | [**PrivateEndpointConnectionServiceCreatePrivateEndpointConnectionRequest**](PrivateEndpointConnectionServiceCreatePrivateEndpointConnectionRequest.md) |  | 

### Return type

[**V1beta1PrivateEndpointConnection**](V1beta1PrivateEndpointConnection.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)


## PrivateEndpointConnectionServiceDeletePrivateEndpointConnection

> map[string]interface{} PrivateEndpointConnectionServiceDeletePrivateEndpointConnection(ctx, clusterId, tidbNodeGroupId, privateEndpointConnectionId).Execute()

Delete a private endpoint connection

### Example

```go
package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	clusterId := "clusterId_example" // string | 
	tidbNodeGroupId := "tidbNodeGroupId_example" // string | 
	privateEndpointConnectionId := "privateEndpointConnectionId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceDeletePrivateEndpointConnection(context.Background(), clusterId, tidbNodeGroupId, privateEndpointConnectionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceDeletePrivateEndpointConnection``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PrivateEndpointConnectionServiceDeletePrivateEndpointConnection`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceDeletePrivateEndpointConnection`: %v\n", resp)
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**clusterId** | **string** |  | 
**tidbNodeGroupId** | **string** |  | 
**privateEndpointConnectionId** | **string** |  | 

### Other Parameters

Other parameters are passed through a pointer to a apiPrivateEndpointConnectionServiceDeletePrivateEndpointConnectionRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------




### Return type

**map[string]interface{}**

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)


## PrivateEndpointConnectionServiceGetPrivateEndpointConnection

> V1beta1PrivateEndpointConnection PrivateEndpointConnectionServiceGetPrivateEndpointConnection(ctx, clusterId, tidbNodeGroupId, privateEndpointConnectionId).Execute()

Get a private endpoint connection

### Example

```go
package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	clusterId := "clusterId_example" // string | 
	tidbNodeGroupId := "tidbNodeGroupId_example" // string | 
	privateEndpointConnectionId := "privateEndpointConnectionId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceGetPrivateEndpointConnection(context.Background(), clusterId, tidbNodeGroupId, privateEndpointConnectionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceGetPrivateEndpointConnection``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PrivateEndpointConnectionServiceGetPrivateEndpointConnection`: V1beta1PrivateEndpointConnection
	fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceGetPrivateEndpointConnection`: %v\n", resp)
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**clusterId** | **string** |  | 
**tidbNodeGroupId** | **string** |  | 
**privateEndpointConnectionId** | **string** |  | 

### Other Parameters

Other parameters are passed through a pointer to a apiPrivateEndpointConnectionServiceGetPrivateEndpointConnectionRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------




### Return type

[**V1beta1PrivateEndpointConnection**](V1beta1PrivateEndpointConnection.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)


## PrivateEndpointConnectionServiceGetPrivateLinkService

> Dedicatedv1beta1PrivateLinkService PrivateEndpointConnectionServiceGetPrivateLinkService(ctx, clusterId, tidbNodeGroupId).Execute()

Get the private link service of a TiDB Node Group

### Example

```go
package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	clusterId := "clusterId_example" // string | 
	tidbNodeGroupId := "tidbNodeGroupId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceGetPrivateLinkService(context.Background(), clusterId, tidbNodeGroupId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceGetPrivateLinkService``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PrivateEndpointConnectionServiceGetPrivateLinkService`: Dedicatedv1beta1PrivateLinkService
	fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceGetPrivateLinkService`: %v\n", resp)
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**clusterId** | **string** |  | 
**tidbNodeGroupId** | **string** |  | 

### Other Parameters

Other parameters are passed through a pointer to a apiPrivateEndpointConnectionServiceGetPrivateLinkServiceRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------



### Return type

[**Dedicatedv1beta1PrivateLinkService**](Dedicatedv1beta1PrivateLinkService.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)


## PrivateEndpointConnectionServiceListPrivateEndpointConnections

> V1beta1ListPrivateEndpointConnectionsResponse PrivateEndpointConnectionServiceListPrivateEndpointConnections(ctx, clusterId, tidbNodeGroupId).ProjectId(projectId).CloudProvider(cloudProvider).PageSize(pageSize).PageToken(pageToken).Skip(skip).Execute()

List private endpoint connections

### Example

```go
package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	clusterId := "clusterId_example" // string | To list private link connections across different clusters and TiDB groups, set cluster_id to \"-\".
	tidbNodeGroupId := "tidbNodeGroupId_example" // string | To list private link connections across different clusters and TiDB groups, set tidb_node_group_id to \"-\".
	projectId := "projectId_example" // string | Pass this project_id only when listing under a project across different clusters and TiDB groups. Both cluster_id and tidb_node_group_id should be set to \"-\" in this case. If unspecified, the project ID of the cluster is used. (optional)
	cloudProvider := "cloudProvider_example" // string | If specified, only private link connections of the specified cloud provider will be returned.   - aws: Amazon Web Services. buf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE  - gcp: Google Cloud Platform. buf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE  - azure: Microsoft Azure. buf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE (optional)
	pageSize := int32(56) // int32 | The maximum number of private link connections to return. The service may return fewer than this value. If unspecified, at most X private link connections will be returned. The maximum value is X; values above X will be coerced to X. (optional)
	pageToken := "pageToken_example" // string | A page token, received from a previous `ListPrivateLinkConnections` call. Provide this to retrieve the subsequent page. (optional)
	skip := int32(56) // int32 | The number of individual resources to skip before starting to return results. If the skip value causes the cursor to move past the end of the collection, the response will be 200 OK with an empty result set and no next_page_token. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceListPrivateEndpointConnections(context.Background(), clusterId, tidbNodeGroupId).ProjectId(projectId).CloudProvider(cloudProvider).PageSize(pageSize).PageToken(pageToken).Skip(skip).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceListPrivateEndpointConnections``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PrivateEndpointConnectionServiceListPrivateEndpointConnections`: V1beta1ListPrivateEndpointConnectionsResponse
	fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointConnectionServiceAPI.PrivateEndpointConnectionServiceListPrivateEndpointConnections`: %v\n", resp)
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**clusterId** | **string** | To list private link connections across different clusters and TiDB groups, set cluster_id to \"-\". | 
**tidbNodeGroupId** | **string** | To list private link connections across different clusters and TiDB groups, set tidb_node_group_id to \"-\". | 

### Other Parameters

Other parameters are passed through a pointer to a apiPrivateEndpointConnectionServiceListPrivateEndpointConnectionsRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------


 **projectId** | **string** | Pass this project_id only when listing under a project across different clusters and TiDB groups. Both cluster_id and tidb_node_group_id should be set to \"-\" in this case. If unspecified, the project ID of the cluster is used. | 
 **cloudProvider** | **string** | If specified, only private link connections of the specified cloud provider will be returned.   - aws: Amazon Web Services. buf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE  - gcp: Google Cloud Platform. buf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE  - azure: Microsoft Azure. buf:lint:ignore ENUM_VALUE_UPPER_SNAKE_CASE | 
 **pageSize** | **int32** | The maximum number of private link connections to return. The service may return fewer than this value. If unspecified, at most X private link connections will be returned. The maximum value is X; values above X will be coerced to X. | 
 **pageToken** | **string** | A page token, received from a previous `ListPrivateLinkConnections` call. Provide this to retrieve the subsequent page. | 
 **skip** | **int32** | The number of individual resources to skip before starting to return results. If the skip value causes the cursor to move past the end of the collection, the response will be 200 OK with an empty result set and no next_page_token. | 

### Return type

[**V1beta1ListPrivateEndpointConnectionsResponse**](V1beta1ListPrivateEndpointConnectionsResponse.md)

### Authorization

[Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)