scs

package
v0.9.181 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 23, 2024 License: Apache-2.0 Imports: 8 Imported by: 5

Documentation

Overview

Package scs defines the SCS services of BCE. The supported APIs are all defined in sub-package

scs.go - the SCS for Redis APIs definition supported by the redis service

util.go - define the utilities for api package of SCS service

Index

Constants

View Source 
const (
	KEY_MARKER                = "marker"
	KEY_MAX_KEYS              = "maxKeys"
	INSTANCE_URL_V1           = bce.URI_PREFIX + "v1" + "/instance"
	INSTANCE_URL_V2           = bce.URI_PREFIX + "v2" + "/instance"
	URI_PREFIX_V2             = bce.URI_PREFIX + "v2"
	URI_PREFIX_V1             = bce.URI_PREFIX + "v1"
	REQUEST_SECURITYGROUP_URL = "/security"
	REQUEST_RECYCLER_URL      = "/recycler"
)
View Source 
const (
	DEFAULT_ENDPOINT = "redis." + bce.DEFAULT_REGION + ".baidubce.com"
)

Variables

This section is empty.

Functions

func Aes128EncryptUseSecreteKey added in v0.9.27 

func Aes128EncryptUseSecreteKey(sk string, data string) (string, error)

func Json added in v0.9.55 

func Json(v interface{}) string

Types

type AddParamsArgs added in v0.9.157 

type AddParamsArgs struct {
	Parameters []ParameterItem `json:"parameters"`
}

type ApplyRecord added in v0.9.157 

type ApplyRecord struct {
	CacheClusterShowId string `json:"cacheClusterShowId"`
	CacheClusterName   string `json:"cacheClusterName"`
	AvailabilityZone   string `json:"availabilityZone"`
	Version            int    `json:"version"`
	Status             string `json:"status"`
	Engine             string `json:"engine"`
	EngineVersion      string `json:"engineVersion"`
	ClusterType        string `json:"clusterType"`
	CreateTime         string `json:"createTime"`
	ApplyTime          string `json:"applyTime"`
}

type ApplyTemplateArgs added in v0.9.157 

type ApplyTemplateArgs struct {
	RebootType             int                  `json:"rebootType"`
	Extra                  string               `json:"extra"`
	CacheClusterShowIdItem []CacheClusterShowId `json:"cacheClusterShowId"`
	Parameters             []ParameterItem      `json:"parameters"`
}

type BackupInfo added in v0.9.31 

type BackupInfo struct {
	BackupType string         `json:"backupType"`
	Comment    string         `json:"comment"`
	StartTime  string         `json:"startTime"`
	Records    []BackupRecord `json:"records"`
}

type BackupRecord added in v0.9.31 

type BackupRecord struct {
	BackupRecordId string `json:"backupRecordId"`
	BackupStatus   string `json:"backupStatus"`
	Duration       string `json:"duration"`
	ObjectSize     string `json:"objectSize"`
	ShardName      string `json:"shardName"`
	StartTime      string `json:"startTime"`
}

type BatchInstanceIds added in v0.9.59 

type BatchInstanceIds struct {
	InstanceIds []string `json:"cacheClusterShowIds,omitempty"`
}

type BcmInstanceGroupRequest added in v0.9.172 

type BcmInstanceGroupRequest struct {
	GroupIds          string `json:"groupIds"`
	GroupResourceType string `json:"groupResourceType"`
}

type Billing 

type Billing struct {
	PaymentTiming string       `json:"paymentTiming"`
	Reservation   *Reservation `json:"reservation,omitempty"`
}

type BindingTagArgs added in v0.9.27 

type BindingTagArgs struct {
	ChangeTags []model.TagModel `json:"changeTags"`
}

type CacheClusterShowId added in v0.9.157 

type CacheClusterShowId struct {
	CacheClusterShowId string `json:"cacheClusterShowId"`
	Region             string `json:"region"`
}

type Client 

type Client struct {
	*bce.BceClient
}

Client of SCS service is a kind of BceClient, so derived from BceClient

func NewClient 

func NewClient(ak, sk, endPoint string) (*Client, error)

func (*Client) AddReplication added in v0.9.114 

func (c *Client) AddReplication(instanceId string, args *ReplicationArgs) error

AddReplication - add replications

PARAMS:

  • instanceId: id of the instance to be resized
  • args: replicationInfo

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) AddSecurityIp added in v0.9.27 

func (c *Client) AddSecurityIp(instanceId string, args *SecurityIpArgs) error

AddSecurityIp - add securityIp to access a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to add securityIp

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) ApplyParamsTemplate added in v0.9.157 

func (c *Client) ApplyParamsTemplate(templateId string, args *ApplyTemplateArgs) error

ApplyParamsTemplate - apply params template

PARAMS:

  • templateId: the template id
  • args : the args to apply params template

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) BindSecurityGroups added in v0.9.55 

func (c *Client) BindSecurityGroups(args *SecurityGroupArgs) error

BindSecurityGroups - bind SecurityGroup to instances

PARAMS:

  • args: http request body

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) BindingTag added in v0.9.27 

func (c *Client) BindingTag(instanceId string, args *BindingTagArgs) error

BindingTags - bind tags to a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to bind tags to instance

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) CreateGroup added in v0.9.157 

func (c *Client) CreateGroup(args *CreateGroupArgs) (*CreateGroupResult, error)

CreateGroup - create group

PARAMS:

  • args: the argumetns to create group

RETURNS:

  • error: nil if success otherwise the specific error
  • *CreateGroupResult: the result of create group

func (*Client) CreateInstance 

func (c *Client) CreateInstance(args *CreateInstanceArgs) (*CreateInstanceResult, error)

CreateInstance - create an instance with specified parameters

PARAMS:

  • cli: the client agent which can perform sending request
  • reqBody: the request body to create instance

RETURNS:

  • *CreateInstanceResult: result of the instance ids newly created
  • error: nil if success otherwise the specific error

func (*Client) CreateParamsTemplate added in v0.9.157 

func (c *Client) CreateParamsTemplate(args *CreateTemplateArgs) (*CreateParamsTemplateResult, error)

CreateParamsTemplate - create params template

PARAMS:

  • args: the arguments to create params template

RETURNS:

  • error: nil if success otherwise the specific error
  • *CreateParamsTemplateResult: the result of create params template

func (*Client) DeleteGroup added in v0.9.157 

func (c *Client) DeleteGroup(groupId string) error

DeleteGroup - delete group

PARAMS:

  • groupId: the group id

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) DeleteInstance 

func (c *Client) DeleteInstance(instanceId string, clientToken string) error

DeleteInstance - delete a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance to be deleted

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) DeleteParamsTemplate added in v0.9.157 

func (c *Client) DeleteParamsTemplate(templateId string) error

DeleteParamsTemplate - delete params template

PARAMS:

  • templateId: the template id

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) DeleteRecyclerInstances added in v0.9.59 

func (c *Client) DeleteRecyclerInstances(instanceIds []string) error

