instance

Documentation

Index

• type BatchOpsResult
  • func RestartOrFlushInstances(client *golangsdk.ServiceClient, opts ChangeInstanceStatusOpts) ([]BatchOpsResult, error)
• type ChangeInstanceStatusOpts
• type InstanceStatistic
  • func ListDCSStatistics(client *golangsdk.ServiceClient) ([]InstanceStatistic, error)
• type ListNumberOfInstancesInDifferentStatusResponse
  • func ListDCSStatus(client *golangsdk.ServiceClient, opts StatusOpts) (*ListNumberOfInstancesInDifferentStatusResponse, error)
• type StatusOpts
• type UpdatePasswordOpts
• type UpdatePasswordResponse
  • func UpdatePassword(client *golangsdk.ServiceClient, instanceID string, opts UpdatePasswordOpts) (*UpdatePasswordResponse, error)

Types

type BatchOpsResult

type BatchOpsResult struct {
	// Instance modification result. Options: success or failed
	Result string `json:"result,omitempty"`
	// DCS instance ID.
	Instance string `json:"instance,omitempty"`
}

func RestartOrFlushInstances

func RestartOrFlushInstances(client *golangsdk.ServiceClient, opts ChangeInstanceStatusOpts) ([]BatchOpsResult, error)

type ChangeInstanceStatusOpts

type ChangeInstanceStatusOpts struct {
	// List of DCS instance IDs.
	Instances []string `json:"instances,omitempty"`
	// Action performed on DCS instances. Options: restart, and flush.
	// NOTE
	// Only DCS Redis 4.0 and 5.0 instances can be flushed.
	Action string `json:"action,omitempty"`
}

type InstanceStatistic

type InstanceStatistic struct {
	// Incoming traffic (kbit/s) of the DCS instance
	InputKbps string `json:"input_kbps"`
	// Outgoing traffic (kbit/s) of the DCS instance
	OutputKbps string `json:"output_kbps"`
	// DCS instance ID
	InstanceId string `json:"instance_id"`
	// Number of cached data records
	Keys int64 `json:"keys"`
	// Size of the used memory in MB
	UsedMemory int64 `json:"used_memory"`
	// Overall memory size in MB
	MaxMemory int64 `json:"max_memory"`
	// Number of times the GET command is run
	CmdGetCount int64 `json:"cmd_get_count"`
	// Number of times the SET command is run
	CmdSetCount int64 `json:"cmd_set_count"`
	// Percentage of CPU usage
	UsedCpu string `json:"used_cpu"`
}

func ListDCSStatistics

func ListDCSStatistics(client *golangsdk.ServiceClient) ([]InstanceStatistic, error)

type ListNumberOfInstancesInDifferentStatusResponse

type ListNumberOfInstancesInDifferentStatusResponse struct {
	// Number of instances for which payment is in progress.
	PayingCount int32 `json:"paying_count"`
	// Number of instances for which payment is in progress.
	MigratingCount int32 `json:"migrating_count"`
	// Number of instances whose data is being cleared.
	FlushingCount int32 `json:"flushing_count"`
	// Number of instances that are being upgraded.
	UpgradingCount int32 `json:"upgrading_count"`
	// Number of instances for which data restoration is in progress.
	RestoringCount int32 `json:"restoring_count"`
	// Number of instances that are being scaled up.
	ExtendingCount int32 `json:"extending_count"`
	// Number of instances that are being created.
	CreatingCount int32 `json:"creating_count"`
	// Number of running instances.
	RunningCount int32 `json:"running_count"`
	// Number of abnormal instances.
	ErrorCount int32 `json:"error_count"`
	// Number of instances that fail to be created.
	CreatefailedCount int32 `json:"createfailed_count"`
	// Number of instances that are being restarted.
	RestartingCount int32 `json:"restarting_count"`
	// Number of instances that are being deleted.
	DeletingCount int32 `json:"deleting_count"`
	// Number of instances that have been stopped.
	ClosedCount int32 `json:"closed_count"`
	// Number of instances that are being started.
	StartingCount int32 `json:"starting_count"`
	// Number of instances that are being stopped.
	ClosingCount int32 `json:"closing_count"`
}

func ListDCSStatus

func ListDCSStatus(client *golangsdk.ServiceClient, opts StatusOpts) (*ListNumberOfInstancesInDifferentStatusResponse, error)

type StatusOpts

type StatusOpts struct {
	// An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options:
	// true: The number of DCS instances that failed to be created will be returned to the API caller.
	// false or others: The number of DCS instances that failed to be created will not be returned to the API caller.
	IncludeFailure *bool `q:"includeFailure"`
}

type UpdatePasswordOpts

type UpdatePasswordOpts struct {
	OldPassword string `json:"old_password"`
	// New password.
	// Password complexity requirements:
	// Cannot be empty.
	// Cannot be the username or the username spelled backwards.
	// Can be 8 to 32 characters long.
	// Contain at least three of the following character types:
	// Lowercase letters
	// Uppercase letters
	// Digits
	// Special characters (`~!@#$^&*()-_=+\|{}:,<.>/?)
	NewPassword string `json:"new_password"`
}

type UpdatePasswordResponse

type UpdatePasswordResponse struct {
	// Account lockout duration. If the old password is incorrect or the account is locked, the value of this parameter is not null.
	LockTime string `json:"lock_time,omitempty"`
	// An indicator of whether the password is successfully changed: Options:
	// Success: Password changed successfully.
	// passwordFailed: The old password is incorrect.
	// Locked: This account has been locked.
	// Failed: Failed to change the password.
	Result string `json:"result,omitempty"`
	// Remaining time before the account is unlocked. If the account is locked, the value of this parameter is not null.
	LockTimeLeft string `json:"lock_time_left,omitempty"`
	// Number of remaining password attempts. If the old password is incorrect, the value of this parameter is not null.
	RetryTimesLeft string `json:"retry_times_left,omitempty"`
	// Result of password change.
	Message string `json:"message,omitempty"`
}

func UpdatePassword

func UpdatePassword(client *golangsdk.ServiceClient, instanceID string, opts UpdatePasswordOpts) (*UpdatePasswordResponse, error)