v20200915

package
v1.0.1074 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2025 License: Apache-2.0 Imports: 7 Imported by: 2

Documentation

Index

Constants

View Source 
const (

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"
)
View Source 
const APIVersion = "2020-09-15"

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionAlterCkUserRequest 

type ActionAlterCkUserRequest struct {
	*tchttp.BaseRequest

	// 用户信息
	UserInfo *CkUserAlterInfo `json:"UserInfo,omitnil,omitempty" name:"UserInfo"`

	// api接口类型，
	// AddSystemUser新增用户，UpdateSystemUser，修改用户
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`
}

func NewActionAlterCkUserRequest 

func NewActionAlterCkUserRequest() (request *ActionAlterCkUserRequest)

func (*ActionAlterCkUserRequest) FromJsonString 

func (r *ActionAlterCkUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ActionAlterCkUserRequest) ToJsonString 

func (r *ActionAlterCkUserRequest) ToJsonString() string

type ActionAlterCkUserRequestParams 

type ActionAlterCkUserRequestParams struct {
	// 用户信息
	UserInfo *CkUserAlterInfo `json:"UserInfo,omitnil,omitempty" name:"UserInfo"`

	// api接口类型，
	// AddSystemUser新增用户，UpdateSystemUser，修改用户
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`
}

Predefined struct for user

type ActionAlterCkUserResponse 

type ActionAlterCkUserResponse struct {
	*tchttp.BaseResponse
	Response *ActionAlterCkUserResponseParams `json:"Response"`
}

func NewActionAlterCkUserResponse 

func NewActionAlterCkUserResponse() (response *ActionAlterCkUserResponse)

func (*ActionAlterCkUserResponse) FromJsonString 

func (r *ActionAlterCkUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ActionAlterCkUserResponse) ToJsonString 

func (r *ActionAlterCkUserResponse) ToJsonString() string

type ActionAlterCkUserResponseParams 

type ActionAlterCkUserResponseParams struct {
	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrMsg *string `json:"ErrMsg,omitnil,omitempty" name:"ErrMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AttachCBSSpec added in v1.0.618 

type AttachCBSSpec struct {
	// 节点磁盘类型，例如“CLOUD_SSD”\"CLOUD_PREMIUM"
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// 磁盘容量，单位G
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// 磁盘总数
	DiskCount *int64 `json:"DiskCount,omitnil,omitempty" name:"DiskCount"`

	// 描述
	DiskDesc *string `json:"DiskDesc,omitnil,omitempty" name:"DiskDesc"`
}

type BackUpJobDisplay added in v1.0.736 

type BackUpJobDisplay struct {
	// 备份任务id
	JobId *int64 `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 备份任务名
	Snapshot *string `json:"Snapshot,omitnil,omitempty" name:"Snapshot"`

	// 任务类型(元数据),(数据)
	BackUpType *string `json:"BackUpType,omitnil,omitempty" name:"BackUpType"`

	// 备份数据量
	BackUpSize *int64 `json:"BackUpSize,omitnil,omitempty" name:"BackUpSize"`

	// 任务创建时间
	BackUpTime *string `json:"BackUpTime,omitnil,omitempty" name:"BackUpTime"`

	// 任务过期时间
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// 任务状态
	JobStatus *string `json:"JobStatus,omitnil,omitempty" name:"JobStatus"`
}

type BackupTableContent 

type BackupTableContent struct {
	// 数据库
	// 注意：此字段可能返回 null，表示取不到有效值。
	Database *string `json:"Database,omitnil,omitempty" name:"Database"`

	// 表
	// 注意：此字段可能返回 null，表示取不到有效值。
	Table *string `json:"Table,omitnil,omitempty" name:"Table"`

	// 表总字节数
	// 注意：此字段可能返回 null，表示取不到有效值。
	TotalBytes *int64 `json:"TotalBytes,omitnil,omitempty" name:"TotalBytes"`

	// 虚拟cluster
	// 注意：此字段可能返回 null，表示取不到有效值。
	VCluster *string `json:"VCluster,omitnil,omitempty" name:"VCluster"`

	// 表ip
	// 注意：此字段可能返回 null，表示取不到有效值。
	Ips *string `json:"Ips,omitnil,omitempty" name:"Ips"`

	// zk路径
	// 注意：此字段可能返回 null，表示取不到有效值。
	ZooPath *string `json:"ZooPath,omitnil,omitempty" name:"ZooPath"`

	// cvm的ip地址
	// 注意：此字段可能返回 null，表示取不到有效值。
	Rip *string `json:"Rip,omitnil,omitempty" name:"Rip"`
}

type Charge added in v1.0.563 

type Charge struct {
	// 计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费
	ChargeType *string `json:"ChargeType,omitnil,omitempty" name:"ChargeType"`

	// PREPAID需要传递，是否自动续费，1表示自动续费开启
	RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`

	// 预付费需要传递，计费时间长度，多少个月
	TimeSpan *int64 `json:"TimeSpan,omitnil,omitempty" name:"TimeSpan"`
}

type CkUserAlterInfo 

type CkUserAlterInfo struct {
	// 集群实例id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 用户名
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// base64加密后的密码
	PassWord *string `json:"PassWord,omitnil,omitempty" name:"PassWord"`

	// 描述
	Describe *string `json:"Describe,omitnil,omitempty" name:"Describe"`
}

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ActionAlterCkUser 

func (c *Client) ActionAlterCkUser(request *ActionAlterCkUserRequest) (response *ActionAlterCkUserResponse, err error)

ActionAlterCkUser 新增和修改用户接口

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ActionAlterCkUserWithContext 

func (c *Client) ActionAlterCkUserWithContext(ctx context.Context, request *ActionAlterCkUserRequest) (response *ActionAlterCkUserResponse, err error)

ActionAlterCkUser 新增和修改用户接口

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) CreateBackUpSchedule 

func (c *Client) CreateBackUpSchedule(request *CreateBackUpScheduleRequest) (response *CreateBackUpScheduleResponse, err error)

CreateBackUpSchedule 创建或者修改备份策略

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) CreateBackUpScheduleWithContext 

func (c *Client) CreateBackUpScheduleWithContext(ctx context.Context, request *CreateBackUpScheduleRequest) (response *CreateBackUpScheduleResponse, err error)

CreateBackUpSchedule 创建或者修改备份策略

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) CreateInstanceNew added in v1.0.563 

func (c *Client) CreateInstanceNew(request *CreateInstanceNewRequest) (response *CreateInstanceNewResponse, err error)

CreateInstanceNew 创建集群

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) CreateInstanceNewWithContext added in v1.0.563 

func (c *Client) CreateInstanceNewWithContext(ctx context.Context, request *CreateInstanceNewRequest) (response *CreateInstanceNewResponse, err error)

CreateInstanceNew 创建集群

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DeleteBackUpData added in v1.0.736 

func (c *Client) DeleteBackUpData(request *DeleteBackUpDataRequest) (response *DeleteBackUpDataResponse, err error)

DeleteBackUpData 删除备份数据

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DeleteBackUpDataWithContext added in v1.0.736 

func (c *Client) DeleteBackUpDataWithContext(ctx context.Context, request *DeleteBackUpDataRequest) (response *DeleteBackUpDataResponse, err error)

DeleteBackUpData 删除备份数据

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpJob added in v1.0.736 

func (c *Client) DescribeBackUpJob(request *DescribeBackUpJobRequest) (response *DescribeBackUpJobResponse, err error)

DescribeBackUpJob 查询备份任务列表

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpJobDetail added in v1.0.736 

func (c *Client) DescribeBackUpJobDetail(request *DescribeBackUpJobDetailRequest) (response *DescribeBackUpJobDetailResponse, err error)

DescribeBackUpJobDetail 查询备份任务详情

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpJobDetailWithContext added in v1.0.736 

func (c *Client) DescribeBackUpJobDetailWithContext(ctx context.Context, request *DescribeBackUpJobDetailRequest) (response *DescribeBackUpJobDetailResponse, err error)

DescribeBackUpJobDetail 查询备份任务详情

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpJobWithContext added in v1.0.736 

func (c *Client) DescribeBackUpJobWithContext(ctx context.Context, request *DescribeBackUpJobRequest) (response *DescribeBackUpJobResponse, err error)

DescribeBackUpJob 查询备份任务列表

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpSchedule added in v1.0.589 

func (c *Client) DescribeBackUpSchedule(request *DescribeBackUpScheduleRequest) (response *DescribeBackUpScheduleResponse, err error)

DescribeBackUpSchedule 查询备份策略信息

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpScheduleWithContext added in v1.0.589 

func (c *Client) DescribeBackUpScheduleWithContext(ctx context.Context, request *DescribeBackUpScheduleRequest) (response *DescribeBackUpScheduleResponse, err error)

DescribeBackUpSchedule 查询备份策略信息

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpTables added in v1.0.744 

func (c *Client) DescribeBackUpTables(request *DescribeBackUpTablesRequest) (response *DescribeBackUpTablesResponse, err error)

DescribeBackUpTables 获取可备份表信息

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeBackUpTablesWithContext added in v1.0.744 

func (c *Client) DescribeBackUpTablesWithContext(ctx context.Context, request *DescribeBackUpTablesRequest) (response *DescribeBackUpTablesResponse, err error)

DescribeBackUpTables 获取可备份表信息

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeCkSqlApis 

func (c *Client) DescribeCkSqlApis(request *DescribeCkSqlApisRequest) (response *DescribeCkSqlApisResponse, err error)

DescribeCkSqlApis 查询集群用户、集群表，数据库等相关信息

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeCkSqlApisWithContext 

func (c *Client) DescribeCkSqlApisWithContext(ctx context.Context, request *DescribeCkSqlApisRequest) (response *DescribeCkSqlApisResponse, err error)

DescribeCkSqlApis 查询集群用户、集群表，数据库等相关信息

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeClusterConfigs added in v1.0.589 

func (c *Client) DescribeClusterConfigs(request *DescribeClusterConfigsRequest) (response *DescribeClusterConfigsResponse, err error)

DescribeClusterConfigs 获取集群的最新的几个配置文件（config.xml、metrika.xml、user.xml）的内容，显示给用户

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeClusterConfigsWithContext added in v1.0.589 

func (c *Client) DescribeClusterConfigsWithContext(ctx context.Context, request *DescribeClusterConfigsRequest) (response *DescribeClusterConfigsResponse, err error)

DescribeClusterConfigs 获取集群的最新的几个配置文件（config.xml、metrika.xml、user.xml）的内容，显示给用户

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstance added in v1.0.563 

func (c *Client) DescribeInstance(request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)

DescribeInstance 根据实例ID查询某个实例的具体信息

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceClusters added in v1.0.617 

func (c *Client) DescribeInstanceClusters(request *DescribeInstanceClustersRequest) (response *DescribeInstanceClustersResponse, err error)

DescribeInstanceClusters 集群vcluster列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceClustersWithContext added in v1.0.617 

func (c *Client) DescribeInstanceClustersWithContext(ctx context.Context, request *DescribeInstanceClustersRequest) (response *DescribeInstanceClustersResponse, err error)

DescribeInstanceClusters 集群vcluster列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceKeyValConfigs added in v1.0.589 

func (c *Client) DescribeInstanceKeyValConfigs(request *DescribeInstanceKeyValConfigsRequest) (response *DescribeInstanceKeyValConfigsResponse, err error)

DescribeInstanceKeyValConfigs 在集群详情页面获取所有参数列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceKeyValConfigsWithContext added in v1.0.589 

func (c *Client) DescribeInstanceKeyValConfigsWithContext(ctx context.Context, request *DescribeInstanceKeyValConfigsRequest) (response *DescribeInstanceKeyValConfigsResponse, err error)

DescribeInstanceKeyValConfigs 在集群详情页面获取所有参数列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceNodes added in v1.0.833 

func (c *Client) DescribeInstanceNodes(request *DescribeInstanceNodesRequest) (response *DescribeInstanceNodesResponse, err error)

DescribeInstanceNodes 获取实例节点信息列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceNodesWithContext added in v1.0.833 

func (c *Client) DescribeInstanceNodesWithContext(ctx context.Context, request *DescribeInstanceNodesRequest) (response *DescribeInstanceNodesResponse, err error)

DescribeInstanceNodes 获取实例节点信息列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceShards 

func (c *Client) DescribeInstanceShards(request *DescribeInstanceShardsRequest) (response *DescribeInstanceShardsResponse, err error)

DescribeInstanceShards 获取实例shard信息列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceShardsWithContext 

func (c *Client) DescribeInstanceShardsWithContext(ctx context.Context, request *DescribeInstanceShardsRequest) (response *DescribeInstanceShardsResponse, err error)

DescribeInstanceShards 获取实例shard信息列表

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceState added in v1.0.629 

func (c *Client) DescribeInstanceState(request *DescribeInstanceStateRequest) (response *DescribeInstanceStateResponse, err error)

DescribeInstanceState 集群详情页中显示集群状态、流程进度等

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceStateWithContext added in v1.0.629 

func (c *Client) DescribeInstanceStateWithContext(ctx context.Context, request *DescribeInstanceStateRequest) (response *DescribeInstanceStateResponse, err error)

DescribeInstanceState 集群详情页中显示集群状态、流程进度等

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceWithContext added in v1.0.563 

func (c *Client) DescribeInstanceWithContext(ctx context.Context, request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)

DescribeInstance 根据实例ID查询某个实例的具体信息

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstancesNew added in v1.0.676 

func (c *Client) DescribeInstancesNew(request *DescribeInstancesNewRequest) (response *DescribeInstancesNewResponse, err error)

DescribeInstancesNew 获取实例列表，供外部sdk使用

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeInstancesNewWithContext added in v1.0.676 

func (c *Client) DescribeInstancesNewWithContext(ctx context.Context, request *DescribeInstancesNewRequest) (response *DescribeInstancesNewResponse, err error)

DescribeInstancesNew 获取实例列表，供外部sdk使用

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeSpec added in v1.0.548 

func (c *Client) DescribeSpec(request *DescribeSpecRequest) (response *DescribeSpecResponse, err error)

DescribeSpec 购买页拉取集群的数据节点和zookeeper节点的规格列表

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeSpecWithContext added in v1.0.548 

func (c *Client) DescribeSpecWithContext(ctx context.Context, request *DescribeSpecRequest) (response *DescribeSpecResponse, err error)

DescribeSpec 购买页拉取集群的数据节点和zookeeper节点的规格列表

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DestroyInstance added in v1.0.590 

func (c *Client) DestroyInstance(request *DestroyInstanceRequest) (response *DestroyInstanceResponse, err error)

DestroyInstance 销毁集群 open api

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DestroyInstanceWithContext added in v1.0.590 

func (c *Client) DestroyInstanceWithContext(ctx context.Context, request *DestroyInstanceRequest) (response *DestroyInstanceResponse, err error)

DestroyInstance 销毁集群 open api

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ModifyClusterConfigs 

func (c *Client) ModifyClusterConfigs(request *ModifyClusterConfigsRequest) (response *ModifyClusterConfigsResponse, err error)

ModifyClusterConfigs 在集群配置页面修改集群配置文件接口，xml模式

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ModifyClusterConfigsWithContext 

func (c *Client) ModifyClusterConfigsWithContext(ctx context.Context, request *ModifyClusterConfigsRequest) (response *ModifyClusterConfigsResponse, err error)

ModifyClusterConfigs 在集群配置页面修改集群配置文件接口，xml模式

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ModifyInstanceKeyValConfigs added in v1.0.589 

func (c *Client) ModifyInstanceKeyValConfigs(request *ModifyInstanceKeyValConfigsRequest) (response *ModifyInstanceKeyValConfigsResponse, err error)

ModifyInstanceKeyValConfigs KV模式修改配置接口

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ModifyInstanceKeyValConfigsWithContext added in v1.0.589 

func (c *Client) ModifyInstanceKeyValConfigsWithContext(ctx context.Context, request *ModifyInstanceKeyValConfigsRequest) (response *ModifyInstanceKeyValConfigsResponse, err error)

ModifyInstanceKeyValConfigs KV模式修改配置接口

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ModifyUserNewPrivilege 

func (c *Client) ModifyUserNewPrivilege(request *ModifyUserNewPrivilegeRequest) (response *ModifyUserNewPrivilegeResponse, err error)

ModifyUserNewPrivilege 针对集群账号的权限做管控（新版）

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ModifyUserNewPrivilegeWithContext 

func (c *Client) ModifyUserNewPrivilegeWithContext(ctx context.Context, request *ModifyUserNewPrivilegeRequest) (response *ModifyUserNewPrivilegeResponse, err error)

ModifyUserNewPrivilege 针对集群账号的权限做管控（新版）

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) OpenBackUp 

func (c *Client) OpenBackUp(request *OpenBackUpRequest) (response *OpenBackUpResponse, err error)

OpenBackUp 开启或者关闭策略

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) OpenBackUpWithContext 

func (c *Client) OpenBackUpWithContext(ctx context.Context, request *OpenBackUpRequest) (response *OpenBackUpResponse, err error)

OpenBackUp 开启或者关闭策略

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) RecoverBackUpJob added in v1.0.736 

func (c *Client) RecoverBackUpJob(request *RecoverBackUpJobRequest) (response *RecoverBackUpJobResponse, err error)

RecoverBackUpJob 备份恢复

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) RecoverBackUpJobWithContext added in v1.0.736 

func (c *Client) RecoverBackUpJobWithContext(ctx context.Context, request *RecoverBackUpJobRequest) (response *RecoverBackUpJobResponse, err error)

RecoverBackUpJob 备份恢复

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ResizeDisk added in v1.0.589 

func (c *Client) ResizeDisk(request *ResizeDiskRequest) (response *ResizeDiskResponse, err error)

ResizeDisk 扩容磁盘，包含扩容数据节点，zk节点

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ResizeDiskWithContext added in v1.0.589 

func (c *Client) ResizeDiskWithContext(ctx context.Context, request *ResizeDiskRequest) (response *ResizeDiskResponse, err error)

ResizeDisk 扩容磁盘，包含扩容数据节点，zk节点

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ScaleCNOutUpInstance added in v1.0.1046 

func (c *Client) ScaleCNOutUpInstance(request *ScaleCNOutUpInstanceRequest) (response *ScaleCNOutUpInstanceResponse, err error)

ScaleCNOutUpInstance open-api接口提供弹性伸缩云原生集群能力

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ScaleCNOutUpInstanceWithContext added in v1.0.1046 

func (c *Client) ScaleCNOutUpInstanceWithContext(ctx context.Context, request *ScaleCNOutUpInstanceRequest) (response *ScaleCNOutUpInstanceResponse, err error)

ScaleCNOutUpInstance open-api接口提供弹性伸缩云原生集群能力

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ScaleOutInstance added in v1.0.589 

func (c *Client) ScaleOutInstance(request *ScaleOutInstanceRequest) (response *ScaleOutInstanceResponse, err error)

ScaleOutInstance 调整clickhouse节点数量

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ScaleOutInstanceWithContext added in v1.0.589 

func (c *Client) ScaleOutInstanceWithContext(ctx context.Context, request *ScaleOutInstanceRequest) (response *ScaleOutInstanceResponse, err error)

ScaleOutInstance 调整clickhouse节点数量

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ScaleUpInstance added in v1.0.589 

func (c *Client) ScaleUpInstance(request *ScaleUpInstanceRequest) (response *ScaleUpInstanceResponse, err error)

ScaleUpInstance 垂直扩缩容节点规格，修改节点cvm的规格cpu，内存。 规格变化阶段，服务不可用。

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) ScaleUpInstanceWithContext added in v1.0.589 

func (c *Client) ScaleUpInstanceWithContext(ctx context.Context, request *ScaleUpInstanceRequest) (response *ScaleUpInstanceResponse, err error)

ScaleUpInstance 垂直扩缩容节点规格，修改节点cvm的规格cpu，内存。 规格变化阶段，服务不可用。

可能返回的错误码: 

INTERNALERROR = "InternalError"

type ClusterConfigsInfoFromEMR added in v1.0.589 

type ClusterConfigsInfoFromEMR struct {
	// 配置文件名称
	FileName *string `json:"FileName,omitnil,omitempty" name:"FileName"`

	// 配置文件对应的相关属性信息
	FileConf *string `json:"FileConf,omitnil,omitempty" name:"FileConf"`

	// 配置文件对应的其他属性信息
	KeyConf *string `json:"KeyConf,omitnil,omitempty" name:"KeyConf"`

	// 配置文件的内容，base64编码
	OriParam *string `json:"OriParam,omitnil,omitempty" name:"OriParam"`

	// 用于表示当前配置文件是不是有过修改后没有重启，提醒用户需要重启
	NeedRestart *int64 `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"`

	// 保存配置文件的路径
	// 注意：此字段可能返回 null，表示取不到有效值。
	FilePath *string `json:"FilePath,omitnil,omitempty" name:"FilePath"`
}

