v3

Documentation

Index

• type ConfigurationSummary
• type EngineVersionInfo
  • func ShowEngineVersion(client *golangsdk.ServiceClient, databaseName string) ([]EngineVersionInfo, error)
• type GetJobInfoDetail
  • func ShowJobInfo(client *golangsdk.ServiceClient, taskId string) (*GetJobInfoDetail, error)
  • func WaitForGaussJob(client *golangsdk.ServiceClient, jobId string, timeout int) (*GetJobInfoDetail, error)
• type JobDatastore
• type JobEntities
• type JobInstance
• type JobInstanceInfo
• type ListConfigOpts
• type ListConfigResponse
  • func ListConfigurations(client *golangsdk.ServiceClient, opts ListConfigOpts) (*ListConfigResponse, error)
• type MysqlFlavorsInfo
  • func ShowGaussMySqlFlavors(client *golangsdk.ServiceClient, opts ShowFlavorsOpts) ([]MysqlFlavorsInfo, error)
• type ShowFlavorsOpts

Types

type ConfigurationSummary

type ConfigurationSummary struct {
	// Parameter template ID
	Id string `json:"id"`
	// Parameter template name
	Name string `json:"name"`
	// Parameter template description
	Description string `json:"description"`
	// DB version name
	DatastoreVersionName string `json:"datastore_version_name"`
	// Database name
	DatastoreName string `json:"datastore_name"`
	// Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.
	// T is the separator between the calendar and the hourly notation of time.
	// Z indicates the time zone offset.
	// For example, for French Winter Time (FWT), the time offset is shown as +0200.
	Created string `json:"created"`
	// Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.
	// T is the separator between the calendar and the hourly notation of time.
	// Z indicates the time zone offset.
	// For example, for French Winter Time (FWT), the time offset is shown as +0200.
	Updated string `json:"updated"`
	// Whether the parameter template is a custom template.
	// false: The parameter template is a default template.
	// true: The parameter template is a custom template.
	UserDefined bool `json:"user_defined"`
}

type EngineVersionInfo

type EngineVersionInfo struct {
	// DB version ID. Its value is unique.
	Id string `json:"id"`
	// DB version number. Only the major version number with two digits is returned.
	Name string `json:"name"`
}

func ShowEngineVersion

func ShowEngineVersion(client *golangsdk.ServiceClient, databaseName string) ([]EngineVersionInfo, error)

ShowEngineVersion databaseName: DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql

type GetJobInfoDetail

type GetJobInfoDetail struct {
	// Task ID
	Id string `json:"id"`
	// Task name
	Name string `json:"name"`
	// Task execution status Value:
	// Running: The task is being executed.
	// Completed: The task is successfully executed.
	// Failed: The task failed to be executed.
	Status string `json:"status"`
	// Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.
	// T is the separator between the calendar and the hourly notation of time.
	// Z indicates the time zone offset.
	// For example, for French Winter Time (FWT), the time offset is shown as +0200.
	// The value is empty unless the instance creation is complete.
	Created string `json:"created"`
	// End time in the "yyyy-mm-ddThh:mm:ssZ" format.
	// T is the separator between the calendar and the hourly notation of time.
	// Z indicates the time zone offset.
	// For example, for French Winter Time (FWT), the time offset is shown as +0200.
	// The value is empty unless the instance creation is complete.
	Ended string `json:"ended,omitempty"`
	// Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, "" is returned.
	Process string `json:"process,omitempty"`
	// Instance information of the task with the specified ID
	Instance JobInstanceInfo `json:"instance"`
	// Displayed information varies depending on tasks.
	Entities JobEntities `json:"entities,omitempty"`
	// Task failure information
	FailReason string `json:"fail_reason,omitempty"`
}

func ShowJobInfo

func ShowJobInfo(client *golangsdk.ServiceClient, taskId string) (*GetJobInfoDetail, error)

func WaitForGaussJob

func WaitForGaussJob(client *golangsdk.ServiceClient, jobId string, timeout int) (*GetJobInfoDetail, error)

type JobDatastore

type JobDatastore struct {
	// DB engine
	Type string `json:"type"`
	// DB engine version
	Version string `json:"version"`
}

type JobEntities

type JobEntities struct {
	// Instance queried in the task
	Instance JobInstance `json:"instance"`
	// Resource ID involved in a task
	ResourceIds []string `json:"resource_ids"`
}

type JobInstance

type JobInstance struct {
	// Instance connection address
	Endpoint string `json:"endpoint"`
	// Instance type
	Type string `json:"type"`
	// Database information.
	Datastore JobDatastore `json:"datastore"`
}

type JobInstanceInfo

type JobInstanceInfo struct {
	// Instance ID
	Id string `json:"id"`
	// Instance name
	Name string `json:"name"`
}

type ListConfigOpts

type ListConfigOpts struct {
	// Index offset. If offset is set to N, the resource query starts from the N+1 piece of data.
	// The default value is 0, indicating that the query starts from the first piece of data.
	// The value must be a positive integer
	Offset int `q:"offset"`
	// Number of records to be queried. The default value is 100.
	// The value must be a positive integer.
	// The minimum value is 1 and the maximum value is 100.
	Limit int `q:"limit"`
}

type ListConfigResponse

type ListConfigResponse struct {
	// Parameter template information
	Configurations []ConfigurationSummary `json:"configurations"`
	// Total number of parameter templates
	TotalCount int32 `json:"total_count"`
}

func ListConfigurations

func ListConfigurations(client *golangsdk.ServiceClient, opts ListConfigOpts) (*ListConfigResponse, error)

type MysqlFlavorsInfo

type MysqlFlavorsInfo struct {
	// Number of vCPUs. For example, the value 1 indicates 1 vCPU.
	Vcpus string `json:"vcpus"`
	// Memory size in GB
	Ram string `json:"ram"`
	// Specification type. The value can be arm
	Type string `json:"type"`
	// Specification ID. The value must be unique.
	Id string `json:"id"`
	// Resource specification code. Its value is same as the value of flavor_ref, for example, gaussdb.mysql.4xlarge.arm.8.
	SpecCode string `json:"spec_code"`
	// DB version number.
	VersionName string `json:"version_name"`
	// Instance type. Currently, its value can only be Cluster.
	InstanceMode string `json:"instance_mode"`
	// Specification status in an AZ. Its value can be any of the following:
	// normal: on sale.
	// unsupported: Not supported.
	// sellout: sold out.
	AzStatus map[string]string `json:"az_status"`
}

func ShowGaussMySqlFlavors

func ShowGaussMySqlFlavors(client *golangsdk.ServiceClient, opts ShowFlavorsOpts) ([]MysqlFlavorsInfo, error)

type ShowFlavorsOpts

type ShowFlavorsOpts struct {
	// DB engine.
	DatabaseName string
	// DB engine version. Currently, only MySQL 8.0 is supported.
	VersionName string `q:"version_name"`
	// AZ mode. Its value can be single or multi and is case-insensitive.
	AvailabilityZoneMode string `q:"availability_zone_mode"`
	// Specification code.
	SpecCode string `q:"spec_code"`
}