DeleteRecyclerInstances - batch delete instances that in recycler

PARAMS:

  • instanceIds: instanceId list to delete

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) DeleteReplication added in v0.9.114 

func (c *Client) DeleteReplication(instanceId string, args *ReplicationArgs) error

DeleteReplication - delete replications

PARAMS:

  • instanceId: id of the instance to be resized
  • args: replicationInfo

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) DeleteSecurityIp added in v0.9.27 

func (c *Client) DeleteSecurityIp(instanceId string, args *SecurityIpArgs) error

DeleteSecurityIp - delete securityIp to access a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to delete securityIp

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) FlushInstance added in v0.9.27 

func (c *Client) FlushInstance(instanceId string, args *FlushInstanceArgs) error

FlushInstance - flush a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to flush instance

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GetApplyRecords added in v0.9.157 

func (c *Client) GetApplyRecords(templateId string, marker *Marker) (*GetApplyRecordsResult, error)

GetApplyRecords - get template apply records

PARAMS:

  • args : the args to get template apply records

RETURNS:

  • error: nil if success otherwise the specific error
  • *GetApplyRecordsResult: the result of get template apply records

func (*Client) GetBackupDetail added in v0.9.157 

func (c *Client) GetBackupDetail(instanceId, backupRecordId string) (*GetBackupDetailResult, error)

GetBackupDetail - get backup detail of the instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • backupRecordId: the backup record id

RETURNS:

  • *GetBackupDetailResult: result of the backup detail
  • error: nil if success otherwise the specific error

func (*Client) GetBackupList added in v0.9.27 

func (c *Client) GetBackupList(instanceId string) (*GetBackupListResult, error)

GetBackupList - get backup list of the instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance

RETURNS:

  • *GetBackupListResult: result of the backup list
  • error: nil if success otherwise the specific error

func (*Client) GetCreatePrice added in v0.9.157 

func (c *Client) GetCreatePrice(args *CreatePriceArgs) (*CreatePriceResult, error)

GetCreatePrice - get create price

PARAMS:

  • cli: the client agent which can perform sending request
  • reqBody: the request body to get price

RETURNS:

  • error: nil if success otherwise the specific error
  • *GetCreatePriceResult: result of the create price

func (*Client) GetGroupDetail added in v0.9.157 

func (c *Client) GetGroupDetail(groupId string) (*GroupDetailResult, error)

GetGroupDetail - get group detail

PARAMS:

  • groupId: the group id

RETURNS:

  • error: nil if success otherwise the specific error
  • *GroupDetailResult: the result of group detail

func (*Client) GetGroupList added in v0.9.157 

func (c *Client) GetGroupList(args *GetGroupListArgs) (*GroupListResult, error)

GetGroupList - get group list

PARAMS:

RETURNS:

  • error: nil if success otherwise the specific error
  • *GroupListResult: the result of group list

func (*Client) GetInstanceDetail 

func (c *Client) GetInstanceDetail(instanceId string) (*GetInstanceDetailResult, error)

GetInstanceDetail - get details of the specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance

RETURNS:

  • *GetInstanceDetailResult: result of the instance details
  • error: nil if success otherwise the specific error

func (*Client) GetLogById added in v0.9.59 

func (c *Client) GetLogById(instanceId, logId string, args *GetLogArgs) (*LogItem, error)

GetLogById - get log's detail of instance

PARAMS:

  • instanceId: id of instance

RETURNS:

  • *Log:log's detail of instance
  • error: nil if success otherwise the specific error

func (*Client) GetMaintainTime added in v0.9.63 

func (c *Client) GetMaintainTime(instanceId string) (*GetMaintainTimeResult, error)

GetMaintainTime - get maintainTime of instance

PARAMS:

  • instanceId: id of instance

RETURNS:

  • *GetMaintainTimeResult:maintainTime of instance
  • error: nil if success otherwise the specific error

func (*Client) GetNodeTypeList 

func (c *Client) GetNodeTypeList() (*GetNodeTypeListResult, error)

GetNodeTypeList - list all nodetype

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance to be deleted
  • args: the arguments to Update instanceName

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GetParameters added in v0.9.27 

func (c *Client) GetParameters(instanceId string) (*GetParametersResult, error)

GetParameters - query the configuration parameters and running parameters of redis instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance

RETURNS:

  • *GetParameterResult: result of the parameters
  • error: nil if success otherwise the specific error

func (*Client) GetParamsTemplateDetail added in v0.9.157 

func (c *Client) GetParamsTemplateDetail(templateId string) (*ResultItem, error)

GetParamsTemplateDetail - get params template detail

PARAMS:

  • templateId: the template id

RETURNS:

  • error: nil if success otherwise the specific error
  • *ParamsTemplateDetailResult: the result of get params template detail

func (*Client) GetParamsTemplateList added in v0.9.157 

func (c *Client) GetParamsTemplateList(marker *Marker) (*ParamsTemplateListResult, error)

GetParamsTemplateList - get params template list

PARAMS:

  • marker: pagination marker
  • maxkeys : max keys

RETURNS:

  • error: nil if success otherwise the specific error
  • *ParamsTemplateListResult: the result of get params template list

func (*Client) GetResizePrice added in v0.9.157 

func (c *Client) GetResizePrice(instanceId string, args *ResizePriceArgs) (*ResizePriceResult, error)

GetResizePrice - get resize price

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance to be resized
  • reqBody: the request body to get resize price

RETURNS:

  • error: nil if success otherwise the specific error
  • *GetResizePriceResult: result of the resize price

func (*Client) GetSecurityIp added in v0.9.27 

func (c *Client) GetSecurityIp(instanceId string) (*GetSecurityIpResult, error)

GetSecurityIp - list all securityIps

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance

RETURNS:

  • *ListSecurityIp: result of the security IP list
  • error: nil if success otherwise the specific error

func (*Client) GetSystemTemplate added in v0.9.157 

func (c *Client) GetSystemTemplate(args *GetSystemTemplateArgs) (*SystemTemplateResult, error)

GetSystemTemplate - get system template

PARAMS:

  • args : the args to get system params template

RETURNS:

  • error: nil if success otherwise the specific error
  • *SystemTemptaleResult: the result of get system template

func (*Client) GetZoneList added in v0.9.27 

func (c *Client) GetZoneList() (*GetZoneListResult, error)

GetZoneList - list all zone

PARAMS:

  • cli: the client agent which can perform sending request

RETURNS:

  • *GetZoneListResult: result of the zone list
  • error: nil if success otherwise the specific error

func (*Client) GroupAddFollower added in v0.9.157 

func (c *Client) GroupAddFollower(groupId string, args *FollowerInfo) error

GroupAddFollower - add follower to a group

PARAMS:

  • groupId: the group id
  • args: the arguments to add follower

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GroupForbidWrite added in v0.9.157 

func (c *Client) GroupForbidWrite(groupId string, args *ForbidWriteArgs) error