type ClusterInfo added in v1.0.617 

type ClusterInfo struct {
	// vcluster名字
	// 注意：此字段可能返回 null，表示取不到有效值。
	ClusterName *string `json:"ClusterName,omitnil,omitempty" name:"ClusterName"`

	// 当前cluster的IP列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	NodeIps []*string `json:"NodeIps,omitnil,omitempty" name:"NodeIps"`
}

type ConfigSubmitContext 

type ConfigSubmitContext struct {
	// 配置文件名称
	FileName *string `json:"FileName,omitnil,omitempty" name:"FileName"`

	// 配置文件旧内容，base64编码
	OldConfValue *string `json:"OldConfValue,omitnil,omitempty" name:"OldConfValue"`

	// 配置文件新内容，base64编码
	NewConfValue *string `json:"NewConfValue,omitnil,omitempty" name:"NewConfValue"`

	// 保存配置文件的路径
	FilePath *string `json:"FilePath,omitnil,omitempty" name:"FilePath"`
}

type CreateBackUpScheduleRequest 

type CreateBackUpScheduleRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 策略类型 meta(元数据)  data (表数据)
	ScheduleType *string `json:"ScheduleType,omitnil,omitempty" name:"ScheduleType"`

	// 操作类型 create(创建) update(编辑修改)
	OperationType *string `json:"OperationType,omitnil,omitempty" name:"OperationType"`

	// 保留天数 例如7
	RetainDays *int64 `json:"RetainDays,omitnil,omitempty" name:"RetainDays"`

	// 编辑时需要传
	ScheduleId *int64 `json:"ScheduleId,omitnil,omitempty" name:"ScheduleId"`

	// 选择的星期 逗号分隔，例如 2 代表周二
	WeekDays *string `json:"WeekDays,omitnil,omitempty" name:"WeekDays"`

	// 执行小时
	ExecuteHour *int64 `json:"ExecuteHour,omitnil,omitempty" name:"ExecuteHour"`

	// 备份表列表
	BackUpTables []*BackupTableContent `json:"BackUpTables,omitnil,omitempty" name:"BackUpTables"`
}

func NewCreateBackUpScheduleRequest 

func NewCreateBackUpScheduleRequest() (request *CreateBackUpScheduleRequest)

func (*CreateBackUpScheduleRequest) FromJsonString 

func (r *CreateBackUpScheduleRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateBackUpScheduleRequest) ToJsonString 

func (r *CreateBackUpScheduleRequest) ToJsonString() string

type CreateBackUpScheduleRequestParams 

type CreateBackUpScheduleRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 策略类型 meta(元数据)  data (表数据)
	ScheduleType *string `json:"ScheduleType,omitnil,omitempty" name:"ScheduleType"`

	// 操作类型 create(创建) update(编辑修改)
	OperationType *string `json:"OperationType,omitnil,omitempty" name:"OperationType"`

	// 保留天数 例如7
	RetainDays *int64 `json:"RetainDays,omitnil,omitempty" name:"RetainDays"`

	// 编辑时需要传
	ScheduleId *int64 `json:"ScheduleId,omitnil,omitempty" name:"ScheduleId"`

	// 选择的星期 逗号分隔，例如 2 代表周二
	WeekDays *string `json:"WeekDays,omitnil,omitempty" name:"WeekDays"`

	// 执行小时
	ExecuteHour *int64 `json:"ExecuteHour,omitnil,omitempty" name:"ExecuteHour"`

	// 备份表列表
	BackUpTables []*BackupTableContent `json:"BackUpTables,omitnil,omitempty" name:"BackUpTables"`
}

Predefined struct for user

type CreateBackUpScheduleResponse 

type CreateBackUpScheduleResponse struct {
	*tchttp.BaseResponse
	Response *CreateBackUpScheduleResponseParams `json:"Response"`
}

func NewCreateBackUpScheduleResponse 

func NewCreateBackUpScheduleResponse() (response *CreateBackUpScheduleResponse)

func (*CreateBackUpScheduleResponse) FromJsonString 

func (r *CreateBackUpScheduleResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateBackUpScheduleResponse) ToJsonString 

func (r *CreateBackUpScheduleResponse) ToJsonString() string

type CreateBackUpScheduleResponseParams 

