\StorageVolumeConfigApiAPI

All URIs are relative to https://api.omnistrate.cloud

Method	HTTP request	Description
StorageVolumeConfigApiCreateStorageVolumeConfig	Post /2022-09-01-00/service/{serviceId}/storage-volume-config	CreateStorageVolumeConfig storage-volume-config-api
StorageVolumeConfigApiDeleteStorageVolumeConfig	Delete /2022-09-01-00/service/{serviceId}/storage-volume-config/{id}	DeleteStorageVolumeConfig storage-volume-config-api
StorageVolumeConfigApiDescribeStorageVolumeConfig	Get /2022-09-01-00/service/{serviceId}/storage-volume-config/{id}	DescribeStorageVolumeConfig storage-volume-config-api
StorageVolumeConfigApiListStorageVolumeConfig	Get /2022-09-01-00/service/{serviceId}/storage-volume-config	ListStorageVolumeConfig storage-volume-config-api
StorageVolumeConfigApiUpdateInstanceStorageVolumeConfig	Patch /2022-09-01-00/service/{serviceId}/storage-volume-config/{id}/instance	UpdateInstanceStorageVolumeConfig storage-volume-config-api
StorageVolumeConfigApiUpdateStorageVolumeConfig	Patch /2022-09-01-00/service/{serviceId}/storage-volume-config/{id}	UpdateStorageVolumeConfig storage-volume-config-api
StorageVolumeConfigApiUpdateStorageVolumeSizeConfig	Patch /2022-09-01-00/service/{serviceId}/storage-volume-config/{id}/size	UpdateStorageVolumeSizeConfig storage-volume-config-api

StorageVolumeConfigApiCreateStorageVolumeConfig

string StorageVolumeConfigApiCreateStorageVolumeConfig(ctx, serviceId).CreateStorageVolumeConfigRequestBody(createStorageVolumeConfigRequestBody).Execute()