GroupForbidWrite - forbid write permission

PARAMS:

  • groupId: the group id

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GroupPreCheck added in v0.9.157 

func (c *Client) GroupPreCheck(args *GroupPreCheckArgs) (*GroupPreCheckResult, error)

GroupPreCheck - group preCheck

PARAMS:

  • args: the argumetns to group preCheck

RETURNS:

  • error: nil if success otherwise the specific error
  • *GroupPreCheckResult: the result of group preCheck

func (*Client) GroupRemoveFollower added in v0.9.157 

func (c *Client) GroupRemoveFollower(groupId, instanceId string) error

GroupRemoveFollower - remove follower to a group

PARAMS:

  • groupId: the group id
  • instanceId: the instance id which to remove

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GroupSetQps added in v0.9.157 

func (c *Client) GroupSetQps(groupId string, args *GroupSetQpsArgs) error

GroupSetQps - set group qps PARAMS:

  • groupId: the group id
  • args: the arguments to set group qps

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GroupStaleReadable added in v0.9.157 

func (c *Client) GroupStaleReadable(groupId string, args *StaleReadableArgs) error

GroupStaleReadable - set group follower stale readable

PARAMS:

  • groupId: the group id
  • args: the arguments to set group follower stale readable

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GroupSyncStatus added in v0.9.157 

func (c *Client) GroupSyncStatus(groupId string) (*GroupSyncStatusResult, error)

GroupSyncStatus - get group sync status

PARAMS:

  • groupId: the group id

RETURNS:

  • error: nil if success otherwise the specific error
  • *GroupSyncStatusResult: the result of group sync status

func (*Client) GroupWhiteList added in v0.9.157 

func (c *Client) GroupWhiteList(groupId string) (*GroupWhiteList, error)

GroupWhiteList - get group white list

PARAMS:

  • groupId: the group id

RETURNS:

  • error: nil if success otherwise the specific error
  • *GroupWhiteListResult: the result of group sync status

func (*Client) GroupWhiteListAdd added in v0.9.157 

func (c *Client) GroupWhiteListAdd(groupId string, args *GroupWhiteList) error

GroupWhiteListAdd - add group white list

PARAMS:

  • groupId: the group id
  • args: the arguments to add group white list

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) GroupWhiteListDelete added in v0.9.157 

func (c *Client) GroupWhiteListDelete(groupId string, args *GroupWhiteList) error

GroupWhiteListDelete - delete group white list

PARAMS:

  • groupId: the group id
  • args: the arguments to delete group white list

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) ListInstances 

func (c *Client) ListInstances(args *ListInstancesArgs) (*ListInstancesResult, error)

ListInstances - list all instances with the specified parameters

PARAMS:

  • cli: the client agent which can perform sending request
  • args: the arguments to list instances

RETURNS:

  • *ListInstanceResult: result of the instance list
  • error: nil if success otherwise the specific error

func (*Client) ListLogByInstanceId added in v0.9.59 

func (c *Client) ListLogByInstanceId(instanceId string, args *ListLogArgs) (*ListLogResult, error)

ListLogByInstanceId - list error or slow logs of instance

PARAMS:

  • instanceId: id of instance

RETURNS:

  • *[]Log:logs of instance
  • error: nil if success otherwise the specific error

func (*Client) ListRecycleInstances added in v0.9.59 

func (c *Client) ListRecycleInstances(marker *Marker) (*RecyclerInstanceList, error)

ListRecycleInstances - list all instances in recycler with marker

PARAMS:

  • marker: marker page

RETURNS:

  • *RecyclerInstanceList: the result of instances in recycler
  • error: nil if success otherwise the specific error

func (*Client) ListSecurityGroupByInstanceId added in v0.9.55 

func (c *Client) ListSecurityGroupByInstanceId(instanceId string) (*ListSecurityGroupResult, error)

ListSecurityGroupByInstanceId - list security groups by instance id

PARAMS:

  • instanceId: id of instance

RETURNS:

  • *ListSecurityGroupResult: list secrity groups result of instance
  • error: nil if success otherwise the specific error

func (*Client) ListSecurityGroupByVpcId added in v0.9.55 

func (c *Client) ListSecurityGroupByVpcId(vpcId string) (*ListVpcSecurityGroupsResult, error)

ListSecurityGroupByVpcId - list security groups by vpc id

PARAMS:

  • vpcId: id of vpc

RETURNS:

  • *[]SecurityGroup:security groups of vpc
  • error: nil if success otherwise the specific error

func (*Client) ListSubnets added in v0.9.27 

func (c *Client) ListSubnets(args *ListSubnetsArgs) (*ListSubnetsResult, error)

ListsSubnet - list all Subnets

PARAMS:

  • cli: the client agent which can perform sending request
  • args: the arguments to list all subnets, not necessary

RETURNS:

  • *ListSubnetsResult: result of the subnet list
  • error: nil if success otherwise the specific error

func (*Client) ModifyBackupPolicy added in v0.9.27 

func (c *Client) ModifyBackupPolicy(instanceId string, args *ModifyBackupPolicyArgs) error

ModifyBackupPolicy - modify the BackupPolicy of a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to Modify BackupPolicy

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) ModifyMaintainTime added in v0.9.63 

func (c *Client) ModifyMaintainTime(instanceId string, args *MaintainTime) error

ModifyMaintainTime - modify MaintainTime of instance

PARAMS:

  • args: new maintainTime

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) ModifyParameters added in v0.9.27 

func (c *Client) ModifyParameters(instanceId string, args *ModifyParametersArgs) error

ModifyParameters - modify the parameters of a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to modify parameters

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) ModifyPassword added in v0.9.27 

func (c *Client) ModifyPassword(instanceId string, args *ModifyPasswordArgs) error

ModifyPassword - modify the password of a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to Modify Password

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) RecoverRecyclerInstances added in v0.9.59 

func (c *Client) RecoverRecyclerInstances(instanceIds []string) error

RecoverRecyclerInstances - batch recover instances that in recycler

PARAMS:

  • instanceIds: instanceId list to recover

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) RenameDomain added in v0.9.157 

func (c *Client) RenameDomain(instanceId string, args *RenameDomainArgs) error

RenameDomain - rename domain

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to rename domain

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) RenameParamsTemplate added in v0.9.157 

func (c *Client) RenameParamsTemplate(templateId string, args *RenameTemplateArgs) error

RenameParamsTemplate - rename params template

PARAMS:

  • templateId: the template id
  • args : new template name args

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) RenewInstances added in v0.9.59 

func (c *Client) RenewInstances(args *RenewInstanceArgs) (*OrderIdResult, error)

RenewInstances - batch renew instances

PARAMS:

  • args: renew instanceIds and duration

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) ReplaceSecurityGroups added in v0.9.55 

func (c *Client) ReplaceSecurityGroups(args *SecurityGroupArgs) error

ReplaceSecurityGroups - replace SecurityGroup to instances