type CreateBackUpScheduleResponseParams struct {
	// 错误描述
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateInstanceNewRequest added in v1.0.563 

type CreateInstanceNewRequest struct {
	*tchttp.BaseRequest

	// 可用区
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 是否高可用
	HaFlag *bool `json:"HaFlag,omitnil,omitempty" name:"HaFlag"`

	// 私有网络
	UserVPCId *string `json:"UserVPCId,omitnil,omitempty" name:"UserVPCId"`

	// 子网
	UserSubnetId *string `json:"UserSubnetId,omitnil,omitempty" name:"UserSubnetId"`

	// 系统版本
	ProductVersion *string `json:"ProductVersion,omitnil,omitempty" name:"ProductVersion"`

	// 计费方式
	ChargeProperties *Charge `json:"ChargeProperties,omitnil,omitempty" name:"ChargeProperties"`

	// 实例名称
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 数据节点
	// SpecName从DescribeSpec接口中返回的DataSpec.Name获取
	DataSpec *NodeSpec `json:"DataSpec,omitnil,omitempty" name:"DataSpec"`

	// 标签列表（废弃）
	Tags *Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 日志主题ID
	ClsLogSetId *string `json:"ClsLogSetId,omitnil,omitempty" name:"ClsLogSetId"`

	// COS桶名称
	CosBucketName *string `json:"CosBucketName,omitnil,omitempty" name:"CosBucketName"`

	// 是否是裸盘挂载，默认值 0 为 未挂载，1 为挂载。
	MountDiskType *int64 `json:"MountDiskType,omitnil,omitempty" name:"MountDiskType"`

	// 是否是ZK高可用
	HAZk *bool `json:"HAZk,omitnil,omitempty" name:"HAZk"`

	// ZK节点
	// SpecName从DescribeSpec接口中返回的CommonSpec.Name（ZK节点）获取
	CommonSpec *NodeSpec `json:"CommonSpec,omitnil,omitempty" name:"CommonSpec"`

	// 标签列表
	TagItems []*Tag `json:"TagItems,omitnil,omitempty" name:"TagItems"`
}

func NewCreateInstanceNewRequest added in v1.0.563 

func NewCreateInstanceNewRequest() (request *CreateInstanceNewRequest)

func (*CreateInstanceNewRequest) FromJsonString added in v1.0.563 

func (r *CreateInstanceNewRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateInstanceNewRequest) ToJsonString added in v1.0.563 

func (r *CreateInstanceNewRequest) ToJsonString() string

type CreateInstanceNewRequestParams added in v1.0.563 

type CreateInstanceNewRequestParams struct {
	// 可用区
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 是否高可用
	HaFlag *bool `json:"HaFlag,omitnil,omitempty" name:"HaFlag"`

	// 私有网络
	UserVPCId *string `json:"UserVPCId,omitnil,omitempty" name:"UserVPCId"`

	// 子网
	UserSubnetId *string `json:"UserSubnetId,omitnil,omitempty" name:"UserSubnetId"`

	// 系统版本
	ProductVersion *string `json:"ProductVersion,omitnil,omitempty" name:"ProductVersion"`

	// 计费方式
	ChargeProperties *Charge `json:"ChargeProperties,omitnil,omitempty" name:"ChargeProperties"`

	// 实例名称
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 数据节点
	// SpecName从DescribeSpec接口中返回的DataSpec.Name获取
	DataSpec *NodeSpec `json:"DataSpec,omitnil,omitempty" name:"DataSpec"`

	// 标签列表（废弃）
	//
	// Deprecated: Tags is deprecated.
	Tags *Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 日志主题ID
	ClsLogSetId *string `json:"ClsLogSetId,omitnil,omitempty" name:"ClsLogSetId"`

	// COS桶名称
	CosBucketName *string `json:"CosBucketName,omitnil,omitempty" name:"CosBucketName"`

	// 是否是裸盘挂载，默认值 0 为 未挂载，1 为挂载。
	MountDiskType *int64 `json:"MountDiskType,omitnil,omitempty" name:"MountDiskType"`

	// 是否是ZK高可用
	HAZk *bool `json:"HAZk,omitnil,omitempty" name:"HAZk"`

	// ZK节点
	// SpecName从DescribeSpec接口中返回的CommonSpec.Name（ZK节点）获取
	CommonSpec *NodeSpec `json:"CommonSpec,omitnil,omitempty" name:"CommonSpec"`

	// 标签列表
	TagItems []*Tag `json:"TagItems,omitnil,omitempty" name:"TagItems"`
}

Predefined struct for user

type CreateInstanceNewResponse added in v1.0.563 

type CreateInstanceNewResponse struct {
	*tchttp.BaseResponse
	Response *CreateInstanceNewResponseParams `json:"Response"`
}

func NewCreateInstanceNewResponse added in v1.0.563 

func NewCreateInstanceNewResponse() (response *CreateInstanceNewResponse)

func (*CreateInstanceNewResponse) FromJsonString added in v1.0.563 

func (r *CreateInstanceNewResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateInstanceNewResponse) ToJsonString added in v1.0.563 

func (r *CreateInstanceNewResponse) ToJsonString() string

type CreateInstanceNewResponseParams added in v1.0.563 

type CreateInstanceNewResponseParams struct {
	// 流程ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowId *string `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// 实例ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DatabasePrivilegeInfo added in v1.0.742 

type DatabasePrivilegeInfo struct {
	// 数据库名称
	DatabaseName *string `json:"DatabaseName,omitnil,omitempty" name:"DatabaseName"`

	// //库表权限，SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE、CREATE_TABLE、DROP_DATABASE
	// 注意：此字段可能返回 null，表示取不到有效值。
	DatabasePrivileges []*string `json:"DatabasePrivileges,omitnil,omitempty" name:"DatabasePrivileges"`

	// // 库下面的表权限
	// 注意：此字段可能返回 null，表示取不到有效值。
	TablePrivilegeList []*TablePrivilegeInfo `json:"TablePrivilegeList,omitnil,omitempty" name:"TablePrivilegeList"`
}

type DeleteBackUpDataRequest added in v1.0.736 

type DeleteBackUpDataRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 任务id
	BackUpJobId *int64 `json:"BackUpJobId,omitnil,omitempty" name:"BackUpJobId"`

	// 是否删除所有数据
	IsDeleteAll *bool `json:"IsDeleteAll,omitnil,omitempty" name:"IsDeleteAll"`
}

func NewDeleteBackUpDataRequest added in v1.0.736 

func NewDeleteBackUpDataRequest() (request *DeleteBackUpDataRequest)

func (*DeleteBackUpDataRequest) FromJsonString added in v1.0.736 

func (r *DeleteBackUpDataRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteBackUpDataRequest) ToJsonString added in v1.0.736 

func (r *DeleteBackUpDataRequest) ToJsonString() string

type DeleteBackUpDataRequestParams added in v1.0.736 

type DeleteBackUpDataRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 任务id
	BackUpJobId *int64 `json:"BackUpJobId,omitnil,omitempty" name:"BackUpJobId"`

	// 是否删除所有数据
	IsDeleteAll *bool `json:"IsDeleteAll,omitnil,omitempty" name:"IsDeleteAll"`
}

Predefined struct for user

type DeleteBackUpDataResponse added in v1.0.736 

type DeleteBackUpDataResponse struct {
	*tchttp.BaseResponse
	Response *DeleteBackUpDataResponseParams `json:"Response"`
}

func NewDeleteBackUpDataResponse added in v1.0.736 

func NewDeleteBackUpDataResponse() (response *DeleteBackUpDataResponse)

func (*DeleteBackUpDataResponse) FromJsonString added in v1.0.736 

func (r *DeleteBackUpDataResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteBackUpDataResponse) ToJsonString added in v1.0.736 

func (r *DeleteBackUpDataResponse) ToJsonString() string

type DeleteBackUpDataResponseParams added in v1.0.736 

type DeleteBackUpDataResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeBackUpJobDetailRequest added in v1.0.736 

type DescribeBackUpJobDetailRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 任务id
	BackUpJobId *int64 `json:"BackUpJobId,omitnil,omitempty" name:"BackUpJobId"`
}

func NewDescribeBackUpJobDetailRequest added in v1.0.736 

func NewDescribeBackUpJobDetailRequest() (request *DescribeBackUpJobDetailRequest)

func (*DescribeBackUpJobDetailRequest) FromJsonString added in v1.0.736 

func (r *DescribeBackUpJobDetailRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpJobDetailRequest) ToJsonString added in v1.0.736 

func (r *DescribeBackUpJobDetailRequest) ToJsonString() string

type DescribeBackUpJobDetailRequestParams added in v1.0.736 

type DescribeBackUpJobDetailRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 任务id
	BackUpJobId *int64 `json:"BackUpJobId,omitnil,omitempty" name:"BackUpJobId"`
}

Predefined struct for user

type DescribeBackUpJobDetailResponse added in v1.0.736 

type DescribeBackUpJobDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeBackUpJobDetailResponseParams `json:"Response"`
}

func NewDescribeBackUpJobDetailResponse added in v1.0.736 

func NewDescribeBackUpJobDetailResponse() (response *DescribeBackUpJobDetailResponse)

func (*DescribeBackUpJobDetailResponse) FromJsonString added in v1.0.736 

func (r *DescribeBackUpJobDetailResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpJobDetailResponse) ToJsonString added in v1.0.736 

func (r *DescribeBackUpJobDetailResponse) ToJsonString() string

type DescribeBackUpJobDetailResponseParams added in v1.0.736 

type DescribeBackUpJobDetailResponseParams struct {
	// 备份表详情
	// 注意：此字段可能返回 null，表示取不到有效值。
	TableContents []*BackupTableContent `json:"TableContents,omitnil,omitempty" name:"TableContents"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeBackUpJobRequest added in v1.0.736 

type DescribeBackUpJobRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 分页大小
	PageSize *int64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`

	// 页号
	PageNum *int64 `json:"PageNum,omitnil,omitempty" name:"PageNum"`

	// 开始时间
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// 结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

func NewDescribeBackUpJobRequest added in v1.0.736 

func NewDescribeBackUpJobRequest() (request *DescribeBackUpJobRequest)

func (*DescribeBackUpJobRequest) FromJsonString added in v1.0.736 

func (r *DescribeBackUpJobRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpJobRequest) ToJsonString added in v1.0.736 

func (r *DescribeBackUpJobRequest) ToJsonString() string

type DescribeBackUpJobRequestParams added in v1.0.736 

type DescribeBackUpJobRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 分页大小
	PageSize *int64 `json:"PageSize,omitnil,omitempty" name:"PageSize"`

	// 页号
	PageNum *int64 `json:"PageNum,omitnil,omitempty" name:"PageNum"`

	// 开始时间
	BeginTime *string `json:"BeginTime,omitnil,omitempty" name:"BeginTime"`

	// 结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

Predefined struct for user

type DescribeBackUpJobResponse added in v1.0.736 

type DescribeBackUpJobResponse struct {
	*tchttp.BaseResponse
	Response *DescribeBackUpJobResponseParams `json:"Response"`
}

func NewDescribeBackUpJobResponse added in v1.0.736 

func NewDescribeBackUpJobResponse() (response *DescribeBackUpJobResponse)

func (*DescribeBackUpJobResponse) FromJsonString added in v1.0.736 

func (r *DescribeBackUpJobResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpJobResponse) ToJsonString added in v1.0.736 

func (r *DescribeBackUpJobResponse) ToJsonString() string

type DescribeBackUpJobResponseParams added in v1.0.736 

type DescribeBackUpJobResponseParams struct {
	// 任务列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	BackUpJobs []*BackUpJobDisplay `json:"BackUpJobs,omitnil,omitempty" name:"BackUpJobs"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeBackUpScheduleRequest added in v1.0.589 

type DescribeBackUpScheduleRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeBackUpScheduleRequest added in v1.0.589 

func NewDescribeBackUpScheduleRequest() (request *DescribeBackUpScheduleRequest)

func (*DescribeBackUpScheduleRequest) FromJsonString added in v1.0.589 

func (r *DescribeBackUpScheduleRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpScheduleRequest) ToJsonString added in v1.0.589 

func (r *DescribeBackUpScheduleRequest) ToJsonString() string

type DescribeBackUpScheduleRequestParams added in v1.0.589 

type DescribeBackUpScheduleRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeBackUpScheduleResponse added in v1.0.589 

type DescribeBackUpScheduleResponse struct {
	*tchttp.BaseResponse
	Response *DescribeBackUpScheduleResponseParams `json:"Response"`
}

func NewDescribeBackUpScheduleResponse added in v1.0.589 

func NewDescribeBackUpScheduleResponse() (response *DescribeBackUpScheduleResponse)

func (*DescribeBackUpScheduleResponse) FromJsonString added in v1.0.589 

func (r *DescribeBackUpScheduleResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpScheduleResponse) ToJsonString added in v1.0.589 

func (r *DescribeBackUpScheduleResponse) ToJsonString() string

type DescribeBackUpScheduleResponseParams added in v1.0.589 

type DescribeBackUpScheduleResponseParams struct {
	// 备份是否开启
	BackUpOpened *bool `json:"BackUpOpened,omitnil,omitempty" name:"BackUpOpened"`

	// 元数据备份策略
	// 注意：此字段可能返回 null，表示取不到有效值。
	MetaStrategy *ScheduleStrategy `json:"MetaStrategy,omitnil,omitempty" name:"MetaStrategy"`

	// 表数据备份策略
	// 注意：此字段可能返回 null，表示取不到有效值。
	DataStrategy *ScheduleStrategy `json:"DataStrategy,omitnil,omitempty" name:"DataStrategy"`

	// 备份表列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	BackUpContents []*BackupTableContent `json:"BackUpContents,omitnil,omitempty" name:"BackUpContents"`

	// 备份的状态
	BackUpStatus *int64 `json:"BackUpStatus,omitnil,omitempty" name:"BackUpStatus"`

	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeBackUpTablesRequest added in v1.0.744 

type DescribeBackUpTablesRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeBackUpTablesRequest added in v1.0.744 

func NewDescribeBackUpTablesRequest() (request *DescribeBackUpTablesRequest)

func (*DescribeBackUpTablesRequest) FromJsonString added in v1.0.744 

func (r *DescribeBackUpTablesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpTablesRequest) ToJsonString added in v1.0.744 

func (r *DescribeBackUpTablesRequest) ToJsonString() string

type DescribeBackUpTablesRequestParams added in v1.0.744 

type DescribeBackUpTablesRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeBackUpTablesResponse added in v1.0.744 

type DescribeBackUpTablesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeBackUpTablesResponseParams `json:"Response"`
}

func NewDescribeBackUpTablesResponse added in v1.0.744 

func NewDescribeBackUpTablesResponse() (response *DescribeBackUpTablesResponse)

func (*DescribeBackUpTablesResponse) FromJsonString added in v1.0.744 

func (r *DescribeBackUpTablesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeBackUpTablesResponse) ToJsonString added in v1.0.744 

func (r *DescribeBackUpTablesResponse) ToJsonString() string

type DescribeBackUpTablesResponseParams added in v1.0.744 

type DescribeBackUpTablesResponseParams struct {
	// 可备份表列表
	AvailableTables []*BackupTableContent `json:"AvailableTables,omitnil,omitempty" name:"AvailableTables"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeCkSqlApisRequest 

type DescribeCkSqlApisRequest struct {
	*tchttp.BaseRequest

	// 实例id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// api接口名称,GetClusters:获取集群cluster列表
	// GetSystemUsers:获取系统用户列表
	// CheckNodeCluster: 检查节点是否隶属一个cluster
	// GetClusterDatabases: 获取一个cluster下的数据库列表
	// GetClusterTables: 获取一个cluster下的数据库表列表
	// GetPrivilegeUsers: 获取授权的用户列表
	// GET_USER_CLUSTER_PRIVILEGES:获取用户cluster下的权限
	// GetUserClusterNewPrivileges:获取用户cluster下的权限 (新版）
	// RevokeClusterUser:解绑cluster用户
	// DeleteSystemUser:删除系统用户 —— 必须所有cluster先解绑
	// GetUserOptionMessages:获取用户配置备注信息
	// GET_USER_CONFIGS:获取用户配置列表  QUOTA、PROFILE、POLICY
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// 集群名称，GET_SYSTEM_USERS，GET_PRIVILEGE_USERS，GET_CLUSTER_DATABASES，GET_CLUSTER_TABLES 必填
	Cluster *string `json:"Cluster,omitnil,omitempty" name:"Cluster"`

	// 用户名称，api与user相关的必填
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 账户的类型
	UserType *string `json:"UserType,omitnil,omitempty" name:"UserType"`
}

func NewDescribeCkSqlApisRequest 

func NewDescribeCkSqlApisRequest() (request *DescribeCkSqlApisRequest)

func (*DescribeCkSqlApisRequest) FromJsonString 

func (r *DescribeCkSqlApisRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCkSqlApisRequest) ToJsonString 

func (r *DescribeCkSqlApisRequest) ToJsonString() string

type DescribeCkSqlApisRequestParams 

type DescribeCkSqlApisRequestParams struct {
	// 实例id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// api接口名称,GetClusters:获取集群cluster列表
	// GetSystemUsers:获取系统用户列表
	// CheckNodeCluster: 检查节点是否隶属一个cluster
	// GetClusterDatabases: 获取一个cluster下的数据库列表
	// GetClusterTables: 获取一个cluster下的数据库表列表
	// GetPrivilegeUsers: 获取授权的用户列表
	// GET_USER_CLUSTER_PRIVILEGES:获取用户cluster下的权限
	// GetUserClusterNewPrivileges:获取用户cluster下的权限 (新版）
	// RevokeClusterUser:解绑cluster用户
	// DeleteSystemUser:删除系统用户 —— 必须所有cluster先解绑
	// GetUserOptionMessages:获取用户配置备注信息
	// GET_USER_CONFIGS:获取用户配置列表  QUOTA、PROFILE、POLICY
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// 集群名称，GET_SYSTEM_USERS，GET_PRIVILEGE_USERS，GET_CLUSTER_DATABASES，GET_CLUSTER_TABLES 必填
	Cluster *string `json:"Cluster,omitnil,omitempty" name:"Cluster"`

	// 用户名称，api与user相关的必填
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 账户的类型
	UserType *string `json:"UserType,omitnil,omitempty" name:"UserType"`
}

Predefined struct for user

type DescribeCkSqlApisResponse 

type DescribeCkSqlApisResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCkSqlApisResponseParams `json:"Response"`
}

func NewDescribeCkSqlApisResponse 

func NewDescribeCkSqlApisResponse() (response *DescribeCkSqlApisResponse)

func (*DescribeCkSqlApisResponse) FromJsonString 

func (r *DescribeCkSqlApisResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCkSqlApisResponse) ToJsonString 

func (r *DescribeCkSqlApisResponse) ToJsonString() string

type DescribeCkSqlApisResponseParams 

type DescribeCkSqlApisResponseParams struct {
	// 返回的查询数据，大部分情况是list，也可能是bool
	// 注意：此字段可能返回 null，表示取不到有效值。
	ReturnData *string `json:"ReturnData,omitnil,omitempty" name:"ReturnData"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeClusterConfigsRequest added in v1.0.589 

type DescribeClusterConfigsRequest struct {
	*tchttp.BaseRequest

	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeClusterConfigsRequest added in v1.0.589 

func NewDescribeClusterConfigsRequest() (request *DescribeClusterConfigsRequest)

func (*DescribeClusterConfigsRequest) FromJsonString added in v1.0.589 

func (r *DescribeClusterConfigsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeClusterConfigsRequest) ToJsonString added in v1.0.589 

func (r *DescribeClusterConfigsRequest) ToJsonString() string

type DescribeClusterConfigsRequestParams added in v1.0.589 

type DescribeClusterConfigsRequestParams struct {
	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeClusterConfigsResponse added in v1.0.589 

type DescribeClusterConfigsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeClusterConfigsResponseParams `json:"Response"`
}

func NewDescribeClusterConfigsResponse added in v1.0.589 

func NewDescribeClusterConfigsResponse() (response *DescribeClusterConfigsResponse)

func (*DescribeClusterConfigsResponse) FromJsonString added in v1.0.589 

func (r *DescribeClusterConfigsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeClusterConfigsResponse) ToJsonString added in v1.0.589 

func (r *DescribeClusterConfigsResponse) ToJsonString() string

type DescribeClusterConfigsResponseParams added in v1.0.589 

type DescribeClusterConfigsResponseParams struct {
	// 返回实例的配置文件相关的信息
	ClusterConfList []*ClusterConfigsInfoFromEMR `json:"ClusterConfList,omitnil,omitempty" name:"ClusterConfList"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceClustersRequest added in v1.0.617 

type DescribeInstanceClustersRequest struct {
	*tchttp.BaseRequest

	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceClustersRequest added in v1.0.617 

func NewDescribeInstanceClustersRequest() (request *DescribeInstanceClustersRequest)

func (*DescribeInstanceClustersRequest) FromJsonString added in v1.0.617 

func (r *DescribeInstanceClustersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceClustersRequest) ToJsonString added in v1.0.617 

func (r *DescribeInstanceClustersRequest) ToJsonString() string

type DescribeInstanceClustersRequestParams added in v1.0.617 

type DescribeInstanceClustersRequestParams struct {
	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceClustersResponse added in v1.0.617 

type DescribeInstanceClustersResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceClustersResponseParams `json:"Response"`
}

func NewDescribeInstanceClustersResponse added in v1.0.617 

func NewDescribeInstanceClustersResponse() (response *DescribeInstanceClustersResponse)

func (*DescribeInstanceClustersResponse) FromJsonString added in v1.0.617 

func (r *DescribeInstanceClustersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceClustersResponse) ToJsonString added in v1.0.617 

func (r *DescribeInstanceClustersResponse) ToJsonString() string

type DescribeInstanceClustersResponseParams added in v1.0.617 

type DescribeInstanceClustersResponseParams struct {
	// cluster列表
	Clusters []*ClusterInfo `json:"Clusters,omitnil,omitempty" name:"Clusters"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceKeyValConfigsRequest added in v1.0.589 

type DescribeInstanceKeyValConfigsRequest struct {
	*tchttp.BaseRequest

	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 搜索的配置项名称
	SearchConfigName *string `json:"SearchConfigName,omitnil,omitempty" name:"SearchConfigName"`
}

func NewDescribeInstanceKeyValConfigsRequest added in v1.0.589 

func NewDescribeInstanceKeyValConfigsRequest() (request *DescribeInstanceKeyValConfigsRequest)

func (*DescribeInstanceKeyValConfigsRequest) FromJsonString added in v1.0.589 

func (r *DescribeInstanceKeyValConfigsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceKeyValConfigsRequest) ToJsonString added in v1.0.589 

func (r *DescribeInstanceKeyValConfigsRequest) ToJsonString() string

type DescribeInstanceKeyValConfigsRequestParams added in v1.0.589 

type DescribeInstanceKeyValConfigsRequestParams struct {
	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 搜索的配置项名称
	SearchConfigName *string `json:"SearchConfigName,omitnil,omitempty" name:"SearchConfigName"`
}

Predefined struct for user

type DescribeInstanceKeyValConfigsResponse added in v1.0.589 

type DescribeInstanceKeyValConfigsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceKeyValConfigsResponseParams `json:"Response"`
}

func NewDescribeInstanceKeyValConfigsResponse added in v1.0.589 

func NewDescribeInstanceKeyValConfigsResponse() (response *DescribeInstanceKeyValConfigsResponse)

func (*DescribeInstanceKeyValConfigsResponse) FromJsonString added in v1.0.589 

func (r *DescribeInstanceKeyValConfigsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceKeyValConfigsResponse) ToJsonString added in v1.0.589 

func (r *DescribeInstanceKeyValConfigsResponse) ToJsonString() string

type DescribeInstanceKeyValConfigsResponseParams added in v1.0.589 

type DescribeInstanceKeyValConfigsResponseParams struct {
	// 参数列表
	ConfigItems []*InstanceConfigInfo `json:"ConfigItems,omitnil,omitempty" name:"ConfigItems"`

	// 未配置的参数列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	UnConfigItems []*InstanceConfigInfo `json:"UnConfigItems,omitnil,omitempty" name:"UnConfigItems"`

	// 配置的多层级参数列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	MapConfigItems []*MapConfigItem `json:"MapConfigItems,omitnil,omitempty" name:"MapConfigItems"`

	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceNodesRequest added in v1.0.833 

type DescribeInstanceNodesRequest struct {
	*tchttp.BaseRequest

	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 集群角色类型，默认为 "data"数据节点
	NodeRole *string `json:"NodeRole,omitnil,omitempty" name:"NodeRole"`

	// 分页参数，第一页为0，第二页为10
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页参数，分页步长，默认为10
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 展现策略，All时显示所有
	DisplayPolicy *string `json:"DisplayPolicy,omitnil,omitempty" name:"DisplayPolicy"`

	// 当true的时候返回所有节点，即Limit无限大
	ForceAll *bool `json:"ForceAll,omitnil,omitempty" name:"ForceAll"`
}

func NewDescribeInstanceNodesRequest added in v1.0.833 

func NewDescribeInstanceNodesRequest() (request *DescribeInstanceNodesRequest)

func (*DescribeInstanceNodesRequest) FromJsonString added in v1.0.833 

func (r *DescribeInstanceNodesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceNodesRequest) ToJsonString added in v1.0.833 

func (r *DescribeInstanceNodesRequest) ToJsonString() string

type DescribeInstanceNodesRequestParams added in v1.0.833 

type DescribeInstanceNodesRequestParams struct {
	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 集群角色类型，默认为 "data"数据节点
	NodeRole *string `json:"NodeRole,omitnil,omitempty" name:"NodeRole"`

	// 分页参数，第一页为0，第二页为10
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页参数，分页步长，默认为10
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 展现策略，All时显示所有
	DisplayPolicy *string `json:"DisplayPolicy,omitnil,omitempty" name:"DisplayPolicy"`

	// 当true的时候返回所有节点，即Limit无限大
	ForceAll *bool `json:"ForceAll,omitnil,omitempty" name:"ForceAll"`
}

Predefined struct for user

type DescribeInstanceNodesResponse added in v1.0.833 

type DescribeInstanceNodesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceNodesResponseParams `json:"Response"`
}

func NewDescribeInstanceNodesResponse added in v1.0.833 

func NewDescribeInstanceNodesResponse() (response *DescribeInstanceNodesResponse)

func (*DescribeInstanceNodesResponse) FromJsonString added in v1.0.833 

func (r *DescribeInstanceNodesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceNodesResponse) ToJsonString added in v1.0.833 

func (r *DescribeInstanceNodesResponse) ToJsonString() string

type DescribeInstanceNodesResponseParams added in v1.0.833 

type DescribeInstanceNodesResponseParams struct {
	// 总数
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 实例节点总数
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceNodesList []*InstanceNode `json:"InstanceNodesList,omitnil,omitempty" name:"InstanceNodesList"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceRequest added in v1.0.563 

type DescribeInstanceRequest struct {
	*tchttp.BaseRequest

	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 是否是open api查询
	IsOpenApi *bool `json:"IsOpenApi,omitnil,omitempty" name:"IsOpenApi"`
}

func NewDescribeInstanceRequest added in v1.0.563 

func NewDescribeInstanceRequest() (request *DescribeInstanceRequest)

func (*DescribeInstanceRequest) FromJsonString added in v1.0.563 

func (r *DescribeInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceRequest) ToJsonString added in v1.0.563 

func (r *DescribeInstanceRequest) ToJsonString() string

type DescribeInstanceRequestParams added in v1.0.563 

type DescribeInstanceRequestParams struct {
	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 是否是open api查询
	IsOpenApi *bool `json:"IsOpenApi,omitnil,omitempty" name:"IsOpenApi"`
}

Predefined struct for user

type DescribeInstanceResponse added in v1.0.563 

type DescribeInstanceResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceResponseParams `json:"Response"`
}

func NewDescribeInstanceResponse added in v1.0.563 

func NewDescribeInstanceResponse() (response *DescribeInstanceResponse)

func (*DescribeInstanceResponse) FromJsonString added in v1.0.563 

func (r *DescribeInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceResponse) ToJsonString added in v1.0.563 

func (r *DescribeInstanceResponse) ToJsonString() string

type DescribeInstanceResponseParams added in v1.0.563 

type DescribeInstanceResponseParams struct {
	// 实例描述信息
	InstanceInfo *InstanceInfo `json:"InstanceInfo,omitnil,omitempty" name:"InstanceInfo"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceShardsRequest 

type DescribeInstanceShardsRequest struct {
	*tchttp.BaseRequest

	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceShardsRequest 

func NewDescribeInstanceShardsRequest() (request *DescribeInstanceShardsRequest)

func (*DescribeInstanceShardsRequest) FromJsonString 

func (r *DescribeInstanceShardsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceShardsRequest) ToJsonString 

func (r *DescribeInstanceShardsRequest) ToJsonString() string

type DescribeInstanceShardsRequestParams 

type DescribeInstanceShardsRequestParams struct {
	// 集群实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceShardsResponse 

type DescribeInstanceShardsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceShardsResponseParams `json:"Response"`
}

func NewDescribeInstanceShardsResponse 

func NewDescribeInstanceShardsResponse() (response *DescribeInstanceShardsResponse)

func (*DescribeInstanceShardsResponse) FromJsonString 

func (r *DescribeInstanceShardsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceShardsResponse) ToJsonString 

func (r *DescribeInstanceShardsResponse) ToJsonString() string

type DescribeInstanceShardsResponseParams 

type DescribeInstanceShardsResponseParams struct {
	// 实例shard信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceShardsList *string `json:"InstanceShardsList,omitnil,omitempty" name:"InstanceShardsList"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceStateRequest added in v1.0.629 

type DescribeInstanceStateRequest struct {
	*tchttp.BaseRequest

	// 集群实例名称
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceStateRequest added in v1.0.629 

func NewDescribeInstanceStateRequest() (request *DescribeInstanceStateRequest)

func (*DescribeInstanceStateRequest) FromJsonString added in v1.0.629 

func (r *DescribeInstanceStateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceStateRequest) ToJsonString added in v1.0.629 

func (r *DescribeInstanceStateRequest) ToJsonString() string

type DescribeInstanceStateRequestParams added in v1.0.629 

type DescribeInstanceStateRequestParams struct {
	// 集群实例名称
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceStateResponse added in v1.0.629 

type DescribeInstanceStateResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceStateResponseParams `json:"Response"`
}

func NewDescribeInstanceStateResponse added in v1.0.629 

func NewDescribeInstanceStateResponse() (response *DescribeInstanceStateResponse)

func (*DescribeInstanceStateResponse) FromJsonString added in v1.0.629 

func (r *DescribeInstanceStateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceStateResponse) ToJsonString added in v1.0.629 

func (r *DescribeInstanceStateResponse) ToJsonString() string

type DescribeInstanceStateResponseParams added in v1.0.629 

type DescribeInstanceStateResponseParams struct {
	// 集群状态，例如：Serving
	InstanceState *string `json:"InstanceState,omitnil,omitempty" name:"InstanceState"`

	// 集群操作创建时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowCreateTime *string `json:"FlowCreateTime,omitnil,omitempty" name:"FlowCreateTime"`

	// 集群操作名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowName *string `json:"FlowName,omitnil,omitempty" name:"FlowName"`

	// 集群操作进度
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowProgress *float64 `json:"FlowProgress,omitnil,omitempty" name:"FlowProgress"`

	// 集群状态描述，例如：运行中
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceStateDesc *string `json:"InstanceStateDesc,omitnil,omitempty" name:"InstanceStateDesc"`

	// 集群流程错误信息，例如：“创建失败，资源不足”
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowMsg *string `json:"FlowMsg,omitnil,omitempty" name:"FlowMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstancesNewRequest added in v1.0.676 

type DescribeInstancesNewRequest struct {
	*tchttp.BaseRequest

	// 搜索的集群id名称
	SearchInstanceId *string `json:"SearchInstanceId,omitnil,omitempty" name:"SearchInstanceId"`

	// 搜索的集群name
	SearchInstanceName *string `json:"SearchInstanceName,omitnil,omitempty" name:"SearchInstanceName"`

	// 分页参数，第一页为0，第二页为10
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页参数，分页步长，默认为10
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 搜索标签列表
	SearchTags []*SearchTags `json:"SearchTags,omitnil,omitempty" name:"SearchTags"`

	// 信息详细与否
	IsSimple *bool `json:"IsSimple,omitnil,omitempty" name:"IsSimple"`
}

func NewDescribeInstancesNewRequest added in v1.0.676 

func NewDescribeInstancesNewRequest() (request *DescribeInstancesNewRequest)

func (*DescribeInstancesNewRequest) FromJsonString added in v1.0.676 

func (r *DescribeInstancesNewRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesNewRequest) ToJsonString added in v1.0.676 

func (r *DescribeInstancesNewRequest) ToJsonString() string

type DescribeInstancesNewRequestParams added in v1.0.676 

type DescribeInstancesNewRequestParams struct {
	// 搜索的集群id名称
	SearchInstanceId *string `json:"SearchInstanceId,omitnil,omitempty" name:"SearchInstanceId"`

	// 搜索的集群name
	SearchInstanceName *string `json:"SearchInstanceName,omitnil,omitempty" name:"SearchInstanceName"`

	// 分页参数，第一页为0，第二页为10
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页参数，分页步长，默认为10
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 搜索标签列表
	SearchTags []*SearchTags `json:"SearchTags,omitnil,omitempty" name:"SearchTags"`

	// 信息详细与否
	IsSimple *bool `json:"IsSimple,omitnil,omitempty" name:"IsSimple"`
}

Predefined struct for user

type DescribeInstancesNewResponse added in v1.0.676 

type DescribeInstancesNewResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstancesNewResponseParams `json:"Response"`
}

func NewDescribeInstancesNewResponse added in v1.0.676 

func NewDescribeInstancesNewResponse() (response *DescribeInstancesNewResponse)

func (*DescribeInstancesNewResponse) FromJsonString added in v1.0.676 

func (r *DescribeInstancesNewResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesNewResponse) ToJsonString added in v1.0.676 

func (r *DescribeInstancesNewResponse) ToJsonString() string

type DescribeInstancesNewResponseParams added in v1.0.676 

type DescribeInstancesNewResponseParams struct {
	// 实例总数
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 实例数组
	InstancesList []*InstanceInfo `json:"InstancesList,omitnil,omitempty" name:"InstancesList"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSpecRequest added in v1.0.548 

type DescribeSpecRequest struct {
	*tchttp.BaseRequest

	// 地域信息，例如"ap-guangzhou-1"
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 计费类型，PREPAID 包年包月，POSTPAID_BY_HOUR 按量计费
	PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// 是否弹性ck
	IsElastic *bool `json:"IsElastic,omitnil,omitempty" name:"IsElastic"`

	// 是否是购买页面需要的spec
	CaseType *int64 `json:"CaseType,omitnil,omitempty" name:"CaseType"`
}

func NewDescribeSpecRequest added in v1.0.548 

func NewDescribeSpecRequest() (request *DescribeSpecRequest)

func (*DescribeSpecRequest) FromJsonString added in v1.0.548 

func (r *DescribeSpecRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSpecRequest) ToJsonString added in v1.0.548 

func (r *DescribeSpecRequest) ToJsonString() string

type DescribeSpecRequestParams added in v1.0.548 

type DescribeSpecRequestParams struct {
	// 地域信息，例如"ap-guangzhou-1"
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 计费类型，PREPAID 包年包月，POSTPAID_BY_HOUR 按量计费
	PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// 是否弹性ck
	IsElastic *bool `json:"IsElastic,omitnil,omitempty" name:"IsElastic"`

	// 是否是购买页面需要的spec
	CaseType *int64 `json:"CaseType,omitnil,omitempty" name:"CaseType"`
}

Predefined struct for user

type DescribeSpecResponse added in v1.0.548 

type DescribeSpecResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSpecResponseParams `json:"Response"`
}

func NewDescribeSpecResponse added in v1.0.548 

func NewDescribeSpecResponse() (response *DescribeSpecResponse)

func (*DescribeSpecResponse) FromJsonString added in v1.0.548 

func (r *DescribeSpecResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSpecResponse) ToJsonString added in v1.0.548 

func (r *DescribeSpecResponse) ToJsonString() string

type DescribeSpecResponseParams added in v1.0.548 

type DescribeSpecResponseParams struct {
	// zookeeper节点规格描述
	CommonSpec []*ResourceSpec `json:"CommonSpec,omitnil,omitempty" name:"CommonSpec"`

	// 数据节点规格描述
	DataSpec []*ResourceSpec `json:"DataSpec,omitnil,omitempty" name:"DataSpec"`

	// 云盘列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	AttachCBSSpec []*DiskSpec `json:"AttachCBSSpec,omitnil,omitempty" name:"AttachCBSSpec"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DestroyInstanceRequest added in v1.0.590 

type DestroyInstanceRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDestroyInstanceRequest added in v1.0.590 

func NewDestroyInstanceRequest() (request *DestroyInstanceRequest)

func (*DestroyInstanceRequest) FromJsonString added in v1.0.590 

func (r *DestroyInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DestroyInstanceRequest) ToJsonString added in v1.0.590 

func (r *DestroyInstanceRequest) ToJsonString() string

type DestroyInstanceRequestParams added in v1.0.590 

type DestroyInstanceRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DestroyInstanceResponse added in v1.0.590 

type DestroyInstanceResponse struct {
	*tchttp.BaseResponse
	Response *DestroyInstanceResponseParams `json:"Response"`
}

func NewDestroyInstanceResponse added in v1.0.590 

func NewDestroyInstanceResponse() (response *DestroyInstanceResponse)

func (*DestroyInstanceResponse) FromJsonString added in v1.0.590 

func (r *DestroyInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DestroyInstanceResponse) ToJsonString added in v1.0.590 

func (r *DestroyInstanceResponse) ToJsonString() string

type DestroyInstanceResponseParams added in v1.0.590 

type DestroyInstanceResponseParams struct {
	// 作业id
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowID *string `json:"FlowID,omitnil,omitempty" name:"FlowID"`

	// 集群id
	InstanceID *string `json:"InstanceID,omitnil,omitempty" name:"InstanceID"`

	// 错误信息
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DiskSpec added in v1.0.548 

type DiskSpec struct {
	// 磁盘类型，例如“CLOUD_SSD", "LOCAL_SSD"等
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// 磁盘类型说明，例如"云SSD", "本地SSD"等
	DiskDesc *string `json:"DiskDesc,omitnil,omitempty" name:"DiskDesc"`

	// 磁盘最小规格大小，单位G
	MinDiskSize *int64 `json:"MinDiskSize,omitnil,omitempty" name:"MinDiskSize"`

	// 磁盘最大规格大小，单位G
	MaxDiskSize *int64 `json:"MaxDiskSize,omitnil,omitempty" name:"MaxDiskSize"`

	// 磁盘数目
	DiskCount *int64 `json:"DiskCount,omitnil,omitempty" name:"DiskCount"`
}

type GroupInfo added in v1.0.833 

type GroupInfo struct {
	// 分组名称
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// 分片变量名称
	ShardName *string `json:"ShardName,omitnil,omitempty" name:"ShardName"`

	// 副本变量名称
	ReplicaName *string `json:"ReplicaName,omitnil,omitempty" name:"ReplicaName"`
}

type InstanceConfigInfo added in v1.0.589 

type InstanceConfigInfo struct {
	// 配置项名称
	ConfKey *string `json:"ConfKey,omitnil,omitempty" name:"ConfKey"`

	// 配置项内容
	ConfValue *string `json:"ConfValue,omitnil,omitempty" name:"ConfValue"`

	// 默认值
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// 是否需要重启
	NeedRestart *bool `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"`

	// 是否可编辑
	Editable *bool `json:"Editable,omitnil,omitempty" name:"Editable"`

	// 配置项解释
	ConfDesc *string `json:"ConfDesc,omitnil,omitempty" name:"ConfDesc"`

	// 文件名称
	FileName *string `json:"FileName,omitnil,omitempty" name:"FileName"`

	// 规则名称类型
	ModifyRuleType *string `json:"ModifyRuleType,omitnil,omitempty" name:"ModifyRuleType"`

	// 规则名称内容
	ModifyRuleValue *string `json:"ModifyRuleValue,omitnil,omitempty" name:"ModifyRuleValue"`

	// 修改人的uin
	Uin *string `json:"Uin,omitnil,omitempty" name:"Uin"`

	// 修改时间
	ModifyTime *string `json:"ModifyTime,omitnil,omitempty" name:"ModifyTime"`
}

type InstanceConfigItem added in v1.0.589 

type InstanceConfigItem struct {
	// key
	ConfKey *string `json:"ConfKey,omitnil,omitempty" name:"ConfKey"`

	// value
	ConfValue *string `json:"ConfValue,omitnil,omitempty" name:"ConfValue"`
}

type InstanceDetail added in v1.0.970 

type InstanceDetail struct {
	// 告警策略是否可用
	// 注意：此字段可能返回 null，表示取不到有效值。
	EnableAlarmStrategy *bool `json:"EnableAlarmStrategy,omitnil,omitempty" name:"EnableAlarmStrategy"`
}

type InstanceInfo added in v1.0.563 

type InstanceInfo struct {
	// 集群实例ID, "cdw-xxxx" 字符串类型
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 集群实例名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 状态,
	// Init 创建中; Serving 运行中；
	// Deleted已销毁；Deleting 销毁中；
	// Modify 集群变更中；
	// 注意：此字段可能返回 null，表示取不到有效值。
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 版本
	// 注意：此字段可能返回 null，表示取不到有效值。
	Version *string `json:"Version,omitnil,omitempty" name:"Version"`

	// 地域, ap-guangzhou
	// 注意：此字段可能返回 null，表示取不到有效值。
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// 可用区， ap-guangzhou-3
	// 注意：此字段可能返回 null，表示取不到有效值。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 私有网络名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 子网名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 付费类型，"hour", "prepay"
	// 注意：此字段可能返回 null，表示取不到有效值。
	PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// 创建时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 过期时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// 数据节点描述信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	MasterSummary *NodesSummary `json:"MasterSummary,omitnil,omitempty" name:"MasterSummary"`

	// zookeeper节点描述信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	CommonSummary *NodesSummary `json:"CommonSummary,omitnil,omitempty" name:"CommonSummary"`

	// 高可用，“true" "false"
	// 注意：此字段可能返回 null，表示取不到有效值。
	HA *string `json:"HA,omitnil,omitempty" name:"HA"`

	// 访问地址，例如 "10.0.0.1:9000"
	// 注意：此字段可能返回 null，表示取不到有效值。
	AccessInfo *string `json:"AccessInfo,omitnil,omitempty" name:"AccessInfo"`

	// 记录ID，数值型
	// 注意：此字段可能返回 null，表示取不到有效值。
	Id *int64 `json:"Id,omitnil,omitempty" name:"Id"`

	// regionId, 表示地域
	// 注意：此字段可能返回 null，表示取不到有效值。
	RegionId *int64 `json:"RegionId,omitnil,omitempty" name:"RegionId"`

	// 可用区说明，例如 "广州二区"
	// 注意：此字段可能返回 null，表示取不到有效值。
	ZoneDesc *string `json:"ZoneDesc,omitnil,omitempty" name:"ZoneDesc"`

	// 错误流程说明信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowMsg *string `json:"FlowMsg,omitnil,omitempty" name:"FlowMsg"`

	// 状态描述，例如“运行中”等
	// 注意：此字段可能返回 null，表示取不到有效值。
	StatusDesc *string `json:"StatusDesc,omitnil,omitempty" name:"StatusDesc"`

	// 自动续费标记
	// 注意：此字段可能返回 null，表示取不到有效值。
	RenewFlag *bool `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`

	// 标签列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 监控信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	Monitor *string `json:"Monitor,omitnil,omitempty" name:"Monitor"`

	// 是否开通日志
	// 注意：此字段可能返回 null，表示取不到有效值。
	HasClsTopic *bool `json:"HasClsTopic,omitnil,omitempty" name:"HasClsTopic"`

	// 日志主题ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	ClsTopicId *string `json:"ClsTopicId,omitnil,omitempty" name:"ClsTopicId"`

	// 日志集ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	ClsLogSetId *string `json:"ClsLogSetId,omitnil,omitempty" name:"ClsLogSetId"`

	// 是否支持xml配置管理
	// 注意：此字段可能返回 null，表示取不到有效值。
	EnableXMLConfig *int64 `json:"EnableXMLConfig,omitnil,omitempty" name:"EnableXMLConfig"`

	// 区域
	// 注意：此字段可能返回 null，表示取不到有效值。
	RegionDesc *string `json:"RegionDesc,omitnil,omitempty" name:"RegionDesc"`

	// 弹性网卡地址
	// 注意：此字段可能返回 null，表示取不到有效值。
	Eip *string `json:"Eip,omitnil,omitempty" name:"Eip"`

	// 冷热分层系数
	// 注意：此字段可能返回 null，表示取不到有效值。
	CosMoveFactor *int64 `json:"CosMoveFactor,omitnil,omitempty" name:"CosMoveFactor"`

	// external/local/yunti
	// 注意：此字段可能返回 null，表示取不到有效值。
	Kind *string `json:"Kind,omitnil,omitempty" name:"Kind"`

	// 是否弹性ck
	// 注意：此字段可能返回 null，表示取不到有效值。
	IsElastic *bool `json:"IsElastic,omitnil,omitempty" name:"IsElastic"`

	// 集群详细状态
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceStateInfo *InstanceStateInfo `json:"InstanceStateInfo,omitnil,omitempty" name:"InstanceStateInfo"`

	// ZK高可用
	// 注意：此字段可能返回 null，表示取不到有效值。
	HAZk *bool `json:"HAZk,omitnil,omitempty" name:"HAZk"`

	// 挂载盘,默认0:没有类型；1:裸盘;2:lvm
	// 注意：此字段可能返回 null，表示取不到有效值。
	MountDiskType *int64 `json:"MountDiskType,omitnil,omitempty" name:"MountDiskType"`

	// 无
	// 注意：此字段可能返回 null，表示取不到有效值。
	CHProxyVip *string `json:"CHProxyVip,omitnil,omitempty" name:"CHProxyVip"`

	// cos buket的名字
	// 注意：此字段可能返回 null，表示取不到有效值。
	CosBucketName *string `json:"CosBucketName,omitnil,omitempty" name:"CosBucketName"`

	// 是否可以挂载云盘
	// 注意：此字段可能返回 null，表示取不到有效值。
	CanAttachCbs *bool `json:"CanAttachCbs,omitnil,omitempty" name:"CanAttachCbs"`

	// 是否可以挂载云盘阵列
	// 注意：此字段可能返回 null，表示取不到有效值。
	CanAttachCbsLvm *bool `json:"CanAttachCbsLvm,omitnil,omitempty" name:"CanAttachCbsLvm"`

	// 是否可以挂载cos
	// 注意：此字段可能返回 null，表示取不到有效值。
	CanAttachCos *bool `json:"CanAttachCos,omitnil,omitempty" name:"CanAttachCos"`

	// 服务信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	Components []*ServiceInfo `json:"Components,omitnil,omitempty" name:"Components"`

	// 可升级的内核版本
	// 注意：此字段可能返回 null，表示取不到有效值。
	UpgradeVersions *string `json:"UpgradeVersions,omitnil,omitempty" name:"UpgradeVersions"`

	// ex-index
	// 注意：此字段可能返回 null，表示取不到有效值。
	EsIndexId *string `json:"EsIndexId,omitnil,omitempty" name:"EsIndexId"`

	// username
	// 注意：此字段可能返回 null，表示取不到有效值。
	EsIndexUsername *string `json:"EsIndexUsername,omitnil,omitempty" name:"EsIndexUsername"`

	// password
	// 注意：此字段可能返回 null，表示取不到有效值。
	EsIndexPassword *string `json:"EsIndexPassword,omitnil,omitempty" name:"EsIndexPassword"`

	// true
	// 注意：此字段可能返回 null，表示取不到有效值。
	HasEsIndex *bool `json:"HasEsIndex,omitnil,omitempty" name:"HasEsIndex"`

	// true
	// 注意：此字段可能返回 null，表示取不到有效值。
	IsSecondaryZone *bool `json:"IsSecondaryZone,omitnil,omitempty" name:"IsSecondaryZone"`

	// desc
	// 注意：此字段可能返回 null，表示取不到有效值。
	SecondaryZoneInfo *string `json:"SecondaryZoneInfo,omitnil,omitempty" name:"SecondaryZoneInfo"`

	// 是否clickhouse-keeper
	// 注意：此字段可能返回 null，表示取不到有效值。
	ClickHouseKeeper *bool `json:"ClickHouseKeeper,omitnil,omitempty" name:"ClickHouseKeeper"`

	// 实例扩展信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	Details *InstanceDetail `json:"Details,omitnil,omitempty" name:"Details"`

	// 安全组白名单
	// 注意：此字段可能返回 null，表示取不到有效值。
	IsWhiteSGs *bool `json:"IsWhiteSGs,omitnil,omitempty" name:"IsWhiteSGs"`

	// 绑定的安全组
	// 注意：此字段可能返回 null，表示取不到有效值。
	BindSGs []*string `json:"BindSGs,omitnil,omitempty" name:"BindSGs"`
}

type InstanceNode added in v1.0.833 

type InstanceNode struct {
	// IP地址
	Ip *string `json:"Ip,omitnil,omitempty" name:"Ip"`

	// 机型，如 S1
	Spec *string `json:"Spec,omitnil,omitempty" name:"Spec"`

	// cpu核数
	Core *int64 `json:"Core,omitnil,omitempty" name:"Core"`

	// 内存大小
	Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 磁盘类型
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// 磁盘大小
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// 所属clickhouse cluster名称
	Cluster *string `json:"Cluster,omitnil,omitempty" name:"Cluster"`

	// 节点所属的分组信息
	NodeGroups []*GroupInfo `json:"NodeGroups,omitnil,omitempty" name:"NodeGroups"`

	// VPC IP
	// 注意：此字段可能返回 null，表示取不到有效值。
	Rip *string `json:"Rip,omitnil,omitempty" name:"Rip"`

	// ture的时候表示该节点上部署了chproxy进程
	// 注意：此字段可能返回 null，表示取不到有效值。
	IsCHProxy *bool `json:"IsCHProxy,omitnil,omitempty" name:"IsCHProxy"`
}

type InstanceStateInfo added in v1.0.618 

type InstanceStateInfo struct {
	// 集群状态，例如：Serving
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceState *string `json:"InstanceState,omitnil,omitempty" name:"InstanceState"`

	// 集群操作创建时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowCreateTime *string `json:"FlowCreateTime,omitnil,omitempty" name:"FlowCreateTime"`

	// 集群操作名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowName *string `json:"FlowName,omitnil,omitempty" name:"FlowName"`

	// 集群操作进度
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowProgress *int64 `json:"FlowProgress,omitnil,omitempty" name:"FlowProgress"`

	// 集群状态描述，例如：运行中
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceStateDesc *string `json:"InstanceStateDesc,omitnil,omitempty" name:"InstanceStateDesc"`

	// 集群流程错误信息，例如：“创建失败，资源不足”
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowMsg *string `json:"FlowMsg,omitnil,omitempty" name:"FlowMsg"`

	// 当前步骤的名称，例如：”购买资源中“
	// 注意：此字段可能返回 null，表示取不到有效值。
	ProcessName *string `json:"ProcessName,omitnil,omitempty" name:"ProcessName"`

	// 请求id
	// 注意：此字段可能返回 null，表示取不到有效值。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`

	// 流程的二级名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	ProcessSubName *string `json:"ProcessSubName,omitnil,omitempty" name:"ProcessSubName"`
}

type MapConfigItem added in v1.0.589 

type MapConfigItem struct {
	// key
	ConfKey *string `json:"ConfKey,omitnil,omitempty" name:"ConfKey"`

	// 列表
	Items []*InstanceConfigInfo `json:"Items,omitnil,omitempty" name:"Items"`
}

type ModifyClusterConfigsRequest 

type ModifyClusterConfigsRequest struct {
	*tchttp.BaseRequest

	// 集群ID，例如cdwch-xxxx
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 配置文件修改信息
	ModifyConfContext []*ConfigSubmitContext `json:"ModifyConfContext,omitnil,omitempty" name:"ModifyConfContext"`

	// 修改原因
	Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}

func NewModifyClusterConfigsRequest 

func NewModifyClusterConfigsRequest() (request *ModifyClusterConfigsRequest)

func (*ModifyClusterConfigsRequest) FromJsonString 

func (r *ModifyClusterConfigsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyClusterConfigsRequest) ToJsonString 

func (r *ModifyClusterConfigsRequest) ToJsonString() string

type ModifyClusterConfigsRequestParams 

type ModifyClusterConfigsRequestParams struct {
	// 集群ID，例如cdwch-xxxx
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 配置文件修改信息
	ModifyConfContext []*ConfigSubmitContext `json:"ModifyConfContext,omitnil,omitempty" name:"ModifyConfContext"`

	// 修改原因
	Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}

Predefined struct for user

type ModifyClusterConfigsResponse 

type ModifyClusterConfigsResponse struct {
	*tchttp.BaseResponse
	Response *ModifyClusterConfigsResponseParams `json:"Response"`
}

func NewModifyClusterConfigsResponse 

func NewModifyClusterConfigsResponse() (response *ModifyClusterConfigsResponse)

func (*ModifyClusterConfigsResponse) FromJsonString 

func (r *ModifyClusterConfigsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyClusterConfigsResponse) ToJsonString 

func (r *ModifyClusterConfigsResponse) ToJsonString() string

type ModifyClusterConfigsResponseParams 

type ModifyClusterConfigsResponseParams struct {
	// 流程相关信息
	FlowId *int64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// 错误信息
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyInstanceKeyValConfigsRequest added in v1.0.589 

type ModifyInstanceKeyValConfigsRequest struct {
	*tchttp.BaseRequest

	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 新增配置列表
	AddItems []*InstanceConfigItem `json:"AddItems,omitnil,omitempty" name:"AddItems"`

	// 更新配置列表
	UpdateItems []*InstanceConfigItem `json:"UpdateItems,omitnil,omitempty" name:"UpdateItems"`

	// 删除配置列表
	DeleteItems *InstanceConfigItem `json:"DeleteItems,omitnil,omitempty" name:"DeleteItems"`

	// 删除配置列表
	DelItems []*InstanceConfigItem `json:"DelItems,omitnil,omitempty" name:"DelItems"`

	// 备注
	Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}

func NewModifyInstanceKeyValConfigsRequest added in v1.0.589 

func NewModifyInstanceKeyValConfigsRequest() (request *ModifyInstanceKeyValConfigsRequest)

func (*ModifyInstanceKeyValConfigsRequest) FromJsonString added in v1.0.589 

func (r *ModifyInstanceKeyValConfigsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInstanceKeyValConfigsRequest) ToJsonString added in v1.0.589 

func (r *ModifyInstanceKeyValConfigsRequest) ToJsonString() string

type ModifyInstanceKeyValConfigsRequestParams added in v1.0.589 

type ModifyInstanceKeyValConfigsRequestParams struct {
	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 新增配置列表
	AddItems []*InstanceConfigItem `json:"AddItems,omitnil,omitempty" name:"AddItems"`

	// 更新配置列表
	UpdateItems []*InstanceConfigItem `json:"UpdateItems,omitnil,omitempty" name:"UpdateItems"`

	// 删除配置列表
	DeleteItems *InstanceConfigItem `json:"DeleteItems,omitnil,omitempty" name:"DeleteItems"`

	// 删除配置列表
	DelItems []*InstanceConfigItem `json:"DelItems,omitnil,omitempty" name:"DelItems"`

	// 备注
	Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}

Predefined struct for user

type ModifyInstanceKeyValConfigsResponse added in v1.0.589 

type ModifyInstanceKeyValConfigsResponse struct {
	*tchttp.BaseResponse
	Response *ModifyInstanceKeyValConfigsResponseParams `json:"Response"`
}

func NewModifyInstanceKeyValConfigsResponse added in v1.0.589 

func NewModifyInstanceKeyValConfigsResponse() (response *ModifyInstanceKeyValConfigsResponse)

func (*ModifyInstanceKeyValConfigsResponse) FromJsonString added in v1.0.589 

func (r *ModifyInstanceKeyValConfigsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInstanceKeyValConfigsResponse) ToJsonString added in v1.0.589 

func (r *ModifyInstanceKeyValConfigsResponse) ToJsonString() string

type ModifyInstanceKeyValConfigsResponseParams added in v1.0.589 

type ModifyInstanceKeyValConfigsResponseParams struct {
	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// ID
	FlowId *int64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyUserNewPrivilegeRequest 

type ModifyUserNewPrivilegeRequest struct {
	*tchttp.BaseRequest

	// 实例id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// cluster名称
	Cluster *string `json:"Cluster,omitnil,omitempty" name:"Cluster"`

	// 用户名
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 是否所有数据库表
	AllDatabase *bool `json:"AllDatabase,omitnil,omitempty" name:"AllDatabase"`

	// 全局权限
	GlobalPrivileges []*string `json:"GlobalPrivileges,omitnil,omitempty" name:"GlobalPrivileges"`

	// 数据库表权限
	DatabasePrivilegeList []*DatabasePrivilegeInfo `json:"DatabasePrivilegeList,omitnil,omitempty" name:"DatabasePrivilegeList"`
}

func NewModifyUserNewPrivilegeRequest 

func NewModifyUserNewPrivilegeRequest() (request *ModifyUserNewPrivilegeRequest)

func (*ModifyUserNewPrivilegeRequest) FromJsonString 

func (r *ModifyUserNewPrivilegeRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUserNewPrivilegeRequest) ToJsonString 

func (r *ModifyUserNewPrivilegeRequest) ToJsonString() string

type ModifyUserNewPrivilegeRequestParams 

type ModifyUserNewPrivilegeRequestParams struct {
	// 实例id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// cluster名称
	Cluster *string `json:"Cluster,omitnil,omitempty" name:"Cluster"`

	// 用户名
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 是否所有数据库表
	AllDatabase *bool `json:"AllDatabase,omitnil,omitempty" name:"AllDatabase"`

	// 全局权限
	GlobalPrivileges []*string `json:"GlobalPrivileges,omitnil,omitempty" name:"GlobalPrivileges"`

	// 数据库表权限
	DatabasePrivilegeList []*DatabasePrivilegeInfo `json:"DatabasePrivilegeList,omitnil,omitempty" name:"DatabasePrivilegeList"`
}

Predefined struct for user

type ModifyUserNewPrivilegeResponse 

type ModifyUserNewPrivilegeResponse struct {
	*tchttp.BaseResponse
	Response *ModifyUserNewPrivilegeResponseParams `json:"Response"`
}

func NewModifyUserNewPrivilegeResponse 

func NewModifyUserNewPrivilegeResponse() (response *ModifyUserNewPrivilegeResponse)

func (*ModifyUserNewPrivilegeResponse) FromJsonString 

func (r *ModifyUserNewPrivilegeResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUserNewPrivilegeResponse) ToJsonString 

func (r *ModifyUserNewPrivilegeResponse) ToJsonString() string

type ModifyUserNewPrivilegeResponseParams 

type ModifyUserNewPrivilegeResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type NodeSpec added in v1.0.563 

type NodeSpec struct {
	// 规格名称
	SpecName *string `json:"SpecName,omitnil,omitempty" name:"SpecName"`

	// 数量
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`

	// 云盘大小
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`
}

type NodesSummary added in v1.0.563 

type NodesSummary struct {
	// 机型，如 S1
	Spec *string `json:"Spec,omitnil,omitempty" name:"Spec"`

	// 节点数目
	NodeSize *int64 `json:"NodeSize,omitnil,omitempty" name:"NodeSize"`

	// cpu核数，单位个
	Core *int64 `json:"Core,omitnil,omitempty" name:"Core"`

	// 内存大小，单位G
	Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 磁盘大小，单位G
	Disk *int64 `json:"Disk,omitnil,omitempty" name:"Disk"`

	// 磁盘类型
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// 磁盘描述
	DiskDesc *string `json:"DiskDesc,omitnil,omitempty" name:"DiskDesc"`

	// 挂载云盘信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	AttachCBSSpec *AttachCBSSpec `json:"AttachCBSSpec,omitnil,omitempty" name:"AttachCBSSpec"`

	// 子产品类型
	// 注意：此字段可能返回 null，表示取不到有效值。
	SubProductType *string `json:"SubProductType,omitnil,omitempty" name:"SubProductType"`

	// 规格对应的核数
	// 注意：此字段可能返回 null，表示取不到有效值。
	SpecCore *int64 `json:"SpecCore,omitnil,omitempty" name:"SpecCore"`

	// 规格对应的内存大小
	// 注意：此字段可能返回 null，表示取不到有效值。
	SpecMemory *int64 `json:"SpecMemory,omitnil,omitempty" name:"SpecMemory"`

	// 磁盘的数量
	// 注意：此字段可能返回 null，表示取不到有效值。
	DiskCount *int64 `json:"DiskCount,omitnil,omitempty" name:"DiskCount"`

	// 磁盘的最大大小
	// 注意：此字段可能返回 null，表示取不到有效值。
	MaxDiskSize *int64 `json:"MaxDiskSize,omitnil,omitempty" name:"MaxDiskSize"`

	// 是否为加密云盘
	// 注意：此字段可能返回 null，表示取不到有效值。
	Encrypt *int64 `json:"Encrypt,omitnil,omitempty" name:"Encrypt"`
}

type OpenBackUpRequest 

type OpenBackUpRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// OPEN 或者CLOSE
	OperationType *string `json:"OperationType,omitnil,omitempty" name:"OperationType"`

	// 桶名字
	CosBucketName *string `json:"CosBucketName,omitnil,omitempty" name:"CosBucketName"`
}

func NewOpenBackUpRequest 

func NewOpenBackUpRequest() (request *OpenBackUpRequest)

func (*OpenBackUpRequest) FromJsonString 

func (r *OpenBackUpRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OpenBackUpRequest) ToJsonString 

func (r *OpenBackUpRequest) ToJsonString() string

type OpenBackUpRequestParams 

type OpenBackUpRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// OPEN 或者CLOSE
	OperationType *string `json:"OperationType,omitnil,omitempty" name:"OperationType"`

	// 桶名字
	CosBucketName *string `json:"CosBucketName,omitnil,omitempty" name:"CosBucketName"`
}

Predefined struct for user

type OpenBackUpResponse 

type OpenBackUpResponse struct {
	*tchttp.BaseResponse
	Response *OpenBackUpResponseParams `json:"Response"`
}

func NewOpenBackUpResponse 

func NewOpenBackUpResponse() (response *OpenBackUpResponse)

func (*OpenBackUpResponse) FromJsonString 

func (r *OpenBackUpResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OpenBackUpResponse) ToJsonString 

func (r *OpenBackUpResponse) ToJsonString() string

type OpenBackUpResponseParams 

type OpenBackUpResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RecoverBackUpJobRequest added in v1.0.736 

type RecoverBackUpJobRequest struct {
	*tchttp.BaseRequest

	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 任务id
	BackUpJobId *int64 `json:"BackUpJobId,omitnil,omitempty" name:"BackUpJobId"`
}

func NewRecoverBackUpJobRequest added in v1.0.736 

func NewRecoverBackUpJobRequest() (request *RecoverBackUpJobRequest)

func (*RecoverBackUpJobRequest) FromJsonString added in v1.0.736 

func (r *RecoverBackUpJobRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RecoverBackUpJobRequest) ToJsonString added in v1.0.736 

func (r *RecoverBackUpJobRequest) ToJsonString() string

type RecoverBackUpJobRequestParams added in v1.0.736 

type RecoverBackUpJobRequestParams struct {
	// 集群id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 任务id
	BackUpJobId *int64 `json:"BackUpJobId,omitnil,omitempty" name:"BackUpJobId"`
}

Predefined struct for user

type RecoverBackUpJobResponse added in v1.0.736 

type RecoverBackUpJobResponse struct {
	*tchttp.BaseResponse
	Response *RecoverBackUpJobResponseParams `json:"Response"`
}

func NewRecoverBackUpJobResponse added in v1.0.736 

func NewRecoverBackUpJobResponse() (response *RecoverBackUpJobResponse)

func (*RecoverBackUpJobResponse) FromJsonString added in v1.0.736 

func (r *RecoverBackUpJobResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RecoverBackUpJobResponse) ToJsonString added in v1.0.736 

func (r *RecoverBackUpJobResponse) ToJsonString() string

type RecoverBackUpJobResponseParams added in v1.0.736 

type RecoverBackUpJobResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ResizeDiskRequest added in v1.0.589 

type ResizeDiskRequest struct {
	*tchttp.BaseRequest

	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 磁盘扩容后容量，不能小于原有用量。clickhouse最小200，且为100的整数倍。 zk最小100，且为10的整数倍；
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`
}

func NewResizeDiskRequest added in v1.0.589 

func NewResizeDiskRequest() (request *ResizeDiskRequest)

func (*ResizeDiskRequest) FromJsonString added in v1.0.589 

func (r *ResizeDiskRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ResizeDiskRequest) ToJsonString added in v1.0.589 

func (r *ResizeDiskRequest) ToJsonString() string

type ResizeDiskRequestParams added in v1.0.589 

type ResizeDiskRequestParams struct {
	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 磁盘扩容后容量，不能小于原有用量。clickhouse最小200，且为100的整数倍。 zk最小100，且为10的整数倍；
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`
}

Predefined struct for user

type ResizeDiskResponse added in v1.0.589 

type ResizeDiskResponse struct {
	*tchttp.BaseResponse
	Response *ResizeDiskResponseParams `json:"Response"`
}

func NewResizeDiskResponse added in v1.0.589 

func NewResizeDiskResponse() (response *ResizeDiskResponse)

func (*ResizeDiskResponse) FromJsonString added in v1.0.589 

func (r *ResizeDiskResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ResizeDiskResponse) ToJsonString added in v1.0.589 

func (r *ResizeDiskResponse) ToJsonString() string

type ResizeDiskResponseParams added in v1.0.589 

type ResizeDiskResponseParams struct {
	// 流程ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowId *string `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// 实例ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ResourceSpec added in v1.0.548 

type ResourceSpec struct {
	// 规格名称，例如“SCH1"
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// cpu核数
	Cpu *int64 `json:"Cpu,omitnil,omitempty" name:"Cpu"`

	// 内存大小，单位G
	Mem *int64 `json:"Mem,omitnil,omitempty" name:"Mem"`

	// 分类标记，STANDARD/BIGDATA/HIGHIO分别表示标准型/大数据型/高IO
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 系统盘描述信息
	SystemDisk *DiskSpec `json:"SystemDisk,omitnil,omitempty" name:"SystemDisk"`

	// 数据盘描述信息
	DataDisk *DiskSpec `json:"DataDisk,omitnil,omitempty" name:"DataDisk"`

	// 最大节点数目限制
	MaxNodeSize *int64 `json:"MaxNodeSize,omitnil,omitempty" name:"MaxNodeSize"`

	// 是否可用，false代表售罄
	// 注意：此字段可能返回 null，表示取不到有效值。
	Available *bool `json:"Available,omitnil,omitempty" name:"Available"`

	// 规格描述信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ComputeSpecDesc *string `json:"ComputeSpecDesc,omitnil,omitempty" name:"ComputeSpecDesc"`

	// 规格名
	// 注意：此字段可能返回 null，表示取不到有效值。
	DisplayName *string `json:"DisplayName,omitnil,omitempty" name:"DisplayName"`

	// 库存数
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceQuota *int64 `json:"InstanceQuota,omitnil,omitempty" name:"InstanceQuota"`
}

type ScaleCNOutUpInstanceRequest added in v1.0.1046 

type ScaleCNOutUpInstanceRequest struct {
	*tchttp.BaseRequest

	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// warehouse名称
	VirtualCluster *string `json:"VirtualCluster,omitnil,omitempty" name:"VirtualCluster"`

	// 子网id
	UserSubnetID *string `json:"UserSubnetID,omitnil,omitempty" name:"UserSubnetID"`

	// 新的warehouse的个数
	NewCount *int64 `json:"NewCount,omitnil,omitempty" name:"NewCount"`

	// 集群的规格2X-Small、X-Small、Small
	NewSpecName *string `json:"NewSpecName,omitnil,omitempty" name:"NewSpecName"`
}

func NewScaleCNOutUpInstanceRequest added in v1.0.1046 

func NewScaleCNOutUpInstanceRequest() (request *ScaleCNOutUpInstanceRequest)

func (*ScaleCNOutUpInstanceRequest) FromJsonString added in v1.0.1046 

func (r *ScaleCNOutUpInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScaleCNOutUpInstanceRequest) ToJsonString added in v1.0.1046 

func (r *ScaleCNOutUpInstanceRequest) ToJsonString() string

type ScaleCNOutUpInstanceRequestParams added in v1.0.1046 

type ScaleCNOutUpInstanceRequestParams struct {
	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// warehouse名称
	VirtualCluster *string `json:"VirtualCluster,omitnil,omitempty" name:"VirtualCluster"`

	// 子网id
	UserSubnetID *string `json:"UserSubnetID,omitnil,omitempty" name:"UserSubnetID"`

	// 新的warehouse的个数
	NewCount *int64 `json:"NewCount,omitnil,omitempty" name:"NewCount"`

	// 集群的规格2X-Small、X-Small、Small
	NewSpecName *string `json:"NewSpecName,omitnil,omitempty" name:"NewSpecName"`
}

Predefined struct for user

type ScaleCNOutUpInstanceResponse added in v1.0.1046 

type ScaleCNOutUpInstanceResponse struct {
	*tchttp.BaseResponse
	Response *ScaleCNOutUpInstanceResponseParams `json:"Response"`
}

func NewScaleCNOutUpInstanceResponse added in v1.0.1046 

func NewScaleCNOutUpInstanceResponse() (response *ScaleCNOutUpInstanceResponse)

func (*ScaleCNOutUpInstanceResponse) FromJsonString added in v1.0.1046 

func (r *ScaleCNOutUpInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScaleCNOutUpInstanceResponse) ToJsonString added in v1.0.1046 

func (r *ScaleCNOutUpInstanceResponse) ToJsonString() string

type ScaleCNOutUpInstanceResponseParams added in v1.0.1046 

type ScaleCNOutUpInstanceResponseParams struct {
	// 流程ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowId *string `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// 实例ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ScaleOutInstanceRequest added in v1.0.589 

type ScaleOutInstanceRequest struct {
	*tchttp.BaseRequest

	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 调整clickhouse节点数量
	NodeCount *int64 `json:"NodeCount,omitnil,omitempty" name:"NodeCount"`

	// v_cluster分组，
	// 新增扩容节点将加入到已选择的v_cluster分组中，提交同步VIP生效.
	ScaleOutCluster *string `json:"ScaleOutCluster,omitnil,omitempty" name:"ScaleOutCluster"`

	// 子网剩余ip数量，用于判断当前实例子网剩余ip数是否能扩容。需要根据实际填写
	UserSubnetIPNum *int64 `json:"UserSubnetIPNum,omitnil,omitempty" name:"UserSubnetIPNum"`

	// 同步元数据节点IP （uip），扩容的时候必填
	ScaleOutNodeIp *string `json:"ScaleOutNodeIp,omitnil,omitempty" name:"ScaleOutNodeIp"`

	// 缩容节点shard的节点IP （uip），其中ha集群需要主副节点ip都传入以逗号分隔，缩容的时候必填
	ReduceShardInfo []*string `json:"ReduceShardInfo,omitnil,omitempty" name:"ReduceShardInfo"`
}

func NewScaleOutInstanceRequest added in v1.0.589 

func NewScaleOutInstanceRequest() (request *ScaleOutInstanceRequest)

func (*ScaleOutInstanceRequest) FromJsonString added in v1.0.589 

func (r *ScaleOutInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScaleOutInstanceRequest) ToJsonString added in v1.0.589 

func (r *ScaleOutInstanceRequest) ToJsonString() string

type ScaleOutInstanceRequestParams added in v1.0.589 

type ScaleOutInstanceRequestParams struct {
	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 调整clickhouse节点数量
	NodeCount *int64 `json:"NodeCount,omitnil,omitempty" name:"NodeCount"`

	// v_cluster分组，
	// 新增扩容节点将加入到已选择的v_cluster分组中，提交同步VIP生效.
	ScaleOutCluster *string `json:"ScaleOutCluster,omitnil,omitempty" name:"ScaleOutCluster"`

	// 子网剩余ip数量，用于判断当前实例子网剩余ip数是否能扩容。需要根据实际填写
	UserSubnetIPNum *int64 `json:"UserSubnetIPNum,omitnil,omitempty" name:"UserSubnetIPNum"`

	// 同步元数据节点IP （uip），扩容的时候必填
	ScaleOutNodeIp *string `json:"ScaleOutNodeIp,omitnil,omitempty" name:"ScaleOutNodeIp"`

	// 缩容节点shard的节点IP （uip），其中ha集群需要主副节点ip都传入以逗号分隔，缩容的时候必填
	ReduceShardInfo []*string `json:"ReduceShardInfo,omitnil,omitempty" name:"ReduceShardInfo"`
}

Predefined struct for user

type ScaleOutInstanceResponse added in v1.0.589 

type ScaleOutInstanceResponse struct {
	*tchttp.BaseResponse
	Response *ScaleOutInstanceResponseParams `json:"Response"`
}

func NewScaleOutInstanceResponse added in v1.0.589 

func NewScaleOutInstanceResponse() (response *ScaleOutInstanceResponse)

func (*ScaleOutInstanceResponse) FromJsonString added in v1.0.589 

func (r *ScaleOutInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScaleOutInstanceResponse) ToJsonString added in v1.0.589 

func (r *ScaleOutInstanceResponse) ToJsonString() string

type ScaleOutInstanceResponseParams added in v1.0.589 

type ScaleOutInstanceResponseParams struct {
	// 流程ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowId *string `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// 实例ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ScaleUpInstanceRequest added in v1.0.589 

type ScaleUpInstanceRequest struct {
	*tchttp.BaseRequest

	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// clickhouse节点规格。
	SpecName *string `json:"SpecName,omitnil,omitempty" name:"SpecName"`

	// 是否滚动重启，false为不滚动重启，true为滚动重启
	ScaleUpEnableRolling *bool `json:"ScaleUpEnableRolling,omitnil,omitempty" name:"ScaleUpEnableRolling"`
}

func NewScaleUpInstanceRequest added in v1.0.589 

func NewScaleUpInstanceRequest() (request *ScaleUpInstanceRequest)

func (*ScaleUpInstanceRequest) FromJsonString added in v1.0.589 

func (r *ScaleUpInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScaleUpInstanceRequest) ToJsonString added in v1.0.589 

func (r *ScaleUpInstanceRequest) ToJsonString() string

type ScaleUpInstanceRequestParams added in v1.0.589 

type ScaleUpInstanceRequestParams struct {
	// 实例唯一ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// clickhouse节点规格。
	SpecName *string `json:"SpecName,omitnil,omitempty" name:"SpecName"`

	// 是否滚动重启，false为不滚动重启，true为滚动重启
	ScaleUpEnableRolling *bool `json:"ScaleUpEnableRolling,omitnil,omitempty" name:"ScaleUpEnableRolling"`
}

Predefined struct for user

type ScaleUpInstanceResponse added in v1.0.589 

type ScaleUpInstanceResponse struct {
	*tchttp.BaseResponse
	Response *ScaleUpInstanceResponseParams `json:"Response"`
}

func NewScaleUpInstanceResponse added in v1.0.589 

func NewScaleUpInstanceResponse() (response *ScaleUpInstanceResponse)

func (*ScaleUpInstanceResponse) FromJsonString added in v1.0.589 

func (r *ScaleUpInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScaleUpInstanceResponse) ToJsonString added in v1.0.589 

func (r *ScaleUpInstanceResponse) ToJsonString() string

type ScaleUpInstanceResponseParams added in v1.0.589 

type ScaleUpInstanceResponseParams struct {
	// 流程ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	FlowId *string `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// 实例ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 错误信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ScheduleStrategy added in v1.0.589 

type ScheduleStrategy struct {
	// 备份桶名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	CosBucketName *string `json:"CosBucketName,omitnil,omitempty" name:"CosBucketName"`

	// 备份保留天数
	RetainDays *int64 `json:"RetainDays,omitnil,omitempty" name:"RetainDays"`

	// 备份的天
	WeekDays *string `json:"WeekDays,omitnil,omitempty" name:"WeekDays"`

	// 备份小时
	ExecuteHour *int64 `json:"ExecuteHour,omitnil,omitempty" name:"ExecuteHour"`

	// 策略id
	ScheduleId *int64 `json:"ScheduleId,omitnil,omitempty" name:"ScheduleId"`

	// 下次备份时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	NextBackupTime *string `json:"NextBackupTime,omitnil,omitempty" name:"NextBackupTime"`
}

type SearchTags added in v1.0.676 

type SearchTags struct {
	// 标签的键
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// 标签的值
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`

	// 1表示只输入标签的键，没有输入值；0表示输入键时且输入值
	AllValue *int64 `json:"AllValue,omitnil,omitempty" name:"AllValue"`
}

type ServiceInfo added in v1.0.618 

type ServiceInfo struct {
	// 服务名称
	// 注意：此字段可能返回 null，表示取不到有效值。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 服务的版本
	// 注意：此字段可能返回 null，表示取不到有效值。
	Version *string `json:"Version,omitnil,omitempty" name:"Version"`
}

type TablePrivilegeInfo added in v1.0.742 

type TablePrivilegeInfo struct {
	// 表名称
	TableName *string `json:"TableName,omitnil,omitempty" name:"TableName"`

	// 表权限列表 SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE 查询、插入、设置、清空表、删除表
	TablePrivileges []*string `json:"TablePrivileges,omitnil,omitempty" name:"TablePrivileges"`
}

type Tag added in v1.0.563 

type Tag struct {
	// 标签的键
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// 标签的值
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

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.