CreateStorageVolumeConfig storage-volume-config-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	serviceId := "s-12345678" // string | The service ID
	createStorageVolumeConfigRequestBody := *openapiclient.NewCreateStorageVolumeConfigRequestBody("A storage volume set to store the MySQL data directory", "MySQL Data Volume") // CreateStorageVolumeConfigRequestBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.StorageVolumeConfigApiAPI.StorageVolumeConfigApiCreateStorageVolumeConfig(context.Background(), serviceId).CreateStorageVolumeConfigRequestBody(createStorageVolumeConfigRequestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StorageVolumeConfigApiAPI.StorageVolumeConfigApiCreateStorageVolumeConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `StorageVolumeConfigApiCreateStorageVolumeConfig`: string
	fmt.Fprintf(os.Stdout, "Response from `StorageVolumeConfigApiAPI.StorageVolumeConfigApiCreateStorageVolumeConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId	string	The service ID

Other Parameters

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

Name	Type	Description	Notes

createStorageVolumeConfigRequestBody | CreateStorageVolumeConfigRequestBody | |

Return type

string

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json, application/vnd.goa.error

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

StorageVolumeConfigApiDeleteStorageVolumeConfig

StorageVolumeConfigApiDeleteStorageVolumeConfig(ctx, serviceId, id).Execute()

DeleteStorageVolumeConfig storage-volume-config-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	serviceId := "s-12345678" // string | The service ID
	id := "svc-12345678" // string | The storage volume config ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.StorageVolumeConfigApiAPI.StorageVolumeConfigApiDeleteStorageVolumeConfig(context.Background(), serviceId, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StorageVolumeConfigApiAPI.StorageVolumeConfigApiDeleteStorageVolumeConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId	string	The service ID
id	string	The storage volume config ID

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.goa.error

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

StorageVolumeConfigApiDescribeStorageVolumeConfig

DescribeStorageVolumeConfigResult StorageVolumeConfigApiDescribeStorageVolumeConfig(ctx, serviceId, id).ProductTierVersion(productTierVersion).ProductTierId(productTierId).Execute()

DescribeStorageVolumeConfig storage-volume-config-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	serviceId := "s-12345678" // string | The service ID
	id := "svc-12345678" // string | The storage volume config ID
	productTierVersion := "Quia delectus sequi maiores veritatis harum animi." // string | Product tier version of the network config to describe. If not specified, the latest version is described. (optional)
	productTierId := "Beatae beatae." // string | ProductTierId of the network config to describe. Needs to specified in combination with the product tier version (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.StorageVolumeConfigApiAPI.StorageVolumeConfigApiDescribeStorageVolumeConfig(context.Background(), serviceId, id).ProductTierVersion(productTierVersion).ProductTierId(productTierId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StorageVolumeConfigApiAPI.StorageVolumeConfigApiDescribeStorageVolumeConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `StorageVolumeConfigApiDescribeStorageVolumeConfig`: DescribeStorageVolumeConfigResult
	fmt.Fprintf(os.Stdout, "Response from `StorageVolumeConfigApiAPI.StorageVolumeConfigApiDescribeStorageVolumeConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId	string	The service ID
id	string	The storage volume config ID

Other Parameters

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

Name	Type	Description	Notes

productTierVersion | string | Product tier version of the network config to describe. If not specified, the latest version is described. | productTierId | string | ProductTierId of the network config to describe. Needs to specified in combination with the product tier version |

Return type

DescribeStorageVolumeConfigResult

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.goa.error

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

StorageVolumeConfigApiListStorageVolumeConfig

ListServiceEnvironmentsResult StorageVolumeConfigApiListStorageVolumeConfig(ctx, serviceId).Managed(managed).Execute()

ListStorageVolumeConfig storage-volume-config-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	serviceId := "s-12345678" // string | The service to list storage volume configs for
	managed := false // bool | Is storage volume config managed by omnistrate (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.StorageVolumeConfigApiAPI.StorageVolumeConfigApiListStorageVolumeConfig(context.Background(), serviceId).Managed(managed).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StorageVolumeConfigApiAPI.StorageVolumeConfigApiListStorageVolumeConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `StorageVolumeConfigApiListStorageVolumeConfig`: ListServiceEnvironmentsResult
	fmt.Fprintf(os.Stdout, "Response from `StorageVolumeConfigApiAPI.StorageVolumeConfigApiListStorageVolumeConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId	string	The service to list storage volume configs for

Other Parameters

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

Name	Type	Description	Notes

managed | bool | Is storage volume config managed by omnistrate |

Return type

ListServiceEnvironmentsResult

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.goa.error

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

StorageVolumeConfigApiUpdateInstanceStorageVolumeConfig

StorageVolumeConfigApiUpdateInstanceStorageVolumeConfig(ctx, serviceId, id).UpdateInstanceStorageVolumeConfigRequestBody(updateInstanceStorageVolumeConfigRequestBody).Execute()

UpdateInstanceStorageVolumeConfig storage-volume-config-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	serviceId := "s-12345678" // string | The service ID
	id := "svc-12345678" // string | The storage volume config ID
	updateInstanceStorageVolumeConfigRequestBody := *openapiclient.NewUpdateInstanceStorageVolumeConfigRequestBody() // UpdateInstanceStorageVolumeConfigRequestBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.StorageVolumeConfigApiAPI.StorageVolumeConfigApiUpdateInstanceStorageVolumeConfig(context.Background(), serviceId, id).UpdateInstanceStorageVolumeConfigRequestBody(updateInstanceStorageVolumeConfigRequestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StorageVolumeConfigApiAPI.StorageVolumeConfigApiUpdateInstanceStorageVolumeConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId	string	The service ID
id	string	The storage volume config ID

Other Parameters

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

Name	Type	Description	Notes

updateInstanceStorageVolumeConfigRequestBody | UpdateInstanceStorageVolumeConfigRequestBody | |

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: application/json
Accept: application/vnd.goa.error

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

StorageVolumeConfigApiUpdateStorageVolumeConfig

StorageVolumeConfigApiUpdateStorageVolumeConfig(ctx, serviceId, id).UpdateStorageVolumeConfigRequestBody(updateStorageVolumeConfigRequestBody).Execute()

UpdateStorageVolumeConfig storage-volume-config-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	serviceId := "s-12345678" // string | The service ID
	id := "svc-12345678" // string | The storage volume config ID
	updateStorageVolumeConfigRequestBody := *openapiclient.NewUpdateStorageVolumeConfigRequestBody() // UpdateStorageVolumeConfigRequestBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.StorageVolumeConfigApiAPI.StorageVolumeConfigApiUpdateStorageVolumeConfig(context.Background(), serviceId, id).UpdateStorageVolumeConfigRequestBody(updateStorageVolumeConfigRequestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StorageVolumeConfigApiAPI.StorageVolumeConfigApiUpdateStorageVolumeConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId	string	The service ID
id	string	The storage volume config ID

Other Parameters

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

Name	Type	Description	Notes

updateStorageVolumeConfigRequestBody | UpdateStorageVolumeConfigRequestBody | |

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: application/json
Accept: application/vnd.goa.error

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

StorageVolumeConfigApiUpdateStorageVolumeSizeConfig

StorageVolumeConfigApiUpdateStorageVolumeSizeConfig(ctx, serviceId, id).UpdateStorageVolumeSizeConfigRequestBody(updateStorageVolumeSizeConfigRequestBody).Execute()

UpdateStorageVolumeSizeConfig storage-volume-config-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	serviceId := "s-12345678" // string | The service ID
	id := "svc-12345678" // string | The storage volume config ID
	updateStorageVolumeSizeConfigRequestBody := *openapiclient.NewUpdateStorageVolumeSizeConfigRequestBody("$var.storage_size") // UpdateStorageVolumeSizeConfigRequestBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.StorageVolumeConfigApiAPI.StorageVolumeConfigApiUpdateStorageVolumeSizeConfig(context.Background(), serviceId, id).UpdateStorageVolumeSizeConfigRequestBody(updateStorageVolumeSizeConfigRequestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StorageVolumeConfigApiAPI.StorageVolumeConfigApiUpdateStorageVolumeSizeConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceId	string	The service ID
id	string	The storage volume config ID

Other Parameters

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

Name	Type	Description	Notes

updateStorageVolumeSizeConfigRequestBody | UpdateStorageVolumeSizeConfigRequestBody | |

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: application/json
Accept: application/vnd.goa.error

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

Files

StorageVolumeConfigApiAPI.md

Latest commit

History

StorageVolumeConfigApiAPI.md

File metadata and controls

\StorageVolumeConfigApiAPI

StorageVolumeConfigApiCreateStorageVolumeConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

StorageVolumeConfigApiDeleteStorageVolumeConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

StorageVolumeConfigApiDescribeStorageVolumeConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

StorageVolumeConfigApiListStorageVolumeConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

StorageVolumeConfigApiUpdateInstanceStorageVolumeConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

StorageVolumeConfigApiUpdateStorageVolumeConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

StorageVolumeConfigApiUpdateStorageVolumeSizeConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers