Skip to content

AsynchronousReplicationAPI.md

Latest commit

 

History

History
706 lines (461 loc) · 22.7 KB

AsynchronousReplicationAPI.md

File metadata and controls

706 lines (461 loc) · 22.7 KB

\AsynchronousReplicationAPI

All URIs are relative to http://localhost

Method HTTP request Description
CreateXClusterConfig Post /api/v1/customers/{cUUID}/xcluster_configs Create xcluster config
DeleteXClusterConfig Delete /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID} Delete xcluster config
EditXClusterConfig Put /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID} Edit xcluster config
GetXClusterConfig Get /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID} Get xcluster config
NeedBootstrapTable Post /api/v1/customers/{cUUID}/universes/{uniUUID}/need_bootstrap Whether tables need bootstrap before setting up cross cluster replication
NeedBootstrapXClusterConfig Post /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/need_bootstrap Whether tables in an xCluster replication config have fallen far behind and need bootstrap
RestartXClusterConfig Post /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID} Restart xcluster config
SyncXClusterConfig Post /api/v1/customers/{cUUID}/xcluster_configs/sync Sync xcluster config - deprecated
SyncXClusterConfigV2 Post /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/sync Sync xcluster config (V2)

CreateXClusterConfig

YBPTask CreateXClusterConfig(ctx, cUUID).XclusterReplicationCreateFormData(xclusterReplicationCreateFormData).Request(request).Execute()

Create xcluster config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xclusterReplicationCreateFormData := *openapiclient.NewXClusterConfigCreateFormData("Repl-config1", "SourceUniverseUUID_example", []string{"Tables_example"}, "TargetUniverseUUID_example") // XClusterConfigCreateFormData | XCluster Replication Create Form Data
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.CreateXClusterConfig(context.Background(), cUUID).XclusterReplicationCreateFormData(xclusterReplicationCreateFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.CreateXClusterConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateXClusterConfig`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.CreateXClusterConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string

Other Parameters

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

Name Type Description Notes

xclusterReplicationCreateFormData | XClusterConfigCreateFormData | XCluster Replication Create Form Data | request | interface{} | |

Return type

YBPTask

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteXClusterConfig

YBPTask DeleteXClusterConfig(ctx, cUUID, xccUUID).IsForceDelete(isForceDelete).Request(request).Execute()

Delete xcluster config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xccUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	isForceDelete := true // bool |  (optional) (default to false)
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.DeleteXClusterConfig(context.Background(), cUUID, xccUUID).IsForceDelete(isForceDelete).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.DeleteXClusterConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteXClusterConfig`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.DeleteXClusterConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
xccUUID string

Other Parameters

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

Name Type Description Notes

isForceDelete | bool | | [default to false] request | interface{} | |

Return type

YBPTask

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditXClusterConfig

YBPTask EditXClusterConfig(ctx, cUUID, xccUUID).XclusterReplicationEditFormData(xclusterReplicationEditFormData).Request(request).Execute()

Edit xcluster config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xccUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xclusterReplicationEditFormData := *openapiclient.NewXClusterConfigEditFormData() // XClusterConfigEditFormData | XCluster Replication Edit Form Data
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.EditXClusterConfig(context.Background(), cUUID, xccUUID).XclusterReplicationEditFormData(xclusterReplicationEditFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.EditXClusterConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditXClusterConfig`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.EditXClusterConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
xccUUID string

Other Parameters

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

Name Type Description Notes

xclusterReplicationEditFormData | XClusterConfigEditFormData | XCluster Replication Edit Form Data | request | interface{} | |

Return type

YBPTask

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetXClusterConfig

XClusterConfigGetResp GetXClusterConfig(ctx, cUUID, xccUUID).SyncWithDB(syncWithDB).Execute()

Get xcluster config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xccUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	syncWithDB := true // bool |  (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.GetXClusterConfig(context.Background(), cUUID, xccUUID).SyncWithDB(syncWithDB).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.GetXClusterConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetXClusterConfig`: XClusterConfigGetResp
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.GetXClusterConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
xccUUID string

Other Parameters

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

Name Type Description Notes

syncWithDB | bool | | [default to true]

Return type

XClusterConfigGetResp

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NeedBootstrapTable

map[string]map[string]interface{} NeedBootstrapTable(ctx, cUUID, uniUUID).XclusterNeedBootstrapFormData(xclusterNeedBootstrapFormData).ConfigType(configType).IncludeDetails(includeDetails).Request(request).Execute()

Whether tables need bootstrap before setting up cross cluster replication

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	uniUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xclusterNeedBootstrapFormData := *openapiclient.NewXClusterConfigNeedBootstrapFormData([]string{"Tables_example"}) // XClusterConfigNeedBootstrapFormData | XCluster Need Bootstrap Form Data
	configType := "configType_example" // string |  (optional) (default to "null")
	includeDetails := true // bool |  (optional) (default to false)
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.NeedBootstrapTable(context.Background(), cUUID, uniUUID).XclusterNeedBootstrapFormData(xclusterNeedBootstrapFormData).ConfigType(configType).IncludeDetails(includeDetails).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.NeedBootstrapTable``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `NeedBootstrapTable`: map[string]map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.NeedBootstrapTable`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
uniUUID string

Other Parameters

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

Name Type Description Notes

xclusterNeedBootstrapFormData | XClusterConfigNeedBootstrapFormData | XCluster Need Bootstrap Form Data | configType | string | | [default to "null"] includeDetails | bool | | [default to false] request | interface{} | |

Return type

map[string]map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NeedBootstrapXClusterConfig

map[string]map[string]interface{} NeedBootstrapXClusterConfig(ctx, cUUID, xccUUID).XclusterNeedBootstrapFormData(xclusterNeedBootstrapFormData).Request(request).Execute()

Whether tables in an xCluster replication config have fallen far behind and need bootstrap

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xccUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xclusterNeedBootstrapFormData := *openapiclient.NewXClusterConfigNeedBootstrapFormData([]string{"Tables_example"}) // XClusterConfigNeedBootstrapFormData | XCluster Need Bootstrap Form Data
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.NeedBootstrapXClusterConfig(context.Background(), cUUID, xccUUID).XclusterNeedBootstrapFormData(xclusterNeedBootstrapFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.NeedBootstrapXClusterConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `NeedBootstrapXClusterConfig`: map[string]map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.NeedBootstrapXClusterConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
xccUUID string

Other Parameters

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

Name Type Description Notes

xclusterNeedBootstrapFormData | XClusterConfigNeedBootstrapFormData | XCluster Need Bootstrap Form Data | request | interface{} | |

Return type

map[string]map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RestartXClusterConfig

YBPTask RestartXClusterConfig(ctx, cUUID, xccUUID).XclusterReplicationRestartFormData(xclusterReplicationRestartFormData).IsForceDelete(isForceDelete).Request(request).Execute()

Restart xcluster config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xccUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xclusterReplicationRestartFormData := *openapiclient.NewXClusterConfigRestartFormData([]string{"Tables_example"}) // XClusterConfigRestartFormData | XCluster Replication Restart Form Data
	isForceDelete := true // bool |  (optional) (default to false)
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.RestartXClusterConfig(context.Background(), cUUID, xccUUID).XclusterReplicationRestartFormData(xclusterReplicationRestartFormData).IsForceDelete(isForceDelete).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.RestartXClusterConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RestartXClusterConfig`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.RestartXClusterConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
xccUUID string

Other Parameters

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

Name Type Description Notes

xclusterReplicationRestartFormData | XClusterConfigRestartFormData | XCluster Replication Restart Form Data | isForceDelete | bool | | [default to false] request | interface{} | |

Return type

YBPTask

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SyncXClusterConfig

YBPTask SyncXClusterConfig(ctx, cUUID).TargetUniverseUUID(targetUniverseUUID).Request(request).Execute()

Sync xcluster config - deprecated

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	targetUniverseUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.SyncXClusterConfig(context.Background(), cUUID).TargetUniverseUUID(targetUniverseUUID).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.SyncXClusterConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SyncXClusterConfig`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.SyncXClusterConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string

Other Parameters

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

Name Type Description Notes

targetUniverseUUID | string | | request | interface{} | |

Return type

YBPTask

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SyncXClusterConfigV2

YBPTask SyncXClusterConfigV2(ctx, cUUID, xccUUID).Request(request).Execute()

Sync xcluster config (V2)

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	xccUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AsynchronousReplicationAPI.SyncXClusterConfigV2(context.Background(), cUUID, xccUUID).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AsynchronousReplicationAPI.SyncXClusterConfigV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SyncXClusterConfigV2`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `AsynchronousReplicationAPI.SyncXClusterConfigV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
xccUUID string

Other Parameters

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

Name Type Description Notes

request | interface{} | |

Return type

YBPTask

Authorization

apiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]