\PerformanceAdvisorAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
Delete	Delete /api/v1/customers/{cUUID}/performance_recommendations	Delete performance recommendations
Get	Get /api/v1/customers/{cUUID}/performance_recommendations/{rUUID}	Get performance recommendation details
GetLatestRun	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/last_run	Get last performance advisor run details
GetSettings	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settings	Get universe performance advisor settings
Hide	Post /api/v1/customers/{cUUID}/performance_recommendations/hide	Hide performance recommendations
Page	Post /api/v1/customers/{cUUID}/performance_recommendations/page	List performance recommendations (paginated)
PageAuditInfo	Post /api/v1/customers/{cUUID}/performance_recommendation_state_change/page	List performance recommendations state change audit events (paginated)
Resolve	Post /api/v1/customers/{cUUID}/performance_recommendations/resolve	Resolve performance recommendations
RunPerfAdvisor	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/start_manually	Start performance advisor run for universe
UpdateSettings	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settings	Update universe performance advisor settings

Delete

YBPSuccess Delete(ctx, cUUID).DeletePerformanceRecommendationsRequest(deletePerformanceRecommendationsRequest).Request(request).Execute()

Delete performance recommendations

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	deletePerformanceRecommendationsRequest := *openapiclient.NewPerformanceRecommendationFilter(int64(123), "CustomerId_example", []string{"Ids_example"}, false, []string{"Priorities_example"}, []string{"States_example"}, []string{"Types_example"}, "UniverseId_example") // PerformanceRecommendationFilter | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PerformanceAdvisorAPI.Delete(context.Background(), cUUID).DeletePerformanceRecommendationsRequest(deletePerformanceRecommendationsRequest).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorAPI.Delete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Delete`: YBPSuccess
	fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorAPI.Delete`: %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 apiDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

deletePerformanceRecommendationsRequest | PerformanceRecommendationFilter | | request | interface{} | |

Return type

YBPSuccess

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]

Get

PerformanceRecommendation Get(ctx, cUUID, rUUID).Execute()

Get performance recommendation details

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	rUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

PerformanceRecommendation

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]

GetLatestRun

YBPSuccess GetLatestRun(ctx, cUUID, uniUUID).Execute()

Get last performance advisor run details

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 | 

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

Path Parameters

Name	Type	Description
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 apiGetLatestRunRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

YBPSuccess

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]

GetSettings

PerfAdvisorSettingsWithDefaults GetSettings(ctx, cUUID, uniUUID).Request(request).Execute()

Get universe performance advisor settings

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 | 
	request := TODO // interface{} |  (optional)

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

Path Parameters

Name	Type	Description
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 apiGetSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

request | interface{} | |

Return type

PerfAdvisorSettingsWithDefaults

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]

Hide

YBPSuccess Hide(ctx, cUUID).HidePerformanceRecommendationsRequest(hidePerformanceRecommendationsRequest).Request(request).Execute()

Hide performance recommendations

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	hidePerformanceRecommendationsRequest := *openapiclient.NewPerformanceRecommendationFilter(int64(123), "CustomerId_example", []string{"Ids_example"}, false, []string{"Priorities_example"}, []string{"States_example"}, []string{"Types_example"}, "UniverseId_example") // PerformanceRecommendationFilter | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PerformanceAdvisorAPI.Hide(context.Background(), cUUID).HidePerformanceRecommendationsRequest(hidePerformanceRecommendationsRequest).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorAPI.Hide``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Hide`: YBPSuccess
	fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorAPI.Hide`: %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 apiHideRequest struct via the builder pattern

Name	Type	Description	Notes

hidePerformanceRecommendationsRequest | PerformanceRecommendationFilter | | request | interface{} | |

Return type

YBPSuccess

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]

Page

PerformanceRecommendationPagedResponse Page(ctx, cUUID).PagePerformanceRecommendationRequest(pagePerformanceRecommendationRequest).Request(request).Execute()

List performance recommendations (paginated)

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pagePerformanceRecommendationRequest := *openapiclient.NewPerformanceRecommendationPagedQuery("Direction_example", *openapiclient.NewPerformanceRecommendationFilter(int64(123), "CustomerId_example", []string{"Ids_example"}, false, []string{"Priorities_example"}, []string{"States_example"}, []string{"Types_example"}, "UniverseId_example"), int32(123), false, int32(123), "SortBy_example") // PerformanceRecommendationPagedQuery | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PerformanceAdvisorAPI.Page(context.Background(), cUUID).PagePerformanceRecommendationRequest(pagePerformanceRecommendationRequest).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorAPI.Page``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Page`: PerformanceRecommendationPagedResponse
	fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorAPI.Page`: %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 apiPageRequest struct via the builder pattern

Name	Type	Description	Notes

pagePerformanceRecommendationRequest | PerformanceRecommendationPagedQuery | | request | interface{} | |

Return type

PerformanceRecommendationPagedResponse

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]

PageAuditInfo

StateChangeAuditInfoPagedResponse PageAuditInfo(ctx, cUUID).PageStateChangeAuditInfoRequest(pageStateChangeAuditInfoRequest).Request(request).Execute()

List performance recommendations state change audit events (paginated)

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pageStateChangeAuditInfoRequest := *openapiclient.NewStateChangeAuditInfoPagedQuery("Direction_example", *openapiclient.NewStateChangeAuditInfoFilter("CustomerId_example", []string{"Ids_example"}, "RecommendationId_example", "UserId_example"), int32(123), false, int32(123), "SortBy_example") // StateChangeAuditInfoPagedQuery | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PerformanceAdvisorAPI.PageAuditInfo(context.Background(), cUUID).PageStateChangeAuditInfoRequest(pageStateChangeAuditInfoRequest).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorAPI.PageAuditInfo``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PageAuditInfo`: StateChangeAuditInfoPagedResponse
	fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorAPI.PageAuditInfo`: %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 apiPageAuditInfoRequest struct via the builder pattern

Name	Type	Description	Notes

pageStateChangeAuditInfoRequest | StateChangeAuditInfoPagedQuery | | request | interface{} | |

Return type

StateChangeAuditInfoPagedResponse

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]

Resolve

YBPSuccess Resolve(ctx, cUUID).ResolvePerformanceRecommendationsRequest(resolvePerformanceRecommendationsRequest).Request(request).Execute()

Resolve performance recommendations

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	resolvePerformanceRecommendationsRequest := *openapiclient.NewPerformanceRecommendationFilter(int64(123), "CustomerId_example", []string{"Ids_example"}, false, []string{"Priorities_example"}, []string{"States_example"}, []string{"Types_example"}, "UniverseId_example") // PerformanceRecommendationFilter | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PerformanceAdvisorAPI.Resolve(context.Background(), cUUID).ResolvePerformanceRecommendationsRequest(resolvePerformanceRecommendationsRequest).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorAPI.Resolve``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Resolve`: YBPSuccess
	fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorAPI.Resolve`: %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 apiResolveRequest struct via the builder pattern

Name	Type	Description	Notes

resolvePerformanceRecommendationsRequest | PerformanceRecommendationFilter | | request | interface{} | |

Return type

YBPSuccess

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]

RunPerfAdvisor

PerfAdvisorManualRunStatus RunPerfAdvisor(ctx, cUUID, uniUUID).Request(request).Execute()

Start performance advisor run for universe

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 | 
	request := TODO // interface{} |  (optional)

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

Path Parameters

Name	Type	Description
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 apiRunPerfAdvisorRequest struct via the builder pattern

Name	Type	Description	Notes

request | interface{} | |

Return type

PerfAdvisorManualRunStatus

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]

UpdateSettings

YBPSuccess UpdateSettings(ctx, cUUID, uniUUID).PerformanceAdvisorSettingsRequest(performanceAdvisorSettingsRequest).Request(request).Execute()

Update universe performance advisor settings

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 | 
	performanceAdvisorSettingsRequest := *openapiclient.NewPerfAdvisorSettingsFormData() // PerfAdvisorSettingsFormData | 
	request := TODO // interface{} |  (optional)

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

Path Parameters

Name	Type	Description
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 apiUpdateSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

performanceAdvisorSettingsRequest | PerfAdvisorSettingsFormData | | request | interface{} | |

Return type

YBPSuccess

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]

FilesExpand file tree

PerformanceAdvisorAPI.md

Latest commit

History

PerformanceAdvisorAPI.md

File metadata and controls

\PerformanceAdvisorAPI

Delete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Get

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetLatestRun

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetSettings

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Hide

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Page

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PageAuditInfo

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Resolve

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RunPerfAdvisor

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateSettings

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers