Documentation ¶
Index ¶
- type BackupPolicy
- type ConfigurationParameter
- type ConfigurationParameterType
- type ConfigurationParameterTypeEnum
- type ConfigurationSummary
- type CreateInstanceRequest
- type CreateInstanceResponse
- type DataStroeErrorResponse
- type DeleteInstanceRequest
- type DeleteInstanceResponse
- type Flavor
- type FlavorErrorResponse
- type ListConfigurationsRequest
- type ListConfigurationsRequestXLanguage
- type ListConfigurationsRequestXLanguageEnum
- type ListConfigurationsResponse
- type ListDatastore
- type ListDatastoresRequest
- type ListDatastoresResponse
- type ListFlavorInfo
- type ListFlavorsRequest
- type ListFlavorsResponse
- type ListHa
- type ListHaConsistency
- type ListHaConsistencyEnum
- type ListInstanceResponse
- type ListInstancesRequest
- type ListInstancesRequestDatastoreType
- type ListInstancesRequestDatastoreTypeEnum
- type ListInstancesRequestType
- type ListInstancesRequestTypeEnum
- type ListInstancesResponse
- type ListStorageTypesRequest
- type ListStorageTypesRequestHaMode
- type ListStorageTypesRequestHaModeEnum
- type ListStorageTypesResponse
- type ListVolume
- type OpenGaussBackupStrategy
- type OpenGaussBackupStrategyForListResponse
- type OpenGaussBackupStrategyForResponse
- type OpenGaussChargeInfo
- type OpenGaussChargeInfoChargeMode
- type OpenGaussChargeInfoChargeModeEnum
- type OpenGaussChargeInfoListResponse
- type OpenGaussChargeInfoListResponseChargeMode
- type OpenGaussChargeInfoListResponseChargeModeEnum
- type OpenGaussChargeInfoResponse
- type OpenGaussChargeInfoResponseChargeMode
- type OpenGaussChargeInfoResponseChargeModeEnum
- type OpenGaussCoordinators
- type OpenGaussDatastore
- type OpenGaussDatastoreResponse
- type OpenGaussDatastoreResponseType
- type OpenGaussDatastoreResponseTypeEnum
- type OpenGaussDatastoreType
- type OpenGaussDatastoreTypeEnum
- type OpenGaussEnlargeVolume
- type OpenGaussErrorResponse
- type OpenGaussExpandCluster
- type OpenGaussHa
- type OpenGaussHaConsistency
- type OpenGaussHaConsistencyEnum
- type OpenGaussHaMode
- type OpenGaussHaModeEnum
- type OpenGaussHaReplicationMode
- type OpenGaussHaReplicationModeEnum
- type OpenGaussHaResponse
- type OpenGaussHaResponseConsistency
- type OpenGaussHaResponseConsistencyEnum
- type OpenGaussHaResponseMode
- type OpenGaussHaResponseModeEnum
- type OpenGaussHaResponseReplicationMode
- type OpenGaussHaResponseReplicationModeEnum
- type OpenGaussInstanceActionRequest
- type OpenGaussInstanceRequest
- type OpenGaussInstanceRequestReplicaNum
- type OpenGaussInstanceRequestReplicaNumEnum
- type OpenGaussInstanceResponse
- type OpenGaussModifyInstanceConfigurationRequest
- type OpenGaussShard
- type OpenGaussVolume
- type OpenGaussVolumeResponse
- type OpenGaussVolumeResponseType
- type OpenGaussVolumeResponseTypeEnum
- type OpenGaussVolumeType
- type OpenGaussVolumeTypeEnum
- type PwdResetRequest
- type ResetPwdRequest
- type ResetPwdResponse
- type RestartInstanceRequest
- type RestartInstanceRequestXLanguage
- type RestartInstanceRequestXLanguageEnum
- type RestartInstanceResponse
- type RunInstanceActionRequest
- type RunInstanceActionResponse
- type SetBackupPolicyRequest
- type SetBackupPolicyRequestBody
- type SetBackupPolicyResponse
- type ShowInstanceConfigurationRequest
- type ShowInstanceConfigurationResponse
- type Storage
- type UpdateInstanceConfigurationRequest
- type UpdateInstanceConfigurationResponse
- type UpdateInstanceNameRequest
- type UpdateInstanceNameResponse
- type UpdateNameRequestBody
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BackupPolicy ¶
type BackupPolicy struct { // 备份文件可以保存的天数。 取值范围:1-732天。 KeepDays int32 `json:"keep_days"` // 备份时间段。自动备份将在该时间段内触发。 取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。 HH取值必须比hh大1,mm和MM取值必须相同,且取值必须为00。 取值示例: 21:00-22:00 StartTime string `json:"start_time"` // 全量备份周期配置。自动全量备份将在每星期指定的天进行。取值范围:格式为逗号隔开的数字,数字代表星期。取值示例:1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。 Period string `json:"period"` // 差异备份间隔时间配置。每次自动差异备份的间隔时间。 取值范围:15、30、60、180、360、720、1440。单位:分钟。 取值示例:30 DifferentialPeriod string `json:"differential_period"` }
备份策略信息。
func (BackupPolicy) String ¶
func (o BackupPolicy) String() string
type ConfigurationParameter ¶ added in v0.0.84
type ConfigurationParameter struct { // 参数名称。 Name string `json:"name"` // 参数值。 Value string `json:"value"` // 修改该参数是否需要重启实例。 RestartRequired bool `json:"restart_required"` // 参数取值范围。 ValueRange string `json:"value_range"` // 参数类型,取值为“string”、“integer”、“boolean”、“list”或“float”之一。 Type ConfigurationParameterType `json:"type"` // 参数描述。 Description string `json:"description"` }
func (ConfigurationParameter) String ¶ added in v0.0.84
func (o ConfigurationParameter) String() string
type ConfigurationParameterType ¶ added in v0.0.84
type ConfigurationParameterType struct {
// contains filtered or unexported fields
}
func (ConfigurationParameterType) MarshalJSON ¶ added in v0.0.84
func (c ConfigurationParameterType) MarshalJSON() ([]byte, error)
func (*ConfigurationParameterType) UnmarshalJSON ¶ added in v0.0.84
func (c *ConfigurationParameterType) UnmarshalJSON(b []byte) error
type ConfigurationParameterTypeEnum ¶ added in v0.0.84
type ConfigurationParameterTypeEnum struct { STRING ConfigurationParameterType INTEGER ConfigurationParameterType BOOLEAN ConfigurationParameterType LIST ConfigurationParameterType FLOAT ConfigurationParameterType }
func GetConfigurationParameterTypeEnum ¶ added in v0.0.84
func GetConfigurationParameterTypeEnum() ConfigurationParameterTypeEnum
type ConfigurationSummary ¶ added in v0.0.83
type ConfigurationSummary struct { // 参数组ID。 Id string `json:"id"` // 参数组名称。 Name string `json:"name"` // 参数组描述。 Description *string `json:"description,omitempty"` // 引擎版本。 DatastoreVersion string `json:"datastore_version"` // 引擎名称。 DatastoreName string `json:"datastore_name"` // 数据库部署模式。 HaMode string `json:"ha_mode"` // 创建时间,格式为\"yyyy-MM-dd HH:mm:ss\"。 Created string `json:"created"` // 更新时间,格式为\"yyyy-MM-dd HH:mm:ss\"。 Updated string `json:"updated"` // 是否是用户自定义参数模板: - false,表示为系统默认参数模板。 - true,表示为用户自定义参数模板。 UserDefined bool `json:"user_defined"` }
参数模板信息。
func (ConfigurationSummary) String ¶ added in v0.0.83
func (o ConfigurationSummary) String() string
type CreateInstanceRequest ¶
type CreateInstanceRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` Body *OpenGaussInstanceRequest `json:"body,omitempty"` }
Request Object
func (CreateInstanceRequest) String ¶
func (o CreateInstanceRequest) String() string
type CreateInstanceResponse ¶
type CreateInstanceResponse struct { Instance *OpenGaussInstanceResponse `json:"instance,omitempty"` // 实例创建的任务id。 仅创建按需实例时会返回该参数。 JobId *string `json:"job_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (CreateInstanceResponse) String ¶
func (o CreateInstanceResponse) String() string
type DataStroeErrorResponse ¶ added in v0.0.83
type DataStroeErrorResponse struct { // 错误码 ErrorCode string `json:"error_code"` // 错误消息。 ErrorMsg string `json:"error_msg"` }
func (DataStroeErrorResponse) String ¶ added in v0.0.83
func (o DataStroeErrorResponse) String() string
type DeleteInstanceRequest ¶
type DeleteInstanceRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID,严格匹配UUID规则。 InstanceId string `json:"instance_id"` }
Request Object
func (DeleteInstanceRequest) String ¶
func (o DeleteInstanceRequest) String() string
type DeleteInstanceResponse ¶
type DeleteInstanceResponse struct { // 任务id。 JobId *string `json:"job_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (DeleteInstanceResponse) String ¶
func (o DeleteInstanceResponse) String() string
type Flavor ¶ added in v0.0.83
type Flavor struct { // CPU个数。 Vcpus string `json:"vcpus"` // 内存大小,单位为GB。 Ram string `json:"ram"` // 资源规格编码。例如:gaussdb.opengauss.ee.dn.m6.4xlarge.8.in。 SpecCode string `json:"spec_code"` // 可用az AvailabilityZone []string `json:"availability_zone"` // 其中key是可用区编号,value是规格所在az的状态,包含以下状态: - normal,在售。 - unsupported,暂不支持该规格。 - sellout,售罄。 AzStatus map[string]string `json:"az_status"` // 该规格支持的数据库版本号 Version string `json:"version"` // 数组库引擎名称 Name string `json:"name"` // 性能规格,包含以下状态: - normal:通用增强型。 - normal2:通用增强Ⅱ型。 - armFlavors:鲲鹏通用增强型。 - dedicicatenormal :x86独享型。 - armlocalssd:鲲鹏通用型。 - normallocalssd:x86通用型。 - general:通用型。 - dedicated:独享型,仅云盘SSD支持。 - rapid:独享型,仅极速型SSD支持。 GroupType string `json:"group_type"` }
规格信息。
type FlavorErrorResponse ¶ added in v0.0.83
type FlavorErrorResponse struct { // 错误码 ErrorCode string `json:"error_code"` // 错误消息。 ErrorMsg string `json:"error_msg"` }
func (FlavorErrorResponse) String ¶ added in v0.0.83
func (o FlavorErrorResponse) String() string
type ListConfigurationsRequest ¶ added in v0.0.83
type ListConfigurationsRequest struct { // 语言 XLanguage *ListConfigurationsRequestXLanguage `json:"X-Language,omitempty"` // 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 Offset *int32 `json:"offset,omitempty"` // 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 Limit *int32 `json:"limit,omitempty"` }
Request Object
func (ListConfigurationsRequest) String ¶ added in v0.0.83
func (o ListConfigurationsRequest) String() string
type ListConfigurationsRequestXLanguage ¶ added in v0.0.83
type ListConfigurationsRequestXLanguage struct {
// contains filtered or unexported fields
}
func (ListConfigurationsRequestXLanguage) MarshalJSON ¶ added in v0.0.83
func (c ListConfigurationsRequestXLanguage) MarshalJSON() ([]byte, error)
func (*ListConfigurationsRequestXLanguage) UnmarshalJSON ¶ added in v0.0.83
func (c *ListConfigurationsRequestXLanguage) UnmarshalJSON(b []byte) error
type ListConfigurationsRequestXLanguageEnum ¶ added in v0.0.83
type ListConfigurationsRequestXLanguageEnum struct { ZH_CN ListConfigurationsRequestXLanguage EN_US ListConfigurationsRequestXLanguage }
func GetListConfigurationsRequestXLanguageEnum ¶ added in v0.0.83
func GetListConfigurationsRequestXLanguageEnum() ListConfigurationsRequestXLanguageEnum
type ListConfigurationsResponse ¶ added in v0.0.83
type ListConfigurationsResponse struct { Count *int32 `json:"count,omitempty"` Configurations *[]ConfigurationSummary `json:"configurations,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListConfigurationsResponse) String ¶ added in v0.0.83
func (o ListConfigurationsResponse) String() string
type ListDatastore ¶
type ListDatastore struct { // 数据库引擎。 Type string `json:"type"` // 数据库版本。 Version string `json:"version"` }
数据库信息。
func (ListDatastore) String ¶
func (o ListDatastore) String() string
type ListDatastoresRequest ¶ added in v0.0.83
type ListDatastoresRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` }
Request Object
func (ListDatastoresRequest) String ¶ added in v0.0.83
func (o ListDatastoresRequest) String() string
type ListDatastoresResponse ¶ added in v0.0.83
type ListDatastoresResponse struct { // 数据库版本号。 Versions *[]string `json:"versions,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListDatastoresResponse) String ¶ added in v0.0.83
func (o ListDatastoresResponse) String() string
type ListFlavorsRequest ¶ added in v0.0.83
type ListFlavorsRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 数据库版本号。 Version *string `json:"version,omitempty"` // 规格编码 SpecCode *string `json:"spec_code,omitempty"` // 实例类型 集中式centralization_standard 分布式enterprise HaMode *string `json:"ha_mode,omitempty"` // 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 Limit *int32 `json:"limit,omitempty"` // 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 Offset *int32 `json:"offset,omitempty"` }
Request Object
func (ListFlavorsRequest) String ¶ added in v0.0.83
func (o ListFlavorsRequest) String() string
type ListFlavorsResponse ¶ added in v0.0.83
type ListFlavorsResponse struct { // 实例规格信息。 Flavors *[]Flavor `json:"flavors,omitempty"` // 查询的记录总数 Total *int32 `json:"total,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListFlavorsResponse) String ¶ added in v0.0.83
func (o ListFlavorsResponse) String() string
type ListHa ¶
type ListHa struct { // 数据库一致性类型,分布式模式实例仅有。取值为“strong”、“eventual”,分别表示强一致性、最终一致性。 Consistency ListHaConsistency `json:"consistency"` // 备机同步参数。 取值:非空。 GaussDB(for openGauss)为 “sync” 说明: “sync”为同步模式。 ReplicationMode string `json:"replication_mode"` }
获取分布式/主备版实例时返回。
type ListHaConsistency ¶
type ListHaConsistency struct {
// contains filtered or unexported fields
}
func (ListHaConsistency) MarshalJSON ¶
func (c ListHaConsistency) MarshalJSON() ([]byte, error)
func (*ListHaConsistency) UnmarshalJSON ¶
func (c *ListHaConsistency) UnmarshalJSON(b []byte) error
type ListHaConsistencyEnum ¶
type ListHaConsistencyEnum struct { STRONG ListHaConsistency EVENTUAL ListHaConsistency }
func GetListHaConsistencyEnum ¶
func GetListHaConsistencyEnum() ListHaConsistencyEnum
type ListInstanceResponse ¶
type ListInstanceResponse struct { // 实例ID。 Id string `json:"id"` // 创建的实例名称。 Name string `json:"name"` // 实例状态。 取值: 值为“BUILD”,表示实例正在创建。 值为“ACTIVE”,表示实例正常。 值为“FAILED”,表示实例异常。 值为“FROZEN”,表示实例冻结。 值为“EXPANDING”,表示实例正在扩容CN或DN。 值为“REBOOTING”,表示实例正在重启。 值为“UPGRADING”,表示实例正在升级。 值为“RESTORING”,表示实例正在恢复。 值为“BACKING UP”,表示实例正在进行备份。 值为“REDUCING REPLICATION”,表示实例正在降副本。 值为“STORAGE FULL”,表示实例磁盘空间满。 Status string `json:"status"` // 实例内网IP地址列表。分布式CN所在的弹性云服务器创建成功后该值存在,主备版DN所在的弹性云服务器创建成功后该值存在,其他情况下为空字符串。 PrivateIps []string `json:"private_ips"` // 实例外网IP地址列表。绑定弹性公网IP后,该值不为空。 PublicIps []string `json:"public_ips"` // 数据库端口号。GaussDB(for openGauss)数据库端口设置范围为1024~39998(其中2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,20049,20050,21731,21732被系统占用不可设置)。 当不传该参数时,默认端口如下:8000。 Port int32 `json:"port"` // 实例类型,取值为 \"enterprise\",对应于分布式实例(企业版)。取值为\"Ha\",对应于主备版实例。 Type string `json:"type"` Ha *ListHa `json:"ha"` // 实例副本数。 ReplicaNum *int32 `json:"replica_num,omitempty"` // 实例所在区域。 Region string `json:"region"` Datastore *ListDatastore `json:"datastore"` // 创建时间,格式为“yyyy-mm-dd hh:mm:ss timezone”。 其中timezone是指时区。 说明:创建时该值为实例下发创建的时间,创建完成后,该值为创建完成时间。 Created string `json:"created"` // 更新时间,格式与“created”字段对应格式完全相同。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。 Updated string `json:"updated"` // 默认用户名。 DbUserName string `json:"db_user_name"` // 虚拟私有云ID。 VpcId string `json:"vpc_id"` // 子网的网络ID信息。 SubnetId string `json:"subnet_id"` // 安全组ID。 SecurityGroupId string `json:"security_group_id"` // 规格码。参考[表1](https://support.huaweicloud.com/api-opengauss/opengauss_api_0037.html#opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479)中GaussDB(for openGauss)的“规格编码”列内容获取。 FlavorRef string `json:"flavor_ref"` FlavorInfo *ListFlavorInfo `json:"flavor_info"` Volume *ListVolume `json:"volume"` // 数据库切换策略。取值为“reliability”或“availability”,分别对应于可靠性优先和可用性优先。 若创建时没有选择切换策略,则不予显示。 SwitchStrategy string `json:"switch_strategy"` BackupStrategy *OpenGaussBackupStrategyForListResponse `json:"backup_strategy"` // 可维护时间窗,为UTC时间。 MaintenanceWindow string `json:"maintenance_window"` // 实例节点信息。 Nodes []interface{} `json:"nodes"` // 企业项目标签ID。非企业项目账号的实例,企业项目默认0。 EnterpriseProjectId string `json:"enterprise_project_id"` // basic为基础版 ,enterprise为企业版。 InstanceMode string `json:"instance_mode"` // 磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。 DiskEncryptionId string `json:"disk_encryption_id"` ChargeInfo *OpenGaussChargeInfoListResponse `json:"charge_info"` // 时区。 TimeZone string `json:"time_zone"` // 标签列表,没有标签不返回该参数。 Tags []interface{} `json:"tags"` }
实例信息。
func (ListInstanceResponse) String ¶
func (o ListInstanceResponse) String() string
type ListInstancesRequest ¶
type ListInstancesRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID。 “\\*”为系统保留字符,如果id是以“\\*”起始,表示按照\\*后面的值模糊匹配,否则,按照id精确匹配查询。不能只传入“\\*”。 Id *string `json:"id,omitempty"` // 实例名称。 “\\*”为系统保留字符,如果name是以“\\*”起始,表示按照\\*后面的值模糊匹配,否则,按照name精确匹配查询。不能只传入“\\*”。 Name *string `json:"name,omitempty"` // 按照实例类型查询。目前仅支持取值“Enterprise”(区分大小写),对应分布式实例(企业版)。当前支持取值\"Ha\"(区分大小写),对应主备式实例。 Type *ListInstancesRequestType `json:"type,omitempty"` // 数据库类型,区分大小写。 - GaussDB(for openGauss) DatastoreType *ListInstancesRequestDatastoreType `json:"datastore_type,omitempty"` // 虚拟私有云ID。 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。 VpcId *string `json:"vpc_id,omitempty"` // 子网的网络ID信息。 - 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。 - 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。 SubnetId *string `json:"subnet_id,omitempty"` // 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 Offset *int32 `json:"offset,omitempty"` // 查询记录数。默认为100,不能为负数,最小值为1,最大值为100 Limit *int32 `json:"limit,omitempty"` // 根据实例标签键值对进行查询。 {key}表示标签键,不可以为空或重复。最大长度127个unicode字符。key不能为空或者空字符串,不能为空格,使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}表示标签值,可以为空。最大长度255个unicode字符,使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。 如果value为空,则表示any_value(查询任意value)。 如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,最多包含10组。 Tags *[]string `json:"tags,omitempty"` }
Request Object
func (ListInstancesRequest) String ¶
func (o ListInstancesRequest) String() string
type ListInstancesRequestDatastoreType ¶
type ListInstancesRequestDatastoreType struct {
// contains filtered or unexported fields
}
func (ListInstancesRequestDatastoreType) MarshalJSON ¶
func (c ListInstancesRequestDatastoreType) MarshalJSON() ([]byte, error)
func (*ListInstancesRequestDatastoreType) UnmarshalJSON ¶
func (c *ListInstancesRequestDatastoreType) UnmarshalJSON(b []byte) error
type ListInstancesRequestDatastoreTypeEnum ¶
type ListInstancesRequestDatastoreTypeEnum struct {
GAUSS_DB_FOR_OPEN_GAUSS ListInstancesRequestDatastoreType
}
func GetListInstancesRequestDatastoreTypeEnum ¶
func GetListInstancesRequestDatastoreTypeEnum() ListInstancesRequestDatastoreTypeEnum
type ListInstancesRequestType ¶
type ListInstancesRequestType struct {
// contains filtered or unexported fields
}
func (ListInstancesRequestType) MarshalJSON ¶
func (c ListInstancesRequestType) MarshalJSON() ([]byte, error)
func (*ListInstancesRequestType) UnmarshalJSON ¶
func (c *ListInstancesRequestType) UnmarshalJSON(b []byte) error
type ListInstancesRequestTypeEnum ¶
type ListInstancesRequestTypeEnum struct { ENTERPRISE ListInstancesRequestType HA ListInstancesRequestType }
func GetListInstancesRequestTypeEnum ¶
func GetListInstancesRequestTypeEnum() ListInstancesRequestTypeEnum
type ListInstancesResponse ¶
type ListInstancesResponse struct { // 实例信息。 Instances *[]ListInstanceResponse `json:"instances,omitempty"` // 总记录数。 TotalCount *int32 `json:"total_count,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListInstancesResponse) String ¶
func (o ListInstancesResponse) String() string
type ListStorageTypesRequest ¶ added in v0.0.83
type ListStorageTypesRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 数据库版本号。 Version string `json:"version"` // 实例类型: enterprise(企业版), centralization_standard(主备版),不区分大小写。 HaMode *ListStorageTypesRequestHaMode `json:"ha_mode,omitempty"` }
Request Object
func (ListStorageTypesRequest) String ¶ added in v0.0.83
func (o ListStorageTypesRequest) String() string
type ListStorageTypesRequestHaMode ¶ added in v0.0.83
type ListStorageTypesRequestHaMode struct {
// contains filtered or unexported fields
}
func (ListStorageTypesRequestHaMode) MarshalJSON ¶ added in v0.0.83
func (c ListStorageTypesRequestHaMode) MarshalJSON() ([]byte, error)
func (*ListStorageTypesRequestHaMode) UnmarshalJSON ¶ added in v0.0.83
func (c *ListStorageTypesRequestHaMode) UnmarshalJSON(b []byte) error
type ListStorageTypesRequestHaModeEnum ¶ added in v0.0.83
type ListStorageTypesRequestHaModeEnum struct { ENTERPRISE ListStorageTypesRequestHaMode CENTRALIZATION_STANDARD ListStorageTypesRequestHaMode }
func GetListStorageTypesRequestHaModeEnum ¶ added in v0.0.83
func GetListStorageTypesRequestHaModeEnum() ListStorageTypesRequestHaModeEnum
type ListStorageTypesResponse ¶ added in v0.0.83
type ListStorageTypesResponse struct { // 实例磁盘类型信息。 StorageType *[]Storage `json:"storage_type,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ListStorageTypesResponse) String ¶ added in v0.0.83
func (o ListStorageTypesResponse) String() string
type OpenGaussBackupStrategy ¶
type OpenGaussBackupStrategy struct { // 备份时间段。自动备份将在该时间段内触发。 取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。 - HH取值必须比hh大1。 - mm和MM取值必须相同,且取值必须为00。 取值示例: - 08:00-09:00 - 23:00-00:00 StartTime string `json:"start_time"` // 指定备份文件的可保存天数。 取值范围:0~732。该参数缺省或为0时,默认填写为7天。 KeepDays *int32 `json:"keep_days,omitempty"` }
备份策略。
func (OpenGaussBackupStrategy) String ¶
func (o OpenGaussBackupStrategy) String() string
type OpenGaussBackupStrategyForListResponse ¶
type OpenGaussBackupStrategyForListResponse struct { // 备份时间段。自动备份将在该时间段内触发。 当前时间指UTC时间。 StartTime string `json:"start_time"` // 已生成的备份文件可以保存的天数。 取值范围:1~732。 KeepDays int32 `json:"keep_days"` }
备份策略。
func (OpenGaussBackupStrategyForListResponse) String ¶
func (o OpenGaussBackupStrategyForListResponse) String() string
type OpenGaussBackupStrategyForResponse ¶
type OpenGaussBackupStrategyForResponse struct { // 备份时间段。自动备份将在该时间段内触发。 取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。 - HH取值必须比hh大1。 - mm和MM取值必须相同,且取值必须为00。 取值示例: - 08:00-09:00 - 23:00-00:00 StartTime string `json:"start_time"` // 指定已生成备份文件的可保存天数。 取值范围:1~732。 如果请求体中不填写“backup_strategy”字段,则响应体中 “keep_days”默认返回“7”。 KeepDays int32 `json:"keep_days"` }
自动备份策略。
func (OpenGaussBackupStrategyForResponse) String ¶
func (o OpenGaussBackupStrategyForResponse) String() string
type OpenGaussChargeInfo ¶
type OpenGaussChargeInfo struct { // 计费模式。仅支持postPaid,后付费,即按需付费。 ChargeMode OpenGaussChargeInfoChargeMode `json:"charge_mode"` }
计费类型信息,仅支持按需。
func (OpenGaussChargeInfo) String ¶
func (o OpenGaussChargeInfo) String() string
type OpenGaussChargeInfoChargeMode ¶
type OpenGaussChargeInfoChargeMode struct {
// contains filtered or unexported fields
}
func (OpenGaussChargeInfoChargeMode) MarshalJSON ¶
func (c OpenGaussChargeInfoChargeMode) MarshalJSON() ([]byte, error)
func (*OpenGaussChargeInfoChargeMode) UnmarshalJSON ¶
func (c *OpenGaussChargeInfoChargeMode) UnmarshalJSON(b []byte) error
type OpenGaussChargeInfoChargeModeEnum ¶
type OpenGaussChargeInfoChargeModeEnum struct {
POST_PAID OpenGaussChargeInfoChargeMode
}
func GetOpenGaussChargeInfoChargeModeEnum ¶
func GetOpenGaussChargeInfoChargeModeEnum() OpenGaussChargeInfoChargeModeEnum
type OpenGaussChargeInfoListResponse ¶
type OpenGaussChargeInfoListResponse struct { // 计费模式。 取值范围: postPaid:后付费,即按需付费。 prePaid:预付费,即包年/包月。 ChargeMode OpenGaussChargeInfoListResponseChargeMode `json:"charge_mode"` }
计费类型信息,支持按需和包周期。
func (OpenGaussChargeInfoListResponse) String ¶
func (o OpenGaussChargeInfoListResponse) String() string
type OpenGaussChargeInfoListResponseChargeMode ¶
type OpenGaussChargeInfoListResponseChargeMode struct {
// contains filtered or unexported fields
}
func (OpenGaussChargeInfoListResponseChargeMode) MarshalJSON ¶
func (c OpenGaussChargeInfoListResponseChargeMode) MarshalJSON() ([]byte, error)
func (*OpenGaussChargeInfoListResponseChargeMode) UnmarshalJSON ¶
func (c *OpenGaussChargeInfoListResponseChargeMode) UnmarshalJSON(b []byte) error
type OpenGaussChargeInfoListResponseChargeModeEnum ¶
type OpenGaussChargeInfoListResponseChargeModeEnum struct {
POST_PAID OpenGaussChargeInfoListResponseChargeMode
}
func GetOpenGaussChargeInfoListResponseChargeModeEnum ¶
func GetOpenGaussChargeInfoListResponseChargeModeEnum() OpenGaussChargeInfoListResponseChargeModeEnum
type OpenGaussChargeInfoResponse ¶
type OpenGaussChargeInfoResponse struct { // 计费模式。 取值范围: postPaid:后付费,即按需付费。 ChargeMode OpenGaussChargeInfoResponseChargeMode `json:"charge_mode"` }
计费类型信息,支持按需,默认为按需。
func (OpenGaussChargeInfoResponse) String ¶
func (o OpenGaussChargeInfoResponse) String() string
type OpenGaussChargeInfoResponseChargeMode ¶
type OpenGaussChargeInfoResponseChargeMode struct {
// contains filtered or unexported fields
}
func (OpenGaussChargeInfoResponseChargeMode) MarshalJSON ¶
func (c OpenGaussChargeInfoResponseChargeMode) MarshalJSON() ([]byte, error)
func (*OpenGaussChargeInfoResponseChargeMode) UnmarshalJSON ¶
func (c *OpenGaussChargeInfoResponseChargeMode) UnmarshalJSON(b []byte) error
type OpenGaussChargeInfoResponseChargeModeEnum ¶
type OpenGaussChargeInfoResponseChargeModeEnum struct {
POST_PAID OpenGaussChargeInfoResponseChargeMode
}
func GetOpenGaussChargeInfoResponseChargeModeEnum ¶
func GetOpenGaussChargeInfoResponseChargeModeEnum() OpenGaussChargeInfoResponseChargeModeEnum
type OpenGaussCoordinators ¶
type OpenGaussCoordinators struct { // 新增CN横向扩容每个节点的可用区。如果需要扩容多个CN,请分别填写待扩容CN所在的可用区。 不同区域的可用区请参考[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 说明: 扩容后,实例中CN节点的数量必须小于或等于两倍的分片数量。 AzCode string `json:"az_code"` }
CN横向扩容时必填
func (OpenGaussCoordinators) String ¶
func (o OpenGaussCoordinators) String() string
type OpenGaussDatastore ¶
type OpenGaussDatastore struct { // 数据库引擎,不区分大小写,取值如下: GaussDB(for openGauss)。 Type OpenGaussDatastoreType `json:"type"` // 数据库版本。不填时,默认为当前最新版本。 GaussDB(for openGauss)支持的版本参考[查询数据库引擎的版本](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListDatastores)。 Version *string `json:"version,omitempty"` }
数据库信息。
func (OpenGaussDatastore) String ¶
func (o OpenGaussDatastore) String() string
type OpenGaussDatastoreResponse ¶
type OpenGaussDatastoreResponse struct { // 数据库引擎,不区分大小写,取值如下: GaussDB(for openGauss) Type OpenGaussDatastoreResponseType `json:"type"` // 数据库版本。 Version string `json:"version"` }
数据库版本。不填时,默认为当前最新版本。 数据库支持版本可根据查询数据库引擎版本接口获取
func (OpenGaussDatastoreResponse) String ¶
func (o OpenGaussDatastoreResponse) String() string
type OpenGaussDatastoreResponseType ¶
type OpenGaussDatastoreResponseType struct {
// contains filtered or unexported fields
}
func (OpenGaussDatastoreResponseType) MarshalJSON ¶
func (c OpenGaussDatastoreResponseType) MarshalJSON() ([]byte, error)
func (*OpenGaussDatastoreResponseType) UnmarshalJSON ¶
func (c *OpenGaussDatastoreResponseType) UnmarshalJSON(b []byte) error
type OpenGaussDatastoreResponseTypeEnum ¶
type OpenGaussDatastoreResponseTypeEnum struct {
GAUSS_DB_FOR_OPEN_GAUSS OpenGaussDatastoreResponseType
}
func GetOpenGaussDatastoreResponseTypeEnum ¶
func GetOpenGaussDatastoreResponseTypeEnum() OpenGaussDatastoreResponseTypeEnum
type OpenGaussDatastoreType ¶
type OpenGaussDatastoreType struct {
// contains filtered or unexported fields
}
func (OpenGaussDatastoreType) MarshalJSON ¶
func (c OpenGaussDatastoreType) MarshalJSON() ([]byte, error)
func (*OpenGaussDatastoreType) UnmarshalJSON ¶
func (c *OpenGaussDatastoreType) UnmarshalJSON(b []byte) error
type OpenGaussDatastoreTypeEnum ¶
type OpenGaussDatastoreTypeEnum struct {
GAUSS_DB_FOR_OPEN_GAUSS OpenGaussDatastoreType
}
func GetOpenGaussDatastoreTypeEnum ¶
func GetOpenGaussDatastoreTypeEnum() OpenGaussDatastoreTypeEnum
type OpenGaussEnlargeVolume ¶
type OpenGaussEnlargeVolume struct { // GaussDB(for openGauss)磁盘大小要求(分片数*40GB)的倍数;取值范围:(分片数*40GB)~(分片数*16TB) Size int32 `json:"size"` }
扩容实例磁盘时必填。 所需扩容到的磁盘容量大小。
func (OpenGaussEnlargeVolume) String ¶
func (o OpenGaussEnlargeVolume) String() string
type OpenGaussErrorResponse ¶
type OpenGaussErrorResponse struct { // 错误码 ErrorCode string `json:"error_code"` // 错误消息。 ErrorMsg string `json:"error_msg"` }
func (OpenGaussErrorResponse) String ¶
func (o OpenGaussErrorResponse) String() string
type OpenGaussExpandCluster ¶
type OpenGaussExpandCluster struct { // CN横向扩容时必填 Coordinators *[]OpenGaussCoordinators `json:"coordinators,omitempty"` Shard *OpenGaussShard `json:"shard,omitempty"` }
CN横向扩容/DN分片扩容时必填
func (OpenGaussExpandCluster) String ¶
func (o OpenGaussExpandCluster) String() string
type OpenGaussHa ¶
type OpenGaussHa struct { // GaussDB(for openGauss)为分布式时,取值:enterprise;为集中式时,取值:centralization_standard。不区分大小写。 Mode OpenGaussHaMode `json:"mode"` // 指定实例一致性类型,当创建分布式模式实例时,该字段值必传,当创建主备模式实例时,该字段值不传。取值范围:strong(强一致性) | eventual(最终一致性),不分区大小写。 Consistency OpenGaussHaConsistency `json:"consistency"` // 备机同步参数。 取值: GaussDB(for openGauss)为“sync\" 说明: - “sync”为同步模式。 ReplicationMode OpenGaussHaReplicationMode `json:"replication_mode"` }
实例部署形态。
func (OpenGaussHa) String ¶
func (o OpenGaussHa) String() string
type OpenGaussHaConsistency ¶
type OpenGaussHaConsistency struct {
// contains filtered or unexported fields
}
func (OpenGaussHaConsistency) MarshalJSON ¶
func (c OpenGaussHaConsistency) MarshalJSON() ([]byte, error)
func (*OpenGaussHaConsistency) UnmarshalJSON ¶
func (c *OpenGaussHaConsistency) UnmarshalJSON(b []byte) error
type OpenGaussHaConsistencyEnum ¶
type OpenGaussHaConsistencyEnum struct { STRONG OpenGaussHaConsistency EVENTUAL OpenGaussHaConsistency }
func GetOpenGaussHaConsistencyEnum ¶
func GetOpenGaussHaConsistencyEnum() OpenGaussHaConsistencyEnum
type OpenGaussHaMode ¶
type OpenGaussHaMode struct {
// contains filtered or unexported fields
}
func (OpenGaussHaMode) MarshalJSON ¶
func (c OpenGaussHaMode) MarshalJSON() ([]byte, error)
func (*OpenGaussHaMode) UnmarshalJSON ¶
func (c *OpenGaussHaMode) UnmarshalJSON(b []byte) error
type OpenGaussHaModeEnum ¶
type OpenGaussHaModeEnum struct { ENTERPRISE OpenGaussHaMode CENTRALIZATION_STANDARD OpenGaussHaMode }
func GetOpenGaussHaModeEnum ¶
func GetOpenGaussHaModeEnum() OpenGaussHaModeEnum
type OpenGaussHaReplicationMode ¶
type OpenGaussHaReplicationMode struct {
// contains filtered or unexported fields
}
func (OpenGaussHaReplicationMode) MarshalJSON ¶
func (c OpenGaussHaReplicationMode) MarshalJSON() ([]byte, error)
func (*OpenGaussHaReplicationMode) UnmarshalJSON ¶
func (c *OpenGaussHaReplicationMode) UnmarshalJSON(b []byte) error
type OpenGaussHaReplicationModeEnum ¶
type OpenGaussHaReplicationModeEnum struct {
SYNC OpenGaussHaReplicationMode
}
func GetOpenGaussHaReplicationModeEnum ¶
func GetOpenGaussHaReplicationModeEnum() OpenGaussHaReplicationModeEnum
type OpenGaussHaResponse ¶
type OpenGaussHaResponse struct { // GaussDB(for openGauss) 分布式模式,返回值为:Enterprise(企业版);主备版,返回值为:Ha(主备版)。 Mode OpenGaussHaResponseMode `json:"mode"` // 备机同步参数。 取值: GaussDB(for openGauss)为“sync”。 说明: - “sync”为同步模式。 ReplicationMode OpenGaussHaResponseReplicationMode `json:"replication_mode"` // GaussDB(for openGauss)的预留参数:指定实例一致性类型,取值范围:strong(强一致性) | eventual(最终一致性)。 Consistency OpenGaussHaResponseConsistency `json:"consistency"` }
实例部署形态。
func (OpenGaussHaResponse) String ¶
func (o OpenGaussHaResponse) String() string
type OpenGaussHaResponseConsistency ¶
type OpenGaussHaResponseConsistency struct {
// contains filtered or unexported fields
}
func (OpenGaussHaResponseConsistency) MarshalJSON ¶
func (c OpenGaussHaResponseConsistency) MarshalJSON() ([]byte, error)
func (*OpenGaussHaResponseConsistency) UnmarshalJSON ¶
func (c *OpenGaussHaResponseConsistency) UnmarshalJSON(b []byte) error
type OpenGaussHaResponseConsistencyEnum ¶
type OpenGaussHaResponseConsistencyEnum struct { STRONG OpenGaussHaResponseConsistency EVENTUAL OpenGaussHaResponseConsistency }
func GetOpenGaussHaResponseConsistencyEnum ¶
func GetOpenGaussHaResponseConsistencyEnum() OpenGaussHaResponseConsistencyEnum
type OpenGaussHaResponseMode ¶
type OpenGaussHaResponseMode struct {
// contains filtered or unexported fields
}
func (OpenGaussHaResponseMode) MarshalJSON ¶
func (c OpenGaussHaResponseMode) MarshalJSON() ([]byte, error)
func (*OpenGaussHaResponseMode) UnmarshalJSON ¶
func (c *OpenGaussHaResponseMode) UnmarshalJSON(b []byte) error
type OpenGaussHaResponseModeEnum ¶
type OpenGaussHaResponseModeEnum struct { ENTERPRISE OpenGaussHaResponseMode HA OpenGaussHaResponseMode }
func GetOpenGaussHaResponseModeEnum ¶
func GetOpenGaussHaResponseModeEnum() OpenGaussHaResponseModeEnum
type OpenGaussHaResponseReplicationMode ¶
type OpenGaussHaResponseReplicationMode struct {
// contains filtered or unexported fields
}
func (OpenGaussHaResponseReplicationMode) MarshalJSON ¶
func (c OpenGaussHaResponseReplicationMode) MarshalJSON() ([]byte, error)
func (*OpenGaussHaResponseReplicationMode) UnmarshalJSON ¶
func (c *OpenGaussHaResponseReplicationMode) UnmarshalJSON(b []byte) error
type OpenGaussHaResponseReplicationModeEnum ¶
type OpenGaussHaResponseReplicationModeEnum struct {
SYNC OpenGaussHaResponseReplicationMode
}
func GetOpenGaussHaResponseReplicationModeEnum ¶
func GetOpenGaussHaResponseReplicationModeEnum() OpenGaussHaResponseReplicationModeEnum
type OpenGaussInstanceActionRequest ¶
type OpenGaussInstanceActionRequest struct { ExpandCluster *OpenGaussExpandCluster `json:"expand_cluster,omitempty"` EnlargeVolume *OpenGaussEnlargeVolume `json:"enlarge_volume,omitempty"` }
func (OpenGaussInstanceActionRequest) String ¶
func (o OpenGaussInstanceActionRequest) String() string
type OpenGaussInstanceRequest ¶
type OpenGaussInstanceRequest struct { // 实例名称。 用于表示实例的名称,同一租户下,同类型的实例名可重名。 取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。 Name string `json:"name"` Datastore *OpenGaussDatastore `json:"datastore"` Ha *OpenGaussHa `json:"ha"` // 参数模板ID。当不传该参数时,使用系统默认的参数模板。 ConfigurationId *string `json:"configuration_id,omitempty"` // 数据库对外开放的端口,不填默认为8000,可选范围为:1024-39998。限制端口: 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。 - GaussDB(for openGauss)数据库端口当前只支持设置为8000,当不传该参数时,默认端口为8000。 Port *string `json:"port,omitempty"` // 数据库密码。必选。 取值范围: '非空; 至少包含大写字母(A-Z),小写字母(a-z),数字(0-9),非字母数字字符(限定为~!@#%^*-_=+?,)四类字符中的三类字符;长度8~32个字符。' '建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。' Password string `json:"password"` BackupStrategy *OpenGaussBackupStrategy `json:"backup_strategy,omitempty"` // 企业项目ID。只有企业租户时该参数才生效。 使用请参考《企业管理 API参考》的“[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)”响应消息表“enterprise_project字段数据结构说明”的“id”。 EnterpriseProjectId *string `json:"enterprise_project_id,omitempty"` // 用于磁盘加密的密钥ID,默认为空。 DiskEncryptionId *string `json:"disk_encryption_id,omitempty"` // 规格码,取值范围:非空。参考[表1](https://support.huaweicloud.com/api-opengauss/opengauss_api_0037.html#opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479)中GaussDB(for openGauss)的“规格编码”列内容获取。 FlavorRef string `json:"flavor_ref"` Volume *OpenGaussVolume `json:"volume"` // 区域ID。 取值范围:非空,请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 Region string `json:"region"` // 可用区ID。 GaussDB(for openGauss)取值范围:非空,可选部署在同一可用区或三个不同可用区,可用区之间用逗号隔开。详见示例。 - 部署在同一可用区:需要输入三个相同的可用区。例如:部署在“cn-north-4a”可用区,则需要在此处输入\"cn-north-4a,cn-north-4a,cn-north-4a\"。 - 部署在三个不同可用区:需要分别输入三个不同的可用区。 取值范围:非空,请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 AvailabilityZone string `json:"availability_zone"` // 虚拟私有云ID,获取方法如下: - 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 - 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。 VpcId string `json:"vpc_id"` // 子网的网络ID信息,获取方法如下: - 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。 - 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。 SubnetId string `json:"subnet_id"` // 指定实例所属的安全组。如果不需要指定安全组,请联系客服申请白名单。 - 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。 - 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)。 SecurityGroupId string `json:"security_group_id"` ChargeInfo *OpenGaussChargeInfo `json:"charge_info,omitempty"` // UTC时区。 - 不选择时,GaussDB(for openGauss)国内站、默认为UTC时间。 - 选择填写时,取值范围为UTC-12:00~UTC+12:00,且只支持整段时间,如UTC+08:00,不支持UTC+08:30。 TimeZone *string `json:"time_zone,omitempty"` // 仅分布式形态需要填写该参数。分片数量,取值范围1~9。 ShardingNum *int32 `json:"sharding_num,omitempty"` // 仅分布式形态需要填写该参数。协调节点数量,取值范围1~9。CN数量必须小于或等于两倍的分片数。 CoordinatorNum *int32 `json:"coordinator_num,omitempty"` // 实例副本数,支持取值2,3。不填默认为3。仅支持1.3.0及以上版本的实例。 说明: 2副本选项仅针对特定用户开放,如需配置白名单权限,您可以在管理控制台右上角,选择“[工单 > 新建工单](https://auth.huaweicloud.com/authui/login.html?service=https%3A%2F%2Fconsole.huaweicloud.com%2Fticket%2F%3Fregion%3Dcn-north-1%26locale%3Dzh-cn%26cloud_route_state%3D%2Fticketindex%2FcreateIndex#/login)”,提交开通白名单的申请。 ReplicaNum *OpenGaussInstanceRequestReplicaNum `json:"replica_num,omitempty"` // enable_force_switch表示是否开启备机强升主功能,enable_force_switch=true表示开启备机强升主功能,enable_force_switch=false表示关闭,默认关闭。仅支持1.2.2及以上版本。 说明: 备机强升主功能适用场景:在主机发生故障后,为了保障集群的可用性,强制拉起备机作为新主机对外提供服务的场景。 本功能在集群故障状态下,以丢失部分数据为代价换取集群尽可能快的恢复服务。本功能是集群状态为不可用时的一个逃生方法,如果操作者不清楚备机强升后丢失数据对业务的影响,请勿使用本功能。 备机强升主相关介绍请参考《故障处理》备机强升主章节。 EnableForceSwitch *bool `json:"enable_force_switch,omitempty"` }
实例信息
func (OpenGaussInstanceRequest) String ¶
func (o OpenGaussInstanceRequest) String() string
type OpenGaussInstanceRequestReplicaNum ¶
type OpenGaussInstanceRequestReplicaNum struct {
// contains filtered or unexported fields
}
func (OpenGaussInstanceRequestReplicaNum) MarshalJSON ¶
func (c OpenGaussInstanceRequestReplicaNum) MarshalJSON() ([]byte, error)
func (*OpenGaussInstanceRequestReplicaNum) UnmarshalJSON ¶
func (c *OpenGaussInstanceRequestReplicaNum) UnmarshalJSON(b []byte) error
type OpenGaussInstanceRequestReplicaNumEnum ¶
type OpenGaussInstanceRequestReplicaNumEnum struct { E_2 OpenGaussInstanceRequestReplicaNum E_3 OpenGaussInstanceRequestReplicaNum }
func GetOpenGaussInstanceRequestReplicaNumEnum ¶
func GetOpenGaussInstanceRequestReplicaNumEnum() OpenGaussInstanceRequestReplicaNumEnum
type OpenGaussInstanceResponse ¶
type OpenGaussInstanceResponse struct { // 实例ID。 Id string `json:"id"` // 实例名称。用于表示实例的名称,同一租户下,同类型的实例名称可相同。 取值范围:4~64个字符之间,必须以字母开头,不区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。 Name string `json:"name"` // 实例状态。如BUILD,表示创建中。 仅创建按需实例时会返回该参数。 Status string `json:"status"` Datastore *OpenGaussDatastoreResponse `json:"datastore"` Ha *OpenGaussHaResponse `json:"ha,omitempty"` // 实例副本数。 ReplicaNum *int32 `json:"replica_num,omitempty"` BackupStrategy *OpenGaussBackupStrategyForResponse `json:"backup_strategy"` // 数据库端口信息,与请求参数相同。 Port string `json:"port"` // 项目标签。 EnterpriseProjectId string `json:"enterprise_project_id"` // 规格码,取值范围:非空。参考[表1](https://support.huaweicloud.com/api-opengauss/opengauss_api_0037.html#opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479)中GaussDB(for openGauss)的“规格编码”列内容获取。 FlavorRef string `json:"flavor_ref"` Volume *OpenGaussVolumeResponse `json:"volume"` // 区域ID。 Region string `json:"region"` // 可用区ID。 AvailabilityZone string `json:"availability_zone"` // 虚拟私有云ID。 VpcId string `json:"vpc_id"` // 子网的网络ID信息。 SubnetId string `json:"subnet_id"` // 实例所属的安全组。 SecurityGroupId string `json:"security_group_id"` ChargeInfo *OpenGaussChargeInfoResponse `json:"charge_info"` }
实例信息。
func (OpenGaussInstanceResponse) String ¶
func (o OpenGaussInstanceResponse) String() string
type OpenGaussModifyInstanceConfigurationRequest ¶
type OpenGaussModifyInstanceConfigurationRequest struct { // 参数值对象Map<String,String>,用户基于默认参数模板自定义的参数值。 Values map[string]string `json:"values"` }
func (OpenGaussModifyInstanceConfigurationRequest) String ¶
func (o OpenGaussModifyInstanceConfigurationRequest) String() string
type OpenGaussShard ¶
type OpenGaussShard struct { // 新增的DN分片扩容数大小 Count int32 `json:"count"` }
DN分片扩容时必填
func (OpenGaussShard) String ¶
func (o OpenGaussShard) String() string
type OpenGaussVolume ¶
type OpenGaussVolume struct { // 磁盘类型。 仅支持ULTRAHIGH和ESSD,区分大小写,分别表示SSD和急速云盘。 Type OpenGaussVolumeType `json:"type"` // 磁盘大小。例如:该参数填写为“40”,表示为创建的实例分配40GB的磁盘空间。 取值范围:(分片数*40GB)~(分片数*16TB),且大小只能为分片数*40的整数倍。 Size int32 `json:"size"` }
volume信息。
func (OpenGaussVolume) String ¶
func (o OpenGaussVolume) String() string
type OpenGaussVolumeResponse ¶
type OpenGaussVolumeResponse struct { // 磁盘类型。 取值如下,区分大小写: - ULTRAHIGH,表示SSD。 - ESSD,表示急速云盘 Type OpenGaussVolumeResponseType `json:"type"` // 磁盘大小。 GaussDB(for openGauss)分布式实例创建时需指定大小:要求必须为(分片数 * 40GB)的倍数,取值范围:(分片数*40GB)~(分片数*16TB)。 Size int32 `json:"size"` }
volume信息。
func (OpenGaussVolumeResponse) String ¶
func (o OpenGaussVolumeResponse) String() string
type OpenGaussVolumeResponseType ¶
type OpenGaussVolumeResponseType struct {
// contains filtered or unexported fields
}
func (OpenGaussVolumeResponseType) MarshalJSON ¶
func (c OpenGaussVolumeResponseType) MarshalJSON() ([]byte, error)
func (*OpenGaussVolumeResponseType) UnmarshalJSON ¶
func (c *OpenGaussVolumeResponseType) UnmarshalJSON(b []byte) error
type OpenGaussVolumeResponseTypeEnum ¶
type OpenGaussVolumeResponseTypeEnum struct { ULTRAHIGH OpenGaussVolumeResponseType ESSD OpenGaussVolumeResponseType }
func GetOpenGaussVolumeResponseTypeEnum ¶
func GetOpenGaussVolumeResponseTypeEnum() OpenGaussVolumeResponseTypeEnum
type OpenGaussVolumeType ¶
type OpenGaussVolumeType struct {
// contains filtered or unexported fields
}
func (OpenGaussVolumeType) MarshalJSON ¶
func (c OpenGaussVolumeType) MarshalJSON() ([]byte, error)
func (*OpenGaussVolumeType) UnmarshalJSON ¶
func (c *OpenGaussVolumeType) UnmarshalJSON(b []byte) error
type OpenGaussVolumeTypeEnum ¶
type OpenGaussVolumeTypeEnum struct { ULTRAHIGH OpenGaussVolumeType ESSD OpenGaussVolumeType }
func GetOpenGaussVolumeTypeEnum ¶
func GetOpenGaussVolumeTypeEnum() OpenGaussVolumeTypeEnum
type PwdResetRequest ¶
type PwdResetRequest struct { // 数据库root用户密码。 - 8~32个字符。 - 至少包含以下字符中的三种: - 大写字母、小写字母、数字和特殊字符~!@#%^*-_=+?, - 弱密码校验。 Password string `json:"password"` }
数据库root用户密码。 8~32个字符。 至少包含以下字符中的三种: 大写字母、小写字母、数字和特殊字符~!@#%^*-_=+?, 弱密码校验。
func (PwdResetRequest) String ¶
func (o PwdResetRequest) String() string
type ResetPwdRequest ¶
type ResetPwdRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID,严格匹配UUID规则。 InstanceId string `json:"instance_id"` Body *PwdResetRequest `json:"body,omitempty"` }
Request Object
func (ResetPwdRequest) String ¶
func (o ResetPwdRequest) String() string
type ResetPwdResponse ¶
type ResetPwdResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (ResetPwdResponse) String ¶
func (o ResetPwdResponse) String() string
type RestartInstanceRequest ¶ added in v0.0.84
type RestartInstanceRequest struct { // 语言 XLanguage *RestartInstanceRequestXLanguage `json:"X-Language,omitempty"` // 实例ID。 InstanceId string `json:"instance_id"` }
Request Object
func (RestartInstanceRequest) String ¶ added in v0.0.84
func (o RestartInstanceRequest) String() string
type RestartInstanceRequestXLanguage ¶ added in v0.0.84
type RestartInstanceRequestXLanguage struct {
// contains filtered or unexported fields
}
func (RestartInstanceRequestXLanguage) MarshalJSON ¶ added in v0.0.84
func (c RestartInstanceRequestXLanguage) MarshalJSON() ([]byte, error)
func (*RestartInstanceRequestXLanguage) UnmarshalJSON ¶ added in v0.0.84
func (c *RestartInstanceRequestXLanguage) UnmarshalJSON(b []byte) error
type RestartInstanceRequestXLanguageEnum ¶ added in v0.0.84
type RestartInstanceRequestXLanguageEnum struct { ZH_CN RestartInstanceRequestXLanguage EN_US RestartInstanceRequestXLanguage }
func GetRestartInstanceRequestXLanguageEnum ¶ added in v0.0.84
func GetRestartInstanceRequestXLanguageEnum() RestartInstanceRequestXLanguageEnum
type RestartInstanceResponse ¶ added in v0.0.84
type RestartInstanceResponse struct { // 任务ID。 JobId *string `json:"job_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (RestartInstanceResponse) String ¶ added in v0.0.84
func (o RestartInstanceResponse) String() string
type RunInstanceActionRequest ¶
type RunInstanceActionRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID。 InstanceId string `json:"instance_id"` Body *OpenGaussInstanceActionRequest `json:"body,omitempty"` }
Request Object
func (RunInstanceActionRequest) String ¶
func (o RunInstanceActionRequest) String() string
type RunInstanceActionResponse ¶
type RunInstanceActionResponse struct { // 任务id。 JobId *string `json:"job_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (RunInstanceActionResponse) String ¶
func (o RunInstanceActionResponse) String() string
type SetBackupPolicyRequest ¶
type SetBackupPolicyRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID,严格匹配UUID规则。 InstanceId string `json:"instance_id"` Body *SetBackupPolicyRequestBody `json:"body,omitempty"` }
Request Object
func (SetBackupPolicyRequest) String ¶
func (o SetBackupPolicyRequest) String() string
type SetBackupPolicyRequestBody ¶
type SetBackupPolicyRequestBody struct {
BackupPolicy *BackupPolicy `json:"backup_policy"`
}
func (SetBackupPolicyRequestBody) String ¶
func (o SetBackupPolicyRequestBody) String() string
type SetBackupPolicyResponse ¶
type SetBackupPolicyResponse struct {
HttpStatusCode int `json:"-"`
}
Response Object
func (SetBackupPolicyResponse) String ¶
func (o SetBackupPolicyResponse) String() string
type ShowInstanceConfigurationRequest ¶ added in v0.0.84
type ShowInstanceConfigurationRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID。 InstanceId string `json:"instance_id"` }
Request Object
func (ShowInstanceConfigurationRequest) String ¶ added in v0.0.84
func (o ShowInstanceConfigurationRequest) String() string
type ShowInstanceConfigurationResponse ¶ added in v0.0.84
type ShowInstanceConfigurationResponse struct { // 引擎版本。 DatastoreVersion *string `json:"datastore_version,omitempty"` // 引擎名称。 DatastoreName *string `json:"datastore_name,omitempty"` // 创建时间,格式为\"yyyy-MM-dd HH:mm:ss\"。 Created *string `json:"created,omitempty"` // 更新时间,格式为\"yyyy-MM-ddHH:mm:ss\"。 Updated *string `json:"updated,omitempty"` // 参数对象,用户基于默认参数模板自定义的参数配置。 ConfigurationParameters *[]ConfigurationParameter `json:"configuration_parameters,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (ShowInstanceConfigurationResponse) String ¶ added in v0.0.84
func (o ShowInstanceConfigurationResponse) String() string
type Storage ¶ added in v0.0.83
type Storage struct { // 磁盘类型名称,可能取值如下: - ULTRAHIGH,表示SSD。 - ESSD,表示急速云盘 Name string `json:"name"` // 其中key是可用区编号,value是规格所在az的状态,包含以下状态: - normal,在售。 - unsupported,暂不支持该规格。 - sellout,售罄。 AzStatus map[string]string `json:"az_status"` // 性能规格,包含以下状态: - normal:通用增强型。 - normal2:通用增强Ⅱ型。 - armFlavors:鲲鹏通用计算增强型。 - armFlavors2Shared:鲲鹏通用计算增强II型(共享型)。 SupportComputeGroupType *[]string `json:"support_compute_group_type,omitempty"` }
实例磁盘类型信息。
type UpdateInstanceConfigurationRequest ¶
type UpdateInstanceConfigurationRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID。 InstanceId string `json:"instance_id"` Body *OpenGaussModifyInstanceConfigurationRequest `json:"body,omitempty"` }
Request Object
func (UpdateInstanceConfigurationRequest) String ¶
func (o UpdateInstanceConfigurationRequest) String() string
type UpdateInstanceConfigurationResponse ¶
type UpdateInstanceConfigurationResponse struct { // 实例是否需要重启。 - “true”需要重启。 - “false”不需要重启。 RestartRequired *bool `json:"restart_required,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (UpdateInstanceConfigurationResponse) String ¶
func (o UpdateInstanceConfigurationResponse) String() string
type UpdateInstanceNameRequest ¶
type UpdateInstanceNameRequest struct { // 语言 XLanguage *string `json:"X-Language,omitempty"` // 实例ID,严格匹配UUID规则。 InstanceId string `json:"instance_id"` Body *UpdateNameRequestBody `json:"body,omitempty"` }
Request Object
func (UpdateInstanceNameRequest) String ¶
func (o UpdateInstanceNameRequest) String() string
type UpdateInstanceNameResponse ¶
type UpdateInstanceNameResponse struct { // 修改实例名称的任务ID。 JobId *string `json:"job_id,omitempty"` HttpStatusCode int `json:"-"` }
Response Object
func (UpdateInstanceNameResponse) String ¶
func (o UpdateInstanceNameResponse) String() string
type UpdateNameRequestBody ¶
type UpdateNameRequestBody struct { // 实例名称。用于表示实例的名称,同一租户下,同类型的实例名可重名。 取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。 Name string `json:"name"` }
func (UpdateNameRequestBody) String ¶
func (o UpdateNameRequestBody) String() string
Source Files ¶
- model_backup_policy.go
- model_configuration_parameter.go
- model_configuration_summary.go
- model_create_instance_request.go
- model_create_instance_response.go
- model_data_stroe_error_response.go
- model_delete_instance_request.go
- model_delete_instance_response.go
- model_flavor.go
- model_flavor_error_response.go
- model_list_configurations_request.go
- model_list_configurations_response.go
- model_list_datastore.go
- model_list_datastores_request.go
- model_list_datastores_response.go
- model_list_flavor_info.go
- model_list_flavors_request.go
- model_list_flavors_response.go
- model_list_ha.go
- model_list_instance_response.go
- model_list_instances_request.go
- model_list_instances_response.go
- model_list_storage_types_request.go
- model_list_storage_types_response.go
- model_list_volume.go
- model_open_gauss_backup_strategy.go
- model_open_gauss_backup_strategy_for_list_response.go
- model_open_gauss_backup_strategy_for_response.go
- model_open_gauss_charge_info.go
- model_open_gauss_charge_info_list_response.go
- model_open_gauss_charge_info_response.go
- model_open_gauss_coordinators.go
- model_open_gauss_datastore.go
- model_open_gauss_datastore_response.go
- model_open_gauss_enlarge_volume.go
- model_open_gauss_error_response.go
- model_open_gauss_expand_cluster.go
- model_open_gauss_ha.go
- model_open_gauss_ha_response.go
- model_open_gauss_instance_action_request.go
- model_open_gauss_instance_request.go
- model_open_gauss_instance_response.go
- model_open_gauss_modify_instance_configuration_request.go
- model_open_gauss_shard.go
- model_open_gauss_volume.go
- model_open_gauss_volume_response.go
- model_pwd_reset_request.go
- model_reset_pwd_request.go
- model_reset_pwd_response.go
- model_restart_instance_request.go
- model_restart_instance_response.go
- model_run_instance_action_request.go
- model_run_instance_action_response.go
- model_set_backup_policy_request.go
- model_set_backup_policy_request_body.go
- model_set_backup_policy_response.go
- model_show_instance_configuration_request.go
- model_show_instance_configuration_response.go
- model_storage.go
- model_update_instance_configuration_request.go
- model_update_instance_configuration_response.go
- model_update_instance_name_request.go
- model_update_instance_name_response.go
- model_update_name_request_body.go