PARAMS:

  • args: http request body

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) ResizeInstance 

func (c *Client) ResizeInstance(instanceId string, args *ResizeInstanceArgs) error

ResizeInstance - resize a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance to be resized
  • reqBody: the request body to resize instance

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) RestartInstance added in v0.9.63 

func (c *Client) RestartInstance(instanceId string, args *RestartInstanceArgs) error

RestartInstance - restart a specified instance

PARAMS:

  • instanceId: id of the instance to be resized
  • args: specify restart immediately or postpone restart to time window

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) SetAsLeader added in v0.9.157 

func (c *Client) SetAsLeader(groupId, instanceId string) error

SetAsLeader - set instance as leader

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) SetAsMaster added in v0.9.157 

func (c *Client) SetAsMaster(instanceId string) error

SetAsMaster - set instance as master

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) SetAsSlave added in v0.9.157 

func (c *Client) SetAsSlave(instanceId string, args *SetAsSlaveArgs) error

SetAsSlave - set instance as master

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to set instance as slave

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) SwapDomain added in v0.9.157 

func (c *Client) SwapDomain(instanceId string, args *SwapDomainArgs) error

SwapDomain - swap domain

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to swap domain

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) TemplateAddParams added in v0.9.157 

func (c *Client) TemplateAddParams(templateId string, args *AddParamsArgs) error

TemplateAddParams - add params to template

PARAMS:

  • templateId: the template id
  • args : the args to add params template

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) TemplateDeleteParams added in v0.9.157 

func (c *Client) TemplateDeleteParams(templateId string, args *DeleteParamsArgs) error

TemplateDeleteParams - delete params to template

PARAMS:

  • templateId: the template id
  • args : the args to delete params template

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) TemplateModifyParams added in v0.9.157 

func (c *Client) TemplateModifyParams(templateId string, args *ModifyParamsArgs) error

TemplateModifyParams - modify params to template

PARAMS:

  • templateId: the template id
  • args : the args to modify params template

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) UnBindSecurityGroups added in v0.9.55 

func (c *Client) UnBindSecurityGroups(args *UnbindSecurityGroupArgs) error

UnBindSecurityGroups - unbind SecurityGroup to instances

PARAMS:

  • args: http request body

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) UnBindingTag added in v0.9.27 

func (c *Client) UnBindingTag(instanceId string, args *BindingTagArgs) error

UnBindingTags - unbind tags to a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to unbind tags to instance

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) UpdateGroupName added in v0.9.157 

func (c *Client) UpdateGroupName(groupId string, args *GroupNameArgs) error

UpdateGroupName - update group name

PARAMS:

  • groupId: the group id
  • args: the arguments to update group name

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) UpdateInstanceDomainName added in v0.9.27 

func (c *Client) UpdateInstanceDomainName(instanceId string, args *UpdateInstanceDomainNameArgs) error

UpdateInstanceDomainName - update name of a specified instance domain

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance
  • args: the arguments to update domainName

RETURNS:

  • error: nil if success otherwise the specific error

func (*Client) UpdateInstanceName 

func (c *Client) UpdateInstanceName(instanceId string, args *UpdateInstanceNameArgs) error

UpdateInstanceName - update name of a specified instance

PARAMS:

  • cli: the client agent which can perform sending request
  • instanceId: id of the instance to be deleted
  • args: the arguments to Update instanceName

RETURNS:

  • error: nil if success otherwise the specific error

type CreateGroupArgs added in v0.9.157 

type CreateGroupArgs struct {
	Leader CreateGroupLeader `json:"leader"`
}

type CreateGroupLeader added in v0.9.157 

type CreateGroupLeader struct {
	GroupName    string `json:"groupName"`
	LeaderRegion string `json:"leaderRegion"`
	LeaderId     string `json:"leaderId"`
}

type CreateGroupResult added in v0.9.157 

type CreateGroupResult struct {
	GroupId string `json:"groupId"`
}

type CreateInstanceArgs 

type CreateInstanceArgs struct {
	Billing           Billing                   `json:"billing"`
	PurchaseCount     int                       `json:"purchaseCount"`
	InstanceName      string                    `json:"instanceName"`
	NodeType          string                    `json:"nodeType"`
	ShardNum          int                       `json:"shardNum"`
	ProxyNum          int                       `json:"proxyNum"`
	ClusterType       string                    `json:"clusterType"`
	ReplicationNum    int                       `json:"replicationNum"`
	ReplicationInfo   []Replication             `json:"replicationInfo"`
	Port              int                       `json:"port"`
	Engine            int                       `json:"engine,omitempty"`
	EngineVersion     string                    `json:"engineVersion"`
	DiskFlavor        int                       `json:"diskFlavor,omitempty"`
	DiskType          string                    `json:"diskType,omitempty"`
	VpcID             string                    `json:"vpcId"`
	Subnets           []Subnet                  `json:"subnets,omitempty"`
	AutoRenewTimeUnit string                    `json:"autoRenewTimeUnit,omitempty"`
	AutoRenewTime     int                       `json:"autoRenewTime,omitempty"`
	BgwGroupId        string                    `json:"bgwGroupId,omitempty"`
	ClientToken       string                    `json:"-"`
	ClientAuth        string                    `json:"clientAuth"`
	ResourceGroupId   string                    `json:"resourceGroupId"`
	StoreType         int                       `json:"storeType"`
	EnableReadOnly    int                       `json:"enableReadOnly,omitempty"`
	Tags              []model.TagModel          `json:"tags"`
	BcmInstanceGroups []BcmInstanceGroupRequest `json:"bcmInstanceGroups"`
}

type CreateInstanceResult 

type CreateInstanceResult struct {
	InstanceIds []string `json:"instanceIds"`
}

type CreateParamsTemplateResult added in v0.9.157 

type CreateParamsTemplateResult struct {
	TemplateId     int    `json:"templateId"`
	TemplateShowId string `json:"templateShowId"`
}

type CreatePriceArgs added in v0.9.157 

type CreatePriceArgs struct {
	Engine         int    `json:"engine,omitempty"`
	ClusterType    string `json:"clusterType,omitempty"`
	NodeType       string `json:"nodeType,omitempty"`
	ShardNum       int    `json:"shardNum,omitempty"`
	ReplicationNum int    `json:"replicationNum,omitempty"`
	InstanceNum    int    `json:"instanceNum,omitempty"`
	DiskType       int    `json:"diskType,omitempty"`
	DiskFlavor     int    `json:"diskFlavor,omitempty"`
	ChargeType     string `json:"chargeType,omitempty"`
	Period         int    `json:"period,omitempty"`
}

type CreatePriceResult added in v0.9.157 

type CreatePriceResult struct {
	Price float64 `json:"price,omitempty"`
}

type CreateTemplateArgs added in v0.9.157 

type CreateTemplateArgs struct {
	EngineVersion string          `json:"engineVersion"`
	TemplateType  int             `json:"templateType"`
	ClusterType   string          `json:"clusterType"`
	Engine        string          `json:"engine"`
	Name          string          `json:"name"`
	Comment       string          `json:"comment"`
	Parameters    []ParameterItem `json:"parameters"`
}

