\RolesTsdbAPI
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| TsdbGetMetrics | Get /api/v1/tsdb/metrics | Retrieve Metrics |
| TsdbGetRoleConfig | Get /api/v1/roles/tsdb | TSDB role config |
| TsdbPutRoleConfig | Post /api/v1/roles/tsdb | TSDB role config |
TsdbGetMetrics
TypesAPIMetricsGetOutput TsdbGetMetrics(ctx).Role(role).Category(category).ExtraKeys(extraKeys).Node(node).Since(since).Execute()
Retrieve Metrics
Example
package main
import (
"context"
"fmt"
"os"
"time"
openapiclient "beryju.io/gravity/api"
)
func main() {
role := openapiclient.TypesAPIMetricsRole("system") // TypesAPIMetricsRole |
category := "category_example" // string | (optional)
extraKeys := []string{"Inner_example"} // []string | (optional)
node := "node_example" // string | (optional)
since := time.Now() // time.Time | Optionally set a start time for which to return datapoints after (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.RolesTsdbAPI.TsdbGetMetrics(context.Background()).Role(role).Category(category).ExtraKeys(extraKeys).Node(node).Since(since).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RolesTsdbAPI.TsdbGetMetrics``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TsdbGetMetrics`: TypesAPIMetricsGetOutput
fmt.Fprintf(os.Stdout, "Response from `RolesTsdbAPI.TsdbGetMetrics`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiTsdbGetMetricsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| role | TypesAPIMetricsRole | ||
| category | string | ||
| extraKeys | []string | ||
| node | string | ||
| since | time.Time | Optionally set a start time for which to return datapoints after |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TsdbGetRoleConfig
TsdbAPIRoleConfigOutput TsdbGetRoleConfig(ctx).Execute()
TSDB role config
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "beryju.io/gravity/api"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.RolesTsdbAPI.TsdbGetRoleConfig(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RolesTsdbAPI.TsdbGetRoleConfig``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TsdbGetRoleConfig`: TsdbAPIRoleConfigOutput
fmt.Fprintf(os.Stdout, "Response from `RolesTsdbAPI.TsdbGetRoleConfig`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiTsdbGetRoleConfigRequest struct via the builder pattern
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TsdbPutRoleConfig
TsdbPutRoleConfig(ctx).TsdbAPIRoleConfigInput(tsdbAPIRoleConfigInput).Execute()
TSDB role config
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "beryju.io/gravity/api"
)
func main() {
tsdbAPIRoleConfigInput := *openapiclient.NewTsdbAPIRoleConfigInput(*openapiclient.NewTsdbRoleConfig()) // TsdbAPIRoleConfigInput | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.RolesTsdbAPI.TsdbPutRoleConfig(context.Background()).TsdbAPIRoleConfigInput(tsdbAPIRoleConfigInput).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RolesTsdbAPI.TsdbPutRoleConfig``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiTsdbPutRoleConfigRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| tsdbAPIRoleConfigInput | TsdbAPIRoleConfigInput |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]