type DeleteParamsArgs added in v0.9.157 

type DeleteParamsArgs struct {
	Parameters []string `json:"parameters"`
}

type FlushInstanceArgs added in v0.9.27 

type FlushInstanceArgs struct {
	Password    string `json:"password"`
	ClientToken string `json:"-"`
}

type FollowerInfo added in v0.9.157 

type FollowerInfo struct {
	FollowerId     string `json:"followerId"`
	FollowerRegion string `json:"followerRegion"`
	SyncMaster     string `json:"syncMaster"`
}

type FollowerSyncInfo added in v0.9.157 

type FollowerSyncInfo struct {
	ClusterShowId string `json:"clusterShowId"`
	SyncStatus    string `json:"syncStatus"`
	MaxOffset     int    `json:"maxOffset"`
	Lag           int    `json:"lag"`
}

type ForbidWriteArgs added in v0.9.157 

type ForbidWriteArgs struct {
	ForbidWriteFlag bool `json:"forbidWriteFlag"`
}

type GetApplyRecordsResult added in v0.9.157 

type GetApplyRecordsResult struct {
	Marker      string        `json:"marker"`
	MaxKeys     int           `json:"maxKeys"`
	NextMarker  string        `json:"nextMarker"`
	IsTruncated bool          `json:"isTruncated"`
	Result      []ApplyRecord `json:"result"`
}

type GetBackupDetailResult added in v0.9.157 

type GetBackupDetailResult struct {
	Url           string `json:"url"`
	UrlExpiration string `json:"urlExpiration"`
}

type GetBackupListResult added in v0.9.27 

type GetBackupListResult struct {
	TotalCount string       `json:"totalCount"`
	Backups    []BackupInfo `json:"backups"`
}

type GetGroupListArgs added in v0.9.157 

type GetGroupListArgs struct {
	PageNo   int `json:"pageNo"`
	PageSize int `json:"pageSize"`
}

type GetInstanceDetailResult 

type GetInstanceDetailResult struct {
	InstanceID         string           `json:"instanceId"`
	InstanceName       string           `json:"instanceName"`
	InstanceStatus     string           `json:"instanceStatus"`
	ClusterType        string           `json:"clusterType"`
	Engine             string           `json:"engine"`
	EngineVersion      string           `json:"engineVersion"`
	VnetIP             string           `json:"vnetIp"`
	Domain             string           `json:"domain"`
	Port               int              `json:"port"`
	InstanceCreateTime string           `json:"instanceCreateTime"`
	InstanceExpireTime string           `json:"instanceExpireTime"`
	Capacity           float64          `json:"capacity"`
	UsedCapacity       float64          `json:"usedCapacity"`
	PaymentTiming      string           `json:"paymentTiming"`
	VpcID              string           `json:"vpcId"`
	ZoneNames          []string         `json:"zoneNames"`
	Subnets            []Subnet         `json:"subnets"`
	AutoRenew          string           `json:"autoRenew"`
	Tags               []model.TagModel `json:"tags"`
	ShardNum           int              `json:"shardNum"`
	ReplicationNum     int              `json:"replicationNum"`
	NodeType           string           `json:"nodeType"`
	DiskFlavor         int              `json:"diskFlavor"`
	DiskType           string           `json:"diskType"`
	StoreType          int              `json:"storeType"`
	Eip                string           `json:"eip"`
	PublicDomain       string           `json:"publicDomain"`
	EnableReadOnly     int              `json:"enableReadOnly"`
	ReplicationInfo    []Replication    `json:"replicationInfo"`
	BnsGroup           string           `json:"bnsGroup"`
	ResourceGroupId    string           `json:"resourceGroupId"`
	ResourceGroupName  string           `json:"resourceGroupName"`
}

type GetLogArgs added in v0.9.59 

type GetLogArgs struct {
	ValidSeconds int `json:"validSeconds"`
}

type GetMaintainTimeResult added in v0.9.63 

type GetMaintainTimeResult struct {
	CacheClusterShowId string       `json:"cacheClusterShowId"`
	MaintainTime       MaintainTime `json:"maintainTime"`
}

type GetNodeTypeListResult 

type GetNodeTypeListResult struct {
	ClusterNodeTypeList []NodeType `json:"clusterNodeTypeList"`
	DefaultNodeTypeList []NodeType `json:"defaultNodeTypeList"`
	HsdbNodeTypeList    []NodeType `json:"hsdbNodeTypeList"`
}

type GetParametersResult added in v0.9.27 

type GetParametersResult struct {
	Parameters []Parameter `json:"parameters"`
}

type GetPriceRequest added in v0.9.59 

type GetPriceRequest struct {
	Engine         string `json:"engine,omitempty"`
	ShardNum       int    `json:"shardNum,omitempty"`
	Period         int    `json:"period,omitempty"`
	ChargeType     string `json:"chargeType,omitempty"`
	NodeType       string `json:"nodeType,omitempty"`
	ReplicationNum int    `json:"replicationNum,omitempty"`
	ClusterType    string `json:"clusterType,omitempty"`
}

type GetPriceResult added in v0.9.59 

type GetPriceResult struct {
	Price float64 `json:"price,omitempty"`
}

type GetSecurityIpResult added in v0.9.27 

type GetSecurityIpResult struct {
	SecurityIps []string `json:"securityIps"`
}

type GetSystemTemplateArgs added in v0.9.157 

type GetSystemTemplateArgs struct {
	Engine        string `json:"engine"`
	EngineVersion string `json:"engineVersion"`
	ClusterType   string `json:"clusterType"`
}

type GetZoneListResult added in v0.9.27 

type GetZoneListResult struct {
	Zones []ZoneNames `json:"zones"`
}

type GroupConnectionResult added in v0.9.157 

type GroupConnectionResult struct {
	SourceId    string `json:"sourceId"`
	SourceRole  string `json:"sourceRole"`
	TargetId    string `json:"targetId"`
	TargetRole  string `json:"targetRole"`
	Connectable bool   `json:"connectable"`
}

type GroupDetailResult added in v0.9.157 

type GroupDetailResult struct {
	GroupId         string              `json:"groupId"`
	GroupName       string              `json:"groupName"`
	GroupStatus     string              `json:"groupStatus"`
	ClusterNum      int                 `json:"clusterNum"`
	GroupCreateTime string              `json:"groupCreateTime"`
	ForbidWrite     int                 `json:"forbidWrite"`
	GroupType       string              `json:"groupType"`
	Leader          GroupLeaderInfo     `json:"leader"`
	Followers       []GroupFollowerInfo `json:"followers"`
}

type GroupFollower added in v0.9.157 

type GroupFollower struct {
	FollowerId     string `json:"followerId"`
	FollowerRegion string `json:"followerRegion"`
}

type GroupFollowerInfo added in v0.9.157 

type GroupFollowerInfo struct {
	ClusterName       string  `json:"clusterName"`
	ClusterShowId     string  `json:"clusterShowId"`
	Region            string  `json:"region"`
	Status            string  `json:"status"`
	TotalCapacityInGB float64 `json:"totalCapacityInGB"`
	UsedCapacityInGB  int     `json:"usedCapacityInGB"`
	ShardNum          int     `json:"shardNum"`
	Flavor            float64 `json:"flavor"`
	QpsWrite          int64   `json:"qpsWrite"`
	QpsRead           int64   `json:"qpsRead"`
	StableReadable    bool    `json:"stableReadable"`
	ForbidWrite       int     `json:"forbidWrite"`
	AvailabilityZone  string  `json:"availabilityZone"`
	ExpiredTime       string  `json:"expiredTime"`
}

type GroupFollowerResult added in v0.9.157 

type GroupFollowerResult struct {
	FollowerId      string `json:"followerId"`
	NoData          bool   `json:"noData"`
	Version         bool   `json:"version"`
	EngineVersion   bool   `json:"engineVersion"`
	ClusterStatus   bool   `json:"clusterStatus"`
	ShardNum        bool   `json:"shardNum"`
	ReplicationNum  bool   `json:"replicationNum"`
	Flavor          bool   `json:"flavor"`
	Joined          bool   `json:"joined"`
	NoPasswd        bool   `json:"noPasswd"`
	NoSecurityGroup bool   `json:"noSecurityGroup"`
	IsHitX1         bool   `json:"isHitX1"`
}

type GroupLeader added in v0.9.157 

type GroupLeader struct {
	LeaderRegion string `json:"leaderRegion"`
	LeaderId     string `json:"leaderId"`
}

type GroupLeaderInfo added in v0.9.157 

type GroupLeaderInfo struct {
	ClusterName       string  `json:"clusterName"`
	ClusterShowId     string  `json:"clusterShowId"`
	Region            string  `json:"region"`
	Status            string  `json:"status"`
	TotalCapacityInGB float64 `json:"totalCapacityInGB"`
	UsedCapacityInGB  int     `json:"usedCapacityInGB"`
	ShardNum          int     `json:"shardNum"`
	Flavor            float64 `json:"flavor"`
	QpsWrite          int64   `json:"qpsWrite"`
	QpsRead           int64   `json:"qpsRead"`
	StableReadable    bool    `json:"stableReadable"`
	ForbidWrite       int     `json:"forbidWrite"`
	AvailabilityZone  string  `json:"availabilityZone"`
	ExpiredTime       string  `json:"expiredTime"`
}

type GroupLeaderResult added in v0.9.157 

type GroupLeaderResult struct {
	Version         bool `json:"version"`
	ClusterStatus   bool `json:"clusterStatus"`
	ReplicationNum  bool `json:"replicationNum"`
	Flavor          bool `json:"flavor"`
	Joined          bool `json:"joined"`
	NoPasswd        bool `json:"noPasswd"`
	NoSecurityGroup bool `json:"noSecurityGroup"`
	IsHitX1         bool `json:"isHitX1"`
}

type GroupListResult added in v0.9.157 

type GroupListResult struct {
	TotalCount int           `json:"totalCount"`
	PageNo     int           `json:"pageNo"`
	PageSize   int           `json:"pageSize"`
	Result     []GroupResult `json:"result"`
}

type GroupNameArgs added in v0.9.157 

type GroupNameArgs struct {
	GroupName string `json:"groupName"`
}

type GroupPreCheckArgs added in v0.9.157 

type GroupPreCheckArgs struct {
	Leader    GroupLeader     `json:"leader"`
	Followers []GroupFollower `json:"followers"`
}

type GroupPreCheckResult added in v0.9.157 

type GroupPreCheckResult struct {
	LeaderResult      GroupLeaderResult       `json:"leaderResult"`
	FollowerResult    []GroupFollowerResult   `json:"followerResult"`
	ConnectionResults []GroupConnectionResult `json:"connectionResults"`
}

type GroupResult added in v0.9.157 

type GroupResult struct {
	GroupId         string `json:"groupId"`
	GroupName       string `json:"groupName"`
	GroupStatus     string `json:"groupStatus"`
	ClusterNum      int    `json:"clusterNum"`
	GroupCreateTime string `json:"groupCreateTime"`
	ForbidWrite     int    `json:"forbidWrite"`
	GroupType       string `json:"groupType"`
	LeaderName      string `json:"leaderName"`
	LeaderShowId    string `json:"leaderShowId"`
	LeaderRegion    string `json:"leaderRegion"`
}

type GroupSetQpsArgs added in v0.9.157 

type GroupSetQpsArgs struct {
	ClusterShowId string `json:"clusterShowId"`
	QpsWrite      int    `json:"qpsWrite"`
	QpsRead       int    `json:"qpsRead"`
}

type GroupSyncStatusResult added in v0.9.157 

type GroupSyncStatusResult struct {
	Followers []FollowerSyncInfo `json:"followers"`
}

type GroupWhiteList added in v0.9.157 

type GroupWhiteList struct {
	WhiteLists []string `json:"whiteLists"`
}

type InstanceModel 

type InstanceModel struct {
	InstanceID         string           `json:"instanceId"`
	InstanceName       string           `json:"instanceName"`
	InstanceStatus     string           `json:"instanceStatus"`
	InstanceExpireTime string           `json:"instanceExpireTime"`
	ShardNum           int              `json:"shardNum"`
	ReplicationNum     int              `json:"replicationNum"`
	ClusterType        string           `json:"clusterType"`
	Engine             string           `json:"engine"`
	EngineVersion      string           `json:"engineVersion"`
	VnetIP             string           `json:"vnetIp"`
	Domain             string           `json:"domain"`
	Port               int              `json:"port"`
	InstanceCreateTime string           `json:"instanceCreateTime"`
	Capacity           float64          `json:"capacity"`
	UsedCapacity       float64          `json:"usedCapacity"`
	PaymentTiming      string           `json:"paymentTiming"`
	ZoneNames          []string         `json:"zoneNames"`
	Tags               []model.TagModel `json:"tags"`
	ResourceGroupId    string           `json:"resourceGroupId"`
	ResourceGroupName  string           `json:"resourceGroupName"`
}

type InstanceParam added in v0.9.27 

type InstanceParam struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type ListInstancesArgs 

type ListInstancesArgs struct {
	Marker  string
	MaxKeys int
}

type ListInstancesResult 

type ListInstancesResult struct {
	Marker      string          `json:"marker"`
	IsTruncated bool            `json:"isTruncated"`
	NextMarker  string          `json:"nextMarker"`
	MaxKeys     int             `json:"maxKeys"`
	Instances   []InstanceModel `json:"instances"`
}

type ListLogArgs added in v0.9.59 

type ListLogArgs struct {
	FileType  string `json:"fileType"`
	StartTime string `json:"startTime"`
	EndTime   string `json:"endTime"`
}

type ListLogResult added in v0.9.59 

type ListLogResult struct {
	LogList []ShardLog `json:"logList"`
}

type ListResultWithMarker added in v0.9.59 

type ListResultWithMarker struct {
	IsTruncated bool   `json:"isTruncated"`
	Marker      string `json:"marker"`
	MaxKeys     int    `json:"maxKeys"`
	NextMarker  string `json:"nextMarker"`
}

type ListSecurityGroupResult added in v0.9.55 

type ListSecurityGroupResult struct {
	Groups []SecurityGroupDetail `json:"groups"`
}

type ListSubnetsArgs added in v0.9.27 

type ListSubnetsArgs struct {
	VpcID    string `json:"vpcId"`
	ZoneName string `json:"zoneName"`
}

type ListSubnetsResult added in v0.9.27 

type ListSubnetsResult struct {
	SubnetOriginals []SubnetOriginal `json:"subnets"`
}

type ListVpcSecurityGroupsResult added in v0.9.55 

type ListVpcSecurityGroupsResult struct {
	Groups []SecurityGroup `json:"groups"`
}

type LogItem added in v0.9.59 

type LogItem struct {
	LogStartTime    string `json:"logStartTime"`
	LogEndTime      string `json:"logEndTime"`
	DownloadURL     string `json:"downloadUrl"`
	LogID           string `json:"logId"`
	LogSizeInBytes  int    `json:"logSizeInBytes"`
	DownloadExpires string `json:"downloadExpires"`
}

type MaintainTime added in v0.9.63 

type MaintainTime struct {
	StartTime string `json:"startTime"`
	Duration  int    `json:"duration"`
	Period    []int  `json:"period"`
}

type Marker added in v0.9.59 

type Marker struct {
	Marker  string `json:"marker,omitempty"`
	MaxKeys int    `json:"maxKeys,omitempty"`
}

type ModifyBackupPolicyArgs added in v0.9.27 

type ModifyBackupPolicyArgs struct {
	BackupDays  string `json:"backupDays"`
	BackupTime  string `json:"backupTime"`
	ClientToken string `json:"clientToken"`
	ExpireDay   int    `json:"expireDay"`
}

type ModifyParametersArgs added in v0.9.27 

type ModifyParametersArgs struct {
	Parameter   InstanceParam `json:"parameter"`
	ClientToken string        `json:"-"`
}

type ModifyParamsArgs added in v0.9.157 

type ModifyParamsArgs struct {
	Parameters []ParameterItem `json:"parameters"`
}

type ModifyPasswordArgs added in v0.9.27 

type ModifyPasswordArgs struct {
	Password    string `json:"password"`
	ClientToken string `json:"-"`
}

type NodeType 

type NodeType struct {
	InstanceFlavor          float64 `json:"instanceFlavor"`
	NodeType                string  `json:"nodeType"`
	CPUNum                  int     `json:"cpuNum"`
	NetworkThroughputInGbps float64 `json:"networkThroughputInGbps"`
	PeakQPS                 int     `json:"peakQps"`
	MaxConnections          int     `json:"maxConnections"`
	AllowedNodeNumList      []int   `json:"allowedNodeNumList"`
}

type OrderIdResult added in v0.9.59 

type OrderIdResult struct {
	OrderId string `json:"orderId"`
}

type ParamItem added in v0.9.157 

type ParamItem struct {
	ConfName         string `json:"confName"`
	ConfModule       int    `json:"confModule"`
	ConfCacheVersion int    `json:"confCacheVersion"`
	ConfValue        string `json:"confValue"`
	NeedReboot       int    `json:"needReboot"`
	ConfRedisVersion string `json:"confRedisVersion"`
	ConfDefault      string `json:"confDefault"`
	ConfType         int    `json:"confType"`
	ConfRange        string `json:"confRange"`
	ConfDesc         string `json:"confDesc"`
	ConfUserVisible  int    `json:"confUserVisible"`
}

type Parameter added in v0.9.27 

type Parameter struct {
	Default      string `json:"default"`
	ForceRestart string `json:"forceRestart"`
	Name         string `json:"name"`
	Value        string `json:"value"`
}

type ParameterItem added in v0.9.157 

type ParameterItem struct {
	ConfName   string `json:"confName"`
	ConfModule int    `json:"confModule"`
	ConfValue  string `json:"confValue"`
	ConfType   int    `json:"confType"`
}

type ParamsTemplateListResult added in v0.9.157 

type ParamsTemplateListResult struct {
	Marker      string       `json:"marker"`
	MaxKeys     int          `json:"maxKeys"`
	NextMarker  string       `json:"nextMarker"`
	IsTruncated bool         `json:"isTruncated"`
	Result      []ResultItem `json:"result"`
}

type RecycleInstance added in v0.9.59 

type RecycleInstance struct {
	InstanceID         string           `json:"cacheClusterShowId"`
	InstanceName       string           `json:"instanceName"`
	InstanceStatus     string           `json:"instanceStatus"`
	IsolatedStatus     string           `json:"isolatedStatus"`
	ClusterType        string           `json:"clusterType"`
	Engine             string           `json:"engine"`
	EngineVersion      string           `json:"engineVersion"`
	VnetIP             string           `json:"vnetIp"`
	Domain             string           `json:"domain"`
	Port               string           `json:"port"`
	InstanceCreateTime string           `json:"instanceCreateTime"`
	Capacity           float64          `json:"capacity"`
	UsedCapacity       float64          `json:"usedCapacity"`
	PaymentTiming      string           `json:"paymentTiming"`
	ZoneNames          []string         `json:"zoneNames"`
	Tags               []model.TagModel `json:"tags"`
}

type RecyclerInstanceList added in v0.9.59 

type RecyclerInstanceList struct {
	ListResultWithMarker
	Result []RecycleInstance `json:"result"`
}

type RenameDomainArgs added in v0.9.157 

type RenameDomainArgs struct {
	Domain      string `json:"domain"`
	ClientToken string `json:"clientToken,omitempty"`
}

type RenameTemplateArgs added in v0.9.157 

type RenameTemplateArgs struct {
	Name string `json:"name"`
}

type RenewInstanceArgs added in v0.9.59 

type RenewInstanceArgs struct {
	Duration    int      `json:"duration,omitempty"`
	InstanceIds []string `json:"instanceIds,omitempty"`
}

type Replication added in v0.9.114 

type Replication struct {
	AvailabilityZone string `json:"availabilityZone"`
	SubnetId         string `json:"subnetId"`
	IsMaster         int    `json:"isMaster"`
}

type ReplicationArgs added in v0.9.114 

type ReplicationArgs struct {
	ResizeType      string        `json:"resizeType"`
	ReplicationInfo []Replication `json:"replicationInfo"`
	ClientToken     string        `json:"-"`
}

type RequestBuilder added in v0.9.59 

type RequestBuilder struct {
}

type Reservation 

type Reservation struct {
	ReservationLength   int    `json:"reservationLength"`
	ReservationTimeUnit string `json:"reservationTimeUnit"`
}

type ResizeInstanceArgs 

type ResizeInstanceArgs struct {
	NodeType    string `json:"nodeType"`
	ShardNum    int    `json:"shardNum"`
	IsDefer     bool   `json:"isDefer"`
	ClientToken string `json:"-"`
	DiskFlavor  int    `json:"diskFlavor"`
	DiskType    string `json:"diskType"`
}

type ResizePriceArgs added in v0.9.157 

type ResizePriceArgs struct {
	NodeType       string `json:"nodeType"`
	ShardNum       int    `json:"shardNum,omitempty"`
	ReplicationNum int    `json:"replicationNum,omitempty"`
	DiskFlavor     int    `json:"diskFlavor,omitempty"`
	ChargeType     string `json:"chargeType,omitempty"`
	Period         int    `json:"period,omitempty"`
	ChangeType     string `json:"changeType,omitempty"`
}

type ResizePriceResult added in v0.9.157 

type ResizePriceResult struct {
	Price float64 `json:"price,omitempty"`
}

type RestartInstanceArgs added in v0.9.63 

type RestartInstanceArgs struct {
	IsDefer bool `json:"isDefer"`
}

type ResultItem added in v0.9.157 

type ResultItem struct {
	EngineVersion  string      `json:"engineVersion"`
	TemplateType   int         `json:"templateType"`
	ClusterType    string      `json:"clusterType"`
	NeedReboot     int         `json:"needReboot"`
	TemplateShowId string      `json:"templateShowId"`
	UpdateTime     string      `json:"updateTime"`
	TemplateId     int         `json:"templateId"`
	ParameterNum   int         `json:"parameterNum"`
	TemplateName   string      `json:"templateName"`
	Engine         string      `json:"engine"`
	CreateTime     string      `json:"createTime"`
	Comment        string      `json:"comment"`
	Parameters     []ParamItem `json:"parameters"`
}

type SecurityGroup added in v0.9.55 

type SecurityGroup struct {
	Name                 string `json:"name"`
	SecurityGroupID      string `json:"securityGroupId"`
	Description          string `json:"description"`
	TenantID             string `json:"tenantId"`
	AssociateNum         int    `json:"associateNum"`
	VpcID                string `json:"vpcId"`
	VpcShortID           string `json:"vpcShortId"`
	VpcName              string `json:"vpcName"`
	CreatedTime          string `json:"createdTime"`
	Version              int    `json:"version"`
	DefaultSecurityGroup int    `json:"defaultSecurityGroup"`
}

type SecurityGroupArgs added in v0.9.55 

type SecurityGroupArgs struct {
	InstanceIds      []string `json:"instanceIds"`
	SecurityGroupIds []string `json:"securityGroupIds"`
}

type SecurityGroupDetail added in v0.9.55 

type SecurityGroupDetail struct {
	SecurityGroupName   string              `json:"securityGroupName"`
	SecurityGroupID     string              `json:"securityGroupId"`
	SecurityGroupRemark string              `json:"securityGroupRemark"`
	Inbound             []SecurityGroupRule `json:"inbound"`
	Outbound            []SecurityGroupRule `json:"outbound"`
	VpcName             string              `json:"vpcName"`
	VpcID               string              `json:"vpcId"`
	ProjectID           string              `json:"projectId"`
}

type SecurityGroupRule added in v0.9.55 

type SecurityGroupRule struct {
	PortRange           string `json:"portRange"`
	Protocol            string `json:"protocol"`
	RemoteGroupID       string `json:"remoteGroupId"`
	RemoteIP            string `json:"remoteIP"`
	Ethertype           string `json:"ethertype"`
	TenantID            string `json:"tenantId"`
	Name                string `json:"name"`
	ID                  string `json:"id"`
	SecurityGroupRuleID string `json:"securityGroupRuleId"`
	Direction           string `json:"direction"`
}

type SecurityIpArgs added in v0.9.27 

type SecurityIpArgs struct {
	SecurityIps []string `json:"securityIps"`
	ClientToken string   `json:"-"`
}

type SetAsSlaveArgs added in v0.9.157 

type SetAsSlaveArgs struct {
	MasterDomain string `json:"masterDomain"`
	MasterPort   int    `json:"masterPort"`
}

type ShardLog added in v0.9.59 

type ShardLog struct {
	ShardShowID string    `json:"shardShowId"`
	TotalNum    int       `json:"totalNum"`
	ShardID     int       `json:"shardId"`
	LogItem     []LogItem `json:"logItem"`
}

type StaleReadableArgs added in v0.9.157 

type StaleReadableArgs struct {
	FollowerId    string `json:"followerId"`
	StaleReadable bool   `json:"staleReadable"`
}

type Subnet 

type Subnet struct {
	ZoneName string `json:"zoneName"`
	SubnetID string `json:"subnetId"`
}

type SubnetOriginal added in v0.9.27 

type SubnetOriginal struct {
	Name     string `json:"name"`
	SubnetID string `json:"subnetId"`
	ZoneName string `json:"zoneName"`
	Cidr     string `json:"cidr"`
	VpcID    string `json:"vpcId"`
}

type SwapDomainArgs added in v0.9.157 

type SwapDomainArgs struct {
	SourceInstanceId string `json:"sourceInstanceId"`
	TargetInstanceId string `json:"targetInstanceId"`
	ClientToken      string `json:"clientToken,omitempty"`
}

type SystemTemplate added in v0.9.157 

type SystemTemplate struct {
	ConfName         string `json:"confName"`
	ConfDefault      string `json:"confDefault"`
	ConfValue        string `json:"confValue"`
	ConfType         int    `json:"confType"`
	ConfRange        string `json:"confRange"`
	ConfModule       int    `json:"confModule"`
	ConfDesc         string `json:"confDesc"`
	NeedReboot       int    `json:"needReboot"`
	ConfRedisVersion string `json:"confRedisVersion"`
	ConfCacheVersion int    `json:"confCacheVersion"`
}

type SystemTemplateResult added in v0.9.157 

type SystemTemplateResult struct {
	Success bool             `json:"success"`
	Result  []SystemTemplate `json:"result"`
}

type UnbindSecurityGroupArgs added in v0.9.55 

type UnbindSecurityGroupArgs struct {
	InstanceId       string   `json:"instanceId"`
	SecurityGroupIds []string `json:"securityGroupIds"`
}

type UpdateInstanceDomainNameArgs added in v0.9.27 

type UpdateInstanceDomainNameArgs struct {
	Domain      string `json:"domain"`
	ClientToken string `json:"-"`
}

type UpdateInstanceNameArgs 

type UpdateInstanceNameArgs struct {
	InstanceName string `json:"instanceName"`
	ClientToken  string `json:"-"`
}

type ZoneNames added in v0.9.31 

type ZoneNames struct {
	ZoneNames []string `json:"zoneNames"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.